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

Add-VBRESX (obsolete)

Short Description

Adds ESXi hosts to Veeam Backup & Replication.

Add-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

This cmdlet provides 2 parameter sets.

  • For authenticating with user name/password:

Add-VBRESX [-Name] <string> [-User] <string> [-Password] <string> [-Port <int>] [-SSHUser <string>] [-SSHPassword <string>] [-SSHPort <int>] [-SSHEnable] [-Description <string>] [-SSHCredentials <CCredentials>] [<CommonParameters>]

  • For authenticating with credentials:

Add-VBRESX [-Name] <string> -Credentials <CCredentials> [-Port <int>] [-SSHUser <string>] [-SSHPassword <string>] [-SSHPort <int>] [-SSHEnable] [-Description <string>] [-SSHCredentials <CCredentials>]  [<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

Credentials

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

True

Named

False

False

Port

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

Default: 443.

False

Named

False

False

SSHUser

Specifies the user name of the account used for service console connection to the host (recommended).

False

Named

False

False

SSHPassword

Specifies the password of the account used for service console connection to the host (recommended).

False

Named

False

False

SSHPort

Specifies the service console port (recommended).

False

Named

False

False

SSHEnable

For SSH connection.

Indicates that the ESXi host is connected using service console connection.

False

Named

False

False

Description

Specifies the description of the ESXi server.

False

Named

False

False

SSHCredentials

For SSH connection.

Specify credentials you want to use to authenticate with the service console.

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 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-VBRESX –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-VBRESX –Name 172.16.11.188 -Credentials $Administrator

Related Commands

Get-VBRCredentials

Get-VBRServer

Remove-VBRServer