Chapter 2. IRIS/IRIX System Administration Environment Variables

Chapter 2. IRIS/IRIX System Administration Environment Variables
Prev		Next

The following environment variables are used to refine the operating environment that is in place. This chapter has the following sections:

Section 2.1, describes the Iris FailSafe environment variables.
Section 2.2, describes the PROM environment variables.

2.1. Iris FailSafe Variables

`HA_HOSTNAME`		The output of the `uname` command with the `-n` option, which is the host name or nodename. The nodename is the name by which the system is known to communications networks. Default: `uname -n`
`HA_CMDSPATH`		Path to user commands. Default: `/usr/cluster/bin`
`HA_PRIVCMDSPATH`		Path to privileged commands (those that can only be run by root). Default: `/usr/sysadm/privbin`
`HA_LOGCMD`		Command used to log into the IRIS FailSafe logs. Default: `ha_cilog`
`HA_RESOURCEQUERYCMD`		Resource query command. This is an internal command that is not meant for direct use in scripts; use the `ha_get_info()` function of `scriptlib` instead. Default: `resourceQuery`
`HA_SCRIPTTMPDIR`		Location of the script temporary directory. Default: `/tmp`
`HA_CDB`		Location of the IRIS FailSafe database. Default: `/var/cluster/cdb/cdb.db`
`HA_SCRIPTGROUP`		Log for the script group.
`HA_SCRIPTSUBSYS`		Log for the script subsystem.
`HA_NORMLVL`		Normal level of script logs. Default: 0
`HA_DBGLVL`		Debug level of script logs. Default: 10
`HA_LOGQUERY_OUTPUT`		Determine the current logging level for scripts.
`HA_DBGLOG`		Command used to log debug messages from the scripts. Default: `ha_dbglog`
`HA_CURRENT_LOGLEVEL`		Display the current log level. The default will be 0 (no script logging) if the `loggroupQuery` command fails or does not find configuration information.
`HA_LOG`		Command used to log the scripts. Default: `ha_log`
`HA_SUCCESS`		Successful execution of the script. This variable is used by the start, stop, restart, monitor, and probe scripts. Default: 0
`HA_NOT_RUNNING`		The script is not running. This variable is used by exclusive scripts. Default: 0
`HA_INVAL_ARGS`		An invalid argument was entered. This is used by all scripts. Default: 1
`HA_CMD_FAILED`		A command called by the script has failed. This variable is used by the start, stop, restart, monitor, and probe scripts. Default: 2
`HA_RUNNING`		The script is running. This variable is used by exclusive scripts. Default: 2
`HA_NOTSUPPORTED`		The specific action is not supported for this resource type. This is used by all scripts. Default: 3
`HA_NOCFGINFO`		No configuration information was found. This is used by all scripts. Default: 4

2.2. Command (PROM) Monitor

`netaddr`	Specifies the local network address for booting across the Ethernet. See the `bootp` protocol.
`dbgtty`	Specifies the interactive debugger for the IRIX operating system.
`root`	Specifies filesystem information that is passed on to the IRIX system.
`dbaud`	Specifies the diagnostics console baud rate. You can change it by setting this variable (acceptable rates include 75, 110, 134, 150, 300, 600, 1200, 2400, 4800, 9600, and 19200), or by pressing the `Break` key. IRIS uses the `dbaud` rate for the diagnostics console during the entire system startup. Pressing the `Break` key changes the baud rate only temporarily; the baud rate reverts to the value specified in `dbaud` or `rbaud` when you press the `reset` switch or issue an `init` command.
`rbaud`	Specifies the remote console baud rate. The list of acceptable baud rates is the same as for `dbaud`.
`bootfile`	Specifies the name of the file to use for autobooting, normally a standalone shell (sash). This variable is valid for pre-ARCS PROMs only. ARCS PROMs store this information in the `OSLoader` variable.
`bootmode`	Specifies the type of boot in pre-ARCS PROMs. ARCS PROMs store this information in the `AutoLoad` variable. The options have these meanings: `c`: Performs a complete cold autoboot, using the file pointed to by the `bootfile` variable to boot the kernel; boots sash, then boots kernel; and runs power-on diagnostics. `m`: Goes straight to the command monitor, clears memory, and runs power-on diagnostics. `d`: Goes straight to the command monitor, does not clear memory and does not run power-on diagnostics. Default: `m`.
`boottune`	Selects the boot music string. A value of 0 randomizes the selection each time. (It is supported only on Power Indigo2 and Octane systems.) Default: 1.
`autopower`	Allows systems with software power control to automatically reset after a power failure if set to `y`. (It is supported only on Power Indigo2 and Octane systems.)
`console`	Specifies which console to use. The following values are accepted: `G`: Specifies a graphics console with the SGI logo in the upper left corner. `g`: Specifies a graphics console without the SGI logo. `d`: Specifies the terminal is not available. Default: `g`.

The gConsoleIn/gConsoleOut variable specifies the following variables for the graphic console.

`keybd`	Specifies the type of keyboard used. The default is `df`. Available settings depend on the exact PROM revision, but may include some or all of the following settings: `USA`, `DEU`, `FRA`, `ITA`, `DNK`, `ESP`, `CHE-D`, `SWE`, `FIN`, `GBR`, `BEL`, `NOR`, `PRT`, `CHE-F`. On systems with the keyboard layout selector, the settings may include: `US`, `DE`, `FR`, `IT`, `DK`, `ES`, `deCH`, `SE`, `FI`, `GB`, `BE`, `NO`, `PT`, `frCH`. On some systems, `JP` is also acceptable to specify a Japanese keyboard.
`dbgname`	Specifies whether to obtain `symmon`, the debugger.
`diskless`	Specifies that the system is diskless and must be booted over the network. On ARCS systems, diskless system environment parameters should be set as follows: `diskless=1` `SystemPartition=bootp()host:/path` `OSLoader=kernelname`
`monitor`	Specifies the monitor resolution on Indy systems when an unrecognized brand of monitor is used. Set this variable to `h` or `H` to specify a high-resolution monitor. Default: low-resolution monitor.
`nogfxkbd`	Specifies that the keyboard is not required to be connected if set to `1`.
`notape`	Specifies that no tape drive is attached to the system. If a tape drive is attached to the system, this variable must be set to `1` (true) in order to access a tape drive on another system on the network.
`volume`	Specifies (numerically) the system speaker volume.
`pagecolor`	Specifies the background color of the textport using a set of 6 hexadecimal RGB values.
`ProbeAllScsi`	Specifies that all devices on the SCSI bus are automatically examined for disks.
`prompoweroff`	Specifies that the system should return to the PROM monitor before powering off on shutdown if set to `y`. Indy systems only.
`rebound`	Specifies that the system should automatically reboot after a kernel panic if set to `y`. This variable interacts with the AutoLoad variable and the `reboot_on_panic` kernel tunable parameter.
`RestorePastEnv`	Specifies whether partition information is restored. (Supported only on SGI 3000 Series systems.)
`sgilogo`	Specifies that the SGI logo and related information is displayed on the PROM monitor graphical screen if set to `y`.
`diagmode`	Specifies the mode of power-on diagnostics. If set to `v`, diagnostics are verbose and extensive.

The following list describes command monitor environment variables that directly affect the IRIX operating system. These are not stored in nonvolatile RAM, but they do affect the operation of the PROM and of the IRIX system and are discarded if the system is powered off.

`showconfig`		Prints extra information as IRIX boots. If set through `setenv`, its value must be `istrue`.
`initstate`		Passed to the IRIX system, where it overrides the `initdefault` line in `/etc/inittab`. Permitted values are `s` and the numbers 0-6. See `init(1M)`.
`swap`		Specifies in IRIX notation the swap partition to use. If not set, it defaults to the partition configured into the operating system, which is normally partition 1 on the drive specified by the `root` environment variable.
`path`		Specifies a list of device prefixes that tell the command monitor where to look for a file, if no device is specified.
`verbose`		Tells the system to display detailed error messages.

When you boot a program from the command monitor, it passes the current settings of all the environment variables to the booted program.

The ARCS PROM defines some environment variables that are not found in older PROMs, and these are listed below:

`ConsoleIn`/`Console Out`		These variables are set automatically at system startup.
`OSLoadPartition`		The disk partition where the operating system kernel is located. This is also used as the default root partition and is set automatically at system startup.
`OSLoader`		The operating system loading program. By default, this is `sach` (the stand-alone shell). This is set automatically at system startup.
`SystemPartition`		The disk partition where the operating system loading program is found. This is set automatically at system startup.
`OSLoadFilename`		The filename of the operating system kernel. By default, this is `/unix`. This variable is automatically set at system startup.
`OSLoadOptions`		This variable specifies options to the boot command used to load the operating system.
`AutoLoad`		This variable specifies whether the operating system will boot automatically after a reset or power cycle. This variable supersedes `bootmode` and can be set to `yes` or `no`. This variable interacts with the rebound variable and the `reboot_on_panic` kernel tunable parameter.

Prev	Table of Contents	Next
Chapter 1. Operating System Environment Variables		Chapter 3. Application Environment Variables