Set-VBRNDMPServer

Short Description

Modifies NDMP server settings.

Product Edition: Enterprise

Requires Cloud Connect license

Syntax

Set-VBRNDMPServer -Server <VBRNDMPServer> [-Name <String>] [-Port <Int32>] [-Credentials <CCredentials>]

[-GatewayMode <VBRGatewayMode>] [-SelectedGateway <CHost>] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of a selected NDMP server.

To modify a NetApp NDMP server, use the Set-VBRNetAppNDMPServer cmdlet.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Credentials	Specifies the credentials. Veeam Backup & Replication will use these credentials to connect to the NDMP server. Accepts the `CCredentials` object. To get this object, run the `Get-VBRCredentials` cmdlet.	`CCredentials`	False	Named	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.	`VBRGatewayMode`	False	Named	False
Name	Specifies the DNS or IP address of the NDMP server that you want to modify.	`String`	False	Named	False
Port	Specifies the port. Veeam Backup & Replication will use that port to connect to the NDMP server.	`Int32`	False	Named	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` object. To get this object, run the `Get-VBRServer` cmdlet.	`CHost`	False	Named	False
Server	Specifies the NDMP server that you want to modify. Accepts the `VBRNDMPServer` object. To get this object, run the `Get-VBRNDMPServer` cmdlet.	`VBRNDMPServer`	True	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBRNDMPServer object that contains information about the modified NDMP server.

Examples

Changing Gateway Server Selection for NDMP Server

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

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

$gateway = Get-VBRServer -Name "Gateway server"

$creds = Get-VBRCredentials -Name "GatewayServer"

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

Perform the following steps:

Run the Get-VBRNDMPServer cmdlet. Specify the Name parameter value. Save the result to the $ndmp variable.
Run the Get-VBRServer cmdlet. Specify the Name parameter. Save the result to the $gateway variable.
Run the Get-VBRCredentials cmdlet. Specify the Name parameter value. Save the result to the $creds variable.
Run the Set-VBRNDMPServer cmdlet. Specify the following settings:
- Specify the Name parameter value.
- Set the $creds variable as the Credentials parameter value.
- Set the SelectedGateway option for the GatewayMode parameter.
- Set the $gateway variable as the SelectedGateway parameter value.
- Specify the Port parameter value.