Get-EdgeGateway Command | Vmware PowerCLI Reference

Get-EdgeGateway

This cmdlet retrieves organization virtual datacenter's (vDCs) edge gateways. You can filter the returned objects by using the cmdlet parameters.

Syntax

Get-EdgeGateway
[-Name < String[] > ]
[-OrgVdc < OrgVdc[] > ]
[-Server < CIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Name String[] named
Specifies the names of the edge gateway you want to retrieve.
optional OrgVdc OrgVdc[] named
  • pipeline
Specifies the organizations virtual datacenter (VDC) for which you want to retrieve edge gateways.
optional Server CIServer[] named
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.
Get-EdgeGateway
-Id < String[] >
[-Server < CIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Id String[] named
Specifies the IDs of the edge gateway 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
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.EdgeGateway

Examples

Example 1

Get-EdgeGateway

Gets the cloud edge gateways available to you.

Example 2

Get-EdgeGateway -Name Edge*

Gets the edge gateways with names starting with the specified string.

Example 3

Get-EdgeGateway -ID EdgeGatewayId

Gets the edge gateway with the provided Id.

Example 4

Get-EdgeGateway -OrgVdc OrgVdc1

Retrieves all edge gateways for the specified organization virtual datacenter (VDC).

Example 5

Get-OrgVdc OrgVdc1 | Get-EdgeGateway

Retrieves the edge gateways for an organization virtual datacenter (VDC).

Related Commands

EdgeGateway

This cmdlet retrieves organization vDC's edge gateways.