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

   1 '\" te
   2 .\" Copyright (c) 2008, 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.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" 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 fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH ISNSADM 1M "Sep 25, 2008"
   7 .SH NAME
   8 isnsadm \- administer the internet Storage Name Server (iSNS) server
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBisnsadm\fR \fIoptions\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBisnsadm\fR \fIsubcommand\fR [\fIsubcommand_options\fR] [\fIoperand\fR]
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBisnsadm\fR command is the command-line interface to the Internet Storage
  24 Name Service (iSNS) server. \fBisnsadm\fR comprises a set of subcommands,
  25 described in their own section, each of which accomplishes one of the iSNS
  26 server management functions.
  27 .sp
  28 .LP
  29 For any operations that will change the iSNS configurations the
  30 \fBsolaris.isnsmgr.write\fR authorization is required. Refer to \fBisns\fR(1M).
  31 For read operations, the command does not require special authorizations.
  32 .sp
  33 .LP
  34 \fBisnsadm\fR has a set of general options and a set of subcommand-specific
  35 options. The first category is described under OPTIONS; the second category is
  36 described in the context of each subcommand description.
  37 .SH OPTIONS
  38 .sp
  39 .LP
  40 The following options are supported:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fB-?\fR, \fB--help\fR\fR
  45 .ad
  46 .sp .6
  47 .RS 4n
  48 Displays context help. Stops interpretation of any subsequent arguments.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fB-V\fR, \fB--version\fR\fR
  55 .ad
  56 .sp .6
  57 .RS 4n
  58 Displays version information.  Stops interpretation of any subsequent
  59 arguments.
  60 .RE
  61
  62 .SH OPERANDS
  63 .sp
  64 .LP
  65 The following operands are used by one or more \fBisnsadm\fR subcommands.
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fIiscsi-node-name\fR\fR
  70 .ad
  71 .sp .6
  72 .RS 4n
  73 iSCSI target or iSCSI initiator symbolic name. A string with a maximum length
  74 of 223 characters.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fIdiscovery-domain-name\fR\fR
  81 .ad
  82 .sp .6
  83 .RS 4n
  84 Discovery domain symbolic name. A string with a maximum length of 256
  85 characters.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fIdiscovery-domain-set-name\fR\fR
  92 .ad
  93 .sp .6
  94 .RS 4n
  95 Discovery domain set symbolic name. A string with a maximum length of 256
  96 characters.
  97 .RE
  98
  99 .SH SUBCOMMANDS
 100 .sp
 101 .LP
 102 The \fBisnsadm\fR command supports the subcommands described below.
 103 .SS "\fBadd-dd\fR"
 104 .sp
 105 .LP
 106 The \fBadd-dd\fR subcommand adds a discovery domain to a discovery domain set.
 107 .sp
 108 .LP
 109 The \fBadd-dd\fR subcommand has the following syntax:
 110 .sp
 111 .in +2
 112 .nf
 113 # \fBisnsadm add-dd \fIoption\fR \fIdiscovery-domain-name\fR, ...\fR
 114 .fi
 115 .in -2
 116 .sp
 117
 118 .sp
 119 .LP
 120 \fBadd-dd\fR has the following option:
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fB-s\fR \fIdiscovery-domain-set-name\fR\fR
 125 .ad
 126 .sp .6
 127 .RS 4n
 128 Specifies a discovery domain set.
 129 .RE
 130
 131 .SS "\fBadd-node\fR"
 132 .sp
 133 .LP
 134 The \fBadd-node\fR subcommand adds a node to a specified discovery-domain.
 135 .sp
 136 .LP
 137 The \fBadd-node\fR subcommand has the following syntax:
 138 .sp
 139 .in +2
 140 .nf
 141 # \fBisnsadm add-node \fIoption\fR \fIiscsi-node-name\fR,...\fR
 142 .fi
 143 .in -2
 144 .sp
 145
 146 .sp
 147 .LP
 148 \fBadd-node\fR has the following options:
 149 .sp
 150 .ne 2
 151 .na
 152 \fB\fB-d\fR,\fB--dd\fR \fIdiscovery-domain-name\fR\fR
 153 .ad
 154 .sp .6
 155 .RS 4n
 156 Specifies a discovery domain.
 157 .RE
 158
 159 .SS "\fBcreate-dd\fR"
 160 .sp
 161 .LP
 162 The \fBcreate-dd\fR subcommand creates a discovery domain with the name you
 163 specify.
 164 .sp
 165 .LP
 166 The \fBcreate-dd\fR subcommand has the following syntax:
 167 .sp
 168 .in +2
 169 .nf
 170 # \fBisnsadm create-dd \fIdiscovery-domain-name\fR, ...\fR
 171 .fi
 172 .in -2
 173 .sp
 174
 175 .sp
 176 .LP
 177 \fBcreate-dd\fR has no options.
 178 .SS "\fBcreate-dd-set\fR"
 179 .sp
 180 .LP
 181 The \fBcreate-dd-set\fR subcommand creates a discovery domain set with the name
 182 you specify.
 183 .sp
 184 .LP
 185 The \fBcreate-dd-set\fR subcommand has the following syntax:
 186 .sp
 187 .in +2
 188 .nf
 189 # \fBisnsadm create-dd-set \fIdiscovery-domain-set-name\fR, ...\fR
 190 .fi
 191 .in -2
 192 .sp
 193
 194 .sp
 195 .LP
 196 \fBcreate-dd-set\fR has no options.
 197 .SS "\fBdelete-dd\fR"
 198 .sp
 199 .LP
 200 The \fBdelete-dd\fR subcommand deletes a discovery domain of the name you
 201 specify.
 202 .sp
 203 .LP
 204 The \fBdelete-dd\fR subcommand has the following syntax:
 205 .sp
 206 .in +2
 207 .nf
 208 # \fBisnsadm delete-dd \fIdiscovery-domain-name\fR, ...\fR
 209 .fi
 210 .in -2
 211 .sp
 212
 213 .sp
 214 .LP
 215 \fBdelete-dd\fR has no options.
 216 .SS "\fBdelete-dd-set\fR"
 217 .sp
 218 .LP
 219 The \fBdelete-dd-set\fR subcommand deletes a discovery domain set of the name
 220 you specify.
 221 .sp
 222 .LP
 223 The \fBdelete-dd-set\fR subcommand has the following syntax:
 224 .sp
 225 .in +2
 226 .nf
 227 # \fBisnsadm delete-dd-set \fIdiscovery-domain-set-name\fR, ...\fR
 228 .fi
 229 .in -2
 230 .sp
 231
 232 .sp
 233 .LP
 234 \fBdelete-dd-set\fR has no options.
 235 .SS "\fBdisable-dd-set\fR"
 236 .sp
 237 .LP
 238 The \fBdisable-dd-set\fR subcommand disables a discovery domain set.
 239 .sp
 240 .LP
 241 The \fBdisable-dd-set\fR subcommand has the following syntax:
 242 .sp
 243 .in +2
 244 .nf
 245 # \fBisnsadm disable-dd-set \fIdiscovery-domain-set-name\fR, ...\fR
 246 .fi
 247 .in -2
 248 .sp
 249
 250 .sp
 251 .LP
 252 \fBdisable-dd-set\fR has no options.
 253 .SS "\fBenable-dd-set\fR"
 254 .sp
 255 .LP
 256 The \fBenable-dd-set\fR subcommand enables a discovery domain set.
 257 .sp
 258 .LP
 259 The \fBenable-dd-set\fR subcommand has the following syntax:
 260 .sp
 261 .in +2
 262 .nf
 263 # \fBisnsadm enable-dd-set \fIdiscovery-domain-set-name\fR, ...\fR
 264 .fi
 265 .in -2
 266 .sp
 267
 268 .sp
 269 .LP
 270 \fBenable-dd-set\fR has no options.
 271 .SS "\fBlist-dd\fR"
 272 .sp
 273 .LP
 274 The \fBlist-dd\fR subcommand displays information about discovery domains. If
 275 no operand is specified, it lists all discovery domains that currently exist on
 276 the iSNS server.
 277 .sp
 278 .LP
 279 The \fBlist-dd\fR subcommand has the following syntax:
 280 .sp
 281 .in +2
 282 .nf
 283 # \fBisnsadm list-dd [\fIoption\fR] [\fIdiscovery-domain-name\fR, ...]\fR
 284 .fi
 285 .in -2
 286 .sp
 287
 288 .sp
 289 .LP
 290 \fBlist-dd\fR supports the following option:
 291 .sp
 292 .ne 2
 293 .na
 294 \fB\fB-v\fR, \fB--verbose\fR\fR
 295 .ad
 296 .sp .6
 297 .RS 4n
 298 Displays the member contents of the discovery domain(s).
 299 .RE
 300
 301 .SS "\fBlist-dd-set\fR"
 302 .sp
 303 .LP
 304 The \fBlist-dd-set\fR subcommand lists the discovery domain sets, both enabled
 305 and disabled, that exist on the iSNS server. Note that there is no \fBdd-set\fR
 306 registration. If no operand is specified, it lists all of the discovery domain
 307 sets.
 308 .sp
 309 .LP
 310 The \fBlist-dd-set\fR subcommand has the following syntax:
 311 .sp
 312 .in +2
 313 .nf
 314 # \fBisnsadm list-dd-set [\fIoption\fR] [\fIdiscovery-domain-set-name\fR, ...]\fR
 315 .fi
 316 .in -2
 317 .sp
 318
 319 .sp
 320 .LP
 321 \fBlist-dd-set\fR supports the following option:
 322 .sp
 323 .ne 2
 324 .na
 325 \fB\fB-v\fR, \fB--verbose\fR\fR
 326 .ad
 327 .sp .6
 328 .RS 4n
 329 Shows all discovery domains within the discovery domain set.
 330 .RE
 331
 332 .SS "\fBlist-node\fR"
 333 .sp
 334 .LP
 335 The \fBlist-node\fR subcommand displays information about nodes that are
 336 currently registered with the iSNS server or that are not registered and belong
 337 to non-default discovery-domain(s). For the latter case, the node has its type
 338 field shown as \fBunknown\fR. If no operand is specified, \fBlist-node\fR lists
 339 all nodes known by the iSNS server.
 340 .sp
 341 .LP
 342 The \fBlist-node\fR subcommand has the following syntax:
 343 .sp
 344 .in +2
 345 .nf
 346 # \fBisnsadm list-node [\fIoptions\fR] [\fIiscsi-node-name\fR, ...]\fR
 347 .fi
 348 .in -2
 349 .sp
 350
 351 .sp
 352 .LP
 353 \fBlist-node\fR supports the following options:
 354 .sp
 355 .ne 2
 356 .na
 357 \fB\fB-t\fR, \fB--target\fR\fR
 358 .ad
 359 .sp .6
 360 .RS 4n
 361 Filters the list to display only iSCSI target nodes.
 362 .RE
 363
 364 .sp
 365 .ne 2
 366 .na
 367 \fB\fB-i\fR, \fB--initiator\fR\fR
 368 .ad
 369 .sp .6
 370 .RS 4n
 371 Filters the list to display only iSCSI initiator nodes.
 372 .RE
 373
 374 .sp
 375 .ne 2
 376 .na
 377 \fB\fB-v\fR, \fB--verbose\fR\fR
 378 .ad
 379 .sp .6
 380 .RS 4n
 381 Displays details about a node. Without this option, only the name, alias, and
 382 type information are displayed.
 383 .RE
 384
 385 .SS "\fBmodify-dd\fR"
 386 .sp
 387 .LP
 388 The \fBmodify-dd\fR subcommand modifies an attribute of a specified discovery
 389 domain.
 390 .sp
 391 .LP
 392 The \fBmodify-dd\fR subcommand has the following syntax:
 393 .sp
 394 .in +2
 395 .nf
 396 # \fBisnsadm modify-dd \fIoption\fR \fIdiscovery-domain-name\fR\fR
 397 .fi
 398 .in -2
 399 .sp
 400
 401 .sp
 402 .LP
 403 \fBmodify-dd\fR has the following option:
 404 .sp
 405 .ne 2
 406 .na
 407 \fB\fB-n\fR \fIdiscovery-domain-name\fR\fR
 408 .ad
 409 .sp .6
 410 .RS 4n
 411 Specifies the new name of a discovery domain to be applied to an existing
 412 discovery-domain.
 413 .RE
 414
 415 .SS "\fBmodify-dd-set\fR"
 416 .sp
 417 .LP
 418 The \fBmodify-dd-set\fR subcommand modifies a discovery domain set.
 419 .sp
 420 .LP
 421 The \fBmodify-dd-set\fR subcommand has the following syntax:
 422 .sp
 423 .in +2
 424 .nf
 425 # \fBisnsadm modify-dd-set \fIoption\fR \fIdiscovery-domain-set-name\fR\fR
 426 .fi
 427 .in -2
 428 .sp
 429
 430 .sp
 431 .LP
 432 \fBmodify-dd-set\fR has the following option:
 433 .sp
 434 .ne 2
 435 .na
 436 \fB\fB-n\fR \fIdiscovery-domain-set-name\fR\fR
 437 .ad
 438 .sp .6
 439 .RS 4n
 440 Specifies the new name of a discovery domain set to be applied to an existing
 441 discovery-domain-set.
 442 .RE
 443
 444 .SS "\fBremove-dd\fR"
 445 .sp
 446 .LP
 447 The \fBremove-dd\fR subcommand removes the association with a specified
 448 discovery domain set.
 449 .sp
 450 .LP
 451 The \fBremove-dd\fR subcommand has the following syntax:
 452 .sp
 453 .in +2
 454 .nf
 455 # \fBisnsadm remove-dd \fIoption\fR \fIdiscovery-domain-name\fR, ...\fR
 456 .fi
 457 .in -2
 458 .sp
 459
 460 .sp
 461 .LP
 462 \fBremove-dd\fR has the following option:
 463 .sp
 464 .ne 2
 465 .na
 466 \fB\fB-s\fR \fIdiscovery-domain-set-name\fR\fR
 467 .ad
 468 .sp .6
 469 .RS 4n
 470 Specifies the discovery domain set from which the discovery domain will be
 471 removed.
 472 .RE
 473
 474 .SS "\fBremove-node\fR"
 475 .sp
 476 .LP
 477 The \fBremove-node\fR subcommand removes a node.
 478 .sp
 479 .LP
 480 The \fBremove-node\fR subcommand has the following syntax:
 481 .sp
 482 .in +2
 483 .nf
 484 # \fBisnsadm remove-node \fIoption\fR \fIiscsi-node-name\fR, ...\fR
 485 .fi
 486 .in -2
 487 .sp
 488
 489 .sp
 490 .LP
 491 \fBremove-node\fR has the following option:
 492 .sp
 493 .ne 2
 494 .na
 495 \fB\fB-d\fR \fIdiscovery-domain-name\fR\fR
 496 .ad
 497 .sp .6
 498 .RS 4n
 499 Specifies the discovery domain from which a node will be removed.
 500 .RE
 501
 502 .SS "\fBshow-config\fR"
 503 .sp
 504 .LP
 505 The \fBshow-config\fR subcommand displays the iSNS server administrative
 506 settings. Note that the setting can be modified by means of the service
 507 management facility (see \fBsmf\fR(5)).  Refer to \fBisns\fR(1M).
 508 .sp
 509 .LP
 510 The \fBshow-config\fR subcommand has the following syntax:
 511 .sp
 512 .in +2
 513 .nf
 514 # \fBisnsadm show-config\fR
 515 .fi
 516 .in -2
 517 .sp
 518
 519 .sp
 520 .LP
 521 \fBshow-config\fR has no options.
 522 .SH EXAMPLES
 523 .LP
 524 \fBExample 1 \fRDisplaying Clients
 525 .sp
 526 .LP
 527 The following use of the \fBlist-node\fR subcommand displays clients.
 528
 529 .sp
 530 .in +2
 531 .nf
 532 # \fBisnsadm list-node -v\fR
 533 iSCSI Name: iqn.1986-03.com.sun:01:000e0c9f10da.45173FEA.engr
 534         Alias: STK5320_NAS
 535         Type: Target
 536         Network Entity: SE5310
 537         Portal: 172.20.57.95:3260
 538                 Portal Group: 1
 539         Portal: 172.20.56.95:3260
 540                 Portal Group: 1
 541         DD Name: Default
 542 iSCSI Name: iqn.1986-03.com.sun:01:000e0c9f10da.454F00A2.acct
 543         Alias:
 544         Type: Target
 545         Network Entity: SE5310
 546         Portal: 172.20.57.95:3260
 547                 Portal Group: 1
 548         Portal: 172.20.56.95:3260
 549                 Portal Group: 1
 550         DD Name: Default
 551 iSCSI Name: iqn.1986-03.com.sun:01:e00000000000.46fd8e2b
 552         Alias: host-x2100
 553         Type: Initiator
 554         Network Entity: iqn.1986-03.com.sun:01:e00000000000.46fd8e2b
 555         Portal: 172.20.236.123:58530
 556                 Portal Group: 1
 557         DD Name: Default
 558 .fi
 559 .in -2
 560 .sp
 561
 562 .LP
 563 \fBExample 2 \fRDisplaying a Discovery Domain
 564 .sp
 565 .LP
 566 The following use of the \fBlist-dd\fR subcommand displays discovery domains.
 567
 568 .sp
 569 .in +2
 570 .nf
 571 # \fBisnsadm list-dd -v\fR
 572 DD name: Default
 573         DD set(s): Default
 574         iSCSI Name: iqn.1986-03.com.sun:01:000e0c9f10da.45173FEA.engr
 575         iSCSI Name: iqn.1986-03.com.sun:01:000e0c9f10da.454F00A2.acct
 576         iSCSI name: iqn.1986-03.com.sun:01:e00000000000.46fd8e2b
 577 DD name: acct-dd
 578 DD name: engineering-dd
 579 .fi
 580 .in -2
 581 .sp
 582
 583 .LP
 584 \fBExample 3 \fRAdding a Node
 585 .sp
 586 .LP
 587 The following use of the \fBadd-node\fR subcommand adds a node to a discovery
 588 domain, creating a discovery domain membership.
 589
 590 .sp
 591 .in +2
 592 .nf
 593 # \fBisnsadm add-node -d engineering-dd \e
 594 iqn.1986-03.com.sun:01:000e0c9f10da.454F00A2.engr\fR
 595 .fi
 596 .in -2
 597 .sp
 598
 599 .LP
 600 \fBExample 4 \fRRemoving a Node
 601 .sp
 602 .LP
 603 The following use of the \fBremove-node\fR subcommand removes a node from a
 604 discovery domain, thereby removing a discovery domain membership.
 605
 606 .sp
 607 .in +2
 608 .nf
 609 # \fBisnsadm remove-node -d acct-dd \e
 610 iqn.1986-03.com.sun:01:000e0c9f10da.454F00A2.acct\fR
 611 .fi
 612 .in -2
 613 .sp
 614
 615 .LP
 616 \fBExample 5 \fRCreating a Discovery Domain Set
 617 .sp
 618 .LP
 619 The following use of the \fBcreate-dd-set\fR subcommand creates a discovery
 620 domain set.
 621
 622 .sp
 623 .in +2
 624 .nf
 625 # \fBisnsadm create-dd-set operation-dd-set\fR
 626 .fi
 627 .in -2
 628 .sp
 629
 630 .LP
 631 \fBExample 6 \fRDisplaying a Discovery Domain Set
 632 .sp
 633 .LP
 634 The following use of the \fBlist-dd-set\fR subcommand displays discovery domain
 635 sets.
 636
 637 .sp
 638 .in +2
 639 .nf
 640 # \fBisnsadm list-dd-set -v\fR
 641 DD Set name: Default
 642         State: Disabled
 643         DD Name: Default
 644 DD Set name: operation-dd-set
 645         State: Disabled
 646 .fi
 647 .in -2
 648 .sp
 649
 650 .LP
 651 \fBExample 7 \fRAdding a Discovery Domain
 652 .sp
 653 .LP
 654 The following use of the \fBadd-dd\fR subcommand adds a discovery domain to a
 655 discovery domain set.
 656
 657 .sp
 658 .in +2
 659 .nf
 660 # \fBisnsadm add-dd -s operation-dd-set engineering-dd\fR
 661 .fi
 662 .in -2
 663 .sp
 664
 665 .LP
 666 \fBExample 8 \fRDisplaying a Discovery Domain Set
 667 .sp
 668 .LP
 669 The following use of the \fBlist-dd-set\fR displays the attributes of a
 670 discovery domain set.
 671
 672 .sp
 673 .in +2
 674 .nf
 675 # \fBisnsadm list-dd-set\fR
 676 DD Set name: Default
 677         State: Disabled
 678         DD Name: Default
 679 DD Set name: operation-dd-set
 680         State: Disabled
 681         DD Name: engineering-dd
 682 .fi
 683 .in -2
 684 .sp
 685
 686 .LP
 687 \fBExample 9 \fREnabling a Discovery Domain Set
 688 .sp
 689 .LP
 690 The following use of the \fBenable-dd-set\fR subcommand enables a discovery
 691 domain set.
 692
 693 .sp
 694 .in +2
 695 .nf
 696 # \fBisnsadm enable-dd-set Default\fR
 697 .fi
 698 .in -2
 699 .sp
 700
 701 .LP
 702 \fBExample 10 \fRDisabling a Discovery Domain Set
 703 .sp
 704 .LP
 705 The following use of the \fBdisable-dd-set\fR subcommand disables a discovery
 706 domain set.
 707
 708 .sp
 709 .in +2
 710 .nf
 711 # \fBisnsadm disable-dd-set Default\fR
 712 .fi
 713 .in -2
 714 .sp
 715
 716 .LP
 717 \fBExample 11 \fRDisplaying Administrative Settings
 718 .sp
 719 .LP
 720 The following use of the \fBshow-config\fR subcommand displays current
 721 administrative settings.
 722
 723 .sp
 724 .in +2
 725 .nf
 726 # \fBisnsadm show-config\fR
 727         Data Store Location: /etc/isns/isnsdata.xml
 728         Entity Status Inquiry Non-Response Threshold: 3
 729         Management SCN Enabled: yes
 730         Authorized Control Node Names: -
 731 .fi
 732 .in -2
 733 .sp
 734
 735 .SH ATTRIBUTES
 736 .sp
 737 .LP
 738 See \fBattributes\fR(5) for descriptions of the following attributes:
 739 .sp
 740
 741 .sp
 742 .TS
 743 box;
 744 c | c
 745 l | l .
 746 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 747 _
 748 Interface Stability     Volatile
 749 .TE
 750
 751 .SH SEE ALSO
 752 .sp
 753 .LP
 754 \fBiscsiadm\fR(1M), \fBiscsitadm\fR(1M), \fBisns\fR(1M), \fBattributes\fR(5),
 755 \fBsmf\fR(5)
 756 .SH NOTES
 757 .sp
 758 .LP
 759 When a subcommand is invoked with multiple operands and there are failures on
 760 one or more, but not all, operands, \fBisnsadm\fR displays a generic message
 761 indicating partial failure, with list of failed operands. An error on a
 762 specific operand can be found by issuing the same subcommand on the failing
 763 operand.