--- title: "Set-VBRLinux" description: "Modifies settings of a Linux server added to the backup infrastructure. Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License This cmdlet provides the following parameter sets: This cmdlet modifies settings of a Linux server" canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrlinux.html" breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Backup Infrastructure > Virtualization Servers and Hosts > Set-VBRLinux" dateModified: "2026-08-19" --- # Set-VBRLinux ## Short Description Modifies settings of a Linux server added to the backup infrastructure. **Product Edition**: Standard, Enterprise, Enterprise Plus, Veeam Universal License ## Syntax This cmdlet provides the following parameter sets:

Credentials (Default)
``` Set-VBRLinux -Server [-Description ] [-SSHPort ] [-Credentials ] [-SSHFingerprint ] [-Package ] [-Force] [] ```
AddCredentials
``` Set-VBRLinux -Server [-Description ] -SSHUser -SSHPassword [-SSHPort ] [-SSHElevateToRoot] [-SSHAddToSudoers] [-SSHFailoverToSu] [-SSHRootPassword ] [-SSHTempCredentials] [-SSHFingerprint ] [-Package ] [-Force] [] ```
UseCertificate
``` Set-VBRLinux -Server [-Description ] [-SSHPort ] [-UseCertificate] [-HandshakeCode ] [-Package ] [-Force] [] ```

## Detailed Description This cmdlet modifies settings of a Linux server added to the backup infrastructure. ## Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Credentials	Specifies the credentials you want to use for authenticating with the Linux server.	`CCredentials`	False	Named	False
Description	Specifies the description of the Linux server.	`String`	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
HandshakeCode	Specifies the handshake code used to pair with the server.	`String`	False	Named	False
Package	Specifies the Linux package. Accepts the `VBRLinuxPackage` object. To get this object, run the `Get-VBRLinuxPackage` `cmdlet.`	`VBRLinuxPackage[]`	False	Named	False
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.	`CHost`	True	Named	True (ByPropertyName, ByValue)
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
SSHElevateToRoot	Defines that non-root users are provided with the root account privileges. Default: `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. Default: `False`.	`SwitchParameter`	False	Named	False
SSHFingerprint	Specifies SSH host fingerprint.	`String`	False	Named	False
SSHPassword	Specifies the password you want to use for authenticating with the Linux server.	`String`	True	Named	False
SSHPort	Specifies the SSH port for connection to the Linux server. Default: `22`	`Int32`	False	Named	False
SSHRootPassword	Specifies the root password to be used for authentication.	`String`	False	Named	False
SSHTempCredentials	Defines that the cmdlet will use the temporary credentials to connect to Linux server. Default: `False`.	`SwitchParameter`	False	Named	False
SSHUser	Specifies the user name you want to use for authenticating with the Linux server.	`String`	True	Named	False
UseCertificate	Defines if certificate-based authentication is used.	`SwitchParameter`	True	Named	False

`` This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7). ## Output Object The cmdlet returns the `CHost` object that contains settings of a Linux server added to the backup infrastructure. ## Examples ::: example ### Modifying Linux Server Settings This example shows how to set the SSH port to `2222`. ``` $server = Get-VBRServer Set-VBRLinux -Server $server -SSHPort 2222 ``` Perform the following steps: 1. Run the [`Get-VBRServer`](get-vbrserver.md) cmdlet. Save the result to the `$server` variable. 2. Run the `Set-VBRLinux` cmdlet. Set the `$server` variable as the `Server` parameter value. Specify the `SSHPort` parameter value. ::: ## Related Commands [`Get-VBRServer`](get-vbrserver.md)