Get-VBRCredentials

Short Description

Returns credentials records.

Platform: VMware, Hyper-V

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

Syntax

This cmdlet provides the following parameter sets:

AllParameterSets (Default)

Get-VBRCredentials [-Name <String[]>] [<CommonParameters>]
Entity

Get-VBRCredentials [-Name <String[]>] [-Entity <Object[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns credentials records managed by Veeam Backup & Replication. You can get the list of all credentials records or look for instances directly by name.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Entity	Specifies an array of hosts. The cmdlet will return credentials of these hosts.	`Object[]`	False	Named	True (ByValue)
Name	Specifies an array of user names. The cmdlet will return credentials with these names.	`String[]`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the CCredentials object that contains user credentials.

Examples

Get-VBRCredentials Example 1. Getting Credentials Records by Name

This command gets credentials records with the Administrator user name.

Get-VBRCredentials -Name *Administrator*

Get-VBRCredentials Example 2. Getting Credentials Records by Host

This command gets credentials records of a specific host.

$host = Get-VBRServer

Get-VBRCredentials -Entity $host[1]

Perform the following steps:

Run the Get-VBRServer cmdlet. Save the result to the $host variable.
Run the Get-VBRCredentials cmdlet. Set the $host variable as the Entity parameter value. Specify the necessary host of the $host variable.

Get-VBRServer