--- a/usr/src/man/installadm.1m.txt Tue Aug 17 18:22:44 2010 -0400
+++ b/usr/src/man/installadm.1m.txt Fri Aug 20 11:31:18 2010 -0600
@@ -1,26 +1,3 @@
-'\" te
-.\" CDDL HEADER START
-.\"
-.\" 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]
-.\"
-.\" CDDL HEADER END
-.\"
-.\" Copyright 2010 Sun Microsystems, Inc. All rights reserved.
-.\" Use is subject to license terms.
-.\"
System Administration Commands installadm(1M)
NAME
@@ -43,9 +20,13 @@
installadm disable <svcname>
- installadm add -m <manifest> -n <svcname>
+ installadm add-manifest -m <manifest> -n <svcname>
+ [-c <criteria=value|range> ... | -C <criteria.xml>]
- installadm remove -m <manifest> -n <svcname>
+ installadm delete-manifest -m <manifest> -n <svcname>
+
+ installadm set-criteria -m <manifest> -n <svcname>
+ -a|-c <criteria=value|range> ... | -C <criteria.xml>
installadm create-client [-b <property>=<value>,...]
[-t <imagepath>] -e <macaddr> -n <svcname>
@@ -111,8 +92,8 @@
specifications, you can manually create or modify
manifests so that the manifests cover those specific
machine specifications. Then, you can use the
- installadm add command to add your new manifests to an
- install service.
+ installadm add-manifest command to add your new manifests
+ to an install service.
If you want a specific client to use a specific
install service, you can associate a service to a
@@ -124,6 +105,7 @@
- Set up installation images
- Set up or remove clients
- Add or delete manifests
+ - Specify or modify criteria for a manifest
- Enable or disable install services
- List install services
- List manifests for an install service
@@ -285,12 +267,16 @@
- installadm add -m <manifest> -n <svcname>
+ installadm add-manifest -m <manifest> -n <svcname>
+ [-c <criteria=value|range> ... | -C <criteria.xml>]
Associates manifests with a specific install
service, thus making the manifests available on
the network, independently from creating a
- service.
+ service. When publishing a non-default manifest,
+ it is required to associate criteria either via
+ criteria entered on the command line (-c) or
+ via a criteria XML file (-C).
-m <manifest>
Required: Specifies the path name to a criteria
@@ -312,9 +298,25 @@
service name will be "_install_service_46510."
- installadm remove -m <manifest> -n <svcname>
+ -c <-c <criteria=value|range> ...>
+ Optional: Specifies criteria to be associated with the
+ added non-default manifest. When publishing a default
+ manifest, criteria must not be specified. When
+ publishing a non-default manifest, criteria must be
+ specified.
- Remove a manifest that was published with a
+ -C <criteria.xml>
+ Optional: Specifies the path name of a criteria
+ XML file containing criteria to be associated with the
+ added non-default manifest. When publishing a default
+ manifest, criteria must not be specified. When
+ publishing a non-default manifest, criteria must be
+ specified.
+
+
+ installadm delete-manifest -m <manifest> -n <svcname>
+
+ Deletes a manifest that was published with a
specific install service.
-m <manifest>
@@ -326,6 +328,36 @@
service this manifest is associated with.
+ installadm set-criteria -m <manifest> -n <svcname>
+ -a|-c <criteria=value|range> ... | -C <criteria.xml>
+
+ Updates criteria of an already published manifest.
+ Criteria can be specified via the command line or
+ or via a criteria xml file. Criteria must be
+ specified with one of the mutually exclusive
+ options, -a, -c, or -C.
+
+ -m <manifest>
+ Required: Specifies the name of a manifest.
+
+ -n <svcname>
+ Required: Specifies the name of the install
+ service this manifest is associated with.
+
+ -c <-c <criteria=value|range> ...>
+ Optional: Specifies criteria to replace all existing
+ criteria for the manifest.
+
+ -a <-a <criteria=value|range> ...>
+ Optional: Specifies criteria to be appended to the
+ existing criteria for the manifest. If the criteria
+ specified already exists, the value/range of that
+ criteria is replaced by the specified value/range.
+
+ -C <criteria.xml>
+ Optional: Specifies the path name of a criteria
+ XML file containing criteria to replace all existing
+ criteria for the manifest.
installadm create-client [-b <property>=<value>,...]
[-t <imagepath>] -e <macaddr> -n <svcname>
@@ -380,9 +412,43 @@
If subcommand is provided, the command provides
the syntax for that subcommand.
+CRITERIA FILES
+ A criteria XML file allows you to specify criteria for a
+ manifest by passing the file to the add-manifest or
+ set-criteria commands. Criteria can be specified as a
+ value or a range, by using the following tags.
+
+ For a criterion with a specific value:
+
+ <ai_criteria_manifest>
+ <ai_criteria name=XXXX>
+ <value>yyyy</value>
+ </ai_criteria>
+ </ai_criteria_manifest>
+
+ where XXXX is the name of the criterion (e.g. MAC, IPV4,
+ MEM, or ARCH) and yyyy is the value of the criterion.
+ For a criterion with a range:
+ <ai_criteria_manifest>
+ <ai_criteria name=XXXX>
+ <range>
+ yyyy1
+ yyyy2
+ </range>
+ </ai_criteria>
+ </ai_criteria_manifest>
+
+ where XXXX is the name of the criterion (e.g. MAC, IPV4,
+ or MEM) and yyyy1 and yyyy2 are the lower and uppper
+ bounds of the range.
+
+ Multiple criteria may be specified in the file between
+ the <ai_criteria_manifest> and </ai_criteria_manifest>
+ tags.
+
EXAMPLES
@@ -507,7 +573,7 @@
to add a new custom manifest to an existing install
service:
- # installadm add -m criteria_mac.xml \
+ # installadm add-manifest -m criteria_mac.xml \
-n service_032509
The command assigns the manifest, criteria_mac.xml
@@ -575,13 +641,51 @@
.in -9
.sp
+ Example 7: Use the following sample command to add manifest1
+ to svc1 with a criteria of MAC address equaling
+ "aa:bb:cc:dd:ee:ff":
+
+ # installadm add-manifest -m manifest1 -n svc1
+ -c MAC="aa:bb:cc:dd:ee:ff"
+
+ Example 8: Use the following sample command to add manifest2
+ to svc1 with a criteria of an IPv4 range between 10.0.2.100
+ to 10.0.2.199:
+
+ # installadm add-manifest -m manifest2 -n svc1
+ -c IPV4="10.0.2.100-10.0.2.199"
+
+ Example 9: Use the following sample command to add manifest3
+ to svc1 with a criteria of 2048MB memory or greater and an
+ architecture of i86pc:
+
+ # installadm add-manifest -m manifest3 -n svc1
+ -c MEM="2048-unbounded" -c ARCH=i86pc
+
+ Example 10: Use the following sample command to append to
+ the criteria of manifest2 of svc1, a criterion of 4096MB
+ memory or greater:
+
+ # installadm set-criteria -m manifest2 -n svc1
+ -a MEM="4096-unbounded"
+
+ Example 11: Use the following sample command to replace the
+ criteria of manifest2 of svc1 with the criteria specified by
+ the file, /tmp/criteria.xml:
+
+ # installadm set-criteria -m manifest2 -n svc1
+ -C /tmp/criteria.xml
+
+ See the CRITERIA FILES section for more information on the
+ contents of the criteria xml file.
+
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
- | Availability | SUNWinstalladm-tools |
+ | Availability | install/installadm |
|_____________________________|_____________________________|
| Interface Stability | None / Under Development |
|_____________________________|_____________________________|
@@ -600,5 +704,5 @@
getstart/
- Last Changed March 4, 2010
+ Last Changed August 17, 2010