egoinstallfixes

The command to install, roll back, and query information about fixes to your IBM® Spectrum Symphony installation on Linux® (including a IBM Spectrum Symphony-IBM Spectrum LSF® cluster on Linux).

Typically, you download these fixes from IBM Fix Central: http://www.ibm.com/eserver/support/fixes or obtain them from your IBM Support representative. Use the egoinstallfixes command on Linux hosts; to manage fixes on Windows, refer to the readme file applicable to the fix you want to install.

Synopsis

Important:

To run the egoinstallfixes command, your Linux host must include the ed Linux line-oriented text editor.
To run the egoinstallfixes command remotely, note the following considerations:
- Set the full path and file name to the environment file that properly defines your EGO_TOP and EGO_CONFDIR parameters by running the command with the -f env_file option.
- Force pseudo-tty allocation to that remote host by prefacing the egoinstallfixes command with the ssh -t remote_hostname command.
- Surround the command syntax with quotation marks ().
Here is an example of using the egoinstallfixes command from your local host to apply the sym-version_x86_64_build123456.tar.gz package to a remote host called abc123, specifying the /home/egoadmin/cluster.env location for the -f option:
```
ssh -t abc123 /opt/ibm/spectrumcomputing/4.0/install/egoinstallfixes -f /home/egoadmin/cluster.env sym-version_x86_64_build123456.tar.gz
```
If any files under the $EGO_TOP directory is not owned by the cluster administrator, then run the egoinstallfixes command as root; otherwise, file ownership cannot be set.

egoinstallfixes [-f env_file][--silent] [--nobackup] package ...

egoinstallfixes -c [-f env_file][--silent] package ...

egoinstallfixes -r [-f env_file][--silent] package | build_number

egoinstallfixes -h

Description

Use the egoinstallfixes command to install, roll back, and query information about fixes to your IBM Spectrum Symphony (or IBM Spectrum Symphony-IBM Spectrum LSF) installation on Linux. Installing a fix using this command upgrades your cluster to that fix level.

The cluster location is normally determined by your environment setting, so ensure that your environment is set before you run the egoinstallfixes command (that is, you sourced either the cshrc.platform or the profile.platform file). If you cannot source your environment, then use the -f env_file option and specify your full path and file name to the file that properly defines your EGO_TOP and EGO_CONFDIR parameters.

Run the egoinstallfixes command from the $EGO_TOP/4.0/install directory.

You can also run egoinstallfixes -c to check fix packages without installing them; for example, use the -c option before installing the fix package to see if your system is suitable for installing the fix.

If the command encounters problems with the installation, it automatically rolls back to the cluster's previous state. It records the changes in a fix history directory.

-h: Prints command usage to stdout and exits.

Permissions

Permissions required to run this command depend on the package contents for the fix, and the original cluster installation account. Typically, you can run the egoinstallfixes command as the cluster administrator (egoadmin), except when setuid is set for the egosh binary and the fix contains the egosh binary.

egoinstallfixes [-f `env_file`] [--silent] [--nobackup] `package` ...

Applies fix packages, using this flow:

Performs system and permission checks.
If it does not find issues, it backs up the current binary files to the fix backup directory. The backup directory location is defined using the PATCH_BACKUP_DIR environment variable in the $EGO_TOP/patch.conf configuration file. By default, PATCH_BACKUP_DIR is set to $EGO_TOP/patch/backup. You can set this variable to another location (for example, you may want to do this if you do not have enough space under $EGO_TOP). To free up even more space, once you have run the egoinstallfixes command successfully to install a fix, you can delete the related fix backup under the directory defined for PATCH_BACKUP_DIR.
If the command detects a pre-script.sh file within the fix package, runs this pre-script file before applying the fix. A pre-script file is a custom file containing any actions to be completed before applying the fix. It must be included in the fix package, and it must be called pre-script.sh for the command to be able to run it.
Cleans up the file system by deleting files that the IBM Spectrum Symphony cluster no longer requires. These files may have been installed with IBM Spectrum Symphony, or applied during an IBM Spectrum Symphony fix. If the command detects the file, it deletes it. If the command cannot find the file (for example, it was included in a fix that you did not apply), then it provides an informational message to indicate that it will skip deleting the file.
Installs the specified fix package or packages on top of your existing cluster (updating or adding new binary files to your cluster).
If the command detects a post-script.sh file within the fix package, runs this post-script file after applying the fix. A post-script file is a custom file containing any actions to be completed after applying the fix. It must be included in the fix package, and it must be called post-script.sh for the command to be able to run it.

-f env_file: Optionally, if you cannot set your environment (that is, you cannot source either the cshrc.platform or the profile.platform file), then use the -f option and specify your full path and file name to the file that properly defines your EGO_TOP and EGO_CONFDIR parameters.
If you use the -f env_file option, the egoinstallfixes command obtains the cluster location from this file, not from the settings in your environment.
--silent: Optionally, install the fix package in silent mode, without interactive prompts for confirmation, by specifying the --silent option. For example, specify egoinstallfixes --silent sym-version_x86_64_build123456.tar.gz to install that fix package silently (versus specifying egoinstallfixes sym-version_x86_64_build123456.tar.gz to install the fix package with interaction).
If you run the egoinstallfixes command from a script, use this option as you will want to suppress confirmation for the command.
--nobackup: By default, the egoinstallfixes command backs up the current binary files to the fix backup directory before installing a fix. Optionally, you can specify the --nobackup option so that the egoinstallfixes command does not create a backup, and simply applies the fix and overwrites existing files. This option is useful if you want to save space. Note, however, that using the --nobackup option means rolling back existing files that were updated by the fix or any previous fixes (using the -r option) will not be rolled back to their original state.
package ...: Specify the full path and file name for the fix package to install. For example, specify egoinstallfixes /myfixes/sym-version_x86_64_build123456.tar.gz to indicate that the command should install that particular fix package.
To specify multiple fix packages, separate each package name with a space.

egoinstallfixes -c [-f `env_file`] [--silent] `package` ...

Performs system checks, as if to install, but does not proceed with installing the specified fix package. This option also provides a list of fixes.

-c

Specifying the -c option allows the command to check the system and lists the files to be fixed, as such:

Checks that the existing cluster is compatible with the fix you want to install (that is, checks that same software component version is already installed on the same binary types). Some fixes may also require you to first install prerequisite fixes.
Checks that the user account has permissions to write to the installation directory, backup directory, and history directory. The command creates installation, pre-check, and any error log files to these directories, and stores a backup of the files before installing fixes to them.
Lists existing files that will be overwritten by this fix.
Lists files that will be added by the fix.
Lists files that will be deleted by the fix. These files may have been installed with IBM Spectrum Symphony, or applied during an IBM Spectrum Symphony fix. If the command detects the file, it lists it here. If the command cannot find the file (for example, it was included in a fix that you did not apply), then it provides an informational message to indicate that it will skip deleting the file.
Indicates if there is a pre-script.sh file within the fix package. The command runs this pre-script file before applying the fix.
Indicates if there is a post-script.sh file within the fix package. The command runs this post-script file after applying the fix.

-f env_file: Optionally, if you cannot set your environment (that is, you cannot source either the cshrc.platform or the profile.platform file), then use the -f option and specify your full path and file name to the file that properly defines your EGO_TOP and EGO_CONFDIR parameters.
If you use the -f env_file option, the egoinstallfixes command obtains the cluster location from this file, not from the settings in your environment.
--silent: Optionally, complete the checks in silent mode, without interactive prompts for confirmation, by specifying the --silent option. For example, specify egoinstallfixes -c --silent sym-version_x86_64_build123456.tar.gz to check that fix package silently (versus specifying egoinstallfixes -c sym-version_x86_64_build123456.tar.gz to check the fix package with interaction).
If you run the egoinstallfixes command from a script, use this option as you will want to suppress confirmation for the command.
package ...: Specify the full path and file name for the fix package to check. For example, specify egoinstallfixes -c /myfixes/sym-version_x86_64_build123456.tar.gz to indicate that the command should check that particular fix package.
To specify multiple fix packages, separate each package name with a space.

egoinstallfixes -r [-f `env_file`] [--silent] `package`|`build_number`

Rolls back the installation of the most recently installed fix so that the cluster returns to its previous state. Once complete, the command records the rollback changes in a fix history directory.

This option removes one product fix and rolls back the cluster one fix level at a time. To remove more than on fix, run egoinstallfixes -r [--silent] package|build_number for each fix.

You cannot roll back if the backup files from the previous fix level are not available (for example, if you deleted them from the fix backup directory). Ensure your backup files exist.

-r: Specifying the -r option rolls back the installation of the most recently installed fix so that the cluster returns to its previous state.
-f env_file: Optionally, if you cannot set your environment (that is, you cannot source either the cshrc.platform or the profile.platform file), then use the -f option and specify your full path and file name to the file that properly defines your EGO_TOP and EGO_CONFDIR parameters.
If you use the -f env_file option, the egoinstallfixes command obtains the cluster location from this file, not from the settings in your environment.

--silent

To roll back the cluster in silent mode, without interactive prompts for confirmation, specify the --silent option. For example, specify egoinstallfixes -r --silent /myfixes/sym-version_x86_64_build123456.tar.gz to roll back the fix package silently (versus specifying egoinstallfixes -r /myfixes/sym-version_x86_64_build123456.tar.gz to roll back the fix package with interaction).

If you run the egoinstallfixes command from a script, use this option as you will want to suppress confirmation for the command.

package | build_number

Specify the most recently installed fix by package name or build number. The command checks all binary types and finds all instances where the most recently installed fix contains the same build number. The command then removes these packages and the cluster reverts to its previous level.

To roll back by fix package name, specify the full path and file name for the fix. For example, specify egoinstallfixes -r /myfixes/sym-version_x86_64_build123456.tar.gz to indicate that the command should uninstall that particular fix package and roll back the cluster to its state before this fix package. The package name typically includes the build number; the command automatically checks the package to determine the build.

To roll back by fix build number, specify the build number for the fix. For example, specify egoinstallfixes -r 123456 to indicate that the command should uninstall that particular fix build and roll back the cluster to its state before this fix.

What to do next

Once you have successfully run the egoinstallfixes, you can use the pversions command to see details about the product and component versions and fixes applied to your local host.

Additionally, to see the installed and active products and components on your cluster, use the System & Services > Software Components page within the cluster management console.

Tip: