PowerCLI Reference

Get-NetworkPool

Synopsis

This cmdlet retrieves the network pools available on a vCloud Director server.

Syntax

Get-NetworkPool [[-Name] <String[]>] [-ProviderVdc <ProviderVdc[]>] [-OrgVdc <OrgVdc[]>] [-Server <CIServer[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]

Get-NetworkPool -Id <String[]> [-Server <CIServer[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]

Related Commands

Online version

Detailed Description

This cmdlet retrieves the network pools available on a vCloud Director server.

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the names of the network pools you want to retrieve.	false	false
Id	String[]	Specifies the IDs of the network pools you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.	true	false
InformationAction	ActionPreference		false	false
InformationVariable	String		false	false
OrgVdc	OrgVdc[]	Specifies organization virtual datacenters (vDCs) to retrieve the network pools assigned to the organization vDCs.	false	true (ByValue)
PipelineVariable	String		false	false
ProviderVdc	ProviderVdc[]	Specifies provider virtual datacenters (vDCs) to filter network pools by. The operation retrieves only network pools that are available to the specified provider vDC.	false	true (ByValue)
Server	CIServer[]	Specifies the cloud servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer.	false	true (ByValue)

Return Type

Zero or more NetworkPool objects

Notes

Examples

-------------- Example 1 --------------

Get-NetworkPool -Name 'MyNetworkPool' -OrgVdc 'MyOrgVdc' -ProviderVdc 'MyProviderVdc'

Retrieve a network pool by specifying the Name, OrgVdc, and ProviderVdc filters.

-------------- Example 2 --------------

Get-NetworkPool -Id 'MyNetworkPoolId'

Retrieve a network pool by specifying its ID.

-------------- Example 3 --------------

Get-OrgVdc "MyOrgVdc*" | Get-NetworkPool

Retrieve all network pools that provide network resources for all organization virtual datacenters with names starting with MyOrgVdc.

-------------- Example 4 --------------

Get-OrgVdc "MyProviderVdc*" | Get-NetworkPool

Retrieve all network pools in all provider virtual datacenters (vDCs) with names starting with MyProviderVdc.