PowerCLI Reference

Get-HCXContainer

Synopsis

This cmdlet retrieves the list of HCX containers.

Syntax

Get-HCXContainer [[-Name] <String[]>] [-Server <HcxServer[]>] [-Site <HCXSite[]>] [-Type {ComputeContainer | Host | Datacenter | Folder | Cluster | ResourcePool | ComputeResource}] [<CommonParameters>]

Get-HCXContainer [-Server <HcxServer[]>] -Uid <String[]> [<CommonParameters>]

Related Commands

Detailed Description

This cmdlet retrieves a list of HCX containers of type ComputeContainer, Host, Datacenter, Folder, Cluster, ResourcePool, and ComputeResource at the HCXSite. If the HCXSite is not passed as input, then source site containers are listed. You can create new HCX migration and replication requests by using the output of the cmdlet.

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the name of the HCX container.	false	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
Site	HCXSite[]	Specifies the HCX site for which you want to list the containers. If this parameter is not specified, the default one is selected from the source site.	false	True (ByValue)
Type	ContainerType	Specifies the type of the HCX container. The valid values are ComputeContainer, Host, Datacenter, Folder, Cluster, ResourcePool, and ComputeResource.	false	False
Uid	String[]	Specifies the Uid of the HCX container. Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.	true	False

Return Type

VMware.VimAutomation.Hcx.Types.V1.HCXContainer

Notes

Examples

-------------------------- Example 1 --------------------------

PS C:\> Get-HCXContainer

Retrieves the available HCX containers at the source site.

-------------------------- Example 2 --------------------------

PS C:\> Get-HCXContainer -Type Folder

Retrieves the available HCX containers of type Folder at the source site.

-------------------------- Example 3 --------------------------

PS C:\> Get-HCXContainer -Name "onpremDC*"

Retrieves the HCX containers by name at the source site.

-------------------------- Example 4 --------------------------

PS C:\> $myDestination = Get-HCXSite -Destination
        Get-HCXContainer -Site $myDestination

Retrieves the HCX containers from the destination site.

-------------------------- Example 5 --------------------------

PS C:\> $myContainer = Get-HCXContainer -Name "myContainerName"
        Get-HCXContainer -Uid $myContainer.Uid

Retrieves the HCX container by Uid.