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

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