VMware HCX Commands Index
All available VMware HCX commands.
VMware HCX
HCX Appliance
| Get-HCXAppliance | This cmdlet retrieves the appliances of type Interconnect, WAN Optimization, and Network Extension that are available on the HCX Server system. |
| New-HCXAppliance | This cmdlet creates an HCX Appliance. |
| Remove-HCXAppliance | This cmdlet removes an HCX Appliance. |
| Set-HCXAppliance | This cmdlet modifies the HCX appliances of type Interconnect and Network Extension that are available on the HCX Server system. |
HCX Compute
| Get-HCXComputeProfile | This cmdlet retrieves a list of the HCX Compute Profiles. |
| New-HCXComputeProfile | This cmdlet creates an HCX Compute Profile. |
| New-HCXComputeProfileDVS | This cmdlet creates a Distributed Virtual Switch (DVS) configuration for a Compute Profile. |
| New-HCXComputeProfileNetwork | This cmdlet creates a Network Profile configuration for the Compute Profile. |
| Remove-HCXComputeProfile | This cmdlet removes an existing HCX Compute Profile. |
| Set-HCXComputeProfile | This cmdlet modifies the HCX Compute Profile. |
HCX Container
| Get-HCXContainer | This cmdlet retrieves the list of HCX containers. |
HCX Datastore
| Get-HCXDatastore | This cmdlet retrieves a list of HCX datastores. |
HCX Gateway
| Get-HCXGateway | This cmdlet retrieves a list of HCX gateways. |
HCX Interconnect
| Get-HCXInterconnectStatus | This cmdlet retrieves a list of the HCX Interconnect status. |
HCX Inventory
| Get-HCXInventoryCompute | This cmdlet retrieves a list of vCenter Server compute resources from the connected HCX server. |
| Get-HCXInventoryDatastore | This cmdlet retrieves a list of the vCenter Server datastore from the connected HCX server. |
| Get-HCXInventoryDVS | This cmdlet retrieves a list of the vCenter Server Distributed Virtual Switch (DVS) from the connected HCX server. |
| Get-HCXInventoryNetwork | This cmdlet retrieves a list of the vCenter Server network from the connected HCX server. |
HCX Job
| Get-HCXJob | This cmdlet retrieves a list of the HCX job. |
| Wait-HCXJob | This cmdlet waits for the job to complete. |
HCX Migration
| Get-HCXMigration | This cmdlet retrieves the list of HCX migrations. |
| New-HCXMigration | This cmdlet creates an HCX migration request. |
| Set-HCXMigration | This cmdlet modifies the HCX migrations. |
| Start-HCXMigration | This cmdlet starts the HCX migrations. |
| Test-HCXMigration | This cmdlet validates an HCX migration request. |
HCX Mobility
| Get-HCXMobilityGroup | This cmdlet retrieves a list of HCX mobility groups. |
| New-HCXMobilityGroup | This cmdlet creates an HCX mobility group request. |
| New-HCXMobilityGroupConfiguration | This cmdlet creates an HCX mobility group configuration request. |
| Set-HCXMobilityGroup | This cmdlet modifies the HCX mobility group. |
| Set-HCXMobilityGroupConfiguration | This cmdlet updates the HCX mobility group configurations. |
| Start-HCXMobilityGroupMigration | This cmdlet starts the HCX Mobility Group migrations. |
| Stop-HCXMobilityGroupMigration | This cmdlet stops the migration of all virtual machines in the mobility group. |
| Test-HCXMobilityGroup | This cmdlet validates an HCX mobility group object. |
HCX Network
| Get-HCXNetwork | This cmdlet retrieves a list of HCX networks. |
| Get-HCXNetworkBacking | This cmdlet retrieves a list of HCX Network Backings. |
| Get-HCXNetworkExtension | This cmdlet retrieves a list of HCX Network Extension (HCX-NET-EXT). |
| Get-HCXNetworkProfile | This cmdlet retrieves a list of HCX Network Profiles. |
| New-HCXNetworkExtension | This cmdlet creates an HCX Network Extension (L2 extension). |
| New-HCXNetworkMapping | This cmdlet creates an HCX network mapping request. |
| New-HCXNetworkProfile | This cmdlet creates an HCX Network Profile. |
| Remove-HCXNetworkExtension | This cmdlet removes an HCX Network Extension. |
| Remove-HCXNetworkProfile | This cmdlet removes an existing HCX Network Profile. |
| Set-HCXNetworkProfile | This cmdlet modifies the HCX Network Profile. |
HCX Replication
| Get-HCXReplication | This cmdlet retrieves a list of HCX replications. |
| Get-HCXReplicationSnapshot | This cmdlet retrieves a list of HCX replication snapshots. |
| New-HCXReplication | This cmdlet creates an HCX replication request. |
| Remove-HCXReplication | This cmdlet removes an existing HCX replication. |
| Resume-HCXReplication | This cmdlet resumes an HCX replication. |
| Set-HCXReplication | This cmdlet modifies an existing HCX replication. |
| Start-HCXReplication | This cmdlet starts an HCX replication. |
| Suspend-HCXReplication | This cmdlet suspends an existing HCX replication. |
| Test-HCXReplication | This cmdlet validates an HCX replication request. |
HCX Sentinel
| New-HCXSentinelBundle | This cmdlet creates and downloads an HCX Sentinel bundle. |
| Uninstall-HCXSentinel | This cmdlet uninstalls the sentinel from a virtual machine. |
| Update-HCXSentinel | This cmdlet upgrades the HCX sentinel software running on the source virtual machine. |
HCX Server
| Connect-HCXServer | This cmdlet establishes a connection to a HCX server. |
| Disconnect-HCXServer | This cmdlet closes the connection to one or more HCX servers. |
HCX Service
| Get-HCXService | This cmdlet retrieves PSObject objects that represent a proxy to an HCX API service. |
HCX Service Mesh
| Get-HCXServiceMesh | This cmdlet retrieves a list of the HCX Service Mesh. |
| New-HCXServiceMesh | This cmdlet creates an HCX Service Mesh. |
| New-HCXServiceMeshDVS | This cmdlet creates a DVS configuration for the Service Mesh. |
| Remove-HCXServiceMesh | This cmdlet removes an existing HCX Service Mesh. |
| Set-HCXServiceMesh | Specifies the HCX Service Mesh that you want to modify. |
HCX Site
| Get-HCXSite | This cmdlet retrieves a list of HCX sites. |
| Get-HCXSitePairing | This cmdlet retrieves a list of site pairings from the HCX. |
| New-HCXSitePairing | This cmdlet creates an HCX site pairing request. |
| Remove-HCXSitePairing | This cmdlet removes the specified site pairing from the HCX. |
HCX Static
| New-HCXStaticRoute | This cmdlet creates a static route. |
HCX Storage
| Get-HCXStorageProfile | This cmdlet retrieves a list of HCX storage profiles. |
HCXvm
| Get-HCXVM | This cmdlet retrieves a list of virtual machines (VMs). |
