1isnsadm(1M) System Administration Commands isnsadm(1M)
2
3
4
6 isnsadm - administer the internet Storage Name Server (iSNS) server
7
9 isnsadm options
10
11
12 isnsadm subcommand [subcommand_options] [operand]
13
14
16 The isnsadm command is the command-line interface to the Internet Stor‐
17 age Name Service (iSNS) server. isnsadm comprises a set of subcommands,
18 described in their own section, each of which accomplishes one of the
19 iSNS server management functions.
20
21
22 For any operations that will change the iSNS configurations the
23 solaris.isnsmgr.write authorization is required. Refer to isns(1M). For
24 read operations, the command does not require special authorizations.
25
26
27 isnsadm has a set of general options and a set of subcommand-specific
28 options. The first category is described under OPTIONS; the second cat‐
29 egory is described in the context of each subcommand description.
30
32 The following options are supported:
33
34 -?, --help
35
36 Displays context help. Stops interpretation of any subsequent argu‐
37 ments.
38
39
40 -V, --version
41
42 Displays version information. Stops interpretation of any subse‐
43 quent arguments.
44
45
47 The following operands are used by one or more isnsadm subcommands.
48
49 iscsi-node-name
50
51 iSCSI target or iSCSI initiator symbolic name. A string with a max‐
52 imum length of 223 characters.
53
54
55 discovery-domain-name
56
57 Discovery domain symbolic name. A string with a maximum length of
58 256 characters.
59
60
61 discovery-domain-set-name
62
63 Discovery domain set symbolic name. A string with a maximum length
64 of 256 characters.
65
66
68 The isnsadm command supports the subcommands described below.
69
70 add-dd
71 The add-dd subcommand adds a discovery domain to a discovery domain
72 set.
73
74
75 The add-dd subcommand has the following syntax:
76
77 # isnsadm add-dd option discovery-domain-name, ...
78
79
80
81
82 add-dd has the following option:
83
84 -s discovery-domain-set-name
85
86 Specifies a discovery domain set.
87
88
89 add-node
90 The add-node subcommand adds a node to a specified discovery-domain.
91
92
93 The add-node subcommand has the following syntax:
94
95 # isnsadm add-node option iscsi-node-name,...
96
97
98
99
100 add-node has the following options:
101
102 -d,--dd discovery-domain-name
103
104 Specifies a discovery domain.
105
106
107 create-dd
108 The create-dd subcommand creates a discovery domain with the name you
109 specify.
110
111
112 The create-dd subcommand has the following syntax:
113
114 # isnsadm create-dd discovery-domain-name, ...
115
116
117
118
119 create-dd has no options.
120
121 create-dd-set
122 The create-dd-set subcommand creates a discovery domain set with the
123 name you specify.
124
125
126 The create-dd-set subcommand has the following syntax:
127
128 # isnsadm create-dd-set discovery-domain-set-name, ...
129
130
131
132
133 create-dd-set has no options.
134
135 delete-dd
136 The delete-dd subcommand deletes a discovery domain of the name you
137 specify.
138
139
140 The delete-dd subcommand has the following syntax:
141
142 # isnsadm delete-dd discovery-domain-name, ...
143
144
145
146
147 delete-dd has no options.
148
149 delete-dd-set
150 The delete-dd-set subcommand deletes a discovery domain set of the name
151 you specify.
152
153
154 The delete-dd-set subcommand has the following syntax:
155
156 # isnsadm delete-dd-set discovery-domain-set-name, ...
157
158
159
160
161 delete-dd-set has no options.
162
163 disable-dd-set
164 The disable-dd-set subcommand disables a discovery domain set.
165
166
167 The disable-dd-set subcommand has the following syntax:
168
169 # isnsadm disable-dd-set discovery-domain-set-name, ...
170
171
172
173
174 disable-dd-set has no options.
175
176 enable-dd-set
177 The enable-dd-set subcommand enables a discovery domain set.
178
179
180 The enable-dd-set subcommand has the following syntax:
181
182 # isnsadm enable-dd-set discovery-domain-set-name, ...
183
184
185
186
187 enable-dd-set has no options.
188
189 list-dd
190 The list-dd subcommand displays information about discovery domains. If
191 no operand is specified, it lists all discovery domains that currently
192 exist on the iSNS server.
193
194
195 The list-dd subcommand has the following syntax:
196
197 # isnsadm list-dd [option] [discovery-domain-name, ...]
198
199
200
201
202 list-dd supports the following option:
203
204 -v, --verbose
205
206 Displays the member contents of the discovery domain(s).
207
208
209 list-dd-set
210 The list-dd-set subcommand lists the discovery domain sets, both
211 enabled and disabled, that exist on the iSNS server. Note that there is
212 no dd-set registration. If no operand is specified, it lists all of the
213 discovery domain sets.
214
215
216 The list-dd-set subcommand has the following syntax:
217
218 # isnsadm list-dd-set [option] [discovery-domain-set-name, ...]
219
220
221
222
223 list-dd-set supports the following option:
224
225 -v, --verbose
226
227 Shows all discovery domains within the discovery domain set.
228
229
230 list-node
231 The list-node subcommand displays information about nodes that are cur‐
232 rently registered with the iSNS server or that are not registered and
233 belong to non-default discovery-domain(s). For the latter case, the
234 node has its type field shown as unknown. If no operand is specified,
235 list-node lists all nodes known by the iSNS server.
236
237
238 The list-node subcommand has the following syntax:
239
240 # isnsadm list-node [options] [iscsi-node-name, ...]
241
242
243
244
245 list-node supports the following options:
246
247 -t, --target
248
249 Filters the list to display only iSCSI target nodes.
250
251
252 -i, --initiator
253
254 Filters the list to display only iSCSI initiator nodes.
255
256
257 -v, --verbose
258
259 Displays details about a node. Without this option, only the name,
260 alias, and type information are displayed.
261
262
263 modify-dd
264 The modify-dd subcommand modifies an attribute of a specified discovery
265 domain.
266
267
268 The modify-dd subcommand has the following syntax:
269
270 # isnsadm modify-dd option discovery-domain-name
271
272
273
274
275 modify-dd has the following option:
276
277 -n discovery-domain-name
278
279 Specifies the new name of a discovery domain to be applied to an
280 existing discovery-domain.
281
282
283 modify-dd-set
284 The modify-dd-set subcommand modifies a discovery domain set.
285
286
287 The modify-dd-set subcommand has the following syntax:
288
289 # isnsadm modify-dd-set option discovery-domain-set-name
290
291
292
293
294 modify-dd-set has the following option:
295
296 -n discovery-domain-set-name
297
298 Specifies the new name of a discovery domain set to be applied to
299 an existing discovery-domain-set.
300
301
302 remove-dd
303 The remove-dd subcommand removes the association with a specified dis‐
304 covery domain set.
305
306
307 The remove-dd subcommand has the following syntax:
308
309 # isnsadm remove-dd option discovery-domain-name, ...
310
311
312
313
314 remove-dd has the following option:
315
316 -s discovery-domain-set-name
317
318 Specifies the discovery domain set from which the discovery domain
319 will be removed.
320
321
322 remove-node
323 The remove-node subcommand removes a node.
324
325
326 The remove-node subcommand has the following syntax:
327
328 # isnsadm remove-node option iscsi-node-name, ...
329
330
331
332
333 remove-node has the following option:
334
335 -d discovery-domain-name
336
337 Specifies the discovery domain from which a node will be removed.
338
339
340 show-config
341 The show-config subcommand displays the iSNS server administrative set‐
342 tings. Note that the setting can be modified by means of the service
343 management facility (see smf(5)). Refer to isns(1M).
344
345
346 The show-config subcommand has the following syntax:
347
348 # isnsadm show-config
349
350
351
352
353 show-config has no options.
354
356 Example 1 Displaying Clients
357
358
359 The following use of the list-node subcommand displays clients.
360
361
362 # isnsadm list-node -v
363 iSCSI Name: iqn.1986-03.com.sun:01:000e0c9f10da.45173FEA.engr
364 Alias: STK5320_NAS
365 Type: Target
366 Network Entity: SE5310
367 Portal: 172.20.57.95:3260
368 Portal Group: 1
369 Portal: 172.20.56.95:3260
370 Portal Group: 1
371 DD Name: Default
372 iSCSI Name: iqn.1986-03.com.sun:01:000e0c9f10da.454F00A2.acct
373 Alias:
374 Type: Target
375 Network Entity: SE5310
376 Portal: 172.20.57.95:3260
377 Portal Group: 1
378 Portal: 172.20.56.95:3260
379 Portal Group: 1
380 DD Name: Default
381 iSCSI Name: iqn.1986-03.com.sun:01:e00000000000.46fd8e2b
382 Alias: host-x2100
383 Type: Initiator
384 Network Entity: iqn.1986-03.com.sun:01:e00000000000.46fd8e2b
385 Portal: 172.20.236.123:58530
386 Portal Group: 1
387 DD Name: Default
388
389
390
391 Example 2 Displaying a Discovery Domain
392
393
394 The following use of the list-dd subcommand displays discovery domains.
395
396
397 # isnsadm list-dd -v
398 DD name: Default
399 DD set(s): Default
400 iSCSI Name: iqn.1986-03.com.sun:01:000e0c9f10da.45173FEA.engr
401 iSCSI Name: iqn.1986-03.com.sun:01:000e0c9f10da.454F00A2.acct
402 iSCSI name: iqn.1986-03.com.sun:01:e00000000000.46fd8e2b
403 DD name: acct-dd
404 DD name: engineering-dd
405
406
407
408 Example 3 Adding a Node
409
410
411 The following use of the add-node subcommand adds a node to a discovery
412 domain, creating a discovery domain membership.
413
414
415 # isnsadm add-node -d engineering-dd \
416 iqn.1986-03.com.sun:01:000e0c9f10da.454F00A2.engr
417
418
419
420 Example 4 Removing a Node
421
422
423 The following use of the remove-node subcommand removes a node from a
424 discovery domain, thereby removing a discovery domain membership.
425
426
427 # isnsadm remove-node -d acct-dd \
428 iqn.1986-03.com.sun:01:000e0c9f10da.454F00A2.acct
429
430
431
432 Example 5 Creating a Discovery Domain Set
433
434
435 The following use of the create-dd-set subcommand creates a discovery
436 domain set.
437
438
439 # isnsadm create-dd-set operation-dd-set
440
441
442
443 Example 6 Displaying a Discovery Domain Set
444
445
446 The following use of the list-dd-set subcommand displays discovery
447 domain sets.
448
449
450 # isnsadm list-dd-set -v
451 DD Set name: Default
452 State: Disabled
453 DD Name: Default
454 DD Set name: operation-dd-set
455 State: Disabled
456
457
458
459 Example 7 Adding a Discovery Domain
460
461
462 The following use of the add-dd subcommand adds a discovery domain to a
463 discovery domain set.
464
465
466 # isnsadm add-dd -s operation-dd-set engineering-dd
467
468
469
470 Example 8 Displaying a Discovery Domain Set
471
472
473 The following use of the list-dd-set displays the attributes of a dis‐
474 covery domain set.
475
476
477 # isnsadm list-dd-set
478 DD Set name: Default
479 State: Disabled
480 DD Name: Default
481 DD Set name: operation-dd-set
482 State: Disabled
483 DD Name: engineering-dd
484
485
486
487 Example 9 Enabling a Discovery Domain Set
488
489
490 The following use of the enable-dd-set subcommand enables a discovery
491 domain set.
492
493
494 # isnsadm enable-dd-set Default
495
496
497
498 Example 10 Disabling a Discovery Domain Set
499
500
501 The following use of the disable-dd-set subcommand disables a discovery
502 domain set.
503
504
505 # isnsadm disable-dd-set Default
506
507
508
509 Example 11 Displaying Administrative Settings
510
511
512 The following use of the show-config subcommand displays current admin‐
513 istrative settings.
514
515
516 # isnsadm show-config
517 Data Store Location: /etc/isns/isnsdata.xml
518 Entity Status Inquiry Non-Response Threshold: 3
519 Management SCN Enabled: yes
520 Authorized Control Node Names: -
521
522
523
525 See attributes(5) for descriptions of the following attributes:
526
527
528
529
530 ┌─────────────────────────────┬─────────────────────────────┐
531 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
532 ├─────────────────────────────┼─────────────────────────────┤
533 │Availability │SUNWisnsadm │
534 ├─────────────────────────────┼─────────────────────────────┤
535 │Interface Stability │Volatile │
536 └─────────────────────────────┴─────────────────────────────┘
537
539 iscsiadm(1M), iscsitadm(1M), isns(1M), attributes(5), smf(5)
540
542 When a subcommand is invoked with multiple operands and there are fail‐
543 ures on one or more, but not all, operands, isnsadm displays a generic
544 message indicating partial failure, with list of failed operands. An
545 error on a specific operand can be found by issuing the same subcommand
546 on the failing operand.
547
548
549
550SunOS 5.11 25 Sep 2008 isnsadm(1M)