Get-HCXVM
This cmdlet retrieves a list of virtual machines. You can create new HCX migration and replication requests by using the output of the cmdlet.
Syntax
[-Container
<HCXContainer[]>]
[-Name <String[]>]
[-PowerState <PowerState>]
[-Server <HcxServer[]>]
[-Site <HCXSite[]>]
[CommonParameters]
[-Name <String[]>]
[-PowerState <PowerState>]
[-Server <HcxServer[]>]
[-Site <HCXSite[]>]
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
optional |
|
HCXContainer[] | named |
|
Specifies the HCX container for which you want to list the virtual machines. | optional |
|
String[] | named |
|
Specifies the name of the HCX virtual machine. | optional |
|
PowerState | named |
|
Indicates the virtual machine power state. The valid values are PoweredOn and PoweredOff. | optional |
|
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 |
|
HCXSite[] | named |
|
Specifies the HCX site for which you want to list the virtual machines. If this parameter is not specified, the default one is selected from the source site. |
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required |
|
String[] | named |
|
Specifies the Uid of the HCX virtual machine. | optional |
|
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. |
Output
VMware.VimAutomation.Hcx.Types.V1.HCXVM
Examples
Example 1
PS C:\> Get-HCXVM
Retrieves a list of the HCX virtual machines from the source site.
Example 2
PS C:\> $myDestination = Get-HCXSite -Destination -Name "myDestinationName"
Get-HCXVM -Site $myDestination
Retrieves a list of the HCX virtual machines from the destination site.
Example 3
PS C:\> Get-HCXVM -Name "myVmName"
Retrieves a list of the HCX virtual machines filtered by name.
Example 4
PS C:\> Get-HCXVM -PowerState PoweredOn
Retrieves a list of the HCX virtual machines filtered by the power state.
Example 5
PS C:\> $myVm = Get-HCXVM -Name "myVmName"
Get-HCXVM -Uid $myVm.Uid
Retrieves a list of the HCX virtual machines by Uid.
Example 6
PS C:\> $container = Get-HCXContainer -Name "myContainerName"
Get-HCXVM -Container $container
Retrieves a list of the HCX virtual machines filtered by the hcx container.