PowerCLI Reference

Get-HCXSite

Synopsis

This cmdlet retrieves a list of HCX sites.

Syntax

Get-HCXSite [[-Name] <String[]>] -Destination [-Server <HcxServer[]>] [<CommonParameters>]

Get-HCXSite -Id <String[]> [-Server <HcxServer[]>] [<CommonParameters>]

Get-HCXSite [[-Name] <String[]>] [-Server <HcxServer[]>] [<CommonParameters>]

Get-HCXSite [[-Name] <String[]>] [-Server <HcxServer[]>] -Source [<CommonParameters>]

Related Commands

Detailed Description

This cmdlet retrieves a list of HCX sites and local/remote HCXSites according to the Source or Destination parameters. You can create new HCX migration, replication, and network extension requests by using the output of the cmdlet.

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the name of the HCX site.	false	False
Destination	SwitchParameter	Specifies the destination site from which you can retrieve sites.	true	False
Id	String[]	Specifies the Id of the HCX site. 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
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
Source	SwitchParameter	Specifies the sites that you want to retrieve from the source site.	true	False

Return Type

VMware.VimAutomation.Hcx.Types.V1.HCXSite

Notes

Examples

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

PS C:\> Get-HCXSite

Retrieves a list of the HCX site at the source site.

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

PS C:\> Get-HCXSite -Destination

Retrieves a list of the HCX site at the destination site.

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

PS C:\> Get-HCXSite -Name "mySiteName"

Retrieves a list of the HCX site by name.