Add-VBRCloudGatewayCertificate
Short Description
Assigns a TLS certificate to the service provider.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Assign a certificate from the certificate store.
Add-VBRCloudGatewayCertificate -Certificate <VBRCloudCertificate> [-WhatIf] [-Confirm] [<CommonParameters>] |
- Assign a certificate using the PFX and KEY files associated with the certificate.
Add-VBRCloudGatewayCertificate -CertificatePath <String> -PrivateKeyPath <String> [-Password <SecureString>] [-WhatIf] [-Confirm] [<CommonParameters>] |
Detailed Description
This cmdlet assigns a TLS certificate to the service provider.
Important |
You can only use the TLS certificate imported from the certificate store. |
Parameters
Parameter | Description | Type | Required | Position | Accept |
---|---|---|---|---|---|
Certificate | Specifies the certificate you want to use. | Accepts the VBRCloudCertificate object. To get this object, run the Get-VBRCloudGatewayCertificate 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, if the file is protected. | String | True | Named | False |
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
None.
Examples
Example 1. Assigning Certificate using Certificate Files
This example shows how to assign a certificate using certificate files.
|
Example 2. Assigning TLS Certificate to Service Provider
This example shows how to get a certificate from the certificate store and assign it to the service provider.
Perform the following steps:
|
Related Commands