Get-HCXSite
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.
Syntax
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
Id | String[] | named |
|
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. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | 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. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional | Name | String[] | named |
|
Specifies the name of the HCX site. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | 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 | Type | HCXSiteType | named |
|
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
Destination | SwitchParameter | named |
|
Specifies the destination site from which you can retrieve sites. |
| optional | Name | String[] | named |
|
Specifies the name of the HCX site. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | 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 | Type | HCXSiteType | named |
|
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
Source | SwitchParameter | named |
|
Specifies the sites that you want to retrieve from the source site. |
| optional | Name | String[] | named |
|
Specifies the name of the HCX site. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | 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 | Type | HCXSiteType | named |
|
Output
VMware.VimAutomation.Hcx.Types.V1.HCXSiteExamples
Example 1
Get-HCXSite
Retrieves a list of the HCX site at the source site.
Example 2
Get-HCXSite -Destination
Retrieves a list of the HCX site at the destination site.
Example 3
Get-HCXSite -Name "mySiteName"
Retrieves a list of the HCX site by name.
Related Commands
HCXSite
This cmdlet retrieves a list of HCX sites.
HCXSitePairing
This cmdlet retrieves a list of site pairings from the HCX.
This cmdlet creates an HCX site pairing request.
This cmdlet removes the specified site pairing from the HCX.