Set-VBRCloudGateway

In this article

    Short Description

    Modifies cloud gateways.

    Applies to

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    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 specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    CloudGateway

    Specifies the cloud gateway you want to modify.

    Accepts the VBRCloudGateway type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Description

    Specifies the description of the cloud gateway.

    False

    Named

    False

    False

    IpAddress

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

    Accepts IPAddress or the string type.

    False

    Named

    False

    False

    IncomingPort

    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

    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.

    Permitted values: 1 to 65535.

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

    False

    Named

    False

    False

    NetworkMode

    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 on common parameters, see the About CommonParameters section of Microsoft Docs.

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

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

    Get-VBRCloudGateway | Set-VBRCloudGateway -IpAddress 172.16.10.20 -IncomingPort 8062

    Related Commands

    Get-VBRCloudGateway