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

Get-VBRCloudGatewayPool

Short Description

Returns cloud gateway pools.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Requires a cloud provider license.

Syntax

This cmdlet provides the following parameter sets:

Used for getting all cloud gateway pools

Get-VBRCloudGatewayPool [<CommonParameters>]

Used for getting cloud gateway pools by the cloud gateway pool ID

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

Used for getting 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	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Id	Specifies an array of IDs for cloud gateway pools that you want to get.	True	Named	True (ByValue)	False
Name	Specifies an array of names for cloud gateway pool that you want to get.	True	Named	True (ByValue)	False

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

Return Type

Example 1

This command gets all cloud gateway pools.

Get-VBRCloudGatewayPool

Example 2

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

Get-VBRCloudGatewayPool -Name "Cloud Gateway Pool 01"