share/man/man8/ndmpadm.8

   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 8 "April 9, 2016"
   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 .LP
  18 The \fBndmpadm\fR command can be used to query the \fBndmpd\fR(8) 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 .LP
 100 The following option is supported:
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fB-?\fR\fR
 105 .ad
 106 .RS 6n
 107 Display a list of all subcommands and options.
 108 .RE
 109
 110 .SH SUBCOMMANDS
 111 .LP
 112 The \fBndmpadm\fR command supports the subcommands described below.
 113 .SS "\fBdisable\fR Subcommand"
 114 .LP
 115 The syntax for the \fBdisable\fR subcommand is:
 116 .sp
 117 .in +2
 118 .nf
 119 # \fBndmpadm disable -a \fIauth-type\fR\fR
 120 .fi
 121 .in -2
 122 .sp
 123
 124 .sp
 125 .LP
 126 This subcommand disables the authentication type specified by \fIauth-type\fR
 127 for an NDMP client's remote access. Valid values for \fIauth-type\fR are
 128 \fBcram-md5\fR or \fBcleartext\fR.
 129 .SS "\fBenable\fR Subcommand"
 130 .LP
 131 The syntax for the \fBenable\fR subcommand is:
 132 .sp
 133 .in +2
 134 .nf
 135 # \fBndmpadm enable -a \fIauth-type\fR -u \fIusername\fR\fR
 136 .fi
 137 .in -2
 138 .sp
 139
 140 .sp
 141 .LP
 142 This subcommand prompts for the user's password twice for confirmation and
 143 activates the specified authentication type with the given username and
 144 password for NDMP client access. Valid values for \fIauth-type\fR are
 145 \fBcram-md5\fR or \fBcleartext\fR.
 146 .SS "\fBget\fR Subcommand"
 147 .LP
 148 The syntax for the \fBget\fR subcommand is:
 149 .sp
 150 .in +2
 151 .nf
 152 # \fBndmpadm get [-p] [\fIproperty\fR] [[-p] \fIproperty\fR=\fIvalue\fR]...\fR
 153 .fi
 154 .in -2
 155 .sp
 156
 157 .sp
 158 .LP
 159 The property names are the same as used for the \fBset\fR subcommand and are
 160 described below. If you do not specify a property, the \fBget\fR subcommand
 161 returns all configuration properties.
 162 .SS "\fBkill-sessions\fR Subcommand"
 163 .LP
 164 The \fBkill-sessions\fR subcommand allows you to terminate the session number
 165 \fIID\fR.
 166 .sp
 167 .LP
 168 The syntax for the \fBkill-sessions\fR subcommand is:
 169 .sp
 170 .in +2
 171 .nf
 172 # \fBndmpadm kill-sessions \fIID\fR\fR
 173 .fi
 174 .in -2
 175 .sp
 176
 177 .SS "\fBset\fR Subcommand"
 178 .LP
 179 The syntax for the \fBset\fR subcommand is:
 180 .sp
 181 .in +2
 182 .nf
 183 # \fBndmpadm set [-p] \fIproperty\fR=\fIvalue\fR [[-p] \fIproperty\fR=\fIvalue\fR]...\fR
 184 .fi
 185 .in -2
 186 .sp
 187
 188 .sp
 189 .LP
 190 The properties you can set with the \fBset\fR subcommand are described in the
 191 \fBndmp\fR(4) man page.
 192 .SS "\fBshow-devices\fR Subcommand"
 193 .LP
 194 The syntax for the \fBshow-devices\fR subcommand is:
 195 .sp
 196 .in +2
 197 .nf
 198 # \fBndmpadm show-devices\fR
 199 .fi
 200 .in -2
 201 .sp
 202
 203 .sp
 204 .LP
 205 This subcommand lists the name, vendor, serial number, and other information
 206 about the current tape drive and libraries connected to the system.
 207 .SS "\fBshow-sessions\fR Subcommand"
 208 .LP
 209 The \fBshow-sessions\fR subcommand displays details of a session. The syntax
 210 for the \fBshow-sessions\fR subcommand is:
 211 .sp
 212 .in +2
 213 .nf
 214 # \fBndmpadm show-sessions [-i tape,scsi,data,mover] [\fIID\fR]\fR
 215 .fi
 216 .in -2
 217 .sp
 218
 219 .sp
 220 .LP
 221 The \fBshow-sessions\fR subcommand supports the following arguments:
 222 .sp
 223 .ne 2
 224 .na
 225 \fB\fB-i\fR \fBtape\fR,\fBscsi\fR,\fBdata\fR,\fBmover\fR\fR
 226 .ad
 227 .sp .6
 228 .RS 4n
 229 Identify a type of interface about which to obtain data. If no interface is
 230 specified, \fBshow-sessions\fR displays information for all types of
 231 interfaces.
 232 .RE
 233
 234 .sp
 235 .ne 2
 236 .na
 237 \fB\fIID\fR\fR
 238 .ad
 239 .sp .6
 240 .RS 4n
 241 Identifies a particular session about which to display data. If no \fIID\fR is
 242 specified, \fBshow-sessions\fR displays data for all sessions.
 243 .RE
 244
 245 .SH EXAMPLES
 246 .LP
 247 \fBExample 1 \fRObtaining the Status of All NDMP Connections
 248 .sp
 249 .LP
 250 The following command obtains status on all connections.
 251
 252 .sp
 253 .in +2
 254 .nf
 255 # \fBndmpadm show-devices\fR
 256 .fi
 257 .in -2
 258 .sp
 259
 260 .LP
 261 \fBExample 2 \fRObtaining the Status of Certain Types of Connections
 262 .sp
 263 .LP
 264 The following command obtains status on tape and SCSI interfaces.
 265
 266 .sp
 267 .in +2
 268 .nf
 269 # \fBndmpadm show-sessions -i scsi,tape\fR
 270 .fi
 271 .in -2
 272 .sp
 273
 274 .LP
 275 \fBExample 3 \fRLimiting Protocol Version
 276 .sp
 277 .LP
 278 The following command limits the use of the NDMP protocol to version 3.
 279
 280 .sp
 281 .in +2
 282 .nf
 283 # \fBndmpadm set -p version=3\fR
 284 .fi
 285 .in -2
 286 .sp
 287
 288 .LP
 289 \fBExample 4 \fRTurning on Debugging
 290 .sp
 291 .LP
 292 The following command enables debugging. It also sets the NDMP protocol to
 293 version 3.
 294
 295 .sp
 296 .in +2
 297 .nf
 298 # \fBndmpadm set -p debug-mode=yes -p version=3\fR
 299 .fi
 300 .in -2
 301 .sp
 302
 303 .LP
 304 \fBExample 5 \fRObtaining Current Version Number
 305 .sp
 306 .LP
 307 The following command obtains the version number of the currently running NDMP.
 308
 309 .sp
 310 .in +2
 311 .nf
 312 # \fBndmpadm get -p version\fR
 313 .fi
 314 .in -2
 315 .sp
 316
 317 .LP
 318 \fBExample 6 \fRDisconnecting a Specific Session
 319 .sp
 320 .LP
 321 The command shown below disconnects session 5. The session number was
 322 previously obtained from an \fBndmpadm show-sessions\fR command.
 323
 324 .sp
 325 .in +2
 326 .nf
 327 # \fBndmpadm kill-session 5\fR
 328 .fi
 329 .in -2
 330 .sp
 331
 332 .LP
 333 \fBExample 7 \fRObtaining the Values for All NDMP Properties
 334 .sp
 335 .LP
 336 The following command obtains the values for all NDMP properties.
 337
 338 .sp
 339 .in +2
 340 .nf
 341 # \fBndmpadm get\fR
 342 .fi
 343 .in -2
 344 .sp
 345
 346 .LP
 347 \fBExample 8 \fREnabling CRAM-MD5 Authentication
 348 .sp
 349 .LP
 350 The following command enables CRAM-MD5 authentication.
 351
 352 .sp
 353 .in +2
 354 .nf
 355 # \fBndmpadm enable -a cram-md5 -u admin\fR
 356 Enter new password:\fB*****\fR
 357 Re-enter password:\fB*****\fR
 358 .fi
 359 .in -2
 360 .sp
 361
 362 .LP
 363 \fBExample 9 \fRDisabling Clear Text Password Authentication
 364 .sp
 365 .LP
 366 The following command disables clear text password authentication.
 367
 368 .sp
 369 .in +2
 370 .nf
 371 # \fBndmpadm disable -a cleartext\fR
 372 .fi
 373 .in -2
 374 .sp
 375
 376 .SH EXIT STATUS
 377 .ne 2
 378 .na
 379 \fB\fB0\fR\fR
 380 .ad
 381 .RS 5n
 382 Successful completion.
 383 .RE
 384
 385 .sp
 386 .ne 2
 387 .na
 388 \fB\fB1\fR\fR
 389 .ad
 390 .RS 5n
 391 An error occurred, such as the \fBndmpd\fR daemon is not running, that
 392 prevented \fBndmpadm\fR from contacting the daemon.
 393 .RE
 394
 395 .sp
 396 .ne 2
 397 .na
 398 \fB\fB2\fR\fR
 399 .ad
 400 .RS 5n
 401 Invalid command-line options were specified.
 402 .RE
 403
 404 .SH ATTRIBUTES
 405 .LP
 406 See \fBattributes\fR(5) for descriptions of the following attributes:
 407 .sp
 408
 409 .sp
 410 .TS
 411 box;
 412 c | c
 413 l | l .
 414 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 415 _
 416 Interface Stability     Committed
 417 .TE
 418
 419 .SH SEE ALSO
 420 .LP
 421 \fBdump\fR(1), \fBtar\fR(1), \fBndmpd\fR(8), \fBndmpstat\fR(8),
 422 \fBsvccfg\fR(8), \fBsyslogd\fR(8), \fBndmp\fR(4), \fBattributes\fR(5),
 423 \fBsmf\fR(5)
 424 .SH NOTES
 425 .LP
 426 The \fBndmpd\fR(8) daemon is managed by the service management facility
 427 (\fBsmf\fR(5)), under the service identifier:
 428 .sp
 429 .in +2
 430 .nf
 431 svc:/system/ndmpd
 432 .fi
 433 .in -2
 434 .sp
 435
 436 .sp
 437 .LP
 438 Administrative actions on this service, such as setting and getting a property
 439 can be alternatively performed using \fBsvccfg\fR(8). For example to enable
 440 Direct Access Recovery (DAR) mode:
 441 .sp
 442 .in +2
 443 .nf
 444 # \fBsvccfg -s svc:/system/ndmpd\fR
 445 svc:/system/ndmpd> \fBsetprop ndmpd/dar-support = yes\fR
 446 .fi
 447 .in -2
 448 .sp
 449
 450 .sp
 451 .LP
 452 \&...and to get the list of properties:
 453 .sp
 454 .in +2
 455 .nf
 456 # \fBsvccfg -s svc:/system/ndmpd\fR
 457 svc:/system/ndmpd> \fBlistprop\fR
 458 .fi
 459 .in -2
 460 .sp
 461