Remove-VBRCredentials

In this article

    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

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

    SwitchParameter

    False

    Named

    False

    Confirm

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

    SwitchParameter

    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

    None.

    Examples

    Remove-VBRCredentialsExample 1. Removing Credentials Record Using User Name

    This example shows how to remove the credentials record with the Administrator user name.

    $credentials = Get-VBRCredentials -Name "Administrator"

    Remove-VBRCredentials -Credential $credentials

    Perform the following steps:

    1. Run the Get-VBRCredentials cmdlet. Specify the Name parameter value. Save the result to the $credentials variable.
    2. Run the Remove-VBRCredentials cmdlet. Specify the Credential parameter value.

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

    This example shows how to remove the credentials record with the Administrator user name.

    Get-VBRCredentials -Name "Administrator" | Remove-VBRCredentials

    Perform the following steps:

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

    Remove-VBRCredentialsExample 3. Removing Specific Credentials Record

    This example shows how to remove the specific credentials record.

    $credentials = Get-VBRCredentials

    Remove-VBRCredentials -Credential $credentials[1]

    Perform the following steps:

    1. Run the Get-VBRCredentials cmdlet. Save the result to the $credentials variable.
    2. Run the Remove-VBRCredentials cmdlet. Set the $credentials variable as the Credentials parameter value. The Get-VBRCredentials cmdlet will return an array of credential records. Mind the ordinal number of the necessary credential record (in our example, it is the second restore session in the array).

    Related Commands

    Get-VBRCredentials