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

Get-VBRCloudGateway

Short Description

Returns cloud gateways.

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

<CommonParameters>

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"

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