Interim fix user-specified package components

Edit online

The listed interim fix control-file components are part of the overall interim fix package and are not related to specific files.

ABSTRACT

Describes the interim fix package. The abstract is limited to 38 bytes.

DESCRIPTION

Contains a detailed description of the interim fix package that is being installed.

APARREF

Specifies the location of a file that contains the APAR number or numbers associated with this interim fix. This component is required. The file must be contain one APAR number per line.

E2E_PREREQ

Lists the interim fix label names of interim fixes that are prerequisites to the interim fix package being installed. Using this file causes emgr to check if the interim fix PREREQ label is installed. If the prerequisite is not installed, emgr aborts installation of the interim fix package. You can also use this file to specify an XREQ interim fix label. Specifiying XREQ interim fix labels causes emgr to not install the interim fix package if the specified interim fix is installed. The maximum number of supported interim fix labels is 32. You can specify the interim fix labels to check for in the following ways.

Specify the file location with the -g flag. For example, to specify interim fix prereq.epkg, type the following:
```
# epkg -g /tmp/efixprereq.epkg myefix
```
Use the -v flag in interactive mode for extended options, and type the file location when prompted by epkg. For example, to specify interim_fixprereq.epkg, when prompted, type the following:
```
Enter the location for the supersede file or "." to skip.
   -> /tmp/interim_fixprereq.epkg
```
Set the E2E_PREREQ attribute in the interim fix control file to the local file location of the interim fix prerequisite file. For example, to specify interim_fixprereq.epkg, set the attribute as follows:
```
E2E_PREREQ=/tmp/interim_fixprereq.epkg
```

The format of the interim fix prerequisite file entries is as follows (where RequisiteType is PREREQ or XREQ):

EfixLabel RequisiteType

Comments beginning with a "#" sign and leading white space are ignored. For example:

oldefix1 PREREQ  # Make sure oldefix1 is already installed
oldefix4 XREQ    # Make sure oldefix4 is NOT installed

Note: This feature is not supported in the original release of interim fix management. You should update to the latest level of interim fix management to enable this feature. To update interim fix management, update bos.rte.install to the latest level.

PKGLOCKS

Lists the packages that should be locked by emgr in addition to those that are automatically locked based on file ownership. You should specify the name of the package, the package lock action (either ALWAYS or IFINST), and the package file type. ALWAYS means always attempt to lock this package, and a failure to lock the package results in interim fix installation failure. IFINST means attempt to lock this package only if the package is installed, and failure to lock an installed package results in interim fix installation failure. The maximum number of supported interim fix labels is 32. You can specify the packages to be locked in the following ways.

Specify the file location with the -l flag. For example, to specify pkglock.epkg, type the following:
```
# epkg -l /tmp/pkglock.epkg myefix
```
Use the -v flag in interactive mode for extended options, and type the file location when prompted by epkg. For example, to specify pkglock.epkg, when prompted, type the following:
```
Enter the location for the supersede file or "." to skip.
   -> /tmp/pkglock.epkg
```
Set the PKGLOCKS attribute in the interim fix control file to the local file location of the package to be locked. For example, to specify pkglock.epkg, set the attribute as follows:
```
PKGLOCKS=/tmp/pkglock.epkg
```

The format of the interim fix package locks file entries is as follows:

PackageName PackageAction PackageType

Comments beginning with a "#" sign and leading white space are ignored. In the following example, emgr will always attempt to lock bos.rte.lvm during installation and will unlock it on removal. emgr will lock bos.games if (and only if) it is installed and will unlock it on removal (if locked).

bos.rte.lvm ALWAYS installp
bos.games   IFINST installp

PRE_INSTALL

Runs after an installation preview and before any interim fix files are installed. Failure in the pre_install script causes the interim fix package installation to be aborted. This script is useful for doing any preinstallation checking or work. Because the emgr command does not call a failure-cleanup procedure for preinstallation failures, this script performs failure cleanup (related to the script) before it exits. This component is optional.

POST_INSTALL

Runs after all interim fix files have been successfully installed. A failure in the post_install script causes the installation to fail and causes interim fix manager to run a failure-cleanup procedure. This component is optional. For more information about the post_install script, refer to Installing and managing interim fix packages.

PRE_REMOVE

Runs after the removal preview and before any interim fix files are removed during a remove operation and in the first stage of a failure-cleanup procedure. A failure in the pre_remove script causes the given operation to fail. In the case of a failure-cleanup procedure, the emgr command sets an EMGR_UNDO global environment variable to 1. If necessary, the EMGR_UNDO variable is used to take different actions for removal as opposed to a failure-cleanup. This component is optional.

POST_REMOVE

Runs after interim fix files are removed during a remove operation and a failure-cleanup procedure. A failure in the post-remove script causes the given operation to fail. In the case of a failure-cleanup procedure, the emgr command sets an EMGR_UNDO global environment variable to 1. The EMGR_UNDO variable is used to take different actions for removal as opposed to a failure-cleanup (if necessary). This component is optional.

REBOOT

Indicates whether a reboot operation is required for this interim fix. You can use this variable to specify one of the following reboot scenarios.

Reboot is not required.
Reboot is required, and the boot image will be rebuilt.
Reboot is required, and the boot image will not be rebuilt.

You can specify the which of these reboot scenarios you want in the following ways.

Specify the reboot scenario with the -r flag. Arguments for this flag are n (reboot is not required), y (reboot required and the boot image will be rebuilt), and o (reboot is required, but the boot image will not be rebuilt). For example, the following command specifies that a reboot is not required:
```
# epkg -r n
```

Use the -v flag in interactive mode for extended options, and select the reboot scenario you want when prompted by epkg. For example:

Select reboot policy for this efix package:
   1) Reboot is NOT required.
   2) Reboot is required. The boot image will be rebuilt.
   3) Reboot is required. The boot image will NOT be rebuilt.

Set the REBOOT and BUILD_BOOT_IMAGE attributes in the interim fix control file to the appropriate values for the reboot scenario you want. For example, to specify that a reboot is not required, set the attributes as follows:
```
REBOOT=no
BUILD_BOOT_IMAGE=no
```
To specify that a reboot is required and the boot image will be rebuilt, set the attributes as follows:
```
REBOOT=yes
BUILD_BOOT_IMAGE=yes
```
To specify that a reboot is required and the boot image will not be rebuilt, set the attributes as follows:
```
REBOOT=yes
BUILD_BOOT_IMAGE=no
```
Note:
1. This feature is not supported in the original release of interim fix management. You should update to the latest level of interim fix management to enable this feature. To update interim fix management, update bos.rte.install to the latest level.

PREREQ

Contains installp prerequisites. This component is optional.

The file has one prerequisite per line.
The format of the prerequisite entry is as follows:
```
Fileset Min Level Max Level Type
```
Fileset

The name of the requisite installp fileset.

Min Level

The minimum level for the requisite fileset. The specification of NONE indicates no minimum level.

Max Level

The maximum level for the requisite fileset. The specification of NONE indicates no maximum level.

Type

The following types are supported: PREREQ and IFREQ. PREREQ is the default type and requires that the requisite fileset meets all criteria. IFREQ requires that requisite fileset meet all criteria only if it is installed.

Blank lines or lines that start with # are ignored, as shown in the following examples:

# Require that abc.xyz is installed at any level:
  abc.xyz NONE NONE      
# Require that bos.rte.lvm is installed at level 5.1.0.10 or above:
  bos.rte.lvm 5.1.0.10 NONE
# Require bos.mp be between 5.1.0.0 and 5.1.0.40 if it is installed:
  bos.mp 5.1.0.0 5.1.0.40 IFREQ

SUPERSEDE

Specifies the interim fix label name of an interim fix or interim fixes that are to be superseded when an epkg is installed. Using this file causes emgr to remove any interim fix labels that are specified in this file (if they are installed) before installing the interim fix package. Failure to remove an installed superseded interim fix aborts the installation of the interim fix package. The maximum supported number of superseded labels is 32. You can specify the superseded file in the following ways.

Specify the file location with the -S flag. For example, to specify susperseded.epkg, type the following:
```
# epkg -S /tmp/superseded.epkg myefix
```
Use the -v flag in interactive mode for extended options, and type the file location when prompted by epkg. For example, to specify susperseded.epkg, when prompted, type the following:
```
Enter the location for the supersede file or "." to skip.
   -> /tmp/superseded.epkg
```
Set the SUPERSEDE attribute in the interim fix control file to the local file location of the superseded file. For example, to specify susperseded.epkg, set the attribute as follows:
```
SUPERSEDE=/tmp/superseded.epkg
```

The format for the list of superseded files is one interim fix label to be superseded per line. Comments beginning with a "#" sign and leading white space are ignored. For example:

# Requisites for efix myefix3
myefix1
myefix2