Go to main content

man pages section 5: File Formats

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ndmp (5)

Name

ndmp - configuration properties for Solaris Network Data Management Protocol (NDMP) server

Description

The behavior of the Solaris NDMP server is specified by property values that are stored in the Service Management Facility, smf(7).

An authorized user can use the ndmpadm(8) command to set global values for these properties in SMF.

The ndmpd service requires a restart by svcadm(8) whenever properties are set. This restart is required whether the properties are set by ndmpadm(8) or svccfg(8).

tcp-port is the TCP port number that the NDMP service accepts for incoming connections. The default is 10000.

You can set the following properties by using the ndmpadm set command:

backup-quarantine

Backup the files marked as quarantined by AV. Acceptable values are yes or no. The default is no.

dar-support

Set the Direct Access Recovery mode. Acceptable values are yes or no. The default is no.

debug-path

The path to which to save the debug log. The default is /var/ndmp.

drive-type

Choose either SystemV or BSD tape drives for the data management application. Valid values are sysv and bsd. The default is sysv.

dump-pathnode

Enable or disable backing up the directories containing modified files or directories in dump(1) backup format. Acceptable values are yes or no. The default is no.

fs-export

Specifies an optional list of mountpoints that are only exported paths for backup. This has no effect if left empty.

ignore-ctime

Determines whether the change timestamp (ctime) of files and directories is used to determine whether a file should be backed up in level backup. If this parameter is set to yes, only the modification time (mtime) of the file or directory determines whether it should be backed up. Acceptable values are yes or no. The default value is no.

overwrite-quarantine

Restore quarantined files on top of current files if they already exist. Acceptable values are yes or no. The default value is no.

restore-quarantine

Restore the files that had been marked as quarantined by AV and are backed up. Acceptable values are yes or no. The default value is no.

tar-pathnode

Enable or disable backing up the directories containing modified files or directories in tar(1) backup format. Acceptable values are yes or no. The default value is no.

token-maxseq

Set the maximum sequence number for subsequent token-based incremental backup in NDMP-V4. The default value is 64. There are two limits for this value: soft-limit, which is 59, and hard-limit, equal to 64. If the token sequence number, passed by the DMA, is between the soft and hard limits, a warning message is issued to the DMA. The token sequence number can never exceed the hard-limit value.

type-override

Override the value of TYPE. Valid values are zfs and off. By default, type-override has a value of off and does not override TYPE. Invalid values are treated as off.

If type-override is set to zfs, the user must make sure that the path format used in the data management application is consistent with the zfs backup type.

version

Set the maximum active NDMP protocol version. Valid values are currently 2, 3, and 4. The default is 4.

zfs-token-support

Enable or disable token based method for ZFS backup type. Acceptable values are yes or no. The default value is no.

zfs-force-override

Override the value of ZFS_FORCE. yes forces a value of y. no forces a value of n. By default, zfs-force-override has a value of off and does not override ZFS_FORCE .

The following property can only be set when using the ndmpadm enable or ndmpadm disable command:

auth-type

Sets the password encryption type for the authentication of local users. Valid values are cram-md5 or cleartext.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
service/storage/ndmp
Interface Stability
Committed

See Also

dump(1), tar(1), attributes(7), smf(7), ndmpadm(8), ndmpd(8), svcadm(8), svccfg(8)