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

Set-VBRCredentials

On This Page

Short Description
Applies to
Syntax
Detailed Description
Parameters
Example 1
Example 2

Short Description

Edits credentials records properties.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRCredentials -Credential <CCredentials> -Password <string> [<CommonParameters>]

-OR-

Set-VBRCredentials -Credential <CCredentials> -Description <string> [<CommonParameters>]

Related Commands

Get-VBRCredentials

Detailed Description

This cmdlet allows editing password or description of a selected credentials record. Select the appropriate syntax for each case.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Credential	Specifies the credentials you want to edit.	True	Named	True (by Value FromPipeline, ValueFromPipeline ByPropertyName)	False
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
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
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
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
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

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This command sets a new password for the credentials record with name "Administrator". The new password is "Password_1". The credentials record is obtained with Get-VBRCredentials and piped down.

PS C:\PS> Get-VBRCredentials -Name "Administrator" | Set-VBRCredentials -Password "Password_1"

Example 2

This command sets a new description for the credentials record. The credentials record is obtained with Get-VBRCredentials and assigned to the variable beforehand.

PS C:\PS> Set-VBRCredentials -Credential $c -Description "ESXi Host Credentials"