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

   1 '\" t
   2 .\" The contents of this file are subject to the terms of the
   3 .\" Common Development and Distribution License (the "License").
   4 .\" You may not use this file except in compliance with the License.
   5 .\"
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   7 .\" or http://www.opensolaris.org/os/licensing.
   8 .\" See the License for the specific language governing permissions
   9 .\" and limitations under the License.
  10 .\"
  11 .\" When distributing Covered Code, include this CDDL HEADER in each
  12 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  13 .\" If applicable, add the following below this CDDL HEADER, with the
  14 .\" fields enclosed by brackets "[]" replaced with your own identifying
  15 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  16 .\"
  17 .\"
  18 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
  19 .\" Copyright 2014 Nexenta Systems, Inc.  All rights reserved.
  20 .\"
  21 .TH ITADM 1M "Mar 27, 2014"
  22 .SH NAME
  23 itadm \- administer iSCSI targets
  24 .SH SYNOPSIS
  25 .LP
  26 .nf
  27 \fBitadm\fR create-target [\fB-a\fR,\fB--auth-method\fR radius | chap | none | default]
  28      [\fB-s\fR,\fB--chap-secret\fR] [\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR]
  29      [\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR] [\fB-n\fR,\fB--node-name\fR \fItarget_node_name\fR]
  30      [\fB-l\fR,\fB--alias\fR \fIalias\fR] [\fB-t\fR,\fB--tpg\fR \fItpg-name\fR[,\fItpg-name\fR]]
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBitadm\fR modify-target [\fB-a\fR,\fB--auth-method\fR radius | chap | none | default]
  36      [\fB-s\fR,\fB--chap-secret\fR] [\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR]
  37      [\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR] [\fB-n\fR,\fB--node-name\fR \fInew_target_node_name\fR]
  38      [\fB-l\fR,\fB--alias\fR \fIalias\fR] [\fB-t\fR,\fB--tpg\fR \fItpg-name\fR[,\fItpg-name\fR]] \fItarget_node_name\fR
  39 .fi
  40
  41 .LP
  42 .nf
  43 \fBitadm\fR delete-target [\fB-f\fR,\fB--force\fR] \fItarget_node_name\fR
  44 .fi
  45
  46 .LP
  47 .nf
  48 \fBitadm\fR list-target [\fB-p\fR,\fB--parsable\fR] [\fB-v\fR,\fB--verbose\fR] [\fItarget_node_name\fR]
  49 .fi
  50
  51 .LP
  52 .nf
  53 \fBitadm\fR create-tpg \fItpg_name\fR \fIIP-address\fR[:\fIport\fR] [\fIIP-address\fR[:\fIport\fR]]...
  54 .fi
  55
  56 .LP
  57 .nf
  58 \fBitadm\fR list-tpg [\fB-p\fR,\fB--parsable\fR] [\fB-v\fR,\fB--verbose\fR] [\fItpg_name\fR]
  59 .fi
  60
  61 .LP
  62 .nf
  63 \fBitadm\fR delete-tpg  [\fB-f\fR,\fB--force\fR] \fItpg_name\fR
  64 .fi
  65
  66 .LP
  67 .nf
  68 \fBitadm\fR create-initiator [\fB-s\fR,\fB--chap-secret\fR] [\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR]
  69      [\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR] \fIinitiator_node_name\fR
  70 .fi
  71
  72 .LP
  73 .nf
  74 \fBitadm\fR modify-initiator [\fB-s\fR,\fB--chap-secret\fR] [\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR]
  75      [\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR] \fIinitiator_node_name\fR
  76 .fi
  77
  78 .LP
  79 .nf
  80 \fBitadm\fR list-initiator [\fB-p\fR,\fB--parsable\fR] [\fB-v\fR,\fB--verbose\fR] \fIinitiator_node_name\fR
  81 .fi
  82
  83 .LP
  84 .nf
  85 \fBitadm\fR delete-initiator \fIinitiator_node_name\fR
  86 .fi
  87
  88 .LP
  89 .nf
  90 \fBitadm\fR modify-defaults [\fB-a\fR,\fB--auth-method\fR radius | chap | none]
  91      [\fB-r\fR,\fB--radius-server\fR \fIIP-address\fR[:\fIport\fR]] [\fB-d\fR,\fB--radius-secret\fR]
  92      [\fB-D\fR,\fB--radius-secret-file\fR \fIpath\fR][\fB-i\fR,\fB--isns\fR enable | disable]
  93      [\fB-I\fR,\fB--isns-server\fR \fIIP-address\fR[:\fIport\fR][,\fIIP-address\fR[:\fIport\fR]]]
  94 .fi
  95
  96 .LP
  97 .nf
  98 \fBitadm\fR list-defaults [\fB-p\fR,\fB--parsable\fR]
  99 .fi
 100
 101 .SH DESCRIPTION
 102 .LP
 103 The \fBitadm\fR command manages Internet SCSI (iSCSI) target nodes within the
 104 SCSI Target Mode Framework described in \fBstmfadm\fR(1M) and
 105 \fBlibstmf\fR(3LIB).  This allows the iSCSI initiators to access STMF logical
 106 units using the iSCSI protocol. In addition to iSCSI target nodes, \fBitadm\fR
 107 manages two other classes of managed objects: iSCSI Target Portal Groups, and
 108 iSCSI Initiator Node Contexts.
 109 .sp
 110 .LP
 111 \fBitadm\fR is implemented as a set of subcommands with options and operands
 112 for each subcommand. These subcommands are described in their own section,
 113 below. In addition to its subcommands, \fBitadm\fR has a help command, which
 114 displays the utility's usage information. The help command is invoked with the
 115 \fB-?\fR option.
 116 .SS "iSCSI Target Portal Groups"
 117 .LP
 118 An iSCSI Target Network Portal is an IP address and TCP port that can be used
 119 by an initiator node to connect to an iSCSI target. A collection of  these
 120 portals is called a Target Portal Group (TPG). You can use a TPG  to limit
 121 access to an iSCSI target. Use the \fBitadm modify\fR \fB-t\fR command to  bind
 122 a specific iSCSI target to the TPG. An iSCSI listener is created on  each IP
 123 address that belongs to the TPG, and listens for connections to  the iSCSI
 124 target.
 125 .sp
 126 .LP
 127 A TPG is identified by a unique name provided when the TPG is created. A
 128 numerical "Target Portal Group Tag" from the range 2-65535 is automatically
 129 generated when the TPG is created. The Target Portal Group Tag 1 is reserved
 130 for the "default" target portal group that is used when no explicit Target
 131 Portal Groups are set on the target. The portal for the default TPG matches
 132 requests from all network interfaces on port  3260.
 133 .SS "iSCSI Initiator Node Contexts"
 134 .LP
 135 Certain operations such as authentication by means of Challenge Handshake
 136 Authentication Protocol (CHAP) require parameters associated with a remote
 137 iSCSI Initiator Node. These parameters are associated with an iSCSI Initiator
 138 Node Context. An iSCSI Initiator Node Context is identified by its Initiator
 139 Node Name, formatted in either IQN or EUI format (see RFC 3720). For example:
 140 .sp
 141 .in +2
 142 .nf
 143 iqn.1986-03.com.sun:01:e00000000000.47d55444
 144 eui.02004567A425678D
 145 .fi
 146 .in -2
 147 .sp
 148
 149 .SS "Specifying IP Addresses"
 150 .LP
 151 A number of \fBitadm\fR subcommands require that you specify one or more IP
 152 addresses with optional port numbers. For IPv4, use standard dotted decimal
 153 notation. For IPv6, enclose addresses in square brackets. The following are
 154 example specifications.
 155 .sp
 156 .in +2
 157 .nf
 158 \fBIPv4\fR:  10.2.4.1
 159        10.2.4.1:3260
 160 \fBIPv6\fR:  [1080:0:0:0:8:800:200C:417A]
 161        [1080:0:0:0:8:800:200C:417A]:3260
 162 .fi
 163 .in -2
 164 .sp
 165
 166 .SH SUB-COMMANDS
 167 .LP
 168 The following are the \fBitadm\fR subcommands with their options.
 169 .SS "\fBitadm create-target\fR"
 170 .in +2
 171 .nf
 172 itadm create-target [-a,--auth-method radius | chap | none | default]
 173      [-s,--chap-secret]
 174      [-S,--chap-secret-file \fIpath\fR] [-u,--chap-user \fIchap-user-name\fR]
 175      [-n,--node-name \fItarget_node_name\fR] [-l,--alias \fIalias\fR]
 176      [-t,--tpg \fItpg-name\fR[,\fItpg-name\fR,...]]
 177 .fi
 178 .in -2
 179 .sp
 180
 181 .sp
 182 .LP
 183 Create a iSCSI target with the specified options. Options are as follows.
 184 .sp
 185 .ne 2
 186 .na
 187 \fB\fB-a\fR,\fB--auth-method\fR \fBradius | chap | none | default\fR\fR
 188 .ad
 189 .sp .6
 190 .RS 4n
 191 Specifies the authentication method to use for the target. Valid values are
 192 \fBradius\fR, \fBchap\fR, and \fBnone\fR. \fBchap\fR indicates that initiators
 193 connecting to this target must be authenticated using the Challenge Handshake
 194 Authentication Protocol (CHAP). \fBradius\fR indicates initiators should also
 195 be authenticated by means of CHAP but the required authentication parameters
 196 should  be obtained from a central RADIUS server (see the \fBradius-server\fR
 197 and \fBradius-secret\fR options). \fBnone\fR means that no authentication is
 198 required to connect to the target. \fBdefault\fR means the target will use the
 199 global setting of this property.  (See the \fBmodify-defaults\fR subcommand.)
 200 .RE
 201
 202 .sp
 203 .ne 2
 204 .na
 205 \fB\fB-s\fR,\fB--chap-secret\fR\fR
 206 .ad
 207 .sp .6
 208 .RS 4n
 209 The CHAP secret to send during mutual CHAP authentication. There is no default
 210 for this property. Maximum length is 255 characters; minimum required length is
 211 12 characters.
 212 .RE
 213
 214 .sp
 215 .ne 2
 216 .na
 217 \fB\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR\fR
 218 .ad
 219 .sp .6
 220 .RS 4n
 221 Path to a temporary file containing the CHAP secret as described in the
 222 \fB-s\fR option.
 223 .RE
 224
 225 .sp
 226 .ne 2
 227 .na
 228 \fB\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR\fR
 229 .ad
 230 .sp .6
 231 .RS 4n
 232 Specifies the CHAP username for a target for use in mutual CHAP authentication.
 233 This value is allowed only for targets, cannot be set globally, and is used
 234 only when the initiator node is configured to use mutual CHAP authentication.
 235 If no value is specified then the target node name is used as the username. See
 236 \fBiscsiadm\fR(1M).
 237 .RE
 238
 239 .sp
 240 .ne 2
 241 .na
 242 \fB\fB-n\fR,\fB--node-name\fR \fItarget_node_name\fR\fR
 243 .ad
 244 .sp .6
 245 .RS 4n
 246 An iSCSI Target Node is identified by its Target Node Name, formatted in either
 247 IQN or EUI format (see RFC 3720). This option establishes that name.
 248 .RE
 249
 250 .sp
 251 .ne 2
 252 .na
 253 \fB\fB-l\fR,\fB--alias\fR \fIalias\fR\fR
 254 .ad
 255 .sp .6
 256 .RS 4n
 257 An alternate identifier associated with a target node. The identifier does not
 258 need to be unique.
 259 .RE
 260
 261 .sp
 262 .ne 2
 263 .na
 264 \fB\fB-t\fR,\fB--tpg\fR \fItpg-name\fR[,\fItpg-name\fR,...]\fR
 265 .ad
 266 .sp .6
 267 .RS 4n
 268 A list of Target Portal Group (TPG) identifiers that specifies the TPGs that an
 269 initiator can use to access a specific target or the keyword \fBdefault\fR.  If
 270 \fBdefault\fR is specified, the target will use the default portal,
 271 \fBINADDR_ANY:3260\fR.
 272 .RE
 273
 274 .SS "\fBitadm modify-target\fR"
 275 .in +2
 276 .nf
 277 itadm modify-target [\fB-a\fR,\fB--auth-method\fR radius | chap | none | default]
 278      [\fB-s\fR,\fB--chap-secret\fR] [\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR]
 279      [\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR] [\fB-n\fR,\fB--node-name\fR \fInew_tgt_node_name\fR]
 280      [\fB-l\fR,\fB--alias\fR \fIalias\fR] [\fB-t\fR,\fB--tpg\fR \fItpg-name\fR[,\fItpg-name\fR]] \fItarget_node_name\fR
 281 .fi
 282 .in -2
 283 .sp
 284
 285 .sp
 286 .LP
 287 Modify an iSCSI target according to the specified options. Options are as
 288 follows.
 289 .sp
 290 .ne 2
 291 .na
 292 \fB\fB-a\fR,\fB--auth-method\fR \fBradius | chap | none | default\fR\fR
 293 .ad
 294 .sp .6
 295 .RS 4n
 296 As described under the \fBcreate-target\fR subcommand, above.
 297 .RE
 298
 299 .sp
 300 .ne 2
 301 .na
 302 \fB\fB-s\fR,\fB--chap-secret\fR\fR
 303 .ad
 304 .sp .6
 305 .RS 4n
 306 As described under the \fBcreate-target\fR subcommand, above.
 307 .RE
 308
 309 .sp
 310 .ne 2
 311 .na
 312 \fB\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR\fR
 313 .ad
 314 .sp .6
 315 .RS 4n
 316 As described under the \fBcreate-target\fR subcommand, above.
 317 .RE
 318
 319 .sp
 320 .ne 2
 321 .na
 322 \fB\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR\fR
 323 .ad
 324 .sp .6
 325 .RS 4n
 326 As described under the \fBcreate-target\fR subcommand, above. To remove an
 327 explicitly set CHAP username use \fB-u\fR \fBnone\fR.
 328 .RE
 329
 330 .sp
 331 .ne 2
 332 .na
 333 \fB\fB-n\fR,\fB--node-name\fR \fItarget_node_name\fR\fR
 334 .ad
 335 .sp .6
 336 .RS 4n
 337 Renames the target. See also the description of \fB-n\fR under the
 338 \fBcreate-target\fR subcommand, above.
 339 .RE
 340
 341 .sp
 342 .ne 2
 343 .na
 344 \fB\fB-l\fR,\fB--alias\fR \fIalias\fR\fR
 345 .ad
 346 .sp .6
 347 .RS 4n
 348 As described under the \fBcreate-target\fR subcommand, above. To remove an
 349 explicitly set alias use \fB-l\fR \fBnone\fR.
 350 .RE
 351
 352 .sp
 353 .ne 2
 354 .na
 355 \fB\fB-t\fR,\fB--tpg\fR \fItpg-name\fR[,\fItpg-name\fR,...]\fR
 356 .ad
 357 .sp .6
 358 .RS 4n
 359 As described under the \fBcreate-target\fR subcommand, above.
 360 .RE
 361
 362 .SS "\fBitadm list-target\fR"
 363 .in +2
 364 .nf
 365 itadm list-target [\fB-p\fR,\fB--parsable\fR] [\fB-v\fR,\fB--verbose\fR] [\fItarget_node_name\fR]
 366 .fi
 367 .in -2
 368 .sp
 369
 370 .sp
 371 .LP
 372 List information about the configured targets. If \fItarget_node_name\fR is
 373 specified, list only the information for that target. Options are as follows.
 374
 375 .sp
 376 .ne 2
 377 .na
 378 \fB\fB-p\fR,\fB--parsable\fR\fR
 379 .ad
 380 .sp .6
 381 .RS 4n
 382 Used for scripting mode. Do not print headers and separate fields by a single
 383 tab instead of arbitrary white space.
 384 .RE
 385
 386 .sp
 387 .ne 2
 388 .na
 389 \fB\fB-v\fR,\fB--verbose\fR\fR
 390 .ad
 391 .sp .6
 392 .RS 4n
 393 Verbose mode.
 394 .RE
 395
 396 .SS "\fBitadm delete-target\fR"
 397 .in +2
 398 .nf
 399 itadm delete-target [\fB-f\fR,\fB--force\fR] \fItarget_node_name\fR
 400 .fi
 401 .in -2
 402 .sp
 403
 404 .sp
 405 .LP
 406 Delete the target specified by \fItarget_node_name\fR. The target must be
 407 \fBoffline\fR before it can be deleted. Option is as follows.
 408 .sp
 409 .ne 2
 410 .na
 411 \fB\fB-f\fR,\fB--force\fR\fR
 412 .ad
 413 .sp .6
 414 .RS 4n
 415 If the target persists in an online state, this option attempts to offline the
 416 target before deleting it.
 417 .RE
 418
 419 .SS "\fBitadm create-tpg\fR"
 420 .in +2
 421 .nf
 422 itadm create-tpg \fItpg_name\fR \fIIP-address\fR[:\fIport\fR]...
 423 .fi
 424 .in -2
 425 .sp
 426
 427 .sp
 428 .LP
 429 Create an iSCSI target portal group made up of the specified portals and assign
 430 it the identifier \fItpg_name\fR. Each portal is an IP address and port pair.
 431 IPv4 portals are specified in dotted address notation, for example,
 432 \fB172.31.255.255\fR. IPv6 portal addresses must be enclosed in square
 433 brackets.
 434 .sp
 435 .LP
 436 This subcommand has no options.
 437 .SS "\fBitadm list-tpg\fR"
 438 .in +2
 439 .nf
 440 itadm list-tpg [\fB-p\fR,\fB--parsable\fR] [\fB-v\fR,\fB--verbose\fR] [\fItpg_name\fR]
 441 .fi
 442 .in -2
 443 .sp
 444
 445 .sp
 446 .LP
 447 List information about the configured target portal group. If \fItpg_name\fR is
 448 specified then list only the information about the target portal group
 449 associated with that \fItpg_name\fR. Options are as follows.
 450
 451 .sp
 452 .ne 2
 453 .na
 454 \fB\fB-p\fR,\fB--parsable\fR\fR
 455 .ad
 456 .sp .6
 457 .RS 4n
 458 Used for scripting mode. Do not print headers and separate fields by a single
 459 tab instead of arbitrary white space.
 460 .RE
 461
 462 .sp
 463 .ne 2
 464 .na
 465 \fB\fB-v\fR,\fB--verbose\fR\fR
 466 .ad
 467 .sp .6
 468 .RS 4n
 469 Verbose mode.
 470 .RE
 471
 472 .SS "\fBitadm delete-tpg\fR"
 473 .in +2
 474 .nf
 475 itadm delete-tpg  [\fB-f\fR,\fB--force\fR] \fItpg_name\fR
 476 .fi
 477 .in -2
 478 .sp
 479
 480 .sp
 481 .LP
 482 Delete the target portal group associated with \fItpg_name\fR. Option is as
 483 follows.
 484 .sp
 485 .ne 2
 486 .na
 487 \fB\fB-f\fR,\fB--force\fR\fR
 488 .ad
 489 .sp .6
 490 .RS 4n
 491 If the TPG is associated with any targets, the request to delete will be denied
 492 unless this option is specified.
 493 .RE
 494
 495 .SS "\fBitadm create-initiator\fR"
 496 .in +2
 497 .nf
 498 itadm create-initiator [\fB-s\fR,\fB--chap-secret\fR] [\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR]
 499      [\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR] \fIinitiator_node_name\fR
 500 .fi
 501 .in -2
 502 .sp
 503
 504 .sp
 505 .LP
 506 Configure parameters associated with the remote initiator named
 507 \fIinitiator_node_name\fR. Options are as follows.
 508 .sp
 509 .ne 2
 510 .na
 511 \fB\fB-s\fR,\fB--chap-secret\fR\fR
 512 .ad
 513 .sp .6
 514 .RS 4n
 515 As described under the \fBcreate-target\fR subcommand, above.
 516 .RE
 517
 518 .sp
 519 .ne 2
 520 .na
 521 \fB\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR\fR
 522 .ad
 523 .sp .6
 524 .RS 4n
 525 As described under the \fBcreate-target\fR subcommand, above.
 526 .RE
 527
 528 .sp
 529 .ne 2
 530 .na
 531 \fB\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR\fR
 532 .ad
 533 .sp .6
 534 .RS 4n
 535 Specifies the CHAP username for an initiator, for use in CHAP authentication.
 536 If no value is specified then the initiator node name is used as the username.
 537 .RE
 538
 539 .SS "\fBitadm modify-initiator\fR"
 540 .in +2
 541 .nf
 542 itadm modify-initiator [\fB-s\fR,\fB--chap-secret\fR] [\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR]
 543      [\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR] \fIinitiator_node_name\fR
 544 .fi
 545 .in -2
 546 .sp
 547
 548 .sp
 549 .LP
 550 Modify parameters associated with the remote initiator named
 551 \fIinitiator_node_name\fR. Options are as follows.
 552 .sp
 553 .ne 2
 554 .na
 555 \fB\fB-s\fR,\fB--chap-secret\fR\fR
 556 .ad
 557 .sp .6
 558 .RS 4n
 559 As described under the \fBcreate-target\fR subcommand, above.
 560 .RE
 561
 562 .sp
 563 .ne 2
 564 .na
 565 \fB\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR\fR
 566 .ad
 567 .sp .6
 568 .RS 4n
 569 As described under the \fBcreate-target\fR subcommand, above.
 570 .RE
 571
 572 .sp
 573 .ne 2
 574 .na
 575 \fB\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR\fR
 576 .ad
 577 .sp .6
 578 .RS 4n
 579 Specifies the CHAP username for an initiator, for use in CHAP authentication.
 580 If no value is specified then the initiator node name is used as the username.
 581 .RE
 582
 583 .SS "\fBitadm delete-initiator\fR"
 584 .in +2
 585 .nf
 586 itadm delete-initiator \fIinitiator_node_name\fR
 587 .fi
 588 .in -2
 589 .sp
 590
 591 .sp
 592 .LP
 593 Delete parameters associated with the remote initiator named
 594 \fIinitiator_node_name\fR. This subcommand has no options.
 595 .SS "\fBitadm list-initiator\fR"
 596 .in +2
 597 .nf
 598 \fBitadm\fR list-initiator [\fB-p\fR,\fB--parsable\fR] [\fB-v\fR,\fB--verbose\fR] \fIinitiator_node_name\fR
 599 .fi
 600 .in -2
 601 .sp
 602
 603 .sp
 604 .LP
 605 List parameters associated with the initiator named \fIinitiator_node_name\fR.
 606 Options are as follows.
 607
 608 .sp
 609 .ne 2
 610 .na
 611 \fB\fB-p\fR,\fB--parsable\fR\fR
 612 .ad
 613 .sp .6
 614 .RS 4n
 615 Used for scripting mode. Do not print headers and separate fields by a single
 616 tab instead of arbitrary white space.
 617 .RE
 618
 619 .sp
 620 .ne 2
 621 .na
 622 \fB\fB-v\fR,\fB--verbose\fR\fR
 623 .ad
 624 .sp .6
 625 .RS 4n
 626 Verbose mode.
 627 .RE
 628
 629 .SS "\fBitadm modify-defaults\fR"
 630 .in +2
 631 .nf
 632 itadm modify-defaults [\fB-a\fR,\fB--auth-method\fR radius | chap | none]
 633      [\fB-r\fR,\fB--radius-server\fR \fIIP-address\fR[:\fIport\fR]] [\fB-d\fR,\fB--radius-secret\fR]
 634      [\fB-D\fR,\fB--radius-secret-file\fR \fIpath\fR][\fB-i\fR,\fB--isns\fR enable | disable]
 635      [\fB-I\fR,\fB--isns-server\fR \fIIP-address\fR[:\fIport\fR][,\fIIP-address\fR[:\fIport\fR]]]
 636 .fi
 637 .in -2
 638 .sp
 639
 640 .sp
 641 .LP
 642 Modify default parameters. Options are as follows.
 643 .sp
 644 .ne 2
 645 .na
 646 \fB\fB-a\fR,\fB--auth-method\fR \fBradius | chap | none\fR\fR
 647 .ad
 648 .sp .6
 649 .RS 4n
 650 Specifies the default authentication method to use for all targets. Valid
 651 values are \fBradius\fR, \fBchap\fR, and \fBnone\fR. \fBchap\fR indicates that
 652 initiators connecting to this target must be authenticated using Challenge
 653 Handshake Authentication Protocol (CHAP). \fBradius\fR indicates initiators
 654 should also be authenticated by means of CHAP, but the required authentication
 655 parameters should be obtained from a central RADIUS server. (See
 656 \fB--radius-server\fR and \fB--radius-secret\fR options.) \fBnone\fR means that
 657 no authentication is required to connect to the target. Individual targets can
 658 override this global setting using the \fB-a\fR option of the
 659 \fBcreate-target\fR and \fBmodify-target\fR subcommands.
 660 .RE
 661
 662 .sp
 663 .ne 2
 664 .na
 665 \fB\fB-d\fR,\fB--radius-secret\fR\fR
 666 .ad
 667 .sp .6
 668 .RS 4n
 669 RADIUS Shared Secret for centralized CHAP authentication.
 670 .RE
 671
 672 .sp
 673 .ne 2
 674 .na
 675 \fB\fB-D\fR,\fB--radius-secret-file\fR \fIpath\fR\fR
 676 .ad
 677 .sp .6
 678 .RS 4n
 679 Path to a temporary file containing the CHAP secret as described in the
 680 \fB-d\fR option.
 681 .RE
 682
 683 .sp
 684 .ne 2
 685 .na
 686 \fB\fB-i\fR,\fB--sns\fR \fBenable | disable\fR\fR
 687 .ad
 688 .sp .6
 689 .RS 4n
 690 Specifies whether targets should be registered with the set of defined iSCSI
 691 Name Service (iSNS) servers.
 692 .RE
 693
 694 .sp
 695 .ne 2
 696 .na
 697 \fB\fB-I\fR,\fB--isns-server\fR
 698 \fIIP-address\fR[:\fIport\fR][,\fIIP-address\fR[:\fIport\fR],...]\fR
 699 .ad
 700 .sp .6
 701 .RS 4n
 702 Defines a list of iSNS servers with which iSCSI target nodes will be registered
 703 when the \fBisns\fR option associated with the respective target is set. Up to
 704 eight iSNS servers can be specified. To remove all iSNS servers, use \fB-I\fR
 705 \fBnone\fR.
 706 .RE
 707
 708 .sp
 709 .ne 2
 710 .na
 711 \fB\fB-r\fR,\fB--radius-server\fR \fIIP-address\fR[:\fIport\fR]\fR
 712 .ad
 713 .sp .6
 714 .RS 4n
 715 Specify the IP address of the RADIUS server used for centralized CHAP
 716 authentication.
 717 .RE
 718
 719 .SS "\fBitadm list-defaults\fR"
 720 .in +2
 721 .nf
 722 itadm list-defaults [\fB-p\fR,\fB--parsable\fR]
 723 .fi
 724 .in -2
 725 .sp
 726
 727 .sp
 728 .LP
 729 List information about the default properties. Option is as follows.
 730
 731 .sp
 732 .ne 2
 733 .na
 734 \fB\fB-p\fR,\fB--parsable\fR\fR
 735 .ad
 736 .sp .6
 737 .RS 4n
 738 Used for scripting mode. Do not print headers and separate fields by a single
 739 tab instead of arbitrary white space.
 740 .RE
 741
 742 .SH EXAMPLES
 743 .LP
 744 \fBExample 1 \fRCreating a Target
 745 .sp
 746 .LP
 747 The following command creates a target.
 748
 749 .sp
 750 .in +2
 751 .nf
 752 # \fBitadm create-target\fR
 753 Target iqn.1986-03.com.sun:02:72e1b181-7bce-c0e6-851e-ec0d8cf14b7a
 754 successfully created
 755 .fi
 756 .in -2
 757 .sp
 758
 759 .LP
 760 \fBExample 2 \fRCreating a Target with a Specific Name
 761 .sp
 762 .LP
 763 The following command creates a target with a specific IQN.
 764
 765 .sp
 766 .in +2
 767 .nf
 768 # \fBitadm create-target -n eui.20387ab8943ef7548\fR
 769 or:
 770 # \fBitadm create-target \e
 771 -n iqn.1986-03.com.sun:02:a9a366f8-cc2b-f291-840948c7f29e\fR
 772 .fi
 773 .in -2
 774 .sp
 775
 776 .LP
 777 \fBExample 3 \fRChanging a Name
 778 .sp
 779 .LP
 780 The following command changes an IQN for an existing target.
 781
 782 .sp
 783 .in +2
 784 .nf
 785 # \fBitadm modify-target -n eui.20387ab8943ef7548 \e
 786 iqn.1986-03.com.sun:02:a9a366f8-909b-cc2b-f291-840948c7f29e\fR
 787 .fi
 788 .in -2
 789 .sp
 790
 791 .LP
 792 \fBExample 4 \fRSetting up CHAP Authentication
 793 .sp
 794 .LP
 795 The following command sets up CHAP authentication for a target using the
 796 default CHAP username.
 797
 798 .sp
 799 .in +2
 800 .nf
 801 # \fBitadm modify-initiator -s iqn.1986-03.com.sun:01:e00000000000.47d55444\fR
 802 \fBEnter CHAP secret:\fR *********
 803 \fBRe-enter secret:\fR *********
 804
 805 # \fBitadm modify-target -a chap eui.20387ab8943ef7548\fR
 806 .fi
 807 .in -2
 808 .sp
 809
 810 .LP
 811 \fBExample 5 \fRCreating Target Portal Groups
 812 .sp
 813 .LP
 814 The following command creates two target portal groups, \fBA\fR and \fBB\fR,
 815 using port 8000 for the addresses in TPG 2.
 816
 817 .sp
 818 .in +2
 819 .nf
 820 # \fBitadm create-tpg A 192.168.0.1 192.168.0.2\fR
 821 # \fBitadm create-tpg B 192.168.0.2:8000 192.168.0.2:8000\fR
 822 .fi
 823 .in -2
 824 .sp
 825
 826 .LP
 827 \fBExample 6 \fRConfiguring a Target to Use TPGs
 828 .sp
 829 .LP
 830 The following command configures a target to use TPGs A and B.
 831
 832 .sp
 833 .in +2
 834 .nf
 835 # \fBitadm modify-target -t A,B eui.20387ab8943ef7548\fR
 836 .fi
 837 .in -2
 838 .sp
 839
 840 .LP
 841 \fBExample 7 \fRSetting up RADIUS Authentication for Specific Target
 842 .sp
 843 .LP
 844 The following command sets up RADIUS authentication for a specific target.
 845
 846 .sp
 847 .in +2
 848 .nf
 849 # \fBitadm modify-defaults -r 192.168.10.1 -d\fR
 850 \fBEnter RADIUS secret:\fR *********
 851 \fBRe-enter secret:\fR *********
 852
 853 # \fBitadm modify-target -a radius eui.20387ab8943ef7548\fR
 854 .fi
 855 .in -2
 856 .sp
 857
 858 .LP
 859 \fBExample 8 \fRSetting up RADIUS Authentication for All Targets
 860 .sp
 861 .LP
 862 The following command sets up RADIUS authentication for all targets.
 863
 864 .sp
 865 .in +2
 866 .nf
 867 # \fBitadm modify-defaults -d -r 192.168.10.1 -a radius\fR
 868 \fBEnter RADIUS secret:\fR *********
 869 \fBRe-enter secret:\fR *********
 870 .fi
 871 .in -2
 872 .sp
 873
 874 .sp
 875 .LP
 876 The preceding command assumes all targets were created with \fB-a\fR
 877 \fBdefault\fR.
 878
 879 .LP
 880 \fBExample 9 \fRListing Default Properties
 881 .sp
 882 .LP
 883 The following command lists default properties.
 884
 885 .sp
 886 .in +2
 887 .nf
 888 # \fBitadm list-defaults\fR
 889 iSCSI Target Default Properties:
 890
 891 alias:          \fInone\fR
 892 auth:           \fInone\fR
 893 radiusserver:   \fInone\fR
 894 radiussecret:   unset
 895 isns:           disabled
 896 isnsserver:     2.3.4.5,4.5.6.7
 897 .fi
 898 .in -2
 899 .sp
 900
 901 .LP
 902 \fBExample 10 \fRListing Targets
 903 .sp
 904 .LP
 905 The following command lists targets.
 906
 907 .sp
 908 .in +2
 909 .nf
 910 # \fBitadm list-target\fR
 911 TARGET NAME                                           STATE    SESSIONS
 912 iqn.1986-03.com.sun:02:72e1b181-7bce-c0e6-851e-ec0d8cf14b7a  online   0
 913 iqn.1986-03.com.sun:02:2cb0c526-c05a-e279-e396-a367006f4227  online   0
 914 iqn.1986-03.com.sun:02:d14125bb-1c9d-c28d-97b0-f89259b642f3  online   0
 915 iqn.1986-03.com.sun:02:03ff9fc5-794a-e9b4-a081-bb82917c292a  online   0
 916 .fi
 917 .in -2
 918 .sp
 919
 920 .LP
 921 \fBExample 11 \fRListing Targets (Verbose)
 922 .sp
 923 .LP
 924 The following command lists targets with the verbose option.
 925
 926 .sp
 927 .in +2
 928 .nf
 929 # \fBitadm list-target -v\fR
 930 TARGET NAME                                           STATE    SESSIONS
 931 iqn.1986-03.com.sun:02:d23e68d8-2d79-c988-98e7-a6361689d33c  online   0
 932        alias:                  -
 933        auth:                   none (defaults)
 934        targetchapuser:         -
 935        targetchapsecret:       unset
 936        tpg-tags:               default
 937 iqn.1986-03.com.sun:02:94ec46d4-c8e1-6993-ef03-ffc1dcd66606  online   1
 938        alias:                  -
 939        auth:                   chap
 940        targetchapuser:         -
 941        targetchapsecret:       unset
 942        tpg-tags:               nge1_ipv4 = 3
 943 .fi
 944 .in -2
 945 .sp
 946
 947 .LP
 948 \fBExample 12 \fRListing a Specific Target
 949 .sp
 950 .LP
 951 The following command lists targets with the verbose option.
 952
 953 .sp
 954 .in +2
 955 .nf
 956 # \fBitadm list-target -v \e
 957 iqn.1986-03.com.sun:02:2cb0c526-c05a-e279-e396-a367006f4227\fR
 958 TARGET NAME                                           STATE    SESSIONS
 959 iqn.1986-03.com.sun:02:2cb0c526-c05a-e279-e396-a367006f4227  online   1
 960         alias:                  -
 961         auth:                   chap
 962         targetchapuser:         -
 963         targetchapsecret:       unset
 964         tpg-tags:               nge1_ipv4 = 3
 965 .fi
 966 .in -2
 967 .sp
 968
 969 .SH ATTRIBUTES
 970 .LP
 971 See \fBattributes\fR(5) for descriptions of the following attributes:
 972 .sp
 973
 974 .sp
 975 .TS
 976 box;
 977 c | c
 978 l | l .
 979 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 980 _
 981 Interface Stability     Committed
 982 .TE
 983
 984 .SH SEE ALSO
 985 .LP
 986 \fBiscsiadm\fR(1M), \fBstmfadm\fR(1M), \fBlibstmf\fR(3LIB), \fBattributes\fR(5)