Set-VBRESX (obsolete)

In this article

    Short Description

    Modifies ESX hosts added to Veeam Backup & Replication.

    Set-VBRESX (obsolete) Note:

    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 ESX 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
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Server

    Specifies the ESX host you want to modify.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Credentials

    Specifies the credentials you want to use for authenticating with the ESX 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 ESX host is connected using service console connection.

    False

    Named

    False

    False

    Port

    Specifies the Web service port for connection to the ESX host.

    Default: 443.

    False

    Named

    False

    False

    Description

    Specifies the description of the ESX 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 ESX host.

    You will need to perform the following steps:

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

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

    $creds = Get-Credential

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

    Related Commands

    Get-VBRServer

    Get-VBRCredentials