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

Add-VBRESX

In this article

Short Description

Adds an ESX host to Veeam Backup & Replication.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Add-VBRESX [-Name] <String> [-User] <String> [-Password] <String> [-Port <Int32>] [-SSHUser <String>] [-SSHPassword <String>] [-SSHPort <Int32>] [-SSHEnable] [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Add-VBRESX [-Name] <String> [-Port <Int32>] [-SSHUser <String>] [-SSHPassword <String>] [-SSHPort <Int32>] [-SSHEnable] [-Description <String>] -Credentials <CCredentials> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Related Commands

Get-VBRCredentials

Detailed Description

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

ESX servers are virtual infrastructure servers hosting the virtual machines of your virtual environment. You need to add the ESX servers to Veeam Backup & Replication to be able to manage your virtual infrastructure via Veeam Backup & Replication console.

You may add an ESX/ESXi host, vCenter Server or Linux server (use corresponding command for each). If you are planning to use an ESX host being a part of the vCenter hierarchy, we recommend adding the corresponding vCenter Server instead of a single ESX host to ensure more flexibility and convenience at work.

When adding a new ESX server, you will need to provide either username and password or credentials. This cmdlet provides syntax for both scenarios accordingly.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Name	Specifies the string with a full DNS name or IP address of the ESX host.	True	1	False	False
User	Specifies the user name you want to use for authenticating with the ESX host. If you use the Username/Password scenario, the -Credentials parameter must be omitted.	True	2	False	False
Password	Specifies the password you want to use for authenticating with the ESX host. If you use the Username/Password scenario, the -Credentials parameter must be omitted.	True	3	False	False
Port	Sets the integer specifying the number of the Web service port used to connect to the ESX host. By default, port 443 is used.	False	Named	False	False
SSHUser	Specifies the string with the user name of the account used for service console connection to the host (recommended).	False	Named	False	False
SSHPassword	Specifies the string with the password of the account used for service console connection to the host (recommended).	False	Named	False	False
SSHPort	Sets the integer specifying the number of the service console port (recommended).	False	Named	False	False
SSHEnable	Set this parameter to TRUE if you want to use service console connection for the added ESX host (recommended).	False	Named	False	False
Description	Specifies the description of the ESX server. If not set, Veeam Backup & Replication will enter date and time of creation by default.	False	Named	False	False
Credentials	Specifies the credentials you want to use for authenticating with the ESX server. If you use the Credentials scenario, the -User and -Password parameters must be omitted.	True	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This command adds the ESX host with 172.16.11.188 IP address. The username is "root" and the password is "qwerty".

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

Example 2

This command adds the ESX 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