Add-VBRESXi

In this article

    Short Description

    Adds ESXi hosts to Veeam Backup & Replication.

    Applies to

    Platform: VMware

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

    Syntax

    Add-VBRESXi [-Name] <String> [-User] <String> [-Password] <String> [-Port <Int32>] [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    -OR-

    Add-VBRESXi [-Name] <String> [-Port <Int32>] [-Description <String>] -Credentials <CCredentials> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet adds ESXi servers to the Veeam Backup & Replication managing console.

    If an ESXi host is a part of a vCenter Server, it is recommended to add the vCenter Server instead of a single ESXi host.

    When adding a new ESXi server, you will need to provide either a user name and password or credentials. Use an appropriate parameter set for each case.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies the full DNS name or IP address of the ESXi host.

    True

    1

    False

    False

    User

    Specifies the user name you want to use for authenticating with the ESXi host.

    True

    2

    False

    False

    Password

    Specifies the password you want to use for authenticating with the ESXi host.

    True

    3

    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

    Credentials

    Specifies the credentials you want to use for authenticating with the ESXi server.

    True

    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 1

    This command adds the ESXi host with 172.16.11.188 IP address. The user name is "root" and the password is "qwerty".

    Add-VBRESXi –Name 172.16.11.188 –User root –Password qwerty

    Example 2

    This command adds the ESXi host with 172.16.11.188 IP address. The credentials to authenticate with the host are obtained with  Get-VBRCredentials and assigned to the $Administrator variable beforehand.

    Add-VBRESXi –Name 172.16.11.188 -Credentials $Administrator

    Related Commands

    Get-VBRCredentials

    Get-VBRServer

    Remove-VBRServer

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.