This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBRESX (obsolete)
Short Description
Modifies ESXi hosts added to Veeam Backup & Replication.
|
This cmdlet is obsolete and will not be supported the next version. |
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Set-VBRESX -Server <CHost> [-Credentials <CCredentials>] [-SSHCredentials <CCredentials>] [-SSHEnable] [-Port <int>] [-Description <string>] [<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
Parameter | Description | Required | Position | Accept | Accept |
|---|---|---|---|---|---|
Server | Specifies the ESXi host you want to modify. | True | Named | True (ByValue, | False |
Credentials | Specifies the credentials you want to use for authenticating with the ESXi server. | True | Named | False | False |
SSHCredentials | For SSH connection. Specify credentials you want to use to authenticate with the service console. | False | Named | False | False |
SSHEnable | For SSH connection. Indicates that the ESXi host is connected using service console connection. | False | Named | False | 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 |
<CommonParameters>
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-VBRESX with the $host and $creds variables.
$host = Get-VBRServer -Type ESXi -Name support.east.local $creds = Get-Credential Set-VBRESX -Server $host -Credentials $creds -Port 444 |
Related Commands
