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

Add-VBRCloudGatewayCertificate -Certificate <VBRCloudCertificate> [-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
Pipeline
Input

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,
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 on common parameters, see Microsoft Docs.

Output Object

None.

Examples

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.

$certificate = Get-VBRCloudGatewayCertificate -FromStore | Where FriendlyName -eq "Omega Company"

Add-VBRCloudGatewayCertificate -Certificate $certificate

Perform the following steps:

  1. Run the Get-VBRCloudGatewayCertificate cmdlet. Provide the FromStore parameter value. Pipe the cmdlet output to the Where command to filter certificates by the FriendlyName parameter. Save the result to the $certificate variable.
  2. Run the Add-VBRCloudGatewayCertificate cmdlet. Set the $certificate variable as the Certificate parameter value.

Related Commands

Get-VBRCloudGatewayCertificate