Add-VBRBackupServerCertificate

In this article

    Short Description

    Assigns a self-signed TLS certificate to the Veeam Backup & Replication settings.

    Applies to

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

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Generate a self-signed TLS certificate a self-signed certificate in the Veeam Backup & Replication> settings.

    Add-VBRBackupServerCertificate -Name <string> [-WhatIf] [-Confirm]  [<CommonParameters>]

    • Import a self-signed TLS certificate from the certificate store.

    Add-VBRBackupServerCertificate -Certificate <VBRBackupServerCertificate> [-WhatIf] [-Confirm]  [<CommonParameters>]

    Detailed Description

    This cmdlet adds a self-signed TLS certificate to the  Veeam Backup & Replication settings.

    Note

    With Veeam PowerShell, you cannot create a self-signed certificate or import an SSL certificate from file in the PFX format. You can only select an existing SSL certificate from the Microsoft Windows Certificates store. The certificate must be imported into the certificate store beforehand.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Name

    Specifies a friendly name for the self-signed TLS certificate.

    String

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    Certificate

    Specifies the certificate you want to use.

    Accepts the VBRBackupServerCertificate object. To create this object, run the Get-VBRBackupServerCertificate cmdlet.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    WhatIf

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

    SwitchParameter

    False

    Named

    False

    Confirm

    Defines that the cmdlet will display a prompt that asks if you want to continue running the command.

    SwitchParameter

    False

    Named

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Return Type

    None.

    Example

    Add-VBRBackupServerCertificateExample 1. Generating Self-Signed Certificate

    This command generates a self-signed certificate in Veeam Backup & Replication.

    Add-VBRBackupServerCertificate -Name "Veeam Software AG certificate"

    Add-VBRBackupServerCertificateExample 2. Importing Certificate from Certificate Store

    This example shows how to get a certificate from the certificate store and import it to the Veeam Backup & Replication settings.

    $certificate = Get-VBRBackupServerCertificate -FromStore | Where FriendlyName -eq "ABC"

    Add-VBRBackupServerCertificate -Certificate $certificate

    Perform the following steps:

    1. Run the Get-VBRBackupServerCertificate cmdlet. Specify the FromStore parameter value. Save the result to the $certificate variable.
    2. Run the Add-VBRBackupServerCertificate cmdlet. Set the $certificate variable as the Certificate parameter value.

    Related Commands

    Get-VBRBackupServerCertificate