egosh

The command that launches the administrative command interface to EGO.

Synopsis

egosh

egosh subcommand [options]

egosh -h | help

egosh -V

Description

With no subcommands specified, launches an interactive command console to EGO. Once it is open, you can continue to issue subcommands until you close the console.

Use the egosh command with one or more subcommands from within a script to run commands in batch mode.

If you want to issue administrative subcommands to control EGO objects, you must first log on to EGO using the user logon subcommand. You are not required to log on to view EGO objects.

-h: When running the egosh command in shell console mode, prints command usage to stderr and exits.
help: When running the egosh command in egosh console mode, displays usage information.
-V: Prints product version to stderr and exits.

How egosh retrieves configuration required for running the command

Unlike other IBM® Spectrum Symphony commands, the egosh command deploys, manage, and load configuration from the ego.conf file on client machines, rather than retrieves configuration from environment variables. To configure the egosh command to behave consistently with other commands (that is, retrieve configuration from environment variables and without loading the client's local ego.conf file), complete these configuration steps on each client host:

Enable the EGO_DISABLE_EGOCONF_DEPENDENCY environment variable:
- On Windows:
  - To enable for the current user, from a Windows command prompt window, run:
```
set EGO_DISABLE_EGOCONF_DEPENDENCY=Y
```
  - To enable for all users, set the EGO_DISABLE_EGOCONF_DEPENDENCY environment variable as a Windows system environment variable (using Control Panel > System & Security > Edti the system encironment varibles).
- On Linux®, run:
```
export EGO_DISABLE_EGOCONF_DEPENDENCY=Y
```

Set mandatory parameters as environment variables:

On Windows, run:

set EGO_MASTER_LIST=%MASTER_HOSTNAME%
set EGO_KD_PORT=%KD_PORT%

On Linux, run:

export EGO_MASTER_LIST=$MASTER_HOSTNAME
export EGO_KD_PORT=$KD_PORT

Set the path (Windows Path or Linux LD_LIBRARY_PATH) variable to include the IBM Spectrum Symphony path library. For example:

On Windows:

set Path=%Path%;C:\Program Files\IBM\SpectrumComputing\soam\7.3.2\w2k3_x64-vc7-psdk\bin;C:\Program Files\IBM\SpectrumComputing\soam\7.3.2\w2k3_x64-vc7-psdk\lib;C:\Program Files\IBM\SpectrumComputing\soam\7.3.2\w2k3_x64-vc7-psdk\lib64;C:\Program Files\IBM\SpectrumComputing\4.0\bin;C:\Program Files\IBM\SpectrumComputing\4.0\lib;

Tip: Ensure that the .dll files located in the C:\Program Files\IBM\SpectrumComputing\4.0\lib directory can be accessed by the egosh command.

On Linux:

export LD_LIBRARY_PATH=/opt/ibm/spectrumcomputing/soam/7.3.2/linux-x86_64/lib64:/opt/ibm/spectrumcomputing/soam/7.3.2/linux-x86_64/lib:/opt/ibm/spectrumcomputing/integration/yarn/4.0/linux-x86_64/lib/:/opt/ibm/spectrumcomputing/4.0/linux-x86_64/lib:/opt/ibm/spectrumcomputing/perf/ego/4.0/linux-x86_64/lib:/opt/ibm/spectrumcomputing/perf/soam/7.3.2./linux-x86_64/lib:/opt/ibm/spectrumcomputing/4.0/linux-x86_64/lib/jni

Tip: Ensure that the .so files located in the $EGO_TOP/4.0/linux-x86_64/lib directory can be accessed by the egosh command.

If SSL is enabled, also set the EGO_CLIENT_TS_PARAMS environment variable. For example:

On Windows:

set EGO_CLIENT_TS_PARAMS=SSL[CIPHER=AES256-GCM-SHA384,CAFILE=%EGO_TOP%\wlp\usr\shared\resources\security\cacert.pem]
set EGO_TRANSPORT_SECURITY=SSL
set EGO_KD_TS_PORT=%SSL_PORT%

On Linux:

export EGO_CLIENT_TS_PARAMS=SSL[CIPHER=AES256-GCM-SHA384,CAFILE=$EGO_TOP/wlp/usr/shared/resources/security/cacert.pem]
export EGO_TRANSPORT_SECURITY=SSL
export EGO_KD_TS_PORT=$SSL_PORT

If you want to run the egosh entitlement info command, also set the EGO_LIM_PORT environment variable. For example:
- On Windows:
```
set EGO_LIM_PORT=%BASE_PORT%
```
- On Linux:
```
export EGO_LIM_PORT=$BASE_PORT
```
Tip: Ensure that the egosh entitlement info command be executed from hosts managed by the cluster (primary, management, or compute host).
For safety reasons, do not run the egosh ego start or egosh ego shutdown commands from a client host. However, if you must run from the client, ensure that the EGO_CONFDIR, EGO_SERVERDIR, and EGO_BINDIR environment variables are correctly set, and then execute the commands from a host managed by the cluster (primary, management, or compute host).