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

Set-VBRCloudGateway

Short Description

Modifies cloud gateways.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Requires a cloud provider license.

Syntax

Set-VBRCloudGateway -CloudGateway <VBRCloudGateway> [-Description <String>] [-IpAddress <String>] [-IncomingPort <Int32>] [-NATPort <Int32>] [-PassThru] [-NetworkMode <VBRGatewayNetworkMode>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet modifies existing cloud gateway. To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Cloud
Gateway

Specifies the cloud gateway you want to modify.

Accepts VBRCloudGateway type.

True

Named

True (ByValue,
ByProperty
Name)

False

Description

Specifies the description of the cloud gateway.

False

Named

False

False

Ip
Address

Specifies an external IP address of the NAT or network interface gateway.

Accepts IPAddress or string type.

False

Named

False

False

Incoming
Port

Specifies a port that will be used by the Veeam backup server to connect to the gateway.

Permitted values: 1 to 65535.

Default: 6180.

False

Named

False

False

NAT
Port

Specifies a port on the NAT gateway used for listening to connections from users and passing cloud commands from users to the SP Veeam backup server.

Permitted values: 1 to 65535.

Default: (for Direct) null, (for NAT) 8080.

False

Named

False

False

Network
Mode

Specifies network mode: Direct, NAT.

False

Named

False

False

PassThru

Indicates that the command returns the output object to the Windows PowerShell console.

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

VBRCloudGateway

Example 1

This command sets a new port for the cloud gateway to connect to Veeam Backup & Replication.

  • The cloud gateway is obtained by Get-VBRCloudGateway and assigned to the '$cloudgateway' variable beforehand.
  • The new port number is set to '9012'.

PS C:\PS> Set-VBRCloudGateway -CloudGateway $cloudgateway -IncomingPort 9012

Example 2

This command sets a new cloud gateway IP address and port to connect to Veeam Backup & Replication.

  • The cloud gateway is obtained by Get-VBRCloudGateway and piped down.
  • The IP address is set to '172.16.10.20' and the port is set to '8062'.

PS C:\PS> Get-VBRCloudGateway | Set-VBRCloudGateway -IpAddress 172.16.10.20 -IncomingPort 8062

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 Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation