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

Get-VBRCloudGateway

Short Description

Returns cloud gateways.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Requires a cloud provider license.

Syntax

Get-VBRCloudGateway [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Get-VBRCloudGateway [-Id <Guid[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Get-VBRCloudGateway [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet returns existing cloud gateways.

You can get the list of all existing cloud gateways or search for instances directly by name or ID. This cmdlet provides syntax for three scenarios accordingly.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Id

Specifies the array of IDs of cloud gateways.

Accepts GUID or 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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

VBRCloudGateway[]

Example 1

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

PS C:\PS> Get-VBRCloudGateway

Example 2

This command gets the cloud gateway by name.

PS C:\PS> 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 Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation