summaryrefslogtreecommitdiff
path: root/usr/src/man/man1m/itadm.1m
blob: d93cd637dfc8b4c60d7c24240cfd148e1f984407 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
'\" te
.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
.\" 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.
.\"  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 fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH ITADM 8 "Aug 4, 2009"
.SH NAME
itadm \- administer iSCSI targets
.SH SYNOPSIS
.LP
.nf
\fBitadm\fR create-target [\fB-a\fR,\fB--auth-method\fR radius | chap | none | default]
     [\fB-s\fR,\fB--chap-secret\fR] [\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR]
     [\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR] [\fB-n\fR,\fB--node-name\fR \fItarget_node_name\fR]
     [\fB-l\fR,\fB--alias\fR \fIalias\fR] [\fB-t\fR,\fB--tpg\fR \fItpg-name\fR[,\fItpg-name\fR]]
.fi

.LP
.nf
\fBitadm\fR modify-target [\fB-a\fR,\fB--auth-method\fR radius | chap | none | default]
     [\fB-s\fR,\fB--chap-secret\fR] [\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR]
     [\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR] [\fB-n\fR,\fB--node-name\fR \fInew_target_node_name\fR]
     [\fB-l\fR,\fB--alias\fR \fIalias\fR] [\fB-t\fR,\fB--tpg\fR \fItpg-name\fR[,\fItpg-name\fR]] \fItarget_node_name\fR
.fi

.LP
.nf
\fBitadm\fR delete-target [\fB-f\fR,\fB--force\fR] \fItarget_node_name\fR
.fi

.LP
.nf
\fBitadm\fR list-target [\fB-v\fR,\fB--verbose\fR] [\fItarget_node_name\fR]
.fi

.LP
.nf
\fBitadm\fR create-tpg \fItpg_name\fR \fIIP-address\fR[:\fIport\fR] [\fIIP-address\fR[:\fIport\fR]]...
.fi

.LP
.nf
\fBitadm\fR list-tpg [\fB-v\fR,\fB--verbose\fR] [\fItpg_name\fR]
.fi

.LP
.nf
\fBitadm\fR delete-tpg  [\fB-f\fR,\fB--force\fR] \fItpg_name\fR
.fi

.LP
.nf
\fBitadm\fR create-initiator [\fB-s\fR,\fB--chap-secret\fR] [\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR]
     [\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR] \fIinitiator_node_name\fR
.fi

.LP
.nf
\fBitadm\fR modify-initiator [\fB-s\fR,\fB--chap-secret\fR] [\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR]
     [\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR] \fIinitiator_node_name\fR
.fi

.LP
.nf
\fBitadm\fR list-initiator [\fB-v\fR,\fB--verbose\fR] \fIinitiator_node_name\fR
.fi

.LP
.nf
\fBitadm\fR delete-initiator \fIinitiator_node_name\fR
.fi

.LP
.nf
\fBitadm\fR modify-defaults [\fB-a\fR,\fB--auth-method\fR radius | chap | none]
     [\fB-r\fR,\fB--radius-server\fR \fIIP-address\fR[:\fIport\fR]] [\fB-d\fR,\fB--radius-secret\fR]
     [\fB-D\fR,\fB--radius-secret-file\fR \fIpath\fR][\fB-i\fR,\fB--isns\fR enable | disable]
     [\fB-I\fR,\fB--isns-server\fR \fIIP-address\fR[:\fIport\fR][,\fIIP-address\fR[:\fIport\fR]]]
.fi

.LP
.nf
\fBitadm\fR list-defaults
.fi

.SH DESCRIPTION
.sp
.LP
The \fBitadm\fR command manages Internet SCSI (iSCSI) target nodes within the
SCSI Target Mode Framework described in \fBstmfadm\fR(8) and
\fBlibstmf\fR(3LIB).  This allows the iSCSI initiators to access STMF logical
units using the iSCSI protocol. In addition to iSCSI target nodes, \fBitadm\fR
manages two other classes of managed objects: iSCSI Target Portal Groups, and
iSCSI Initiator Node Contexts.
.sp
.LP
\fBitadm\fR is implemented as a set of subcommands with options and operands
for each subcommand. These subcommands are described in their own section,
below. In addition to its subcommands, \fBitadm\fR has a help command, which
displays the utility's usage information. The help command is invoked with the
\fB-?\fR option.
.SS "iSCSI Target Portal Groups"
.sp
.LP
An iSCSI Target Network Portal is an IP address and TCP port that can be used
by an initiator node to connect to an iSCSI target. A collection of  these
portals is called a Target Portal Group (TPG). You can use a TPG  to limit
access to an iSCSI target. Use the \fBitadm modify\fR \fB-t\fR command to  bind
a specific iSCSI target to the TPG. An iSCSI listener is created on  each IP
address that belongs to the TPG, and listens for connections to  the iSCSI
target.
.sp
.LP
A TPG is identified by a unique name provided when the TPG is created. A
numerical "Target Portal Group Tag" from the range 2-65535 is automatically
generated when the TPG is created. The Target Portal Group Tag 1 is reserved
for the "default" target portal group that is used when no explicit Target
Portal Groups are set on the target. The portal for the default TPG matches
requests from all network interfaces on port  3260.
.SS "iSCSI Initiator Node Contexts"
.sp
.LP
Certain operations such as authentication by means of Challenge Handshake
Authentication Protocol (CHAP) require parameters associated with a remote
iSCSI Initiator Node. These parameters are associated with an iSCSI Initiator
Node Context. An iSCSI Initiator Node Context is identified by its Initiator
Node Name, formatted in either IQN or EUI format (see RFC 3720). For example:
.sp
.in +2
.nf
iqn.1986-03.com.sun:01:e00000000000.47d55444
eui.02004567A425678D
.fi
.in -2
.sp

.SS "Specifying IP Addresses"
.sp
.LP
A number of \fBitadm\fR subcommands require that you specify one or more IP
addresses with optional port numbers. For IPv4, use standard dotted decimal
notation. For IPv6, enclose addresses in square brackets. The following are
example specifications.
.sp
.in +2
.nf
\fBIPv4\fR:  10.2.4.1
       10.2.4.1:3260
\fBIPv6\fR:  [1080:0:0:0:8:800:200C:417A]
       [1080:0:0:0:8:800:200C:417A]:3260
.fi
.in -2
.sp

.SH SUB-COMMANDS
.sp
.LP
The following are the \fBitadm\fR subcommands with their options.
.SS "\fBitadm create-target\fR"
.sp
.in +2
.nf
itadm create-target [-a,--auth-method radius | chap | none | default]
     [-s,--chap-secret]
     [-S,--chap-secret-file \fIpath\fR] [-u,--chap-user \fIchap-user-name\fR]
     [-n,--node-name \fItarget_node_name\fR] [-l,--alias \fIalias\fR]
     [-t,--tpg \fItpg-name\fR[,\fItpg-name\fR,...]]
.fi
.in -2
.sp

.sp
.LP
Create a iSCSI target with the specified options. Options are as follows.
.sp
.ne 2
.na
\fB\fB-a\fR,\fB--auth-method\fR \fBradius | chap | none | default\fR\fR
.ad
.sp .6
.RS 4n
Specifies the authentication method to use for the target. Valid values are
\fBradius\fR, \fBchap\fR, and \fBnone\fR. \fBchap\fR indicates that initiators
connecting to this target must be authenticated using the Challenge Handshake
Authentication Protocol (CHAP). \fBradius\fR indicates initiators should also
be authenticated by means of CHAP but the required authentication parameters
should  be obtained from a central RADIUS server (see the \fBradius-server\fR
and \fBradius-secret\fR options). \fBnone\fR means that no authentication is
required to connect to the target. \fBdefault\fR means the target will use the
global setting of this property.  (See the \fBmodify-defaults\fR subcommand.)
.RE

.sp
.ne 2
.na
\fB\fB-s\fR,\fB--chap-secret\fR\fR
.ad
.sp .6
.RS 4n
The CHAP secret to send during mutual CHAP authentication. There is no default
for this property. Maximum length is 255 characters; minimum required length is
12 characters.
.RE

.sp
.ne 2
.na
\fB\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR\fR
.ad
.sp .6
.RS 4n
Path to a temporary file containing the CHAP secret as described in the
\fB-s\fR option.
.RE

.sp
.ne 2
.na
\fB\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR\fR
.ad
.sp .6
.RS 4n
Specifies the CHAP username for a target for use in mutual CHAP authentication.
This value is allowed only for targets, cannot be set globally, and is used
only when the initiator node is configured to use mutual CHAP authentication.
If no value is specified then the target node name is used as the username. See
\fBiscsiadm\fR(1M).
.RE

.sp
.ne 2
.na
\fB\fB-n\fR,\fB--node-name\fR \fItarget_node_name\fR\fR
.ad
.sp .6
.RS 4n
An iSCSI Target Node is identified by its Target Node Name, formatted in either
IQN or EUI format (see RFC 3720). This option establishes that name.
.RE

.sp
.ne 2
.na
\fB\fB-l\fR,\fB--alias\fR \fIalias\fR\fR
.ad
.sp .6
.RS 4n
An alternate identifier associated with a target node. The identifier does not
need to be unique.
.RE

.sp
.ne 2
.na
\fB\fB-t\fR,\fB--tpg\fR \fItpg-name\fR[,\fItpg-name\fR,...]\fR
.ad
.sp .6
.RS 4n
A list of Target Portal Group (TPG) identifiers that specifies the TPGs that an
initiator can use to access a specific target or the keyword \fBdefault\fR.  If
\fBdefault\fR is specified, the target will use the default portal,
\fBINADDR_ANY:3260\fR.
.RE

.SS "\fBitadm modify-target\fR"
.sp
.in +2
.nf
itadm modify-target [\fB-a\fR,\fB--auth-method\fR radius | chap | none | default]
     [\fB-s\fR,\fB--chap-secret\fR] [\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR]
     [\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR] [\fB-n\fR,\fB--node-name\fR \fInew_tgt_node_name\fR]
     [\fB-l\fR,\fB--alias\fR \fIalias\fR] [\fB-t\fR,\fB--tpg\fR \fItpg-name\fR[,\fItpg-name\fR]] \fItarget_node_name\fR
.fi
.in -2
.sp

.sp
.LP
Modify an iSCSI target according to the specified options. Options are as
follows.
.sp
.ne 2
.na
\fB\fB-a\fR,\fB--auth-method\fR \fBradius | chap | none | default\fR\fR
.ad
.sp .6
.RS 4n
As described under the \fBcreate-target\fR subcommand, above.
.RE

.sp
.ne 2
.na
\fB\fB-s\fR,\fB--chap-secret\fR\fR
.ad
.sp .6
.RS 4n
As described under the \fBcreate-target\fR subcommand, above.
.RE

.sp
.ne 2
.na
\fB\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR\fR
.ad
.sp .6
.RS 4n
As described under the \fBcreate-target\fR subcommand, above.
.RE

.sp
.ne 2
.na
\fB\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR\fR
.ad
.sp .6
.RS 4n
As described under the \fBcreate-target\fR subcommand, above. To remove an
explicitly set CHAP username use \fB-u\fR \fBnone\fR.
.RE

.sp
.ne 2
.na
\fB\fB-n\fR,\fB--node-name\fR \fItarget_node_name\fR\fR
.ad
.sp .6
.RS 4n
Renames the target. See also the description of \fB-n\fR under the
\fBcreate-target\fR subcommand, above.
.RE

.sp
.ne 2
.na
\fB\fB-l\fR,\fB--alias\fR \fIalias\fR\fR
.ad
.sp .6
.RS 4n
As described under the \fBcreate-target\fR subcommand, above. To remove an
explicitly set alias use \fB-l\fR \fBnone\fR.
.RE

.sp
.ne 2
.na
\fB\fB-t\fR,\fB--tpg\fR \fItpg-name\fR[,\fItpg-name\fR,...]\fR
.ad
.sp .6
.RS 4n
As described under the \fBcreate-target\fR subcommand, above.
.RE

.SS "\fBitadm list-target\fR"
.sp
.in +2
.nf
itadm list-target [\fB-v\fR,\fB--verbose\fR] [\fItarget_node_name\fR]
.fi
.in -2
.sp

.sp
.LP
List information about the configured targets. If \fItarget_node_name\fR is
specified, list only the information for that target. Option is as follows.
.sp
.ne 2
.na
\fB\fB-v\fR,\fB--verbose\fR\fR
.ad
.sp .6
.RS 4n
Verbose mode.
.RE

.SS "\fBitadm delete-target\fR"
.sp
.in +2
.nf
itadm delete-target [\fB-f\fR,\fB--force\fR] \fItarget_node_name\fR
.fi
.in -2
.sp

.sp
.LP
Delete the target specified by \fItarget_node_name\fR. The target must be
\fBoffline\fR before it can be deleted. Option is as follows.
.sp
.ne 2
.na
\fB\fB-f\fR,\fB--force\fR\fR
.ad
.sp .6
.RS 4n
If the target persists in an online state, this option attempts to offline the
target before deleting it.
.RE

.SS "\fBitadm create-tpg\fR"
.sp
.in +2
.nf
itadm create-tpg \fItpg_name\fR \fIIP-address\fR[:\fIport\fR]...
.fi
.in -2
.sp

.sp
.LP
Create an iSCSI target portal group made up of the specified portals and assign
it the identifier \fItpg_name\fR. Each portal is an IP address and port pair.
IPv4 portals are specified in dotted address notation, for example,
\fB172.31.255.255\fR. IPv6 portal addresses must be enclosed in square
brackets.
.sp
.LP
This subcommand has no options.
.SS "\fBitadm list-tpg\fR"
.sp
.in +2
.nf
itadm list-tpg [\fB-v\fR,\fB--verbose\fR] [\fItpg_name\fR]
.fi
.in -2
.sp

.sp
.LP
List information about the configured target portal group. If \fItpg_name\fR is
specified then list only the information about the target portal group
associated with that \fItpg_name\fR. Option is as follows.
.sp
.ne 2
.na
\fB\fB-v\fR,\fB--verbose\fR\fR
.ad
.sp .6
.RS 4n
Verbose mode.
.RE

.SS "\fBitadm delete-tpg\fR"
.sp
.in +2
.nf
itadm delete-tpg  [\fB-f\fR,\fB--force\fR] \fItpg_name\fR
.fi
.in -2
.sp

.sp
.LP
Delete the target portal group associated with \fItpg_name\fR. Option is as
follows.
.sp
.ne 2
.na
\fB\fB-f\fR,\fB--force\fR\fR
.ad
.sp .6
.RS 4n
If the TPG is associated with any targets, the request to delete will be denied
unless this option is specified.
.RE

.SS "\fBitadm create-initiator\fR"
.sp
.in +2
.nf
itadm create-initiator [\fB-s\fR,\fB--chap-secret\fR] [\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR]
     [\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR] \fIinitiator_node_name\fR
.fi
.in -2
.sp

.sp
.LP
Configure parameters associated with the remote initiator named
\fIinitiator_node_name\fR. Options are as follows.
.sp
.ne 2
.na
\fB\fB-s\fR,\fB--chap-secret\fR\fR
.ad
.sp .6
.RS 4n
As described under the \fBcreate-target\fR subcommand, above.
.RE

.sp
.ne 2
.na
\fB\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR\fR
.ad
.sp .6
.RS 4n
As described under the \fBcreate-target\fR subcommand, above.
.RE

.sp
.ne 2
.na
\fB\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR\fR
.ad
.sp .6
.RS 4n
Specifies the CHAP username for an initiator, for use in CHAP authentication.
If no value is specified then the initiator node name is used as the username.
.RE

.SS "\fBitadm modify-initiator\fR"
.sp
.in +2
.nf
itadm modify-initiator [\fB-s\fR,\fB--chap-secret\fR] [\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR]
     [\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR] \fIinitiator_node_name\fR
.fi
.in -2
.sp

.sp
.LP
Modify parameters associated with the remote initiator named
\fIinitiator_node_name\fR. Options are as follows.
.sp
.ne 2
.na
\fB\fB-s\fR,\fB--chap-secret\fR\fR
.ad
.sp .6
.RS 4n
As described under the \fBcreate-target\fR subcommand, above.
.RE

.sp
.ne 2
.na
\fB\fB-S\fR,\fB--chap-secret-file\fR \fIpath\fR\fR
.ad
.sp .6
.RS 4n
As described under the \fBcreate-target\fR subcommand, above.
.RE

.sp
.ne 2
.na
\fB\fB-u\fR,\fB--chap-user\fR \fIchap-user-name\fR\fR
.ad
.sp .6
.RS 4n
Specifies the CHAP username for an initiator, for use in CHAP authentication.
If no value is specified then the initiator node name is used as the username.
.RE

.SS "\fBitadm delete-initiator\fR"
.sp
.in +2
.nf
itadm delete-initiator \fIinitiator_node_name\fR
.fi
.in -2
.sp

.sp
.LP
Delete parameters associated with the remote initiator named
\fIinitiator_node_name\fR. This subcommand has no options.
.SS "\fBitadm list-initiator\fR"
.sp
.in +2
.nf
\fBitadm\fR list-initiator [\fB-v\fR,\fB--verbose\fR] \fIinitiator_node_name\fR
.fi
.in -2
.sp

.sp
.LP
List parameters associated with the initiator named \fIinitiator_node_name\fR.
Option is as follows.
.sp
.ne 2
.na
\fB\fB-v\fR,\fB--verbose\fR\fR
.ad
.sp .6
.RS 4n
Verbose mode.
.RE

.SS "\fBitadm modify-defaults\fR"
.sp
.in +2
.nf
itadm modify-defaults [\fB-a\fR,\fB--auth-method\fR radius | chap | none]
     [\fB-r\fR,\fB--radius-server\fR \fIIP-address\fR[:\fIport\fR]] [\fB-d\fR,\fB--radius-secret\fR]
     [\fB-D\fR,\fB--radius-secret-file\fR \fIpath\fR][\fB-i\fR,\fB--isns\fR enable | disable]
     [\fB-I\fR,\fB--isns-server\fR \fIIP-address\fR[:\fIport\fR][,\fIIP-address\fR[:\fIport\fR]]]
.fi
.in -2
.sp

.sp
.LP
Modify default parameters. Options are as follows.
.sp
.ne 2
.na
\fB\fB-a\fR,\fB--auth-method\fR \fBradius | chap | none\fR\fR
.ad
.sp .6
.RS 4n
Specifies the default authentication method to use for all targets. Valid
values are \fBradius\fR, \fBchap\fR, and \fBnone\fR. \fBchap\fR indicates that
initiators connecting to this target must be authenticated using Challenge
Handshake Authentication Protocol (CHAP). \fBradius\fR indicates initiators
should also be authenticated by means of CHAP, but the required authentication
parameters should be obtained from a central RADIUS server. (See
\fB--radius-server\fR and \fB--radius-secret\fR options.) \fBnone\fR means that
no authentication is required to connect to the target. Individual targets can
override this global setting using the \fB-a\fR option of the
\fBcreate-target\fR and \fBmodify-target\fR subcommands.
.RE

.sp
.ne 2
.na
\fB\fB-d\fR,\fB--radius-secret\fR\fR
.ad
.sp .6
.RS 4n
RADIUS Shared Secret for centralized CHAP authentication.
.RE

.sp
.ne 2
.na
\fB\fB-D\fR,\fB--radius-secret-file\fR \fIpath\fR\fR
.ad
.sp .6
.RS 4n
Path to a temporary file containing the CHAP secret as described in the
\fB-d\fR option.
.RE

.sp
.ne 2
.na
\fB\fB-i\fR,\fB--sns\fR \fBenable | disable\fR\fR
.ad
.sp .6
.RS 4n
Specifies whether targets should be registered with the set of defined iSCSI
Name Service (iSNS) servers.
.RE

.sp
.ne 2
.na
\fB\fB-I\fR,\fB--isns-server\fR
\fIIP-address\fR[:\fIport\fR][,\fIIP-address\fR[:\fIport\fR],...]\fR
.ad
.sp .6
.RS 4n
Defines a list of iSNS servers with which iSCSI target nodes will be registered
when the \fBisns\fR option associated with the respective target is set. Up to
eight iSNS servers can be specified. To remove all iSNS servers, use \fB-I\fR
\fBnone\fR.
.RE

.sp
.ne 2
.na
\fB\fB-r\fR,\fB--radius-server\fR \fIIP-address\fR[:\fIport\fR]\fR
.ad
.sp .6
.RS 4n
Specify the IP address of the RADIUS server used for centralized CHAP
authentication.
.RE

.SS "\fBitadm list-defaults\fR"
.sp
.in +2
.nf
itadm list-defaults
.fi
.in -2
.sp

.sp
.LP
List information about the default properties. This subcommand has no options.
.SH EXAMPLES
.LP
\fBExample 1 \fRCreating a Target
.sp
.LP
The following command creates a target.

.sp
.in +2
.nf
# \fBitadm create-target\fR
Target iqn.1986-03.com.sun:02:72e1b181-7bce-c0e6-851e-ec0d8cf14b7a
successfully created
.fi
.in -2
.sp

.LP
\fBExample 2 \fRCreating a Target with a Specific Name
.sp
.LP
The following command creates a target with a specific IQN.

.sp
.in +2
.nf
# \fBitadm create-target -n eui.20387ab8943ef7548\fR
or:
# \fBitadm create-target \e
-n iqn.1986-03.com.sun:02:a9a366f8-cc2b-f291-840948c7f29e\fR
.fi
.in -2
.sp

.LP
\fBExample 3 \fRChanging a Name
.sp
.LP
The following command changes an IQN for an existing target.

.sp
.in +2
.nf
# \fBitadm modify-target -n eui.20387ab8943ef7548 \e
iqn.1986-03.com.sun:02:a9a366f8-909b-cc2b-f291-840948c7f29e\fR
.fi
.in -2
.sp

.LP
\fBExample 4 \fRSetting up CHAP Authentication
.sp
.LP
The following command sets up CHAP authentication for a target using the
default CHAP username.

.sp
.in +2
.nf
# \fBitadm modify-initiator -s iqn.1986-03.com.sun:01:e00000000000.47d55444\fR
\fBEnter CHAP secret:\fR *********
\fBRe-enter secret:\fR *********

# \fBitadm modify-target -a chap eui.20387ab8943ef7548\fR
.fi
.in -2
.sp

.LP
\fBExample 5 \fRCreating Target Portal Groups
.sp
.LP
The following command creates two target portal groups, \fBA\fR and \fBB\fR,
using port 8000 for the addresses in TPG 2.

.sp
.in +2
.nf
# \fBitadm create-tpg A 192.168.0.1 192.168.0.2\fR
# \fBitadm create-tpg B 192.168.0.2:8000 192.168.0.2:8000\fR
.fi
.in -2
.sp

.LP
\fBExample 6 \fRConfiguring a Target to Use TPGs
.sp
.LP
The following command configures a target to use TPGs A and B.

.sp
.in +2
.nf
# \fBitadm modify-target -t A,B eui.20387ab8943ef7548\fR
.fi
.in -2
.sp

.LP
\fBExample 7 \fRSetting up RADIUS Authentication for Specific Target
.sp
.LP
The following command sets up RADIUS authentication for a specific target.

.sp
.in +2
.nf
# \fBitadm modify-defaults -r 192.168.10.1 -d\fR
\fBEnter RADIUS secret:\fR *********
\fBRe-enter secret:\fR *********

# \fBitadm modify-target -a radius eui.20387ab8943ef7548\fR
.fi
.in -2
.sp

.LP
\fBExample 8 \fRSetting up RADIUS Authentication for All Targets
.sp
.LP
The following command sets up RADIUS authentication for all targets.

.sp
.in +2
.nf
# \fBitadm modify-defaults -d -r 192.168.10.1 -a radius\fR
\fBEnter RADIUS secret:\fR *********
\fBRe-enter secret:\fR *********
.fi
.in -2
.sp

.sp
.LP
The preceding command assumes all targets were created with \fB-a\fR
\fBdefault\fR.

.LP
\fBExample 9 \fRListing Default Properties
.sp
.LP
The following command lists default properties.

.sp
.in +2
.nf
# \fBitadm list-defaults\fR
iSCSI Target Default Properties:

alias:          \fInone\fR
auth:           \fInone\fR
radiusserver:   \fInone\fR
radiussecret:   unset
isns:           disabled
isnsserver:     2.3.4.5,4.5.6.7
.fi
.in -2
.sp

.LP
\fBExample 10 \fRListing Targets
.sp
.LP
The following command lists targets.

.sp
.in +2
.nf
# \fBitadm list-target\fR
TARGET NAME                                           STATE    SESSIONS
iqn.1986-03.com.sun:02:72e1b181-7bce-c0e6-851e-ec0d8cf14b7a  online   0
iqn.1986-03.com.sun:02:2cb0c526-c05a-e279-e396-a367006f4227  online   0
iqn.1986-03.com.sun:02:d14125bb-1c9d-c28d-97b0-f89259b642f3  online   0
iqn.1986-03.com.sun:02:03ff9fc5-794a-e9b4-a081-bb82917c292a  online   0
.fi
.in -2
.sp

.LP
\fBExample 11 \fRListing Targets (Verbose)
.sp
.LP
The following command lists targets with the verbose option.

.sp
.in +2
.nf
# \fBitadm list-target -v\fR
TARGET NAME                                           STATE    SESSIONS
iqn.1986-03.com.sun:02:d23e68d8-2d79-c988-98e7-a6361689d33c  online   0
       alias:                  -
       auth:                   none (defaults)
       targetchapuser:         -
       targetchapsecret:       unset
       tpg-tags:               default
iqn.1986-03.com.sun:02:94ec46d4-c8e1-6993-ef03-ffc1dcd66606  online   1
       alias:                  -
       auth:                   chap
       targetchapuser:         -
       targetchapsecret:       unset
       tpg-tags:               nge1_ipv4 = 3
.fi
.in -2
.sp

.LP
\fBExample 12 \fRListing a Specific Target
.sp
.LP
The following command lists targets with the verbose option.

.sp
.in +2
.nf
# \fBitadm list-target -v \e
iqn.1986-03.com.sun:02:2cb0c526-c05a-e279-e396-a367006f4227\fR
TARGET NAME                                           STATE    SESSIONS
iqn.1986-03.com.sun:02:2cb0c526-c05a-e279-e396-a367006f4227  online   1
        alias:                  -
        auth:                   chap
        targetchapuser:         -
        targetchapsecret:       unset
        tpg-tags:               nge1_ipv4 = 3
.fi
.in -2
.sp

.SH SEE ALSO
.sp
.LP
\fBiscsiadm\fR(1M), \fBstmfadm\fR(8), \fBlibstmf\fR(3LIB)