Get-ExternalNetwork Command | Vmware PowerCLI Reference

Get-ExternalNetwork

This cmdlet retrieves cloud external networks. You can filter the returned networks by name, ID, virtual LAN ID, and provider vDC. Note: This cmdlet is only available to Provider Administrators.

Syntax

Get-ExternalNetwork
[-Name < String[] > ]
[-ProgressAction < ActionPreference > ]
[-ProviderVdc < ProviderVdc[] > ]
[-Server < CIServer[] > ]
[-VlanId < String[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Name String[] named
  • wildcards
Specifies the names of the cloud external networks you want to retrieve.
optional ProgressAction ActionPreference named
optional ProviderVdc ProviderVdc[] named
  • pipeline
  • wildcards
Retrieves only the external networks accessible by the specified provider Vdc.
optional Server CIServer[] named
  • wildcards
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.
optional VlanId String[] named
Specifies the vLAnIDs of the cloud external networks you want to retrieve.
Get-ExternalNetwork
-Id < String[] >
[-ProgressAction < ActionPreference > ]
[-Server < CIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Id String[] named
Specifies the IDs of the cloud external networks 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 ProgressAction ActionPreference named
optional Server CIServer[] named
  • wildcards
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.ExternalNetwork

Examples

Example 1

Get-ExternalNetwork

Gets all available cloud external networks. You must be connected as a system administrator.

Example 2

Get-ExternalNetwork -Name ExtNetwork -Server $CIServer

Gets an external network named ExtNetwork from provided server. You must be connected as a system administrator.

Example 3

Get-ProviderVdc "myProviderVDC" | Get-ExternalNetwork

Gets the external networks from the specified provider Vdc. You must be connected as a system administrator.

Related Commands

ExternalNetwork

This cmdlet retrieves cloud external networks.