Manual Pages for UNIX Operating System command usage for man ndmpadm

System Administration Commands                        ndmpadm(1M)



NAME
     ndmpadm  -  administer  Network  Data  Management   Protocol
     activities

SYNOPSIS
     /usr/sbin/ndmpadm [-? ] subcommand [options] [direct-object]


DESCRIPTION
     The ndmpadm command can be used to query the ndmpd(1M)  dae-
     mon  to  get the status of active sessions, terminate a ses-
     sion, query backup devices, and set or get the current  NDMP
     (Network  Data  Management  Protocol)  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 a given subcommand. Certain subcommands sup-
     port options, which are described along with the subcommand.


     The ndmpadm command supports the following subcommands:

     disable

         Disable the specified authentication password handling.


     enable

         Enable the specified authentication password handling.


     get

         Get the value of an NDMP configuration property.


     kill-sessions

         Terminate an active session.


     set

         Set the value of an NDMP configuration property.


     show-devices

         Get a list of tape devices connected to the server.






SunOS 5.11          Last change: 25 May 2010                    1






System Administration Commands                        ndmpadm(1M)



     show-sessions

         Display the details of active NDMP sessions.


OPTIONS
     The following option is supported:

     -?    Display a list of all subcommands and options.


SUB-COMMANDS
     The  ndmpadm  command  supports  the  subcommands  described
     below.

  disable Subcommand
     The syntax for the disable subcommand is:

       # ndmpadm disable -a auth-type




     This subcommand disables the authentication  type  specified
     by  auth-type  for  an  NDMP  client's  remote access. Valid
     values for auth-type are cram-md5 or cleartext.

  enable Subcommand
     The syntax for the enable subcommand is:

       # ndmpadm enable -a auth-type -u username




     This subcommand prompts for the user's  password  twice  for
     confirmation and activates the specified authentication type
     with the given username and password for NDMP client access.
     Valid values for auth-type are cram-md5 or cleartext.

  get Subcommand
     The syntax for the get subcommand is:

       # ndmpadm get [-p] [property] [[-p] property=value]...




     The property names are the same as used for the set  subcom-
     mand  and  are described below. If you do not specify a pro-
     perty, the get subcommand returns all configuration  proper-
     ties.



SunOS 5.11          Last change: 25 May 2010                    2






System Administration Commands                        ndmpadm(1M)



  kill-sessions Subcommand
     The kill-sessions subcommand allows  you  to  terminate  the
     session number ID.


     The syntax for the kill-sessions subcommand is:

       # ndmpadm kill-sessions ID



  set Subcommand
     The syntax for the set subcommand is:

       # ndmpadm set [-p] property=value [[-p] property=value]...




     The properties you can  set  with  the  set  subcommand  are
     described in the ndmp(4) man page.

  show-devices Subcommand
     The syntax for the show-devices subcommand is:

       # ndmpadm show-devices




     This subcommand lists the name, vendor, serial  number,  and
     other information about the current tape drive and libraries
     connected to the system.

  show-sessions Subcommand
     The show-sessions subcommand displays details of a  session.
     The syntax for the show-sessions subcommand is:

       # ndmpadm show-sessions [-i tape,scsi,data,mover] [ID]




     The show-sessions subcommand supports  the  following  argu-
     ments:

     -i tape,scsi,data,mover

         Identify a type of interface about which to obtain data.
         If  no  interface  is  specified, show-sessions displays
         information for all types of interfaces.




SunOS 5.11          Last change: 25 May 2010                    3






System Administration Commands                        ndmpadm(1M)



     ID

         Identifies a particular session about which  to  display
         data. If no ID is specified, show-sessions displays data
         for all sessions.


EXAMPLES
     Example 1 Obtaining the Status of All NDMP Connections


     The following command obtains status on all connections.


       # ndmpadm show-devices



     Example 2 Obtaining the Status of Certain Types  of  Connec-
     tions


     The following command obtains status on tape and SCSI inter-
     faces.


       # ndmpadm show-sessions -i scsi,tape



     Example 3 Limiting Protocol Version


     The following command limits the use of the NDMP protocol to
     version 3.


       # ndmpadm set -p version=3



     Example 4 Obtaining Current Version Number


     The following command obtains  the  version  number  of  the
     currently running NDMP.


       # ndmpadm get -p version






SunOS 5.11          Last change: 25 May 2010                    4






System Administration Commands                        ndmpadm(1M)



     Example 5 Disconnecting a Specific Session


     The command shown below disconnects session 5.  The  session
     number was previously obtained from an ndmpadm show-sessions
     command.


       # ndmpadm kill-session 5



     Example 6 Obtaining the Values for All NDMP Properties


     The following command obtains the values for all  NDMP  pro-
     perties.


       # ndmpadm get



     Example 7 Enabling CRAM-MD5 Authentication


     The following command enables CRAM-MD5 authentication.


       # ndmpadm enable -a cram-md5 -u admin
       Enter new password:*****
       Re-enter password:*****



     Example 8 Disabling Clear Text Password Authentication


     The following command disables clear text password authenti-
     cation.


       # ndmpadm disable -a cleartext



EXIT STATUS
     0    Successful completion.


     1    An error occurred, such as the ndmpd daemon is not run-
          ning, that prevented ndmpadm from contacting the demon.



SunOS 5.11          Last change: 25 May 2010                    5






System Administration Commands                        ndmpadm(1M)



     2    Invalid command-line options were specified.


ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     _______________________________________________________________
    |       ATTRIBUTE TYPE        |         ATTRIBUTE VALUE        |
    |_____________________________|________________________________|
    | Availability                | service/storage/ndmp, SUNWndmpr|
    |_____________________________|________________________________|
    | Interface Stability         | Committed                      |
    |_____________________________|________________________________|


SEE ALSO
     dump(1),  tar(1),   ndmpd(1M),   ndmpstat(1M),   svccfg(1M),
     syslogd(1M), ndmp(4), attributes(5), smf(5)

NOTES
     The ndmpd(1M) daemon is managed by  the  service  management
     facility (smf(5)), under the service identifier:

       svc:/system/ndmpd




     Administrative actions on this service, such as setting  and
     getting  a  property  can  be  alternatively performed using
     svccfg(1M). For example to  enable  Direct  Access  Recovery
     (DAR) mode:

       # 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









SunOS 5.11          Last change: 25 May 2010                    6