Guide

Network list

Get-NetworkList

Suggest Edits

Synopsis

Get a network list.

Syntax

Get-NetworkList [-Extended] [-IncludeElements] [-ListType <String>] [-Search <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-NetworkList [-NetworkListID <String>] [-Extended] [-IncludeElements] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all network lists or retrieves a specific network list by its ID. When listing all, you can filter the results by name with the -Search parameter or by type with the -ListType parameter.

Parameters

‑AccountSwitchKey
String Pipeline input: False

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑Extended
Switch Pipeline input: False

When enabled, provides additional response data identifying who created and updated the list and when, and the network list's deployment status in both STAGING and PRODUCTION environments. This data takes longer to provide.
‑IncludeElements
Switch Pipeline input: False

When enabled, the response list includes all items. For large network lists, this may slow responses and show large response objects.
‑ListType
String Accepted values: IP, GEO Parameter sets: all Pipeline input: False

If provided, filters the output to list only the given type of network lists, either IP or GEO. This corresponds to the network list object's type member.
‑NetworkListID
String Parameter sets: single Pipeline input: False

Your network list's ID.
‑Search
String Parameter sets: all Pipeline input: False

Lists only items that match the specified substring in any network list's name or list of items.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links

Updated about 5 hours ago