This is an archive version of the document. To get the most up-to-date information, see the current version.

Set-VBRLinux

Short Description

Modifies settings of a Linux server added to the backup infrastructure.

Applies to

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

Syntax

This cmdlet provides parameter sets that allow you to:

Modify settings of a Linux server added to the backup infrastructure

Set-VBRLinux -Server <CHost> [-Description <string>] [-SSHPort <int>] [-Credentials <CCredentials>] [-Force] [<CommonParameters>]

Modify credentials of a Linux server added to the backup infrastructure

Set-VBRLinux -Server <CHost> -SSHUser <string> -SSHPassword <string> [-Description <string>] [-SSHPort <int>] [-SSHElevateToRoot] [-SSHAddToSudoers] [-SSHFailoverToSu] [-SSHRootPassword <string>] [-SSHTempCredentials] [-Force] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of a Linux server added to the backup infrastructure.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Server	Specifies a Linux server which settings that you want to modify.	Accepts the CHost object. To create this object, run the Get-VBRServer cmdlet.	True	Named	True (ByValue, ByPropertyName)
SSHUser	Specifies the user name you want to use for authenticating with the Linux server.	String	True	Named	False
SSHPassword	Specifies the password you want to use for authenticating with the Linux server.	String	True	Named	False
Description	Specifies the description of the Linux server.	String	False	Named	False
SSHPort	Specifies the Web service port for connection to the Linux server console. Default: 443	Int	False	Named	False
Credentials	Specifies the credentials you want to use for authenticating with the Linux server.	CCredentials	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	Defines that the root password is used for authentication.	SwitchParameter	False	Named	False
SSHTempCredentials	Defines that the cmdlet will use the temporary credentials to connect to Linux server.	SwitchParameter	False	Named	False
Force	Defines that the cmdlet will modify settings of Linux server without showing warnings in the PowerShell console.	SwitchParameter	False	Named	False

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

Modifying Linux Server Settings

This example shows how to set the Web service port to 445.

$server = Get-VBRServer

Set-VBRLinux -Server $server -SSHPort 445

Perform the following steps:

Run the Get-VBRServer cmdlet. Save the result to the $server variable.
Run the Set-VBRLinux cmdlet. Set the $server variable as the Server parameter value. Specify the SSHPort parameter value.

Related Commands

Get-VBRServer