New-HCXSitePairing Command | Vmware PowerCLI Reference

New-HCXSitePairing

This cmdlet creates an HCX site pairing request. To use or deploy the HCX migration, mobility and extension services, you must register the remote site in the local/source HCX system. A single HCX source site can be connected with one or more HCX Cloud remote sites.

Syntax

New-HCXSitePairing
-Password < SecureString >
-Url < String >
-Username < String >
[-ProgressAction < ActionPreference > ]
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Password SecureString named
Specifies the password you want to use for authenticating with the remote site.
required
Url String named
Specifies the URL of the remote site that you want to register.
required
Username String named
Specifies the user name for authenticating on the remote 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.

Output

VMware.VimAutomation.Hcx.Types.V1.HCXJob

Examples

Example 1

New-HCXSitePairing -Url $myUrl -Username $myUsername -Password $myPassword

Registers a new site pairing with the specified cloud URL.

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.