PowerCLI Reference

Get-HCXGateway

Synopsis

This cmdlet retrieves a list of HCX gateways.

Syntax

Get-HCXGateway [[-Name] <String[]>] -DestinationSite <HCXSite[]> [-Server <HcxServer[]>] [<CommonParameters>]

Related Commands

Detailed Description

This cmdlet retrieves a list of HCX gateways. This retrieves the gateways from the destination site. You can create a new HCX network extension request by using the output of the cmdlet.

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the name of the HCX gateway.	false	False
DestinationSite	HCXSite[]	Specifies the destination site.	true	True (ByValue)
Server	HcxServer[]	Specifies the HCX Server systems 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 the Connect-HCXServer cmdlet.	false	False

Return Type

VMware.VimAutomation.Hcx.Types.V1.HCXGateway

Notes

Examples

-------------------------- Example 1 --------------------------

PS C:\> $myDestination = Get-HCXSite -Destination -Name "myDestinationName"
        Get-HCXGateway -DestinationSite $myDestination

Retrieves the HCX gateway by destination site.

-------------------------- Example 2 --------------------------

PS C:\> $myDestination = Get-HCXSite -Destination -Name "myDestinationName"
        Get-HCXGateway -DestinationSite $myDestination -Name "myGatewayName"

Retrieves the HCX gateway by name.