PowerCLI Reference

Get-HCXAppliance

Synopsis

This cmdlet retrieves the appliances of type Interconnect, WAN Optimization, and Network Extension that are available on the HCX (Hybrid Cloud Extension) Server system.

Syntax

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

Get-HCXAppliance [[-Name] <String[]>] [-Server <HcxServer[]>] [-Type {L2Concentrator | Interconnect | WANOptimization}] [<CommonParameters>]

Related Commands

Detailed Description

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

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the names of the appliance you want to retrieve.	false	False
Id	String[]	Specifies the IDs of the appliances you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in the list.	true	False
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
Type	HXCApplianceType	Specifies the type of the appliances you want to retrieve. The valid values are L2Concentrator, Interconnect, and WANOptimization.	false	False

Return Type

VMware.VimAutomation.Hcx.Types.V1.HCXAppliance

Notes

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.