Set-HCXAppliance

Syntax

• SetPasswords
• Rename
• StartSync

Set-HCXAppliance

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

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
required	Appliance	HCXAppliance	named	pipeline	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.
optional	AdminPassword	SecureString	named		Specifies the password by which you can log in to the appliance as an administrator.
optional	RootPassword	SecureString	named		Specifies the password by which you can log in to the appliance as a root user.
optional	Server	HcxServer[]	named	wildcards	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.

Set-HCXAppliance

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

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
required	Appliance	HCXAppliance	named	pipeline	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.
optional	Name	String	named		Specifies the name of the appliance.
optional	Server	HcxServer[]	named	wildcards	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.

Set-HCXAppliance

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

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
required	Appliance	HCXAppliance	named	pipeline	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.
required	StartSync	SwitchParameter	named		Specifies that you want to start a sync process for an existing appliance.
optional	DestinationSite	HCXSite	named	pipeline	Specifies the destination site.
optional	Server	HcxServer[]	named	wildcards	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

$myAppliance = Get-HCXAppliance -Name 'myAppliance'

Set-HCXAppliance -AdminPassword 'myAdminPassword' -RootPassword 'myRootPassword' -Appliance $myAppliance

Resets the passwords for the appliance.

Example 2

$myAppliance = Get-HCXAppliance -Name 'myAppliance'

$myDestinationSite = Get-HCXSite -Destination

Set-HCXAppliance -DestinationSite $myDestinationSite -Appliance $myAppliance -StartSync

Starts a sync process for the appliance.

Example 3

$myAppliance = Get-HCXAppliance -Name 'myAppliance'

Set-HCXAppliance -Name 'applianceName' -Appliance $myAppliance

Renames the appliance.

Related Commands