Get-HCXAppliance

This cmdlet retrieves the appliances of type Interconnect, WAN Optimization, and L2Concentrator (Network Extension).

Syntax

[-Name  <String[]>]
[-Server  <HcxServer[]>]
[-Type  <HXCApplianceType>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
Name
String[] named
  • wildcards
  • Specifies the names of the appliance you want to retrieve.
    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.
    optional
    Type
    HXCApplianceType named Specifies the type of the appliances you want to retrieve. The valid values are L2Concentrator, Interconnect, and WANOptimization.

    -Id  <String[]>
    [-Server  <HcxServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Id
    String[] named Specifies the IDs of the appliances you want to retrieve.
    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.

    -ServiceMesh  <HCXServiceMesh>
    [-Name  <String[]>]
    [-Server  <HcxServer[]>]
    [-Type  <HXCApplianceType>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    ServiceMesh
    HCXServiceMesh named
  • pipeline
  • Specifies the Service Mesh for which you want to retrieve the appliances.
    optional
    Name
    String[] named
  • wildcards
  • Specifies the names of the appliance you want to retrieve.
    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.
    optional
    Type
    HXCApplianceType named Specifies the type of the appliances you want to retrieve. The valid values are L2Concentrator, Interconnect, and WANOptimization.

    Output

    VMware.VimAutomation.Hcx.Types.V1.HCXAppliance

    Examples


    Example 1

    PS C:\> Get-HCXAppliance

    Retrieves the available appliances of type Interconnect, WAN Optimization, and L2Concentrator.

    Example 2

    PS C:\> Get-HCXAppliance -Type L2Concentrator

    Retrieves the available appliances of type L2Concentrator.

    Example 3

    PS C:\> Get-HCXAppliance -Name "myName"

    Retrieves available appliances that match the "myName" name.

    Related Commands

    Feedback

    Was this page helpful?