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

Get-VBRCloudGateway

Short Description

Returns cloud gateways.

Applies to

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

Requires a cloud provider license.

Syntax

This cmdlet provides the following parameter sets:

Used for getting all cloud gateways.

Get-VBRCloudGateway [<CommonParameters>]

Used for getting the cloud gateways by ID

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

Used for getting the cloud gateways by name

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

Detailed Description

This cmdlet returns existing cloud gateways.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Id	Specifies the array of IDs of cloud gateways. Accepts GUID or the string type.	False	Named	True (ByValue, ByProperty Name)	False
Name	Specifies the array of the cloud gateway names you want to get or search conditions.	False	Named	True (ByValue, ByProperty Name)	True

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Specifies the array of IDs of cloud gateways.

Accepts GUID or the string type.

False

Named

True (ByValue,
ByProperty
Name)

False

Name

Specifies the array of the cloud gateway names you want to get or search conditions.

False

Named

True (ByValue,
ByProperty
Name)

True

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

Return Type

VBRCloudGateway[]

Example 1

This command returns all cloud gateways configured in Veeam Backup & Replication.

Get-VBRCloudGateway

Example 2

This command gets the cloud gateway by name.

Get-VBRCloudGateway -Name "Cloud gateway"