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

Remove-VBRCloudGateway

Short Description

Removes cloud gateways.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Requires a cloud provider license.

Syntax

Remove-VBRCloudGateway -CloudGateway <VBRCloudGateway[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes a selected cloud gateway from Veeam Backup & Replication console.

When you remove a cloud gateway, Veeam Backup & Replication unassigns the gateway role from the server, so it is no longer used as a cloud gateway. The actual server remains connected to Veeam Backup & Replication.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Cloud
Gateway

Specifies the array of cloud gateways you want to remove.

Accepts VBRCloudGateway type.

True

Named

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

False

WhatIf

Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

False

Named

False

False

Confirm

Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

False

Named

False

False

<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

None

Example 1

This command removes a cloud gateway represented by the '$cloudgateway' variable.

The cloud gateway is obtained with Get-VBRCloudGateway and assigned to the variable beforehand.

PS C:\PS> Remove-VBRCloudGateway -CloudGateway $cloudgateway

Example 2

This command removes the selected cloud gateway.

The cloud gateway is obtained with Get-VBRCloudGateway and piped down.

PS C:\PS> Get-VBRCloudGateway -Name "Cloud gateway" | Remove-VBRCloudGateway

Related Commands

Get-VBRCloudGateway

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 Endpoint Backup Documentation

Veeam Management Pack Documentation