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 parameter sets that allow you to:

  • Get all cloud gateways.

Get-VBRCloudGateway  [<CommonParameters>]

  • Get the cloud gateways by ID.

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

  • Get the cloud gateways by name.

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

Detailed Description

This cmdlet returns existing cloud gateways.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Id

Specifies the array of IDs of cloud gateways.

Accepts GUID[] or string[].

False

Named

True (ByValue,
ByProperty
Name)

Name

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

String[]

False

Named

True (ByValue,
ByProperty
Name)

<CommonParameters>

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

Output Object

VBRCloudGateway[]

Examples

Get-VBRCloudGatewayExample 1. Getting All Cloud Gateways

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

Get-VBRCloudGateway

Get-VBRCloudGatewayExample 2. Getting Cloud Gateway by Name

This command gets the cloud gateway by name.

Get-VBRCloudGateway -Name "Cloud gateway"

Page updated 4/12/2024

Page content applies to build 12.3.0.310