PowerCLI Reference

Set-HCXAppliance

Synopsis

This cmdlet modifies the HCX appliances of type Interconnect and Network Extension that are available on the HCX Server system.

Syntax

Set-HCXAppliance [-AdminPassword <SecureString>] -Appliance <HCXAppliance> [-RootPassword <SecureString>] [-Server <HcxServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-HCXAppliance -Appliance <HCXAppliance> [-DestinationSite <HCXSite>] [-Server <HcxServer[]>] -StartSync [-Confirm] [-WhatIf] [<CommonParameters>]

Set-HCXAppliance -Appliance <HCXAppliance> [-Server <HcxServer[]>] [-Confirm] [-WhatIf] [-Name <String>] [<CommonParameters>]

Related Commands

Detailed Description

This cmdlet modifies the HCX appliances of type Interconnect and Network Extension that are available on the HCX Server system.

Parameters

Name	Type	Description	Required?	Pipeline Input
AdminPassword	SecureString	Specifies the password by which you can log in to the appliance as an administrator.	false	False
Appliance	HCXAppliance	Specifies the appliance for which you want to reset password or start the sync process. If you want to retrieve an appliance, use the Get-HCXAppliance cmdlet.	true	True (ByValue)
Confirm	SwitchParameter	If 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.	false	False
DestinationSite	HCXSite	Specifies the destination site.	false	True (ByValue)
Name	String	Specifies the name of the appliance.	false	False
RootPassword	SecureString	Specifies the password by which you can log in to the appliance as a root user.	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
StartSync	SwitchParameter	Specifies that you want to start a sync process for an existing appliance.	true	False
WhatIf	SwitchParameter	Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	False

Return Type

VMware.VimAutomation.Hcx.Types.V1.HCXJob

Notes

Examples

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

PS C:\> Set-HCXAppliance -AdminPassword $myAdminPassword -RootPassword  $myRootPassword -Appliance $myAppliance

Resets the passwords for the appliance.

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

PS C:\> Set-HCXAppliance -DestinationSite $myDestinationSite -Appliance $myAppliance -StartSync -DestinationSite $myDestinationSite

Starts a sync process for the appliance.