This is an archive version of the document. To get the most up-to-date information, see the current version.

Add-VBRCloudGateway

Short Description

Creates cloud gateways for Veeam Cloud Connect.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Requires a cloud provider license.

Syntax

Add-VBRCloudGateway [-Description <string>] [-Server <CHost>] [-IpAddress <ipaddress>] [-IncomingPort <int>] [-NATPort <int>] [-NetworkMode <VBRGatewayNetworkMode> {Direct | NAT}]  [<CommonParameters>]

Detailed Description

This cmdlet creates a cloud gateway.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Description

Specifies the description of the cloud gateway.

If not set, Veeam Backup & Replication will enter date and time of creation by default.

False

Named

False

False

Server

Specifies server that will perform the role of a cloud gateway. You can select any server added to Veeam Backup & Replication on assign the cloud gateway role to the Veeam backup server itself.

Accepts CHost object.

Accepted server types: Windows, Local.

Default: Local.

False

Named

False

False

IpAddress

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

Accepts IPAddress object 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.

Accepts int type.

Permitted values: 1 to 65535.

Default: 6180.

False

Named

False

False

NATPort

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.

Accepts int type.

Permitted values: 1 to 65535.

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

False

Named

False

False

Network
Mode

Specifies the network mode: Direct, NAT.

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.

Related Commands

Get-VBRServer

Return Type

VBRCloudGateway

Example 1

This command adds a new cloud gateway with a direct network connection.

  • The server that will be used as the cloud gateway is obtained with Get-VBRServer and assigned to the '$server' variable beforehand.
  • The external network gateway IP is 104.45.95.227.
  • The port that will be used by Veeam Backup & Replication to connect to the gateway server is '6260'.
  • The network mode is set to 'Direct'.

PS C:\PS> Add-VBRCloudGateway -Server $server -Description "Gateway directly connected to Internet" -IpAddress 104.45.85.123 -IncomingPort 6260 -NetworkMode Direct

Example 2

This command adds a new cloud gateway in the local network behind the NAT gateway.

  • The server that will be used as the cloud gateway is obtained with Get-VBRServer and assigned to the '$server' variable beforehand.
  • The external NAT gateway IP is 104.45.95.227.
  • The port that will be used by Veeam Backup & Replication to connect to the gateway server is '6180'.
  • The port that will be used by the NAT gateway is '7180'.
  • The network mode is set to 'NAT'.

PS C:\PS> Add-VBRCloudGateway -Server $server -Description "Gateway behind NAT" -IpAddress 104.45.95.227 -IncomingPort 6180 -NATPort 7180 -NetworkMode NAT