Set-VBRESX (obsolete)

Short Description

Modifies ESXi hosts added to Veeam Backup & Replication.

Note

This cmdlet is obsolete and will not be supported the next version.

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Set-VBRESX -Server <CHost> [-Credentials <CCredentials>] [-SSHCredentials <CCredentials>] [-SSHEnable]

[-Port <Int32>] [-Description <String>] [-Force] [<CommonParameters>]

Detailed Description

This cmdlet modifies an ESXi host added to the Veeam Backup & Replication. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Credentials	Specifies the credentials you want to use for authenticating with the ESXi server.	`CCredentials`	False	Named	False
Description	Specifies the description of the ESXi server.	`String`	False	Named	False
Force	Defines that the cmdlet will modify settings of ESX hosts without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
Port	Specifies the Web service port for connection to the ESXi host. Default: 443.	`Int32`	False	Named	False
Server	Specifies the ESXi host you want to modify.	`CHost`	True	Named	False
SSHCredentials	For SSH connection. Specify credentials you want to use to authenticate with the service console.	`CCredentials`	False	Named	False
SSHEnable	For SSH connection. Defines that the ESXi host is connected using service console connection.	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Changing Credentials and Web Service Port Settings for ESXi Host

This example shows how to change the credentials and Web service port settings for the ESXi host.

$host = Get-VBRServer -Type ESXi -Name support.east.local

$creds = Get-Credential

Set-VBRESX -Server $host -Credentials $creds -Port 444

Perform the following steps:

Run the Get-VBRServer cmdlet. Set the ESXi option for the Type parameter value. Specify the Name parameter value. Save the result to the $host variable.
Run the Get-Credential cmdlet. Type the credentials you want to use for authenticating with the ESXi host. Save the result to the $creds variable.
Run the Set-VBRESX cmdlet. Set the $host variable as the Server parameter value. Set the $creds variable as the Credentials parameter value. Specify the Port parameter value.