Get-HCXGateway

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.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
DestinationSite
HCXSite[] named
  • pipeline
  • Specifies the destination site.
    optional
    Name
    String[] named
  • wildcards
  • Specifies the name of the HCX gateway.
    optional
    Server
    HcxServer[] named
  • wildcards
  • Specifies the HCX Server systems 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 the Connect-HCXServer cmdlet.

    Output

    VMware.VimAutomation.Hcx.Types.V1.HCXGateway

    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.

    Related Commands

    Feedback

    Was this page helpful?