1 '\" te |
|
2 .\" CDDL HEADER START |
|
3 .\" |
|
4 .\" The contents of this file are subject to the terms of the |
|
5 .\" Common Development and Distribution License (the "License"). |
|
6 .\" You may not use this file except in compliance with the License. |
|
7 .\" |
|
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE |
|
9 .\" or http://www.opensolaris.org/os/licensing. |
|
10 .\" See the License for the specific language governing permissions |
|
11 .\" and limitations under the License. |
|
12 .\" |
|
13 .\" When distributing Covered Code, include this CDDL HEADER in each |
|
14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. |
|
15 .\" If applicable, add the following below this CDDL HEADER, with the |
|
16 .\" fields enclosed by brackets "[]" replaced with your own identifying |
|
17 .\" information: Portions Copyright [yyyy] [name of copyright owner] |
|
18 .\" |
|
19 .\" CDDL HEADER END |
|
20 .\" |
|
21 .\" Copyright 2010 Sun Microsystems, Inc. All rights reserved. |
|
22 .\" Use is subject to license terms. |
|
23 .\" |
|
24 System Administration Commands installadm(1M) |
1 System Administration Commands installadm(1M) |
25 |
2 |
26 NAME |
3 NAME |
27 installadm - Manages automated installations on a |
4 installadm - Manages automated installations on a |
28 network |
5 network |
41 |
18 |
42 installadm enable <svcname> |
19 installadm enable <svcname> |
43 |
20 |
44 installadm disable <svcname> |
21 installadm disable <svcname> |
45 |
22 |
46 installadm add -m <manifest> -n <svcname> |
23 installadm add-manifest -m <manifest> -n <svcname> |
47 |
24 [-c <criteria=value|range> ... | -C <criteria.xml>] |
48 installadm remove -m <manifest> -n <svcname> |
25 |
|
26 installadm delete-manifest -m <manifest> -n <svcname> |
|
27 |
|
28 installadm set-criteria -m <manifest> -n <svcname> |
|
29 -a|-c <criteria=value|range> ... | -C <criteria.xml> |
49 |
30 |
50 installadm create-client [-b <property>=<value>,...] |
31 installadm create-client [-b <property>=<value>,...] |
51 [-t <imagepath>] -e <macaddr> -n <svcname> |
32 [-t <imagepath>] -e <macaddr> -n <svcname> |
52 |
33 |
53 installadm delete-client <macaddr> |
34 installadm delete-client <macaddr> |
109 |
90 |
110 If you have clients with varying machine |
91 If you have clients with varying machine |
111 specifications, you can manually create or modify |
92 specifications, you can manually create or modify |
112 manifests so that the manifests cover those specific |
93 manifests so that the manifests cover those specific |
113 machine specifications. Then, you can use the |
94 machine specifications. Then, you can use the |
114 installadm add command to add your new manifests to an |
95 installadm add-manifest command to add your new manifests |
115 install service. |
96 to an install service. |
116 |
97 |
117 If you want a specific client to use a specific |
98 If you want a specific client to use a specific |
118 install service, you can associate a service to a |
99 install service, you can associate a service to a |
119 client by using the installadm create-client command. |
100 client by using the installadm create-client command. |
120 |
101 |
122 following tasks: |
103 following tasks: |
123 - Set up install services |
104 - Set up install services |
124 - Set up installation images |
105 - Set up installation images |
125 - Set up or remove clients |
106 - Set up or remove clients |
126 - Add or delete manifests |
107 - Add or delete manifests |
|
108 - Specify or modify criteria for a manifest |
127 - Enable or disable install services |
109 - Enable or disable install services |
128 - List install services |
110 - List install services |
129 - List manifests for an install service |
111 - List manifests for an install service |
130 |
112 |
131 |
113 |
283 Required: Specifies the name of the install |
265 Required: Specifies the name of the install |
284 service to be disabled. |
266 service to be disabled. |
285 |
267 |
286 |
268 |
287 |
269 |
288 installadm add -m <manifest> -n <svcname> |
270 installadm add-manifest -m <manifest> -n <svcname> |
|
271 [-c <criteria=value|range> ... | -C <criteria.xml>] |
289 |
272 |
290 Associates manifests with a specific install |
273 Associates manifests with a specific install |
291 service, thus making the manifests available on |
274 service, thus making the manifests available on |
292 the network, independently from creating a |
275 the network, independently from creating a |
293 service. |
276 service. When publishing a non-default manifest, |
|
277 it is required to associate criteria either via |
|
278 criteria entered on the command line (-c) or |
|
279 via a criteria XML file (-C). |
294 |
280 |
295 -m <manifest> |
281 -m <manifest> |
296 Required: Specifies the path name to a criteria |
282 Required: Specifies the path name to a criteria |
297 manifest. |
283 manifest. |
298 |
284 |
310 the -n option was not used to provide a custom |
296 the -n option was not used to provide a custom |
311 name for the install service, then the install |
297 name for the install service, then the install |
312 service name will be "_install_service_46510." |
298 service name will be "_install_service_46510." |
313 |
299 |
314 |
300 |
315 installadm remove -m <manifest> -n <svcname> |
301 -c <-c <criteria=value|range> ...> |
316 |
302 Optional: Specifies criteria to be associated with the |
317 Remove a manifest that was published with a |
303 added non-default manifest. When publishing a default |
|
304 manifest, criteria must not be specified. When |
|
305 publishing a non-default manifest, criteria must be |
|
306 specified. |
|
307 |
|
308 -C <criteria.xml> |
|
309 Optional: Specifies the path name of a criteria |
|
310 XML file containing criteria to be associated with the |
|
311 added non-default manifest. When publishing a default |
|
312 manifest, criteria must not be specified. When |
|
313 publishing a non-default manifest, criteria must be |
|
314 specified. |
|
315 |
|
316 |
|
317 installadm delete-manifest -m <manifest> -n <svcname> |
|
318 |
|
319 Deletes a manifest that was published with a |
318 specific install service. |
320 specific install service. |
319 |
321 |
320 -m <manifest> |
322 -m <manifest> |
321 Required: Specifies the name of an AI manifest |
323 Required: Specifies the name of an AI manifest |
322 as output by installadm list with -n option. |
324 as output by installadm list with -n option. |
324 -n <svcname> |
326 -n <svcname> |
325 Required: Specifies the name of the install |
327 Required: Specifies the name of the install |
326 service this manifest is associated with. |
328 service this manifest is associated with. |
327 |
329 |
328 |
330 |
|
331 installadm set-criteria -m <manifest> -n <svcname> |
|
332 -a|-c <criteria=value|range> ... | -C <criteria.xml> |
|
333 |
|
334 Updates criteria of an already published manifest. |
|
335 Criteria can be specified via the command line or |
|
336 or via a criteria xml file. Criteria must be |
|
337 specified with one of the mutually exclusive |
|
338 options, -a, -c, or -C. |
|
339 |
|
340 -m <manifest> |
|
341 Required: Specifies the name of a manifest. |
|
342 |
|
343 -n <svcname> |
|
344 Required: Specifies the name of the install |
|
345 service this manifest is associated with. |
|
346 |
|
347 -c <-c <criteria=value|range> ...> |
|
348 Optional: Specifies criteria to replace all existing |
|
349 criteria for the manifest. |
|
350 |
|
351 -a <-a <criteria=value|range> ...> |
|
352 Optional: Specifies criteria to be appended to the |
|
353 existing criteria for the manifest. If the criteria |
|
354 specified already exists, the value/range of that |
|
355 criteria is replaced by the specified value/range. |
|
356 |
|
357 -C <criteria.xml> |
|
358 Optional: Specifies the path name of a criteria |
|
359 XML file containing criteria to replace all existing |
|
360 criteria for the manifest. |
329 |
361 |
330 installadm create-client [-b <property>=<value>,...] |
362 installadm create-client [-b <property>=<value>,...] |
331 [-t <imagepath>] -e <macaddr> -n <svcname> |
363 [-t <imagepath>] -e <macaddr> -n <svcname> |
332 |
364 |
333 Accomplishes optional setup tasks for a specified |
365 Accomplishes optional setup tasks for a specified |
378 <subcommand> |
410 <subcommand> |
379 |
411 |
380 If subcommand is provided, the command provides |
412 If subcommand is provided, the command provides |
381 the syntax for that subcommand. |
413 the syntax for that subcommand. |
382 |
414 |
383 |
415 CRITERIA FILES |
384 |
416 |
385 |
417 A criteria XML file allows you to specify criteria for a |
|
418 manifest by passing the file to the add-manifest or |
|
419 set-criteria commands. Criteria can be specified as a |
|
420 value or a range, by using the following tags. |
|
421 |
|
422 For a criterion with a specific value: |
|
423 |
|
424 <ai_criteria_manifest> |
|
425 <ai_criteria name=XXXX> |
|
426 <value>yyyy</value> |
|
427 </ai_criteria> |
|
428 </ai_criteria_manifest> |
|
429 |
|
430 where XXXX is the name of the criterion (e.g. MAC, IPV4, |
|
431 MEM, or ARCH) and yyyy is the value of the criterion. |
|
432 |
|
433 For a criterion with a range: |
|
434 |
|
435 <ai_criteria_manifest> |
|
436 <ai_criteria name=XXXX> |
|
437 <range> |
|
438 yyyy1 |
|
439 yyyy2 |
|
440 </range> |
|
441 </ai_criteria> |
|
442 </ai_criteria_manifest> |
|
443 |
|
444 where XXXX is the name of the criterion (e.g. MAC, IPV4, |
|
445 or MEM) and yyyy1 and yyyy2 are the lower and uppper |
|
446 bounds of the range. |
|
447 |
|
448 Multiple criteria may be specified in the file between |
|
449 the <ai_criteria_manifest> and </ai_criteria_manifest> |
|
450 tags. |
|
451 |
386 EXAMPLES |
452 EXAMPLES |
387 |
453 |
388 |
454 |
389 Example 1: Set up an install server and an install |
455 Example 1: Set up an install server and an install |
390 service for the first time. The command includes a |
456 service for the first time. The command includes a |
505 |
571 |
506 Example 3: Use the following sample command |
572 Example 3: Use the following sample command |
507 to add a new custom manifest to an existing install |
573 to add a new custom manifest to an existing install |
508 service: |
574 service: |
509 |
575 |
510 # installadm add -m criteria_mac.xml \ |
576 # installadm add-manifest -m criteria_mac.xml \ |
511 -n service_032509 |
577 -n service_032509 |
512 |
578 |
513 The command assigns the manifest, criteria_mac.xml |
579 The command assigns the manifest, criteria_mac.xml |
514 to the install service, service_032509. |
580 to the install service, service_032509. |
515 |
581 |
573 mem = 2048 MB |
639 mem = 2048 MB |
574 .fi |
640 .fi |
575 .in -9 |
641 .in -9 |
576 .sp |
642 .sp |
577 |
643 |
|
644 Example 7: Use the following sample command to add manifest1 |
|
645 to svc1 with a criteria of MAC address equaling |
|
646 "aa:bb:cc:dd:ee:ff": |
|
647 |
|
648 # installadm add-manifest -m manifest1 -n svc1 |
|
649 -c MAC="aa:bb:cc:dd:ee:ff" |
|
650 |
|
651 Example 8: Use the following sample command to add manifest2 |
|
652 to svc1 with a criteria of an IPv4 range between 10.0.2.100 |
|
653 to 10.0.2.199: |
|
654 |
|
655 # installadm add-manifest -m manifest2 -n svc1 |
|
656 -c IPV4="10.0.2.100-10.0.2.199" |
|
657 |
|
658 Example 9: Use the following sample command to add manifest3 |
|
659 to svc1 with a criteria of 2048MB memory or greater and an |
|
660 architecture of i86pc: |
|
661 |
|
662 # installadm add-manifest -m manifest3 -n svc1 |
|
663 -c MEM="2048-unbounded" -c ARCH=i86pc |
|
664 |
|
665 Example 10: Use the following sample command to append to |
|
666 the criteria of manifest2 of svc1, a criterion of 4096MB |
|
667 memory or greater: |
|
668 |
|
669 # installadm set-criteria -m manifest2 -n svc1 |
|
670 -a MEM="4096-unbounded" |
|
671 |
|
672 Example 11: Use the following sample command to replace the |
|
673 criteria of manifest2 of svc1 with the criteria specified by |
|
674 the file, /tmp/criteria.xml: |
|
675 |
|
676 # installadm set-criteria -m manifest2 -n svc1 |
|
677 -C /tmp/criteria.xml |
|
678 |
|
679 See the CRITERIA FILES section for more information on the |
|
680 contents of the criteria xml file. |
|
681 |
578 ATTRIBUTES |
682 ATTRIBUTES |
579 See attributes(5) for descriptions of the following attri- |
683 See attributes(5) for descriptions of the following attri- |
580 butes: |
684 butes: |
581 ____________________________________________________________ |
685 ____________________________________________________________ |
582 | ATTRIBUTE TYPE | ATTRIBUTE VALUE | |
686 | ATTRIBUTE TYPE | ATTRIBUTE VALUE | |
583 |_____________________________|_____________________________| |
687 |_____________________________|_____________________________| |
584 | Availability | SUNWinstalladm-tools | |
688 | Availability | install/installadm | |
585 |_____________________________|_____________________________| |
689 |_____________________________|_____________________________| |
586 | Interface Stability | None / Under Development | |
690 | Interface Stability | None / Under Development | |
587 |_____________________________|_____________________________| |
691 |_____________________________|_____________________________| |
588 |
692 |
589 |
693 |