PowerCLI Reference



This cmdlet creates an HCX site pairing request.


New-HCXSitePairing -Password <SecureString> [-Server <HcxServer[]>] -Url <String> -Username <String> [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Detailed Description

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.


NameTypeDescriptionRequired?Pipeline InputDefault Value
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
PasswordSecureStringSpecifies the password you want to use for authenticating with the remote site.trueFalse
ServerHcxServer[]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.falseFalse
UrlStringSpecifies the URL of the remote site that you want to register.trueFalse
UsernameStringSpecifies the user name for authenticating on the remote site.trueFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type




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

PS C:\>  New-HCXSitePairing -Url $myUrl -Username $myUsername -Password $myPassword

Registers a new site pairing with the specified cloud URL.

Copyright © VMware, Inc. All rights reserved.