PowerCLI Reference

Get-ExternalNetwork

Synopsis

This cmdlet retrieves cloud external networks.

Syntax

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

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

Related Commands

Online version

Detailed Description

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.

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the names of the cloud external networks you want to retrieve.	false	false
Id	String[]	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.	true	false
InformationAction	ActionPreference		false	false
InformationVariable	String		false	false
PipelineVariable	String		false	false
ProviderVdc	ProviderVdc[]	Retrieves only the external networks accessible by 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	false
VlanId	String[]	Specifies the vLAnIDs of the cloud external networks you want to retrieve.	false	false

Return Type

Zero or more ExternalNetwork objects

Notes

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.