Get-VBRBackupServerCertificate
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 certificate from the Microsoft Windows Certificate store.
Add-VBRBackupServerCertificate -Certificate <VBRBackupServerCertificate> [-WhatIf] [-Confirm] [<CommonParameters>] |
- Get the TLS current certificate.
Add-VBRBackupServerCertificate -Name <String> [-WhatIf] [-Confirm] [<CommonParameters>] |
- Get the TLS certificate from a PFX file.
Add-VBRBackupServerCertificate -CertificatePath <String> -PrivateKeyPath <String> [-Password <SecureString>] [-WhatIf] [-Confirm] [<CommonParameters>] |
Detailed Description
This cmdlet returns the TLS certificates.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
FromStore | Defines that 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 |
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, |
CertificatePath | Specifies the full path to the PFX file associated with the certificate. | String | True | Named | False |
Password | Specifies the full path to the KEY file associated with the certificate. | SecureString | False | Named | False |
PrivateKeyPath | Specifies a secure string that contains the password for the certificate file. | String | True | Named | False |
Name | Specifies a friendly name for the self-signed TLS certificate. | String | True | Named | True (ByValue, |
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 on common parameters, see Microsoft Docs.
Output Object
The cmdlet returns the VBRBackupServerCertificate object that contains TLS certificates.
Examples
Example 1. Getting Currently Imported TLS Certificates
This command returns the TLS certificate that is currently imported to the backup server.
|
Example 2. Getting TLS Certificates from Microsoft Windows Certificate Store
This command gets a TLS certificate from the Microsoft Windows Certificate store.
|