Get-VBRBackupServerCertificate

In this article

    Short Description

    Returns TLS certificates.

    Applies to

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

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Get the TLS current certificate.

    Get-VBRBackupServerCertificate  [<CommonParameters>]

    • Get the TLS certificate from the Microsoft Windows Certificate store.

    Get-VBRBackupServerCertificate -FromStore  [<CommonParameters>]

    • Get the TLS certificate from a PFX file.

    Get-VBRBackupServerCertificate -Path <string> [-Password <securestring>]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns the TLS certificates.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    FromStore

    If set, the cmdlet will return the TLS certificate present in the local certificate store on this server. If you run the cmdlet without this parameter, it will return the certificate that is currently used.

    SwitchParameter

    True

    Named

    False

    Path

    Specifies a path to the PXF file. The cmdlet will return TLS certificate that are available at this path

    String

    True

    Named

    False

    Password

    Specifies a password for a PXF file.

    SecureString

    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

    The cmdlet returns the VBRBackupServerCertificate object that contains TLS certificates.

    Get-VBRBackupServerCertificateExample 1. Getting Currently Imported TLS Certificates

    This command returns the TLS  certificate that is currently imported to the backup server.

    Get-VBRBackupServerCertificate

    Get-VBRBackupServerCertificateExample 2. Getting TLS Certificates from Microsoft Windows Certificate Store

    This command gets an TLS certificate from the Microsoft Windows Certificate store.

    Get-VBRBackupServerCertificate -FromStore | Where FriendlyName -eq "ABC"

    Get-VBRBackupServerCertificateExample 3. Getting Certificates from PFX Files

    This command gets an TLS certificate from a PFX file.

    Get-VBRBackupServerCertificate -Path "C:\cert\AMB_cert.pfx"

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.