Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Add-VBRLinux

Short Description

Adds a Linux server to Veeam Backup & Replication.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides two parameter sets.

  • For authenticating with the Linux host with Username/Password:

Add-VBRLinux [-Name] <string> [-SSHUser] <string> [-SSHPassword] <string> [-SSHPort <int>] [-Description <string>] [-WhatIf] [-Confirm]  [<CommonParameters>]

  • For authenticating with the Linux host with credentials:

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

Detailed Description

This cmdlet adds a Linux server to Veeam Backup & Replication.

The Linux server must have SSH and Perl.

When adding a new Linux server, you will need to provide either username and password or credentials.

To add a Linux host using an SSH key fingerprint, run this cmdlet with the Confirm parameter.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Name

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

True

1

False

False

SSHUser

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

True

2

False

False

SSHPassword

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

True

3

False

False

Credentials

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

True

Named

False

False

SSHPort

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

Default: 443

False

Named

False

False

Description

Specifies the description of the Linux server.

False

Named

False

False

WhatIf

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

False

Named

False

False

Confirm

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

False

Named

False

False

<CommonParameters>

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 Linux server with the 172.11.16.13 IP address using a username and a password. The user name is "Administrator" and the password is "Password".

PS C:\PS> Add-VBRLinux -Name "172.11.16.13" -SSHUser "Administrator" -SSHPassword "Password" -Description "Linux host 01"

Example 2

This command adds the Linux server with the 172.11.16.13 IP address using credentials. The credentials record is obtained with Get-VBRCredentials and assigned to the $"Linux Administrator" variable beforehand.

PS C:\PS> Add-VBRLinux -Name '172.11.16.13" -Description "Linux host 01" -Credentials $"Linux Administrator"

Example 3

This command adds the Linux server with the 172.11.16.13 IP address using an SSH key fingerprint.

  • The user name is "Administrator" and the password is "Password".
  • The Web service port is set to "22".
  • The Confirm parameter is used to verify the connection with SSH key fingerprint.

PS C:\PS> Add-VBRLinux -Name "172.11.16.13" -SSHUser "Administrator" -SSHPassword "Password" -SSHPort 22 -Confirm

Confirm
Are you sure you want to perform this action?
Performing operation "Add-VBRLinux" on Target "172.11.16.13"
"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

Get-VBRCredentials

Get-VBRServer

Remove-VBRServer

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation