Set-VBRNDMPServer

In this article

    Short Description

    Modifies NDMP server settings.

    Applies to

    Product Edition: Enterprise

    Requires Cloud Connect license

    Syntax

    Set-VBRNDMPServer -Server <VBRNDMPServer> [-Name <string>] [-Port <int>] [-Credentials <CCredentials>][-GatewayMode <VBRGatewayMode> {Automatic | SelectedGateway}] [-SelectedGateway <CHost>]  [<CommonParameters>]

    Detailed Description

    Modifies settings of a selected NDMP server.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Server

    Specifies the NDMP server that you want to modify.

    Accepts the VBRNDMPServer type.

    True

    Named

    False

    False

    Name

    Specifies the DNS or IP address of the NDMP server that you want to modify.

    False

    Named

    False

    False

    Port

    Specifies the port. Veeam Backup & Replication will use that port to connect to the NDMP server.

    False

    Named

    False

    False

    Credentials

    Specifies the credentials. Veeam Backup & Replication will use these credentials to connect to the NDMP server.

    False

    Named

    False

    False

    GatewayMode

    Specifies the gateway server. Veeam Backup & Replication will use this gateway server to connect to the NDMP server.

    You can specify the following modes of selecting the gateway server:

    • Automatic - use this option if you want Veeam Backup & Replication to choose the gateway server automatically.
    • SelectedGateway - use this option if you want to specify the particlular gateway server.
      Use the SelectedGateway parameter to specify the server.

    False

    Named

    False

    False

    SelectedGateway

    For specifying a particular gateway server with the SelectedGateway option.

    Specifies the server that you want to use as the gateway server.

    Accepts the CHost type.

    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

    Example

    This example shows how to change the gateway server selection mode for an NDMP server. Veeam Backup & Replication will use a specific gateway server.

    1. Run Get-VBRNDMPServer to get the NDMP server that you want to modify. Save the result to the $ndmp variable.
    2. Run Get-VBRCredentials to get the credentials of the server that you want to use as the gateway server. Save the result to the $creds variable.
    3. Run Set-VBRNDMPServer with the $creds variable. Use the SelectedGateway value for the GatewayMode parameter to set the specific gateway server.

    $ndmp = Get-VBRNDMPServer -Name "NetApp.tech.local"

    $creds = Get-VBRCredentials -Name "GatewayServer"

    Set-VBRNDMPServer -Name "NetApp.tech.local" -Credentials $creds -GatewayMode SelectedGateway -SelectedGateway -Port 10000

    Related Commands

    Get-VBRNDMPServer