Remove-VBRCredentials

Short Description

Removes credentials records from Veeam Backup & Replication.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Remove-VBRCredentials -Credential <CCredentials>  [<CommonParameters>]

Detailed Description

This cmdlet permanently removes the selected credentials record from the Veeam Backup & Replication database.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Credential

Specifies credentials you want to remove.

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

True

Named

True (ByValue,
ByProperty
Name)

WhatIf

Defines whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

SwitchParameter

False

Named

False

Confirm

Defines whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.

SwitchParameter

False

Named

False

<CommonParameters>

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

Output Object

None.

Examples

Remove-VBRCredentialsExample 1. Removing Credentials Record Using User Name [Using Variable]

Remove-VBRCredentialsExample 2. Removing Credentials Record Using User Name [Using Pipeline]

Remove-VBRCredentialsExample 3. Removing Specific Credentials Record

Related Commands

Get-VBRCredentials

Page updated 6/17/2024

Page content applies to build 12.3.1.1139