usr/src/man/man1m/ndmpadm.1m

   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
   5 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH NDMPADM 1M "Jun 24, 2009"
   7 .SH NAME
   8 ndmpadm \- administer Network Data Management Protocol activities
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/ndmpadm\fR [\fB-?\fR ] \fIsubcommand\fR [\fIoptions\fR] [\fIdirect-object\fR]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBndmpadm\fR command can be used to query the \fBndmpd\fR(1M) daemon to
  19 get the status of active sessions, terminate a session, query backup devices,
  20 and set or get the current NDMP (Network Data Management Protocol) service
  21 variables and properties. \fBndmpadm\fR is implemented as a set of subcommands,
  22 many with their own direct object, which are described in the section for a
  23 given subcommand. Certain subcommands support options, which are described
  24 along with the subcommand.
  25 .sp
  26 .LP
  27 The \fBndmpadm\fR command supports the following subcommands:
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fBdisable\fR\fR
  32 .ad
  33 .sp .6
  34 .RS 4n
  35 Disable the specified authentication password handling.
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBenable\fR\fR
  42 .ad
  43 .sp .6
  44 .RS 4n
  45 Enable the specified authentication password handling.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBget\fR\fR
  52 .ad
  53 .sp .6
  54 .RS 4n
  55 Get the value of an NDMP configuration property.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBkill-sessions\fR\fR
  62 .ad
  63 .sp .6
  64 .RS 4n
  65 Terminate an active session.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBset\fR\fR
  72 .ad
  73 .sp .6
  74 .RS 4n
  75 Set the value of an NDMP configuration property.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBshow-devices\fR\fR
  82 .ad
  83 .sp .6
  84 .RS 4n
  85 Get a list of tape devices connected to the server.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBshow-sessions\fR\fR
  92 .ad
  93 .sp .6
  94 .RS 4n
  95 Display the details of active NDMP sessions.
  96 .RE
  97
  98 .SH OPTIONS
  99 .sp
 100 .LP
 101 The following option is supported:
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fB-?\fR\fR
 106 .ad
 107 .RS 6n
 108 Display a list of all subcommands and options.
 109 .RE
 110
 111 .SH SUB-COMMANDS
 112 .sp
 113 .LP
 114 The \fBndmpadm\fR command supports the subcommands described below.
 115 .SS "\fBdisable\fR Subcommand"
 116 .sp
 117 .LP
 118 The syntax for the \fBdisable\fR subcommand is:
 119 .sp
 120 .in +2
 121 .nf
 122 # \fBndmpadm disable -a \fIauth-type\fR\fR
 123 .fi
 124 .in -2
 125 .sp
 126
 127 .sp
 128 .LP
 129 This subcommand disables the authentication type specified by \fIauth-type\fR
 130 for an NDMP client's remote access. Valid values for \fIauth-type\fR are
 131 \fBcram-md5\fR or \fBcleartext\fR.
 132 .SS "\fBenable\fR Subcommand"
 133 .sp
 134 .LP
 135 The syntax for the \fBenable\fR subcommand is:
 136 .sp
 137 .in +2
 138 .nf
 139 # \fBndmpadm enable -a \fIauth-type\fR -u \fIusername\fR\fR
 140 .fi
 141 .in -2
 142 .sp
 143
 144 .sp
 145 .LP
 146 This subcommand prompts for the user's password twice for confirmation and
 147 activates the specified authentication type with the given username and
 148 password for NDMP client access. Valid values for \fIauth-type\fR are
 149 \fBcram-md5\fR or \fBcleartext\fR.
 150 .SS "\fBget\fR Subcommand"
 151 .sp
 152 .LP
 153 The syntax for the \fBget\fR subcommand is:
 154 .sp
 155 .in +2
 156 .nf
 157 # \fBndmpadm get [-p] [\fIproperty\fR] [[-p] \fIproperty\fR=\fIvalue\fR]...\fR
 158 .fi
 159 .in -2
 160 .sp
 161
 162 .sp
 163 .LP
 164 The property names are the same as used for the \fBset\fR subcommand and are
 165 described below. If you do not specify a property, the \fBget\fR subcommand
 166 returns all configuration properties.
 167 .SS "\fBkill-sessions\fR Subcommand"
 168 .sp
 169 .LP
 170 The \fBkill-sessions\fR subcommand allows you to terminate the session number
 171 \fIID\fR.
 172 .sp
 173 .LP
 174 The syntax for the \fBkill-sessions\fR subcommand is:
 175 .sp
 176 .in +2
 177 .nf
 178 # \fBndmpadm kill-sessions \fIID\fR\fR
 179 .fi
 180 .in -2
 181 .sp
 182
 183 .SS "\fBset\fR Subcommand"
 184 .sp
 185 .LP
 186 The syntax for the \fBset\fR subcommand is:
 187 .sp
 188 .in +2
 189 .nf
 190 # \fBndmpadm set [-p] \fIproperty\fR=\fIvalue\fR [[-p] \fIproperty\fR=\fIvalue\fR]...\fR
 191 .fi
 192 .in -2
 193 .sp
 194
 195 .sp
 196 .LP
 197 The properties you can set with the \fBset\fR subcommand are described in the
 198 \fBndmp\fR(4) man page.
 199 .SS "\fBshow-devices\fR Subcommand"
 200 .sp
 201 .LP
 202 The syntax for the \fBshow-devices\fR subcommand is:
 203 .sp
 204 .in +2
 205 .nf
 206 # \fBndmpadm show-devices\fR
 207 .fi
 208 .in -2
 209 .sp
 210
 211 .sp
 212 .LP
 213 This subcommand lists the name, vendor, serial number, and other information
 214 about the current tape drive and libraries connected to the system.
 215 .SS "\fBshow-sessions\fR Subcommand"
 216 .sp
 217 .LP
 218 The \fBshow-sessions\fR subcommand displays details of a session. The syntax
 219 for the \fBshow-sessions\fR subcommand is:
 220 .sp
 221 .in +2
 222 .nf
 223 # \fBndmpadm show-sessions [-i tape,scsi,data,mover] [\fIID\fR]\fR
 224 .fi
 225 .in -2
 226 .sp
 227
 228 .sp
 229 .LP
 230 The \fBshow-sessions\fR subcommand supports the following arguments:
 231 .sp
 232 .ne 2
 233 .na
 234 \fB\fB-i\fR \fBtape\fR,\fBscsi\fR,\fBdata\fR,\fBmover\fR\fR
 235 .ad
 236 .sp .6
 237 .RS 4n
 238 Identify a type of interface about which to obtain data. If no interface is
 239 specified, \fBshow-sessions\fR displays information for all types of
 240 interfaces.
 241 .RE
 242
 243 .sp
 244 .ne 2
 245 .na
 246 \fB\fIID\fR\fR
 247 .ad
 248 .sp .6
 249 .RS 4n
 250 Identifies a particular session about which to display data. If no \fIID\fR is
 251 specified, \fBshow-sessions\fR displays data for all sessions.
 252 .RE
 253
 254 .SH EXAMPLES
 255 .LP
 256 \fBExample 1 \fRObtaining the Status of All NDMP Connections
 257 .sp
 258 .LP
 259 The following command obtains status on all connections.
 260
 261 .sp
 262 .in +2
 263 .nf
 264 # \fBndmpadm show-devices\fR
 265 .fi
 266 .in -2
 267 .sp
 268
 269 .LP
 270 \fBExample 2 \fRObtaining the Status of Certain Types of Connections
 271 .sp
 272 .LP
 273 The following command obtains status on tape and SCSI interfaces.
 274
 275 .sp
 276 .in +2
 277 .nf
 278 # \fBndmpadm show-sessions -i scsi,tape\fR
 279 .fi
 280 .in -2
 281 .sp
 282
 283 .LP
 284 \fBExample 3 \fRLimiting Protocol Version
 285 .sp
 286 .LP
 287 The following command limits the use of the NDMP protocol to version 3.
 288
 289 .sp
 290 .in +2
 291 .nf
 292 # \fBndmpadm set -p version=3\fR
 293 .fi
 294 .in -2
 295 .sp
 296
 297 .LP
 298 \fBExample 4 \fRTurning on Debugging
 299 .sp
 300 .LP
 301 The following command enables debugging. It also sets the NDMP protocol to
 302 version 3.
 303
 304 .sp
 305 .in +2
 306 .nf
 307 # \fBndmpadm set -p debug-level=1 -p version=3\fR
 308 .fi
 309 .in -2
 310 .sp
 311
 312 .LP
 313 \fBExample 5 \fRObtaining Current Version Number
 314 .sp
 315 .LP
 316 The following command obtains the version number of the currently running NDMP.
 317
 318 .sp
 319 .in +2
 320 .nf
 321 # \fBndmpadm get -p version\fR
 322 .fi
 323 .in -2
 324 .sp
 325
 326 .LP
 327 \fBExample 6 \fRDisconnecting a Specific Session
 328 .sp
 329 .LP
 330 The command shown below disconnects session 5. The session number was
 331 previously obtained from an \fBndmpadm show-sessions\fR command.
 332
 333 .sp
 334 .in +2
 335 .nf
 336 # \fBndmpadm kill-session 5\fR
 337 .fi
 338 .in -2
 339 .sp
 340
 341 .LP
 342 \fBExample 7 \fRObtaining the Values for All NDMP Properties
 343 .sp
 344 .LP
 345 The following command obtains the values for all NDMP properties.
 346
 347 .sp
 348 .in +2
 349 .nf
 350 # \fBndmpadm get\fR
 351 .fi
 352 .in -2
 353 .sp
 354
 355 .LP
 356 \fBExample 8 \fREnabling CRAM-MD5 Authentication
 357 .sp
 358 .LP
 359 The following command enables CRAM-MD5 authentication.
 360
 361 .sp
 362 .in +2
 363 .nf
 364 # \fBndmpadm enable -a cram-md5 -u admin\fR
 365 Enter new password:\fB*****\fR
 366 Re-enter password:\fB*****\fR
 367 .fi
 368 .in -2
 369 .sp
 370
 371 .LP
 372 \fBExample 9 \fRDisabling Clear Text Password Authentication
 373 .sp
 374 .LP
 375 The following command disables clear text password authentication.
 376
 377 .sp
 378 .in +2
 379 .nf
 380 # \fBndmpadm disable -a cleartext\fR
 381 .fi
 382 .in -2
 383 .sp
 384
 385 .SH EXIT STATUS
 386 .sp
 387 .ne 2
 388 .na
 389 \fB\fB0\fR\fR
 390 .ad
 391 .RS 5n
 392 Successful completion.
 393 .RE
 394
 395 .sp
 396 .ne 2
 397 .na
 398 \fB\fB1\fR\fR
 399 .ad
 400 .RS 5n
 401 An error occurred, such as the \fBndmpd\fR daemon is not running, that
 402 prevented \fBndmpadm\fR from contacting the demon.
 403 .RE
 404
 405 .sp
 406 .ne 2
 407 .na
 408 \fB\fB2\fR\fR
 409 .ad
 410 .RS 5n
 411 Invalid command-line options were specified.
 412 .RE
 413
 414 .SH ATTRIBUTES
 415 .sp
 416 .LP
 417 See \fBattributes\fR(5) for descriptions of the following attributes:
 418 .sp
 419
 420 .sp
 421 .TS
 422 box;
 423 c | c
 424 l | l .
 425 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 426 _
 427 Interface Stability     Committed
 428 .TE
 429
 430 .SH SEE ALSO
 431 .sp
 432 .LP
 433 \fBdump\fR(1), \fBtar\fR(1), \fBndmpd\fR(1M), \fBndmpstat\fR(1M),
 434 \fBsvccfg\fR(1M), \fBsyslogd\fR(1M), \fBndmp\fR(4), \fBattributes\fR(5),
 435 \fBsmf\fR(5)
 436 .SH NOTES
 437 .sp
 438 .LP
 439 The \fBndmpd\fR(1M) daemon is managed by the service management facility
 440 (\fBsmf\fR(5)), under the service identifier:
 441 .sp
 442 .in +2
 443 .nf
 444 svc:/system/ndmpd
 445 .fi
 446 .in -2
 447 .sp
 448
 449 .sp
 450 .LP
 451 Administrative actions on this service, such as setting and getting a property
 452 can be alternatively performed using \fBsvccfg\fR(1M). For example to enable
 453 Direct Access Recovery (DAR) mode:
 454 .sp
 455 .in +2
 456 .nf
 457 # \fBsvccfg -s svc:/system/ndmpd\fR
 458 svc:/system/ndmpd> \fBsetprop ndmpd/dar-support = yes\fR
 459 .fi
 460 .in -2
 461 .sp
 462
 463 .sp
 464 .LP
 465 \&...and to get the list of properties:
 466 .sp
 467 .in +2
 468 .nf
 469 # \fBsvccfg -s svc:/system/ndmpd\fR
 470 svc:/system/ndmpd> \fBlistprop\fR
 471 .fi
 472 .in -2
 473 .sp
 474