Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
PowerShell Reference

Add-VBRCredentials

Short Description

Creates credentials records.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides parameter sets that allow you to:

  • Add credentials records by a user name and a password

Add-VBRCredentials -User <string> -Password <string> [-Description <string>] [-Type {Linux | Windows | LinuxPubKey}] [-SshPort <int>] [-Passphrase <string>] [-ElevateToRoot] [-AddToSudoers] [-FailoverToSu][-RootPassword <string>] [-PrivateKeyPath <string>] [-PrivateKey <string>]  [<CommonParameters>]

  • Add credentials records by specifying the PSCredential object

Add-VBRCredentials -Credential <pscredential> [-Description <string>] [-Type {Linux | Windows | LinuxPubKey}][-SshPort <int>] [-Passphrase <string>] [-ElevateToRoot] [-AddToSudoers] [-FailoverToSu] [-RootPassword <string>][-PrivateKeyPath <string>] [-PrivateKey <string>]  [<CommonParameters>]

Detailed Description

This cmdlet creates a new credentials record for authenticating with the instances of your virtual infrastructure. You can add Windows or Linux credentials records including authentication using the Identity/Pubkey method.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

User

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

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

True

Named

False

False

Password

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

True

Named

False

False

Credential

Specifies the credentials you want to add.

True

Named

False

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.

False

Named

False

False

Type

Specifies the credentials type: Linux, Windows, LinuxPubKey.

Default: Windows.

False

Named

False

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.

False

Named

False

False

Passphrase

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

False

Named

False

False

ElevateToRoot

Used for Identity/Pubkey authentication method.

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

False

Named

False

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.

False

Named

False

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.

False

Named

False

False

RootPassword

Used for Identity/Pubkey authentication method.

Indicates that the root password is used for authentication.

False

Named

False

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.

False

Named

False

False

PrivateKey

Used for Identity/Pubkey authentication method.

Specifies the private key.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Example 1

This command creates a new Windows credentials record for the administrator.

Add-VBRCredentials -Type Windows -User Administrator -Password "Password_1" -Description "Administrator Credentials"

Example 2

This command adds a credentials record for the administrator. Get-Credential is used to enter the username and password in the secure mode.

Get-Credential | Add-VBRCredentials -Description "Administrator Credentials"

Example 3

This command adds a Linux credentials record for the administrator. The credentials record will use the 23 SSH port. The root password privileges are given to the user.

Add-VBRCredentials -Type Linux -User Administrator -Password password -SshPort 23 -ElevateToRoot -AddToSudoers -RootPassword rootpwd

Example 4

This command adds a Linux Pubkey credentials record for the 'User1'.

Add-VBRCredentials -Type LinuxPubKey -User user1 –Password password -PrivateKeyPath c:\temp\deneb.ppk -Passphrase

Related Commands

Get-VBRCredentials

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions Reference

Veeam Availability for Nutanix AHV Documentation

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation