Set-VBRCredentials

In this article

    Short Description

    Edits credentials records properties.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Modify credentials records.

    Set-VBRCredentials -Credential <CCredentials> [-User <string>] [-Password <string>] [-Description <string>][-SshPort <int>] [-Passphrase <string>] [-ElevateToRoot] [-AddToSudoers] [-FailoverToSu] [-RootPassword <string>] [<CommonParameters>]

    • Modify credentials records by specifying the file path to the Linux private key.

    Set-VBRCredentials -Credential <CCredentials> [-User <string>] [-Password <string>] [-Description <string>][-SshPort <int>] [-Passphrase <string>] [-ElevateToRoot] [-AddToSudoers] [-FailoverToSu] [-RootPassword <string>][-PrivateKeyPath <string>] [<CommonParameters>]

    • Modify credentials records by specifying the Linux private key.

    Set-VBRCredentials -Credential <CCredentials> [-User <string>] [-Password <string>] [-Description <string>][-SshPort <int>] [-Passphrase <string>] [-ElevateToRoot] [-AddToSudoers] [-FailoverToSu] [-RootPassword <string>][-PrivateKey <string>] [<CommonParameters>]

    Detailed Description

    This cmdlet allows you to edit password or description of a selected credentials record.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Credential

    Specifies the credentials you want to edit.

    Accepts the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    User

    Specifies the user name you want to use to authenticate with the instances of your virtual infrastructure.

    Note that you should use DOMAIN\username format for all hosts except ESX/ESXi hosts.

    String

    False

    Named

    False

    Password

    Specifies the password you want to use for authenticating with the instances of your virtual infrastructure.

    String

    False

    Named

    False

    Description

    Specifies the description for the credentials record. This parameter in non-mandatory, although it is recommended to input this value to make the credential records easily identified.

    String

    False

    Named

    False

    SshPort

    Used for Identity/Pubkey authentication method.

    Specifies the number of the SSH port that you want to use to connect to a Linux server.

    Permitted values: 1 to 65535.

    Default: 22.

    Int32

    False

    Named

    False

    Passphrase

    Specifies a passphrase for the Linux private key on the backup server.

    String

    False

    Named

    False

    ElevateToRoot

    Used for Identity/Pubkey authentication method.

    Indicates that non-root users are provided with root account privileges.

    SwitchParameter

    False

    Named

    False

    AddToSudoers

    Used for Identity/Pubkey authentication method.

    Indicates that the user account is added to sudoers file.

    Default: (if the ElevateToRoot parameter is set to False) False.

    SwitchParameter

    False

    Named

    False

    FailoverToSu

    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

    RootPassword

    Used for Identity/Pubkey authentication method.

    Indicates that the root password is used for authentication.

    String

    False

    Named

    False

    PrivateKeyPath

    Used for Identity/Pubkey authentication method.

    Specifies the path to the private key. Use this parameter to specify the private key for the LinuxPubKey option of the Type parameter.

    String

    False

    Named

    False

    PrivateKey

    Used for Identity/Pubkey authentication method.

    Specifies the private key.

    String

    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 CCredentials object that contains user credentials.

    Examples

    Set-VBRCredentialsExample 1. Setting New Password for Credentials Record Using User Name

    This command sets a new password for the credentials record with the Administrator user name. The new password is qwerty.

    Get-VBRCredentials -Name "Administrator" | Set-VBRCredentials -Password "qwerty"

    Perform the following steps:

    1. Run the Get-VBRCredentials cmdlet. Specify the Name parameter value.
    2. Pipe the cmdlet output to the Set-VBRCredentials cmdlet. Specify the Password parameter value.

    Set-VBRCredentialsExample 2. Setting New Description for Credentials Record Using Credentials

    This command sets a new description for the credentials record. The new description is ESXi Host Credentials.

    $credentials = Get-VBRCredentials

    Set-VBRCredentials -Credential $credentials -Description "ESXi Host Credentials"

    Perform the following steps:

    1. Run the Get-VBRCredentials cmdlet. Save the result to the $credentials variable.
    2. Run the Set-VBRCredentials cmdlet. Set the $credentials variable as the Credentials parameter value. Specify the new Description parameter value.

    Related Commands

    Get-VBRCredentials