essutils command

Installs and deploys ESS

Synopsis


essutils {-N NODE-LIST | -G NODE-GROUP} 
         [ --prefix PREFIX] [--suffix SUFFIX] 
         [ --config CONFIG_FILE] [--customize]
         [ --ems-node-name EMS_NODE] [--io-node-one-name IO_NODE1]
         [ --io-node-two-nameIO_NODE2]  [-h | --help ]

Availability

Available with IBM Storage Scale System.

Description

essutils is the ESS installation and deployment toolkit. It is a collection of tools and utilities to facilitate SSR, installation and deployment, and upgrade tasks. essutils can be invoked with or without any optional arguments.

It provides a set of task menus related to install and deploy activities. When a task is selected from the menu a command is issued to the system for that task. This toolkit requires a minimum of 80 x 24 character window to operate.

Restriction: Make sure that you use a console of adequate height and width to specify long options for the command during C button customization . An 80 x 24 console size might lead to an unexpected error, if the command option is very long.

At the bottom of the screen, the command for the task with the options is displayed. To change the options, you can press c. A dialog window opens to enter new or modified options. Select back or press Esc key to close the screen. You can select the corresponding menu item using 1 to 9 number keys. If you want to select a menu item mapped to a number that is greater than 9, you must scroll down to that menu item.

essutils can be run on the ESS management server (EMS) node only. If no node name, node list, or group name are specified, ems1 and ess_x86_64 are considered as the default name for EMS and I/O server nodes respectively.

You can customize essutils according to a specific environment such that parameters such as EMS and I/O server node names, and node name suffix and prefix are saved in the essutils configuration file. As a result, you do not need to specify these parameters every time that you use essutils. You can generate the essutils configuration file specific to your environment using --customize option and that configuration file can be used for subsequent essutils operations.

Parameters

-N NODE-LIST: Provides a list of nodes. If node list or group name is not provided, -N localhost is assumed.
-G NODE-GROUP: Provides the name of node group that the nodes are a member of. Nodes in the NODE-LIST are members of the NODE-GROUP.
--prefix PREFIX: Provides the host name prefix. Use = between --prefix and value if the value starts with -.
--suffix SUFFIX: Provides the host name suffix. Use = between --suffix and value if the value starts with -.
--config CONFIG_FILE: Provides the configuration file for essutils for a specific environment.
--customize: Customizes the EMS host name and I/O server node names and generates the essutils configuration file. This file can be used with --config to run essutils specific to an environment.
--ems-node-name EMS_NODE: Specifies the EMS host name to populate the essutils configuration file.
--io-node-one-name IO_NODE1: Specifies the I/O node 1 host name to populate the essutils configuration file.
--io-node-two-name IO_NODE2: Specifies the I/O node 2 host name to populate the essutils configuration file.
-h | --help: Displays usage information about this script and exits.

Exit status

0: Successful completion.
nonzero: A failure has occurred.

Security

You must have root authority to run the essutils script.

Examples

This example shows how to run essutils with default values.
```
# essutils
```
This example shows how to run essutils for ems2 and ess_x86_64 I/O node group, with the suffix -10g.
```
# essutils -G ems2,ess_x86_64 --suffix=-10g
```
This example shows how to run essutils with the prefix sk- and with the suffix -ib.
```
# essutils --prefix sk- --suffix=-ib
```
This example shows how to customize essutils for a specific environment. In this example environment ems node is ems2 and I/O server node names are io3 and io4. The suffix to be used is -40g.
```
# essutils --customize --config /var/tmp/env2 --ems-node-name ems2 \
--io-node-one-name io3 --io-node-two-name io4 --suffix=-40g
```
```
Successfully generated the customization configuration file.
```
In this example, the user has generated the configuration file specific to their environment. The --config option can be used to load essutils with the values specific to the user environment.
```
# essutils –-config /var/tmp/env2
```

Location

/opt/ibm/ess/tools/bin