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