This is an archive version of the document. To get the most up-to-date information, see the current version.

Add-VBRCloudGatewayPool

Short Description

Creates cloud gateway pools.

Applies to

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

Requires a cloud provider license.

Syntax

Add-VBRCloudGatewayPool -Name <String> -CloudGateway <VBRCloudGateway[]> [-Description <String>] [-Force[<SwitchParameter>]] [<CommonParameters>]

Detailed Description

This cmdlet creates cloud gateway pools.

Important

If you add all available gateways to cloud gateway pools, the jobs will fail for tenants with the automatic gateway type. You will not be able to create new tenants with automatic selection type.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Name

Specifies the name of the cloud gateway pool. The cmdlet will add the cloud gateway pool with this name to the cloud infrastructure.

True

Named

True (ByValue)

False

CloudGateway

Specifies an array of gateways from the cloud infrastructure. The cmdlet will add these gateways to the cloud gateway pool.

True

Named

False

False

Description

Specifies the description of the cloud gateway pool. The cmdlet will add the cloud gateway pool with this description to the cloud infrastructure.

False

Named

False

False

Force

Indicates that the cmdlet will add all available gateways to cloud gateway pools without warning.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

Example

This example shows how to create a cloud gateway pool.

  1. Run Get-VBRCloudGateway to get the array of cloud gateways. Save the result to the $gateway variable.
  2. Run Add-VBRCloudGatewayPool with the $gateway variable.

$gateway = Get-VBRCloudGateway

Add-VBRCloudGatewayPool -Name "Silver Pool" -CloudGateway $gateway

Related Commands

Get-VBRCloudGateway