This is an archive version of the document. To get the most up-to-date information, see the current version.

Set-VBRESXi

Short Description

Modifies ESXi hosts added to Veeam Backup & Replication.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRESXi -Server <CHost> [-Port <int>] [-Credentials <CCredentials>] [-Description <string>] [<CommonParameters>]

Detailed Description

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

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Server	Specifies the ESXi host you want to modify.	True	Named	True (ByValue, ByProperty Name)	False
Port	Specifies the Web service port for connection to the ESXi host. Default: 443.	False	Named	False	False
Description	Specifies the description of the ESXi server.	False	Named	False	False
Credentials	Specifies the credentials you want to use for authenticating with the ESXi server.	True	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Example

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

You will need to perform the following steps:

Run Get-VBRServer to get the ESXi host. Save the result to the $host variable.
Run Get-Credential to create a credential object. Type the credentials you want to use for authenticating with the ESXi host. Save the result to the $creds variable.
Run Set-VBRESXi with the $host and $creds variables.

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

$creds = Get-Credential

Set-VBRESXi -Server $host -Credentials $creds -Port 442

Related Commands

Get-VBRServer

Get-VBRCredentials