HCXAppliance Category | Vmware PowerCLI Reference

HCX Appliance Category

Cmdlets are usually implemented around resource operations. The four basic operations are CREATE, READ, UPDATE and DELETE. This set of operations is known as CRUD. Most of the cmdlets support CRUD which are respectively cmdlets that start with the New/Get/Set/Remove cmdlet verbs but they also may have additional operations

Step 1: Retrieve a object by running a Get command

You can READ objects by using Get-HCXAppliance cmdlet. See example below:

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

Get-HCXAppliance

Step 2 : Run commands from the CRUD group

You can CREATE objects by using New-HCXAppliance cmdlet. See example below:

# Deploys a new L2Concentrator appliance.

New-HCXAppliance -AdminPassword $myAdminPassword -Compute $myApplianceCompute -DVS $myDvs -Datastore $myApplianceDatastore -DestinationSite $myDestination -L2Concentrator -NetworkGateway 192.168.4.253 -NetworkIp 192.168.4.220/24 -RootPassword $myRootPassword -ApplianceManagementNetwork $myApplianceNetwork -Name $myApplianceName
You can UPDATE objects by using Set-HCXAppliance cmdlet. See example below:

# Resets the passwords for the appliance.

$myAppliance = Get-HCXAppliance -Name 'myAppliance' Set-HCXAppliance -AdminPassword 'myAdminPassword' -RootPassword 'myRootPassword' -Appliance $myAppliance
You can REMOVE objects by using Remove-HCXAppliance cmdlet. See example below:

# Removes the appliance.

Remove-HCXAppliance -Appliance $myAppliance -DestinationSite $myDestination -Force