Remove-VBRCredentials

In this article

    Short Description

    Removes a credentials record 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 from the Veeam Backup & Replication database.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Credential

    Specifies the 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 command removes 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 2. Removing Credentials Record Using Credentials

    This command removes the credentials record.

    $credentials = Get-VBRCredentials

    Remove-VBRCredentials -Credential $credentials

    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.

    Related Commands

    Get-VBRCredentials