Get-NetworkPool

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

Syntax

[-Name  <String[]>]
[-OrgVdc  <OrgVdc[]>]
[-ProviderVdc  <ProviderVdc[]>]
[-Server  <CIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
Name
String[] named Specifies the names of the network pools you want to retrieve.
optional
OrgVdc
OrgVdc[] named
  • pipeline
  • Specifies organization virtual datacenters (vDCs) to retrieve the network pools assigned to the organization vDCs.
    optional
    ProviderVdc
    ProviderVdc[] named
  • pipeline
  • Specifies provider virtual datacenters (vDCs) to filter network pools by. The operation retrieves only network pools that are available to the specified provider vDC.
    optional
    Server
    CIServer[] named
  • pipeline
  • Specifies the cloud servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer.

    -Id  <String[]>
    [-Server  <CIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Id
    String[] named 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.
    optional
    Server
    CIServer[] named
  • pipeline
  • Specifies the cloud servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer.

    Output

    VMware.VimAutomation.Cloud.Types.V1.NetworkPool

    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.

    Related Commands

    Feedback

    Was this page helpful?