Add-VBRLinux

In this article

    Short Description

    Adds a Linux server to the backup infrastructure.

    Applies to

    Platform: VMware

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

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Add a Linux host using credentials for authentication.

    Add-VBRLinux [-Name] <string> -Credentials <CCredentials> [-Description <string>] [-SSHPort <int>] [-WhatIf] [-Confirm]  [<CommonParameters>]

    • Add a Linux host using the Username/Password for authentication.

    Add-VBRLinux [-Name] <string> [-SSHUser] <string> [-SSHPassword] <string> [-Description <string>] [-SSHPort <int>] [-SSHElevateToRoot] [-SSHAddToSudoers] [-SSHFailoverToSu] [-SSHRootPassword <string>] [-SSHTempCredentials] [-WhatIf] [-Confirm]  [<CommonParameters>]

    • Add a Linux host as a temporary helper appliance.

    Add-VBRLinux -Credentials <CCredentials> -HelperHostName <string> [-Description <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

    Detailed Description

    This cmdlet adds a Linux server to the backup infrastructure.

    Note

    Mind the following:

    • A Linux host that you want to add to the backup infrastructure must have SSH connection enabled and Perl installed.
    • A Linux host that you add as a temporary helper appliance is not displayed in the Veeam Backup & Replication UI. Use this host to perform Linux-based or Unix-based guest OS files restore with the Start-VBRLinuxFileRestore cmdlet. Veeam Backup & Replication will delete this helper appliance after you run the Stop-VBRLinuxFileRestore cmdlet to complete the guest OS file restore.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Name

    Specifies the DNS name or IP address of the Linux server.

    String

    True

    1

    False

    SSHUser

    Specifies the user name you want to use for authenticating with the Linux server.

    Note: To add a Linux host using an SSH key fingerprint, provide the Confirm parameter.

    String

    True

    2

    False

    SSHPassword

    Specifies the password you want to use for authenticating with the Linux server.

    Note: To add a Linux host using an SSH key fingerprint, provide the Confirm parameter.

    String

    True

    3

    False

    Credentials

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

    Accepts the PSCredential object. To get this object, run the Get-Credential cmdlet.

    True

    Named

    False

    HelperHostName

    Note: This parameter is available starting from Veeam Backup & Replication 11a (build 11.0.1.1261).

    Specifies the DNS name or IP address of the temporary helper appliance.

    String

    True

    Named

    False

    SSHPort

    Specifies the Web service port for connection to the Linux server console.

    Default: 443

    Int

    False

    Named

    False

    SSHElevateToRoot

    Defines that non-root users are provided with the root account privileges.

    SwitchParameter

    False

    Named

    False

    SSHAddToSudoers

    Defines that the user account is added to sudoers file.

    Default: (if the ElevateToRoot parameter is set to False) False.

    SwitchParameter

    False

    Named

    False

    SSHFailoverToSu

    Defines that Veeam Backup & Replication will use the su command if the sudo command fails.

    If you provide this parameter, Veeam Backup & Replication will failover to the su command if sudo command fails. Otherwise, if sudo fails Veeam Backup & Replication will not be able to add Linux credentials records.

    SwitchParameter

    False

    Named

    False

    SSHRootPassword

    Specifies the root password used for authentication.

    String

    False

    Named

    False

    SSHTempCredentials

    Defines that the cmdlet will use the temporary credentials to connect to Linux server.

    SwitchParameter

    False

    Named

    False

    Description

    Specifies the description of the Linux server.

    String

    False

    Named

    False

    WhatIf

    Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

    SwitchParameter

    False

    Named

    False

    Confirm

    Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

    SwitchParameter

    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 VBRLinux object that contains settings of a Linux server added to the backup infrastructure.

    Examples

    Add-VBRLinuxExample 1. Adding Linux Host Using Credentials for Authentication

    This example shows how add a Linux host using credentials for authentication.

    $creds = Get-Credential

    Add-VBRLinux -Name "LinRepository" -Credentials $creds

    Perform the following steps:

    1. Run the Get-Credential cmdlet. The console will prompt with Save the result to the $creds variable.
    2. Run the Add-VBRLinux cmdlet. Specify the Name parameter value. Set the $admincreds variable as the Credentials parameter value.

    Add-VBRLinuxExample 2. Adding Linux Host Using Username/Password for Authentication

    This command adds the 198.51.100.2 Linux server.

    Add-VBRLinux -Name "198.51.100.2" -SSHUser "Administrator" -SSHPassword "Password" -Description "Linux host 01"

    Add-VBRLinuxExample 3. Adding Linux Host as Temporary Helper Appliance

    This example shows how add the 198.51.100.1 Linux host as a temporary helper appliance.

    $creds = Get-Credential

    $admincreds = Add-VBRCredentials -Credential $creds -Type Linux -ElevateToRoot -AddToSudoers -FailoverToSu -RootPassword Securepassword

    Add-VBRLinux -Credentials $admincreds -HelperHostName 198.51.100.1

    Perform the following steps:

    1. Run the Get-Credential cmdlet. Save the result to the $creds variable.
    2. Run the Add-VBRCredentials cmdlet. Specify the Credential, Type, ElevateToRoot, AddToSudoers, FailoverToSu and RootPassword parameter values. Save the result to the $admincreds variable.
    3. Run the Add-VBRLinux cmdlet. Set the $admincreds variable as the Credentials parameter value. Specify the HelperHostName parameter value.

    Add-VBRLinuxExample 4. Adding Linux Server Using SSH Key Fingerprint

    This example shows how to add the 198.51.100.5 Linux server using an SSH key fingerprint. The cmdlet adds the Linux server with the following settings:

    • The Web service port is set to 22
    • The Confirm parameter is provided to verify the connection with SSH key fingerprint

    Add-VBRLinux -Name "198.51.100.5" -SSHUser "Administrator" -SSHPassword "Password" -SSHPort 22 -Confirm

    Confirm
    Are you sure you want to perform this action?
    Performing operation "Add-VBRLinux" on Target "198.51.100.5"
    "SSH key fingerprint:
    ssh-dss 1024 7a:64:8d:7d:12:72:e9:e1:28:42:94:51:55:65:13:7a
    Do you trust this server?".
    [Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): Y

    Related Commands