instl_adm.4 (2012 03)

ManualsBrandsHP ManualsSoftwareHP-UX Manpages

instl_adm(4) instl_adm(4)

NAME

instl_adm - Ignite-UX conﬁguration ﬁle syntax

DESCRIPTION

The Ignite-UX conﬁguration ﬁles determine the default system conﬁgurations available during the pro-

cess of installing the HP-UX operating system.

The Ignite-UX process uses conﬁguration ﬁles to bring in default parameters, as well as, determine how

the system will be conﬁgured. During the installation process, you are presented with a user interface

(UI) that allows you to make selections that are implemented inside the conﬁguration ﬁles as variables ,

use models, and software selections . The UI also allows the user to make modiﬁcations beyond what is

speciﬁed by these constructs (such as adding new ﬁle systems or volumes).

Once you approve the conﬁguration, a conﬁguration ﬁle is created. This ﬁle contains only the changes

made in UI. This conﬁguration ﬁle is then passed on to another utility that actually performs the system

conﬁguration and software installation.

Organization and Indexing of Conﬁguration Files

Although all conﬁguration ﬁles use the same basic syntax, the information supplied by them is split into

multiple ﬁles to allow them to be maintained individually. These conﬁguration ﬁles fall into the basic

classes of:

• Default disk and file system layout. Located in

/opt/ignite/data/Rel_

release /config

• Software description of a single Software Distributor (SD) depot,

or system archive. Located in /var/opt/ignite/data/Rel_

release /ﬁle

• Local configuration overrides that apply globally. Located in

/var/opt/ignite/data/config.local

• Named configurations created by saving a configuration via the UI.

Located in /var/opt/ignite/data/saved_cfgs/*

• Client-specific configuration files. Located in

/var/opt/ignite/clients/0x

LLA/config

• Boot control parameters and networking information. Located in the

ﬁrst 8KB of the ﬁle /opt/ignite/boot/Rel_

release /*INSTALLFS managed by the

instl_adm utility.

To completely describe all aspects of a system, it is necessary for Ignite-UX to read multiple conﬁguration

ﬁles as a combined set.

The grouping of conﬁguration ﬁles into a set (known as a "conﬁguration clause" or just "cfg clause") is

accomplished with the use of the

INDEX ﬁles: /var/opt/ignite/data/INDEX

/var/opt/ignite/clients/0x

LLA/CINDEX

The INDEX ﬁle may contain multiple conﬁguration clauses (groups of conﬁguration ﬁles) that together

describe a unique system conﬁguration. The UI allows the user to choose from the conﬁgurations clauses

that are deﬁned in the INDEX ﬁle.

Similarly, the

CINDEX ﬁle can contain conﬁguration clauses, but these are only available for use by the

speciﬁc client corresponding to the per-client directory it exists in. The CINDEX ﬁle is typically used by

the make_net_recovery command to reference conﬁguration ﬁles created for each recovery backup

performed for that client. The paths to conﬁguration ﬁles in the CINDEX ﬁle can be relative paths, in

which case they will be accessed from within the per-client directory. The conﬁguration clauses listed in

both the INDEX and CINDEX ﬁles are available for use during an installation or recovery of the speciﬁc

client.

The default

INDEX conﬁguration clauses provided with Ignite-UX are used to deﬁne the aspects of each

HP-UX release that Ignite-UX supports. A separate conﬁguration clause per HP-UX release is necessary

because each HP-UX release has different defaults for ﬁle system layout and software bundling.

The ability to save a modiﬁed system conﬁguration through the UI makes use of the

INDEX ﬁle. When

the UI is used to make modiﬁcations to the system conﬁguration, Ignite-UX produces a "delta"

conﬁguration ﬁle that represents the changes. When this delta conﬁguration ﬁle is appended to the list of

default conﬁguration ﬁles, it overrides the defaults with the values you speciﬁed. When a system

conﬁguration is saved with a new name, a new INDEX conﬁguration clause is created that contains the

original conﬁguration ﬁles with the addition of the new delta conﬁguration ﬁle.

HP-UX 11i Version 3: March 2012 − 1 − Hewlett-Packard Company 1

Summary of content (34 pages)

PAGE 1
instl_adm(4) instl_adm(4) NAME instl_adm - Ignite-UX configuration file syntax DESCRIPTION The Ignite-UX configuration files determine the default system configurations available during the process of installing the HP-UX operating system. The Ignite-UX process uses configuration files to bring in default parameters, as well as, determine how the system will be configured.
PAGE 2
instl_adm(4) instl_adm(4) Any information stored in the first 8KB of the *INSTALLFS file, as well as the client-specific configuration file, is always appended to the list of configuration files, although is not explicitly listed in the INDEX file set. INDEX File Content and Syntax The INDEX and CINDEX files contain configuration clauses, and may also contain a list of scripts that are available for scheduling in the "Advanced" tab of the UI.
PAGE 3
instl_adm(4) instl_adm(4) An integer may be a hexadecimal value specified using the prefix 0x followed by a value using the hexadecimal digits 0 through 9, a through f, and A through F. An integer may be a decimal value and may have a KiB, MiB, GiB or suffix multiple. For compatibility with prior Ignite-UX releases a KB, MB, GB or suffix multiple may be used instead. These multiples are KiB or KB for 2ˆ10, MiB or MB for 2ˆ20, GiB or GB for 2ˆ30, and TiB or TB for 2ˆ40.
PAGE 4
instl_adm(4) instl_adm(4) _variable ={value1 ,value2 ,...} Sets the list of potential values of the variable to those given and is for use by the UI only. There is no error checking to ensure the resulting value is in the given list. _variable +={value2 ,value3 ,...} Using the += operator adds the given values to any existing values specified for that variable. _variable ={number ..
PAGE 5
instl_adm(4) instl_adm(4) ’l’ Other control information (for example, global mod_kernel statements). For example, the line: _hp_cfg_detail_level="ivsp" in a client configuration file would indicate the file contains information about which cfg INDEX selection should be used, the variable settings, software selection settings, and system parameters. _hp_console_verbosity Integer variable used to control the verboseness of output to the console.
PAGE 6
instl_adm(4) instl_adm(4) and other utilities used to verify and update hardware functionality. This value defaults to a size expected by the diagnostics software. A zero value indicates that no HP Service Partition should be created. This variable is adjusted to the minimum HP Service Partition size if set to a non-zero value less minimum. This variable is supported starting with HP-UX B.11.23 and only supported on Itanium-based systems.
PAGE 7
instl_adm(4) instl_adm(4) Note: All lan interfaces that support autonegotiation of the link speed and duplex values will do so when running the installation kernel. If you have 100BT lan interfaces and switches with ports hard set to 100 full duplex rather than autonegotiate, you will end up with a speed and duplex mismatch. You must use the above configuration in an installation file system.
PAGE 8
instl_adm(4) instl_adm(4) _hp_root_disk String variable set by the UI to contain the hardware path or device specifier of the disk you have chosen to be the root disk. The value is initialized to the value of _hp_primary_path in /opt/ignite/data/Rel_release /config and may be overridden in other configuration files. If the initial value is not specified in the configuration file, it would default to the disk with the hardware path having the highest SCSI priority.
PAGE 9
instl_adm(4) instl_adm(4) ( ) Parentheses may be used to group expressions to force precedence. ! Logical not operator. == != ~ Comparison operators: equal, not-equal and regular expression match, respectively. The == and != operators compare strings in a case-insensitive manner. The ˜ character is a regular expression comparison operator. The right side of ˜ is treated as an extended regular expression string when compared to the left side string. (See regexp (5).
PAGE 10
instl_adm(4) instl_adm(4) the install kernel will fabricate a wwid. See the I/O Configuration section for more information. disk[hw_path|index|dev_spec ].phys_loc Evaluates to the physical location of the disk specified by the hardware address path, index value or device specifier. Note that not all disks have a physical location, only SAS disk drives do. See the I/O Configuration section for more information. disk[hw_path|index|dev_spec ].
PAGE 11
instl_adm(4) instl_adm(4) more descriptive than hardware_model. is_hppa is_ia64 Boolean values that indicate if a system is PA-RISC or Itanium-based architecture, respectively. is_ht_capable Boolean value that indicates if a system supports HyperThreading. Available on HP-UX B.11.31 or later. num_cpus Evaluates to the number of active processors discovered on the system. num_lans Evaluates to the number of LAN hardware devices discovered on the system.
PAGE 12
instl_adm(4) instl_adm(4) (cfg string ) A boolean value that reflects whether the INDEX file selection referenced by string is the one being used for this installation. I/O Configuration Some of the variables that control the I/O configuration process use special types of values. These value types may also be used by some conditional expressions and other variables.
PAGE 13
instl_adm(4) instl_adm(4) disk["WWID=’wwid’ PHYS_LOC=’phys_loc’ HW_PATH=’hw_path’"] In this example, Ignite-UX would first look for a disk with a WWID of wwid, and if it could not be found, then it would look for a disk with a PHYS_LOC of phys_loc , and if that could not be found, then it would look for a disk with a HW_PATH of hw_path and return that if found. If all attributes are exhausted, then Ignite-UX will find a replacement disk if allow_disk_remap is set to true.
PAGE 14
instl_adm(4) instl_adm(4) following examples assign the instance number 10 to the external bus (SCSI bus) 2/0/1, and instance number 1 to the LAN device 2/0/2. Note that legacy disk device special file names contain the instance number of the parent "ext_bus" device.
PAGE 15
instl_adm(4) instl_adm(4) file-system-attributes... } swap_partition { swap-attributes... } } volume_group group_name { volume_group-attributes... physical_volume group "pvgname" { physical_volume disk[hw_path|index|dev_spec ] { physical_volume-attributes... } ... } ... physical_volume disk[hw_path|index|dev_spec ] { physical_volume-attributes... } A ... logical_volume { file-system/swap-attributes... } logical_volume "lvname" { file-system/swap-attributes... } ...
PAGE 16
instl_adm(4) instl_adm(4) If a dev_spec type is used, refer to the discussion regarding Device Specifier in the I/O Configuration section. Following physical_volume, may be a block of physical_volume-attributes surrounded by { } brackets. These attributes are described in the following sections. fs_partition In a partitioned_disk configuration, this keyword starts the specification for the file system partition of the disk.
PAGE 17
instl_adm(4) instl_adm(4) size = minsize | remaining | maxsize Specifies the size of the volume/file system to be number. In the case the size is set to remaining, the volume is assigned the disk space that is left after allocating all other volumes. If maxsize is specified in conjunction with remaining, the remaining disk space, up to maxsize , is assigned to the volume.
PAGE 18
instl_adm(4) instl_adm(4) nbpi = number Sets the number of bytes per inode (inode density) to number. rotational_delay = number Sets the rotational delay factor for the file system to number. (See tunefs (1M).) largefiles = boolean Specifies that largefiles are to be enabled or disabled for this volume. This is supported for both HFS and VxFS file systems. version = number For HP-UX B.11.
PAGE 19
instl_adm(4) instl_adm(4) max_physical_extents = number Sets the maximum number of physical extents that may be allocated from any of the physical volumes in the volume group. max_logical_vols = number Sets the maximum number of logical volumes that the volume group is allowed to contain. max_physical_vols = number Sets the maximum number of physical volumes that the volume group is allowed to contain.
PAGE 20
instl_adm(4) instl_adm(4) [final] netmask = cplx_string [final] netmask[lan_dev] = cplx_string Sets the client’s default netmask, as used by ifconfig(1M), to cplx_string . lan_dev may be used to specify to which LAN interface is applicable. [final] broadcast_addr = cplx_string [final] broadcast_addr [lan_dev] = cplx_string Sets the broadcast address for the specified LAN device.
PAGE 21
instl_adm(4) instl_adm(4) waits at boot time until the server can be contacted. [final] ntpdate_server = cplx_string Sets the network time protocol server that the client uses to keep the clock synchronized. See ntpdate (1M) for details. This is currently not used during the installation, rather after the client is finished installing.
PAGE 22
instl_adm(4) instl_adm(4) run_ui = boolean Specifies whether the installation process should be interactive. This may be set to false if you also set control_from_server = true, or if the configuration file specifies all the necessary information needed to perform the installation. If any information is missing or if any problems are found with the configuration, the installation switches to interactive mode.
PAGE 23
instl_adm(4) instl_adm(4) mode is advanced. Ignite-UX will force this keyword to true, and if found false will issue a warning that the setting will be ignored. sd_command_line = cplx_string sd_command_line += cplx_string Used to specify options to all swinstall, or swm (on HP-UX B.11.31 or later) operations performed during an install. The options specified are added to the default options that are required to perform the software installation.
PAGE 24
instl_adm(4) instl_adm(4) This example assumes _inc has been initialized to some value in the configuration file. The = operator overrides any prior global mod_kernel assignments. The += operator adds to any prior settings. Notice that mod_kernel statements may also be associated with a sw_sel definition. The = operator does not have any effect on mod_kernel assignments made in a sw_sel. Beginning with the B.11.23 release, the format for cplx_string arguments is enhanced.
PAGE 25
instl_adm(4) instl_adm(4) env_vars = cplx_string env_vars += cplx_string Sets a string of variables of the form variable =value that is sourced into the environment for the duration of the installation process. The format of cplx_string should be one variable assignment per line. The value of the assignment does not need to be quoted (unless quotes need to be part of the value). These variable assignments are stored in the file /tmp/install.vars and is left on the client after the installation.
PAGE 26
instl_adm(4) instl_adm(4) description = string } sw_sel sel-tag-string { sw_source = src-tag-string sw_category = cat-tag-string selection-attributes... } init sw_sel sel-tag-string =boolean sw_source src-tag-string { source-attributes } The software source specifies an SD depot or an access method to an archive. The src-tag-string is used by sw_sel to identify which sw_source is applicable.
PAGE 27
instl_adm(4) instl_adm(4) sd_depot_dir = cplx_string Sets the depot directory to be used in combination with the sd_server value when running the swinstall, or swm commands to load the associated software when source_type is "NET". When source_type is "DSK", sd_depot_dir sets the depot directory to be used on the CD when running swinstall, or swm to load the associated software. (If not specified, "/" is assumed.) sd_use_ui = boolean Indicates if the swinstall, or swm (on HP-UX B.11.
PAGE 28
instl_adm(4) instl_adm(4) final_script = cplx_string Use these keywords specify a shell script to be loaded from the Ignite-UX server using tftp and executed at the prescribed points during the installation. See the Command and Script Execution Hooks section for details. sw_category cat-tag-string { description = string } Use the sw_category definition to provide a grouping mechanism for sw_sel definitions to reference. The UI uses the sw_category to help you browse the software more easily.
PAGE 29
instl_adm(4) instl_adm(4) If source_type="DSK" then archive_path is used to access an archive on the CD when mounted as a file system. In this case, archive_path must be a path relative to the top directory of the CD. When using an archive to contain the core HP-UX operating system (a full system archive), the archive must be packaged using relative path names. This allows Ignite-UX to extract it to the mounted disk. In addition, the load_order of the sw_source must be set to 0 (zero).
PAGE 30
instl_adm(4) instl_adm(4) manifest_info = cplx-string Specifies that the text in the client manifest template tagged with the given string should be printed as part of the client’s manifest. See print_manifest(1M) for details. corequisite [+]= tag_string Indicates that the sw_sel referred to by tag_string should be loaded with this sw_sel. Multiple corequisites may be listed using one corequisite statement per line with the += operator.
PAGE 31
instl_adm(4) instl_adm(4) executed at the prescribed points during the installation if this sw_sel is selected. See the Command and Script Execution Hooks section for details. Command and Script Execution Hooks Ignite-UX supports mechanisms for the commands and scripts you supply to be inserted into various stages in the installation process. There are two types of keywords that the configuration file supports. The keywords that end in _cmd may be used to embed scripts directly in the configuration file.
PAGE 32
instl_adm(4) instl_adm(4) final_cmd = cplx_string final_script = cplx_string The final commands and scripts are executed as the very last step before the final client reboot or halt. In fact, these scripts and commands are executed after the log file has been closed and the installation’s overall status has been determined. Thus, the exit code from a final_script does not influence the outcome of the installation.
PAGE 33
instl_adm(4) instl_adm(4) set in earlier files. Thus, the client-specific configuration file has highest precedence. Tape and CD media are in lif (4) format and contain an INDEX file. Typically the only file referenced by the INDEX file is entitled CONFIG. It is this CONFIG file, in addition to the first 8KB of the *INSTALLFS file, that make up the configuration information for these media types. International Code Set Support Ignite-UX uses a variety of system commands to accomplish its functionality.
PAGE 34
instl_adm(4) instl_adm(4) /opt/ignite/bin/manage_index -a \ -f /var/opt/ignite/data/Rel_B.11.11/ee_apps_cfg Scheduling a post_config_script To Be Run /var/opt/ignite/data/config.local file is a convenient place to set the The post_config_script keyword to run the scripts that should always be run, or that may be run based on a logic expression. Also, this is a convenient place to put kernel modifications that you want performed on all clients installed.