Solaris Flash keywords are like custom JumpStart keywords. They define elements of the installation. Each keyword is a command that controls one aspect of how the Solaris Flash software installs the software on a clone system.
Use the following guidelines to format keywords and values:
Keywords and values are separated by a single equal sign with only one pair per line
Keywords are case insensitive
Individual lines can be any length
Each Solaris Flash archive section is defined by the section_begin and section_end keywords. For example, the archive files section includes a section_begin keyword, though with a different value. User-defined archive sections are delimited by section_begin and section_end keywords, with values appropriate to each section. The values for the section_begin and section_end keywords are described in the following table.
Table 23–2 Values for section_begin and section_end Keywords
Archive Section |
Value for section_begin and section_end keywords |
---|---|
Archive cookie |
cookie — This section is not delimited by the section_begin and section_end keywords. |
Archive identification |
identification |
User-defined sections |
section_name An example of a section_name keyword is X-user_section_1. |
Archive files |
archive |
The following tables describe the keywords for use in the Archive Identification section and the values you can define for them.
Every section uses the keywords in Table 23–3 to delimit each section.
Table 23–3 Identification Section Keywords: General Keywords
Keywords |
Value Definitions |
Value |
Required |
---|---|---|---|
section_begin section_end |
These keywords are used to delimit sections in the archive and are not limited exclusively to the identification section. For a description of these keywords, see General Keywords. |
Text |
Yes |
The following keywords, used in the archive identification section, describe the contents of the archive files section.
Table 23–4 Identification Section Keywords: Contents of Archive Files Section
The following keywords provide descriptive information about the entire archive. These keywords are generally used to assist you in archive selection and to aid in archive management. These keywords are all optional and are used to help you to distinguish between individual archives. You use options for the flar create command to include these keywords. For an example, see Example 21–12.
Table 23–5 Identification Section Keywords: User Describes the Archive
The following keywords also describe the entire archive. By default, the values are filled in by uname when the flash archive is created. If you create a flash archive in which the root directory is not /, the archive software inserts the string UNKNOWN for the keywords. The exceptions are the creation_node, creation_release, and creation_os_name keywords.
For creation_node, the software uses the contents of the nodename file.
For creation_release and creation_os_name, the software attempts to use the contents of root directory /var/sadm/system/admin/INST_RELEASE. If the software is unsuccessful in reading this file, it assigns the value UNKNOWN.
Regardless of their sources, you cannot override the values of these keywords.
Table 23–6 Identification Section Keywords: Software Describes the Archive
Keyword |
Value |
---|---|
creation_node |
The return from uname -n |
creation_hardware_class |
The return from uname -m |
creation_platform |
The return from uname -i |
creation_processor |
The return from uname -p |
creation_release |
The return fromuname -r |
creation_os_name |
The return from uname -s |
creation_os_version |
The return from uname -v |
In addition to the keywords that are defined by the Solaris Flash archive, you can define other keywords. The Solaris Flash archive ignores user-defined keywords, but you can provide scripts or programs that process the identification section and use user-defined keywords. Use the following format when creating user-defined keywords:
Begin the keyword name with an X.
Create the keyword with any characters other than linefeeds, equal signs, and null characters.
Suggested naming conventions for user-defined keywords include the underscore-delimited descriptive method used for the predefined keywords. Another convention is a federated convention similar to the naming of Java packages.
For example, X-department is a valid name for a user-defined keyword.
For an example of using options to include user-defined keywords in the identification section, see Example 21–12.