Maintain an Install Server

After you have set up an AI install server, you might want to perform some of the following tasks. For complete information, see the installadm(1M) man page.

Add, Modify, or Delete an Install Service
Associate Clients With Install Services
Associate Client-Specific Installation Instructions With Install Services
List All Install Services on the Install Server
List Clients Associated With Install Services
List All AI Manifests and System Configuration Profiles

Add, Modify, or Delete an Install Service

You need a separate install service for each different client architecture that you plan to install and for each different version of the Oracle Solaris 11 OS that you plan to install on client systems.

Create an Install Service

Use the following command to create an install service. See Create an AI Install Service for examples.

installadm create-service [-n svcname] [-s FMRI_or_ISO]
    [-p prefix=origin] [-a architecture]
    [-d imagepath] [-y] [-t existing_service]
    [-i dhcp_ip_start] [-c count_of_ipaddr]
    [-b boot_property=value,...] [-B server_ipaddr]

-n svcname

The svcname can consist of alphanumeric characters, underscores (_), and hyphens (-). The first character of svcname cannot be a hyphen. If you do not provide a name for the install service, a default name is assigned.

-s FMRI_or_ISO

This option specifies the source of the net boot image. The FMRI is the identifier of the IPS AI net image package, which is install-image/solaris-auto-install in the Oracle Solaris 11 release. If you are using an AI net image ISO file, specify the path name of the net image ISO file.

If you do not specify FMRI_or_ISO, the newest version of the install-image/solaris-auto-install package is installed from the first publisher in the pkg publisher list that provides that package.

To install a different version of the package, or to install the package from a different publisher, specify the version or publisher in the FMRI. For example, specify pkg://publisher/install-image/solaris-auto-install or pkg://publisher/install-image/solaris-auto-install@version. Use the -p option to specify the particular package repository.

-p prefix=origin

This option specifies the IPS package repository from where you want to retrieve install-image/solaris-auto-install package. The prefix is the publisher name and the origin is the URI, as in solaris=http://pkg.oracle.com/solaris/release/.

If -s and -p are not specified, then the newest version of the install-image/solaris-auto-install package is installed from the first publisher in the pkg publisher list that provides that package.

-a architecture

This option is used only when the net image source is an IPS package. The architecture specifies the architecture of the clients to be installed. You can specify either i386 or sparc.

When creating a service from an IPS package, the variant of the package that is installed by default is the variant that matches the architecture of the system where the service is created. For example, if your AI install server is x86, the variant of the solaris-auto-install package that create-service installs by default is the i386 variant. If you are creating a service to install SPARC clients, specify -a sparc to install the sparc variant of the solaris-auto-install package in the install service.

-d imagepath

The imagepath is the location of the new install service. If you do not specify imagepath, the service is created at /export/auto_install/svcname, and you are prompted to confirm that you want to use the automatically generated location. Specify the -y option to suppress this prompt.

-y

Specify the -y option to suppress the prompt to confirm using an automatically generated imagepath.

-t existing_service

Designates the new service as an alias, which shares the net image of the existing_service service but has its own manifests, profiles, and clients.

-i dhcp_ip_start

This option specifies the starting IP address in a range to be added to the local DHCP configuration. The number of IP addresses is provided by the -c option. If a local ISC DHCP configuration does not exist, an ISC DHCP server is started.

-c count_of_ipaddr

Sets up a total number of IP addresses in the DHCP configuration equal to the value of the count_of_ipaddr. The first IP address is the value of dhcp_ip_start that is provided by the -i option.

-b boot_property=value,...

For x86 services only. This option sets a property value in the service-specific menu.lst file in the service image. Use this option to set boot properties that are specific to this service. This option can accept multiple comma-separated boot_property=value pairs.

-B server_ipaddr

Use this option to provide the IP address of the boot server from which clients should request boot files. This option is required only if this IP address cannot be determined by other means.

Modifying Install Service Properties

Use the installadm set-service command to specify a property and value to set for the svcname install service.

installadm set-service -o prop=value svcname

The prop=value pair must be one of the following:

aliasof=another_svcname

Changes the install service that the svcname service is an alias of.

Setting this property changes the svcname service to be an alias of the another_svcname service. The svcname service must already be an alias. The default-arch install services are aliases. A service created using the -t option of create-service is an alias. Use the installadm list command as shown in List All Install Services on the Install Server to confirm that svcname is an alias.

Manifests, profiles, and client bindings that were added to either svcname or another_svcname remain the same after resetting the alias. The only change is which net image the svcname service uses.

Manifests and profiles that were added to svcname prior to setting the alias are revalidated when the alias is reset since the AI and SMF DTDs associated with the new net image could be different. This validation is the same validation that is performed by create-manifest and create-profile, described below.

default-manifest=manifest_or_script_name

Designates a particular manifest or script that is already registered with a given service to be the default manifest or script for that service. Use the following command to show a list of manifests and scripts registered with this service.

$ installadm list -n svcname -m

Rename an Install Service

Use the following command to rename svcname to newsvcname.

installadm rename-service svcname newsvcname

The newsvcname can consist of alphanumeric characters, underscores (_), and hyphens (-). The first character of newsvcname cannot be a hyphen.

Enable or Disable an Install Service

Use the following command to enable the svcname install service.

installadm enable svcname

Use the following command to disable the svcname install service.

installadm disable svcname

Delete an Install Service

Use the following command to delete the svcname install service.

installadm delete-service [-r] [-y] svcname

This command deletes the AI manifests and system configuration profiles, the net image, and the web server configuration for the svcname install service. If the service is a default alias and a local ISC DHCP configuration exists, the boot file associated with this service is removed from the ISC DHCP configuration.

Use the -r option to remove any clients associated with this service and any services aliased to this service. Use the -y option to suppress confirmation prompts.

Associate Clients With Install Services

The installadm create-client command associates a client with a specific install service. See Setting Up an Install Client for more examples and sample output.

Add a Client To an Install Service

Use the installadm create-client command to associate the macaddr client with the svcname install service and provide custom client settings for x86 clients. To find the MAC address of a system, use the dladm command as described in Oracle Solaris Administration: Network Interfaces and Network Virtualization and in the dladm(1M) man page.

installadm create-client [-b property=value,...]
    -e macaddr -n svcname

If the client is an x86 system and a local ISC DHCP configuration exists, the client is configured in the ISC DHCP configuration.

For x86 client systems, use the -b option to set boot properties in the client-specific menu.lst file in /etc/netboot.

The following command adds the client with MAC address 00:14:4f:a7:65:70 to the s11-sparc install service.

# installadm create-client -e 00:14:4f:a7:65:70 -n s11-sparc

The following example adds an x86 client and redirects installation output to a serial console.

# installadm create-client -e c0ffeec0ffee -n s11-x86 -b 'console=ttya'

Associate a Client With a Different Install Service

A client can be associated with only one install service. If you run the installadm create-client command more than once and specify the same MAC address each time, that client is associated only with the install service that was specified last.

Delete a Client From an Install Service

Use the installadm delete-client command to delete the macaddr client from its associated install service.

installadm delete-client macaddr

If the client is an x86 system and a local ISC DHCP configuration exists, the client is unconfigured in the ISC DHCP configuration.

The following command deletes the client with MAC address 00:14:4f:a7:65:70. You do not need to specify the service name since a client can be associated with only one install service.

# installadm delete-client 00:14:4f:a7:65:70

Associate Client-Specific Installation Instructions With Install Services

You can specify multiple sets of installation instructions for each install service, and you can specify which instruction set to use for each client.

Add an AI Manifest

Use the installadm create-manifest command to add the manifest_or_script_filename custom AI manifest to the svcname install service.

installadm create-manifest -n svcname
    -f manifest_or_script_filename [-m manifest_or_script_name]
    [-c criteria=value|list|range...
    | -C criteriafile] [-d]

The manifest_or_script_filename can be an AI manifest XML file, or it can be a derived manifests script. See Chapter 10, Provisioning the Client System. The create-manifest subcommand validates XML manifest files before adding them to the install service. To validate derived manifests script files, use the aimanifest validate command as shown in Add a Derived Manifests Script To an Install Service.

The manifest_or_script_name is the name displayed by the installadm list command. See List All AI Manifests and System Configuration Profiles. If manifest_or_script_name is not provided, the manifest_or_script_name is the value of the name attribute of the ai_instance element, if present, or the base name of the manifest_or_script_filename.

Use the -d option to make this AI manifest the default AI manifest. The default manifest is the manifest used by any clients that do not match criteria specified for any other manifests in this install service. If -d is specified, then -c and -C are ignored for the purpose of manifest selection. The previous default AI manifest for this service becomes inactive if it has no client criteria. If the previous default manifest has criteria, it remains active and its associated criteria become effective.

If -d is not specified, then either -c or -C must be specified to define which clients should use this AI manifest to complete their installation. If -d, -c, and -C are all not specified, then this manifest is added to the service but is inactive: No clients can use it.

If you want certain clients to use this AI manifest, first make sure those clients will use the install service specified in this create-manifest command. Any client systems that have not been explicitly associated with a particular install service by using the create-client command will use the appropriate default-arch install service. You can add customized AI manifests to the default-arch install service, or you can add customized AI manifests to a different service and then use create-client to make sure clients use that service.

The -c option specifies client selection criteria on the command line. The -C option specifies criteria in an XML file. The value of criteriafile is a full path and file name. See Chapter 9, Customizing Installations for a list of criteria keywords with command line and file examples.

The installadm create-manifest command verifies that criteria of the same type do not overlap. For example, if one criteria specification matches IP addresses from 10.0.0.0 to 10.255.255.255, installadm exits with an error if you try to add a criteria specification that matches IP address 10.10.10.10. For more information about criteria specifications, see Chapter 9, Customizing Installations.

The following command adds the manifest_t200.xml manifest to the s11-sparc install service. The -c option specifies that any clients that are using this install service and identify themselves as Sun Fire T200 servers are assigned the manifest_t200.xml installation instructions.

# installadm create-manifest -f ./mymanifests/manifest_t200.xml \
-m t200 -n s11-sparc -c platform="SUNW,Sun-Fire-T200"

The following command is equivalent to the preceding command if the content of the criteria_t200.xml file is as shown.

# installadm create-manifest -f ./mymanifests/manifest_t200.xml \
-m t200 -n s11-sparc -C ./mymanifests/criteria_t200.xml

Following is the content of the criteria_t200.xml file.

<ai_criteria_manifest>
    <ai_criteria name="platform">
        <value>SUNW,Sun-Fire-T200</value>
    </ai_criteria>
</ai_criteria_manifest>

Update an AI Manifest

Use the installadm update-manifest command to replace the contents of the manifest_or_script_name AI manifest with the manifest_or_script_filename AI manifest for the svcname install service. Criteria, default status, and manifest_or_script_name are not changed as a result of the update.

installadm update-manifest -n svcname
    -f manifest_or_script_filename [-m manifest_or_script_name]

The update-manifest subcommand validates XML manifest files before adding them to the install service. To validate derived manifests script files, use the aimanifest validate command as shown in Add a Derived Manifests Script To an Install Service.

The manifest_or_script_name manifest must already exist in the svcname service. Use the installadm list command to confirm. See List All AI Manifests and System Configuration Profiles.

If manifest_or_script_name is not specified, then the manifest that is replaced is identified in one of the following ways:

The name attribute of the ai_instance element in the manifest_or_script_filename manifest, if this attribute is specified and if the value of this attribute matches the manifest_or_script_name of an existing manifest for this install service.
The base name of the manifest_or_script_filename manifest if this name matches the manifest_or_script_name of an existing manifest for this install service.

The following command updates the content of the t200 manifest in the s11-sparc service with the content of ./mymanifests/manifest_newt200.xml. The name of the manifest in installadm list is still t200.

# installadm update-manifest -n s11-sparc \
-f ./mymanifests/manifest_newt200.xml -m t200

Delete an AI Manifest

Use the installadm delete-manifest command to remove the manifest_or_script_name AI manifest from the svcname install service. The manifest_or_script_name is the manifest name that the installadm list command returns. See List All AI Manifests and System Configuration Profiles.

installadm delete-manifest -m manifest_or_script_name -n svcname

You cannot delete the default AI manifest.

The following command removes the t200 AI manifest from the s11-sparc install service.

# installadm delete-manifest -m t200 -n s11-sparc

Associate Client-Specific Configuration Instructions With Install Services

You can specify multiple sets of system configuration instructions for each install service. Multiple system configuration profiles can be associated with each client.

Add a System Configuration Profile

Use the installadm create-profile command to add the profile_filename system configuration profile to the svcname install service.

installadm create-profile -n svcname
    -f profile_filename... [-p profile_name]
    [-c criteria=value|list|range... | -C criteriafile]

Multiple system configuration profiles can be specified in one create-profile command because a single client can use multiple configuration profiles. The same client selection criteria, or overlapping criteria, or no criteria can be specified for multiple profiles. When no criteria are specified, the profile is used by all clients that use this install service.

The create-profile subcommand validates system configuration profiles before adding them to the install service. To validate profiles under development, see the validate subcommand below.

The profile_filename can contain replacement tags that get their values from criteria specified in the create-profile command or from environment variables. See Chapter 11, Configuring the Client System.

The profile_name is the name displayed by the installadm list command. See List All AI Manifests and System Configuration Profiles. If profile_name is not provided, the profile_name is the base name of the profile_filename. The -p option is not valid when more than one profile_filename is specified.

If you want certain clients to use this system configuration profile, first make sure those clients will use the install service specified in this create-profile command. Any client systems that have not been explicitly associated with a particular install service by using the create-client command will use the appropriate default-arch install service. You can add customized system configuration profiles to the default-arch install service, or you can add customized configuration profiles to a different service and then use create-client to make sure clients use that service.

The following command adds the profile_t200.xml profile to the s11-sparc install service. The -c option specifies that any clients that are using this install service and identify themselves as Sun Fire T200 servers are assigned the profile_t200.xml system configuration instructions.

# installadm create-profile -f ./mymanifests/profile_t200.xml \
-p t200 -n s11-sparc -c platform="SUNW,Sun-Fire-T200"

Validate a System Configuration Profile

Use the installadm validate command to validate system configuration profiles for syntactic correctness.

installadm validate -n svcname -P profile_filename... | -p profile_name...

Use the -P option to validate profiles that have not been added to the install service. The profile_filename is a full path name to the file.

Use the -p option to validate profiles that have already been added to the svcname install service using the create-profile subcommand as shown in List All AI Manifests and System Configuration Profiles. The create-profile subcommand validates system configuration profiles before adding them to the install service. The validate -p subcommand verifies that the profile has not become corrupted since it was added.

The svcname is required for both profile_filename and profile_name profiles. The service name is required for profiles that have not yet been added to an install service because the service_bundle(4) DTD might be different in different versions of the OS. An install service might be defined to install a different version of the OS than the version your install server is running. The profile must be validated against the DTD that will be in use on the client being installed.

Validated profiles are output to stdout. Errors are listed to stderr.

Delete a System Configuration Profile

Use the installadm delete-profile command to remove the profile_name system configuration profile from the svcname install service. The profile_name is the profile name that the installadm list command returns. See List All AI Manifests and System Configuration Profiles.

installadm delete-profile -p profile_name... -n svcname

The following command removes the t200 system configuration profile from the s11-sparc install service.

# installadm delete-profile -p t200 -n s11-sparc

Export an AI Manifest or a System Configuration Profile

Use the installadm export command to copy the contents of the specified AI manifests or system configuration profiles from the svcname install service to the pathname file or directory.

installadm export -n svcname
    -m manifest_or_script_name... -p profile_name...
    [-o pathname]

If pathname is not specified, the manifest and profile contents go to stdout. If only one input file is specified, pathname can be a file name. If more than one input file is specified, pathname must be a directory.

The manifest_or_script_name can be an XML AI manifest or a derived manifests script. See Chapter 10, Provisioning the Client System for information about creating manifests and derived manifests scripts.

Use the installadm export command to:

Check the specifications in the manifests and profiles.
Modify an existing manifest or profile. Use an existing manifest or profile as a base for creating a new manifest or profile.

Modify Criteria for an AI Manifest or a System Configuration Profile

Use the installadm set-criteria command to update the client criteria associated with an AI manifest or system configuration profiles that you already added to the svcname install service using create-manifest or create-profile.

installadm set-criteria -m manifest_or_script_name -p profile_name... -n svcname
    -c criteria=value|list|range... | -C criteriafile |
    -a criteria=value|list|range...

Zero or one manifest can be specified along with zero or any number of profiles on the same set-criteria command line. The manifest_or_script_name and profile_name names are the names that the installadm list command returns. See List All AI Manifests and System Configuration Profiles.

Use the -c or -C options to replace the criteria for these existing manifests and profiles with the new criteria specified. Use the -a option to retain the existing criteria and add the specified criteria. See Chapter 9, Customizing Installations for more information about specifying criteria.

The following command adds a memory criteria specification to a manifest that was originally added to this service with a platform criteria specification.

# installadm set-criteria -m t200 -n s11-sparc -a mem="4096-unbounded"

The result of the criteria specified with create-manifest and added with set-criteria is that the manifest is used by any client that is using this install service that is a Sun Fire T200 server and that has at least 4 Gbytes of memory.

You could achieve this same result by using the -C option instead of the -a option with the following criteria_t200.xml file.

<ai_criteria_manifest>
    <ai_criteria name="platform">
        <value>SUNW,Sun-Fire-T200</value>
    </ai_criteria>
    <ai_criteria name="mem">
        <range>
            4096
            unbounded
        </range>
    </ai_criteria>
</ai_criteria_manifest>

Show Information About Install Services

Use the installadm list command to show information about install services.

installadm list [-n svcname] [-c] [-m] [-p]

List All Install Services on the Install Server

The following command displays all of the install services on this server. In this example, two enabled install services are found. Disabled services have a Status value of off. Recall that the first service created for a given architecture is the default service for clients of that architecture. See Add, Modify, or Delete an Install Service.

$ installadm list

Service Name  Alias Of  Status Arch  Image Path
------------  --------  ------ ----  ----------
default-i386  s11-x86   on     x86   /install/images/s11_x86
default-sparc s11-sparc on     Sparc /install/images/s11_sparc
s11-sparc               on     Sparc /install/images/s11_sparc
s11-x86                 on     x86   /install/images/s11_x86

Show Information for a Specified Install Service

The following command displays information about the install service specified by the -n option:

$ installadm list -n s11-sparc

Service Name  Alias Of  Status Arch  Image Path
------------  --------  ------ ----  ----------
s11-sparc               on     Sparc /install/images/s11_sparc

List Clients Associated With Install Services

The following command lists all the clients that are associated with the install services on this install server. The clients were associated with the install services by using the installadm create-client command. See Add a Client To an Install Service.

$ installadm list -c

Service Name Client Address    Arch  Image Path
------------ --------------    ----  ----------
s11-sparc    00:14:4F:A7:65:70 Sparc /install/images/s11_sparc
s11-x86      08:00:27:8B:BD:71 x86   /install/images/s11_x86
             01:C2:52:E6:4B:E0 x86   /install/images/s11_x86

List Clients Associated With a Specific Install Service

The following command lists all the clients that have been added to the specified install service. In the following example, one client is associated with the s11-sparc install service.

$ installadm list -c -n s11-sparc

Service Name Client Address    Arch  Image Path
------------ --------------    ----  ----------
s11-sparc    00:14:4f:a7:65:70 Sparc /install/images/s11_sparc

Show Information About Customized Installations

The commands in this section show which AI manifests and system configuration profiles are associated with a particular install service. These commands also show which client criteria are associated with each manifest and profile.

List All AI Manifests and System Configuration Profiles

The following command lists all AI manifests, derived manifests scripts, and system configuration profiles for all install services on this install server. The Manifest/Profile column displays the internal name of the manifest, script, or profile.

# installadm list -m -p

Service Name  Manifest
------------  --------
s11-sparc     t200
s11-x86       ipv4
              mem1

Service Name  Profile
------------  --------
s11-sparc     mac1
              t200
s11-x86       mac2
              mac3
              ipv4
              mem1

List Manifests and Profiles Associated With a Specified Install Service

The following example shows all AI manifests, derived manifests scripts, and system configuration profiles associated with the install service s11-sparc. The Manifest/Profile column displays the internal name of the manifest, script, or profile. The Criteria column shows the associated client criteria.

The orig_default manifest is the original default AI manifest that was part of the install service when the install service was created. The mem1 manifest was created with memory criteria and also with the -d option to make it the new default manifest for this service. Because mem1 is the default manifest, its criteria are ignored. If another manifest is created as the default manifest, then the mem1 criteria are used to select clients to use this manifest. The original default manifest is inactive because it has no associated criteria to determine which clients should use it. Only the default manifest can have no associated criteria. A client that does not match the criteria to use any other manifest uses the default manifest. See Chapter 9, Customizing Installations for more information about selecting an AI manifest.

# installadm list -m -p -n s11-sparc

Manifest      Status    Criteria
--------      ------    --------
orig_default  Inactive  None
mem1          Default   (Ignored: mem = 2048 - 4095)
t200                    platform = SUNW,Sun-Fire-T200
                        mem = 4096-unbounded

Profile  Criteria
-------  --------
mac1     mac  = 01:C2:52:E6:4B:E0
         hostname = server1
         ipv4 = 192.168.168.251
t200     platform = SUNW,Sun-Fire-T200
         mem = 4096-unbounded

Administering the AI SMF Service

On the AI server, the SMF service svc:/system/install/server:default is the service that represents the overall state of the AI server application and all install services.

Example 8-2 Enabling the AI SMF Service

The AI SMF service is enabled when you run the installadm create-service command. The AI SMF service also is enabled when you run any other installadm command that affects existing install services. To manually enable the AI SMF service, run the following command:

# svcadm enable svc:/system/install/server:default

The AI SMF service goes into maintenance mode if no install services are currently enabled on the install server or if a problem occurs that requires attention.

Example 8-3 Disabling the AI SMF Service

To disable the AI SMF service, run the following command:

# svcadm disable svc:/system/install/server:default

Do not disable the AI SMF service if any AI install service is still enabled. See List All Install Services on the Install Server for information about how to see whether any install services are enabled.

Skip Navigation Links
Exit Print View
	Installing Oracle Solaris 11 Systems Oracle Solaris 11 Information Library