Get-HCXAppliance
This cmdlet retrieves the appliances of type Interconnect, WAN Optimization, and L2Concentrator (Network Extension).
Syntax
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
Id | String[] | named |
|
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. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | HcxServer[] | named |
|
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. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
ServiceMesh | HCXServiceMesh | named |
|
Specifies the Service Mesh for which you want to retrieve the appliances. |
| optional | Name | String[] | named |
|
Specifies the names of the appliance you want to retrieve. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | HcxServer[] | named |
|
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. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional | Name | String[] | named |
|
Specifies the names of the appliance you want to retrieve. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | HcxServer[] | named |
|
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.HCXApplianceExamples
Example 1
Get-HCXAppliance
Retrieves the available appliances of type Interconnect, WAN Optimization, and L2Concentrator.
Example 2
Get-HCXAppliance -Type L2Concentrator
Retrieves the available appliances of type L2Concentrator.
Example 3
Get-HCXAppliance -Name "myName"
Retrieves available appliances that match the "myName" name.
Related Commands
HCXAppliance
This cmdlet retrieves the appliances of type Interconnect, WAN Optimization, and Network Extension that are available on the HCX Server system.
This cmdlet creates an HCX Appliance.
This cmdlet removes an HCX Appliance.
This cmdlet modifies the HCX appliances of type Interconnect and Network Extension that are available on the HCX Server system.