Get-VBRCloudGatewayPool

Short Description

Returns cloud gateway pools.

Applies to

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

Requires a cloud provider license.

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get all cloud gateway pools.

Get-VBRCloudGatewayPool  [<CommonParameters>]

  • Get cloud gateway pools by the cloud gateway pool ID.

Get-VBRCloudGatewayPool [-Id <Guid[]>]  [<CommonParameters>]

  • Get the cloud gateway pools by the cloud gateway pool name.

Get-VBRCloudGatewayPool [-Name <String[]>]  [<CommonParameters>]

Detailed Description

This cmdlet returns existing cloud gateway pools.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Id

Specifies an array of IDs for cloud gateway pools that you want to get.

Guid[]

True

Named

True (ByValue)

Name

Specifies an array of names for cloud gateway pool that you want to get.

String[]

True

Named

True (ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRCloudGatewayPool[]

Examples

Get-VBRCloudGatewayPoolExample 1. Getting All Cloud Gateway Pools

This command gets all cloud gateway pools.

Get-VBRCloudGatewayPool

Get-VBRCloudGatewayPoolExample 2. Getting Cloud Gateway Pool by Name

This command gets the CloudGT01 cloud gateway pool by the cloud gateway pool name.

Get-VBRCloudGatewayPool -Name "CloudGT01"