Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
PowerShell Reference

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

<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 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"

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions Reference

Veeam Availability for Nutanix AHV Documentation

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation