Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Reset-VBRAgentCertificate

Short Description

Resets Veeam Agents SSL certificates.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Requires Veeam Agent for Microsoft Windows/Veeam Agent for Linux 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

Discovered
Computer

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.

PS C:\PS> $group = Get-VBRProtectionGroup -Name "East Support"

PS C:\PS> $discovered = Get-VBRDiscoveredComputer -ProtectionGroup $group

PS C:\PS> 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.

PS C:\PS> $group = Get-VBRProtectionGroup -Name "East Support"

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

PS C:\PS> Reset-VBRAgentCertificate -DiscoveredComputer $comp

Related Commands

Get-VBRProtection

Get-VBRDiscoveredComputer

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Backup Explorers User Guide

Backup and Restore of SQL Server Databases

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation