Add-VBRESXi

In this article

    Short Description

    Adds VMware ESXi hosts to the backup infrastructure.

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

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Add VMware ESXi hosts using the account user name and password.

    Add-VBRESXi [-Name] <String> [-User] <String> [-Password] <String> [-Port <Int32>] [-Description <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

    • Add VMware ESXi hosts using credentials managed by Veeam Backup & Replication.

    Add-VBRESXi [-Name] <String> -Credentials <CCredentials> [-Port <Int32>] [-Description <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

    Detailed Description

    This cmdlet adds VMware ESXi hosts to the backup infrastructure.

    Note

    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.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Name

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

    String

    True

    1

    False

    User

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

    String

    True

    2

    False

    Password

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

    String

    True

    3

    False

    Credentials

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

    Accepts the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet.

     

    True

    Named

    False

    Port

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

    Default: 443.

    Int32

    False

    Named

    False

    Description

    Specifies the description of the ESXi server.

    String

    False

    Named

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Output Object

    The cmdlet returns the CHost object that contains settings of the VMware ESXi hosts to the backup infrastructure

    Examples

    Add-VBRESXiExample 1. Adding VMware ESXi Hosts Using Account User Name and Password

    This command adds the 172.16.11.188 ESXi host with the root user name and the qwerty password of the account.

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

    Add-VBRESXiExample 2. Adding VMware ESXi Hosts Using Credentials Managed by Veeam Backup & Replication

    This example shows how to add the 172.16.11.188 ESXi host using the credentials managed by Veeam Backup & Replication.

    $Administrator = Get-VBRCredentials

    Add-VBRESXi –Name 172.16.11.188 -Credentials $Administrator

    Perform the following steps:

    1. Run the Get-VBRCredentials cmdlet. Save the result to the $Administrator variable.
    2. Run the Add-VBRESXi cmdlet. Specify the Name parameter value. Set the $Administrator variable as the Credentials parameter value.

    Related Commands

    Get-VBRCredentials