This is an archive version of the document. To get the most up-to-date information, see the current version.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>] |
Related Commands
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 | Accept |
Name | Specifies the string with a DNS name or IP address of the Linux server you want to add. | True | 1 | False | False |
SSHUser | Specifies the user name you want to use for authenticating with the Linux server. If you use the Username/Password scenario, the -Credentials parameter must be omitted. | True | 2 | False | False |
SSHPassword | Specifies the password you want to use for authenticating with the Linux server. If you use the Username/Password scenario, the -Credentials parameter must be omitted. | True | 3 | False | False |
Credentials | Specifies the credentials you want to use for authenticating with the Linux server. If you use the Credentials scenario, the -User and -Password parameters must be omitted. | True | Named | False | False |
SSHPort | Provide an integer specifying the Web service port number used to connect to the Linux server console. Default: 443 | False | Named | False | False |
Description | Specifies the description of the Linux server. If not set, Veeam Backup & Replication will enter date and time of creation by default. | 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".
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.
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 |