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 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:
|
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 | To add a Linux server that will be used as a hardened repository. Defines that the cmdlet will use single-use credentials to access a 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
Example 1. Adding Linux Host Using Credentials for Authentication
Example 2. Adding Linux Host Using Username/Password for Authentication
Example 3. Adding Linux Host as Temporary Helper Appliance
Example 4. Adding Linux Server Using SSH Key Fingerprint
Related Commands
