Reset-VBRAgentCertificate

In this article

    Short Description

    Resets Veeam Agents SSL certificates.

    Applies to

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

    Syntax

    Reset-VBRAgentCertificate -DiscoveredComputer <VBRDiscoveredComputer[]> [-WhatIf] [-Confirm]  [<CommonParameters>]

    Detailed Description

    This cmdlet resets SSL certificates for selected Veeam Agents.

    When you reset Veeam Agents certificates, all backup jobs run by these agents stop. You can use this cmdlet for performing maintenance tasks on protected computers where the associated agents are installed.

    Veeam Backup & Replication will regenerate a new Veeam Agent certificate automatically next time you run a Veeam Agent backup job.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    DiscoveredComputer

    Specifies the array of discovered computers. The cmdlet will reset SSL certificates for Veeam Agents installed on these computers.

    NOTE: You can reset the SSL certificate only on discovered computers.

    Accepts VBRDiscoveredComputer[] type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    WhatIf

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

    False

    Named

    False

    False

    Confirm

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

    False

    Named

    False

    False

    <CommonParameters>

    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 example shows how to reset SSL certificates for Veeam Agents installed on computers of a selected protection group.

    You will need to perform the following steps:

    1. Run Get-VBRProtectionGroup to get the protection group. Save the result to the $group variable.
    2. Run Get-VBRDiscoveredComputer with the $group variable to get the discovered computers of the protection group. Save the result to the $discovered variable.
    3. Run Reset-VBRAgentCertificate with the $discovered variable.

    $group = Get-VBRProtectionGroup -Name "East Support"

    $discovered = Get-VBRDiscoveredComputer -ProtectionGroup $group

    Reset-VBRAgentCertificate -DiscoveredComputer $discovered

    Example 2

    This example shows how to reset the SSL certificate for Veeam Agent installed on a selected computer.

    You will need to perform the following steps:

    1. Run Get-VBRProtectionGroup to get the protection group of the computer. Save the result to the $group variable.
    2. Run Get-VBRDiscoveredComputer with the $group variable. Use the Where-Object method to get the discovered computer. Save the result to the $comp variable.
    3. Run Reset-VBRAgentCertificate with the $comp variable.

    $group = Get-VBRProtectionGroup -Name "East Support"

    $comp = Get-VBRDiscoveredComputer -ProtectionGroup $group | where {$_.name -eq "support1.east.local"}

    Reset-VBRAgentCertificate -DiscoveredComputer $comp

    Related Commands

    Get-VBRProtection

    Get-VBRDiscoveredComputer