System Administration Commands ndmpadm(1M) NAME ndmpadm - Network Data Management Protocol(NDMP) CLI tools SYNOPSIS /usr/sbin/ndmpadm subcommand [options] [direct-object] DESCRIPTION ndmpadm is a command that can be used to query the ndmpd(1) daemon to get active sessions status, terminate session, query backup devices, and set or get the current NDMP service variables and properties. Ndmpadm is implemented as a set of subcommands, many with their own direct object, which are described in the section for that subcommand. Also the subcommand might need options which are described in the related section too. The ndmpadm command supports the following subcommands: -? Shows all the sub commands and options for ndmpadm. get-config Get the value of an NDMP configuration property. set-config Set the value of an NDMP configuration property. show-devices Get a list of tape hardware connected to the server. show-sessions Shows active NDMP sessions details. kill-sessions Terminate active session. set-config subcommand The syntax for the set subcommand is: # ndmpadm set-config [-p] [property=value] ... The set-config subcommand configuration properties name options are as following: debug-level Set the debug level. The debug-level can be either 0(off) or 1(on); the default is 0. debug-path The path used to save the debug log. The default is /var/ndmp dump-pathnode Enable or disable backing up the directories leading to the modified files or directories for 'dump' backup format. The values for this could be yes or no. The default is no. tar-pathnode Enable or disable backing up the directories leading to the modified files or directories for 'tar' backup format. The values for this could be yes or no. The default is no. ignore-ctime Determines whether the change timestamp (ctime) of files and directories is used to determine if a file should be backed up in level backup. If this parameter is set to yes, only the modifica- tion time (mtime) of the file or directory deter- mines if it should be backed up or not. The values for this could be yes or no. The default is no. token-maxseq Set the maximum sequence number for consequent token-based incremental backup in NDMP-V4. The default value is 9. 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. version Set the maximum active NDMP protocol version. Valid values are currently 2, 3 and 4; the default is 4. dar-support Set the Direct Access Recovery mode. The values for this could be yes or no. The default is no. backup-quarantine Backup the files marked as quarantined by AV; The values for this could be yes or no. The default is no. restore-quarantine Restore the files that had to be marked as quarantined by AV and are backed up. The values for this could be yes or no. The default is no. overwrite-quarantine Restore quarantined files on top of current files if they already exist; The values for this could be yes or no. The default is no. get-config subcommand The syntax for the get-config subcommand is: # ndmpadm get-config [-p] [property] The get-config subcommand property name options are the same as set-config subcommand. if no property is specified, it will return all configuration properties. show-sessions subcommand The syntax for the show-sessions subcommand is: # ndmpadm show-sessions [-i tape,scsi,data,mover] [ID] The following options are supported: -i The NDMP interface to be used. If no interface is specifed it will show information about all the interfaces. ID Identifies the session number that the commands should act on. If no session id is specified it will show information for all the sessions. kill-sessions subcommand The syntax for the kill-sessions subcommand is: # ndmpadm kill-sessions ... where, ID Identifies the session number that the command should act on. show-devices subcommand The syntax for the show-devices subcommand is: # ndmpadm show-devices It will list the name, vendor, serial number and other information of the current tape drive and libraries connected to the system. EXAMPLES Example 1 Getting the information of all NDMP connections: # ndmpadm show-devices Example 2 Getting the information of tape and scsi interfaces only: # ndmpadm show-sessions -i scsi,tape Example 3 Limit the NDMP protocol version to V3: # ndmpadm set-config -p version=3 Example 4 Limit the NDMP protocol version to V3 and turn on the dubugger # ndmpadm set-config -p version=3 debugl-level=1 Example 5 What is the current NDMP running version: # ndmpadm get-config -p version Example 6 Disconnect the session 5 (based on the list of sessions) # ndmpadm kill-session 5 EXIT STATUS The following exit values are returned: 0 Successful completion 1 An error occurred which prevented the ndmpadm to contact the demon, such as daemon is not running. 2 Invalid command-line options were specified. FILES /usr/sbin/ndmpadm Network data management protocol CLI tools binary. ATTRIBUTES See attributes(5) for descriptions of the following attributes: ____________________________________________________________ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | |_____________________________|_____________________________| | Availability | SUNWndmpu, SUNWndmpr | |_____________________________|_____________________________| | Interface Stability | Committed | |_____________________________|_____________________________| SEE ALSO ndmpd(1), svcadm(1M), syslogd(1M), attributes(5), smf(5), svccfg(1M) NOTES The ndmpd(1) is managed by the smf(5), under the service identifier: svc:/system/ndmpd Administrative actions on this service, such as setting and getting property can be alternatively performed using svccfg(1M). For example to enable DAR: svccfg -s svc:/system/ndmpd svc:/system/ndmpd> setprop ndmpd/dar-support = yes And to get the list of properties: svccfg -s svc:/system/ndmpd svc:/system/ndmpd> listprop