Specifies the name of the NDMP node group. This is NOT case sensitive.
Using unlisted arguments can lead to an error.
Options
-c, --cluster { clusterID | clusterName }
Selects the cluster for the operation. Use either the clusterID or the clusterName to identify the cluster.
If this option is omitted, the default cluster, as defined with the setcluster command, is used.
(Note: The setcluster command is available only for users who are in the cliuser group.)
Optional. This parameter is reserved for future use.
--create
Creates a new NDMP node group. Optional.
--dmaPort dmaPort
Specifies the data management application (DMA) port. A valid value would be in the range of 1 to 65535. The default value is 10000.
It is not advisable to change this value from the default since it will make most of the DMA softwares not able to connect to the NDMP data server.
Optional.
--dataTransferPortRange dataTransferPortRange
Specifies the size of the data-transfer port range. The valid range is from 1025 to 65535.
--tcpSize tcpSize
Specifies the size of the TCP window. A valid value would be in the range of 1 to 1024. The default value is 160. Optional.
--protocol protocol
Specifies the default protocol version. Valid values are 2, 3, and 4. The default version is 4. Optional.
--logLevel logLevel
Specifies the log level. Valid values are 0, 1, 2, 3, 4, 5, 6, 7, and 8. The default value is 0.
0 - No debug output
1 - Log all NDMP communication from/to DMA except file history information
2 - Log all NDMP communication from/to DMA including file history information
3 - Like level 2 and add log for high level data service logs
4 - Like level 3 and add more detailed data service logs
5 - Like level 4 and add more data service function call logs
6 - Like level 5 and add more debug level data service logs
7 - Like level 6 and add more debug on I/Os
8 - All debug logging on
Optional.
--userCredentials userCredentials
Specifies the user name and password. The valid format is <username>%<password>%<retype password>. For example, testuser%testpassword%testpassword. Optional.
--networkGroup networkGroup
Specifies the name of the network group to be attached with the NDMP group. Optional.
--limitDMA limitDMA
Specifies the comma-separated list of IP addresses of the DMA clients to be allowed.
If an empty string is passed, all the IP addresses are added. Optional.
--freeDMA
Allows all DMA clients. Optional.
--limitDataIP limitDataIP
Specifies a specific subnetwork to be used for transferring data. The subnetwork must be already defined in the system.
Only the IP addresses of the subnetwork will be used for NDMP data transfer. Optional.
--freeDataIP
Allows all the public IP addresses to participate in an NDMP communication. Optional.
--addPaths addPaths
Specifies the comma-separated paths to be added in the backup and recovery paths list. Path must be a valid file-system mount point. Optional.
--removePaths removePaths
Specifies the comma-separated paths to be removed from the backup and recovery paths list. Optional.
--allowNewSessions
Allows new NDMP sessions to be started. Optional.
--denyNewSessions
Does not allow new NDMP sessions to be started. Optional.
--activate
Starts all the NDMP daemons on the relevant nodes. Optional.
--deactivate
Stops all the NDMP daemons on the relevant nodes. Optional.
--force
Enforces the operation without calling back the user. Optional.
Using unlisted options can lead to an error.
Description
The
cfgndmp
command configures the NDMP server on a group of nodes of the cluster
with the input values. It is assumed that the cluster is configured in stand-alone mode.
If NDMP is active and a parameter is changed, the user will be prompted to deactivate NDMP.
Then, NDMP will be activated again automatically and utilize the new value of the parameter.
Diagnostics
0
No error - The command was successful.
1
Syntax Error or Help - The command syntax was incorrect or --help was specified.
2
No Permission - The user does not have permission to issue the command.
3
Version Error - Mismatch between the expected and actual version of the software stack.
4
Communication Error - Communication with other cluster nodes or back-end services failed.
5
Timeout error - An operation waiting for data did not receive it within the time it expected it.
6
Input error - An argument or option was invalid.
7
Server error - An error occurred in a back-end service that caused the command to fail.
8
Command error - An internal error occurred while executing the command.
9
Invalid object - An object referenced by an argument or option value does not exist.
10
Duplicate object - The object to be created already exists.
11
Not enabled - The command is not enabled on this hardware platform.
12
Not licensed - The license agreement was not accepted.
14
User abort - The user aborted the command.
Copyright
Licensed Materials - Property of IBM, 5639-SN1, (C) Copyright IBM Corp. 2009, 2014. All rights reserved.