egoconfig

The command to set host configuration, join a host to the cluster, set the list of primary candidates and the failover priority, and add hosts to or remove hosts from the ManagementHosts resource groups.

Synopsis

egoconfig subcommand [options]

egoconfig -h

egoconfig -V

Description

Use the egoconfig command to join a host to the cluster, set the list of primary candidates and the failover priority, and add hosts to or remove hosts from the ManagementHosts resource groups, or set other configuration options.

This is an administrative command. For most subcommands, you must be logged on as cluster administrator to issue this command.

-h: Outputs command usage and exits.
-V: Prints product version to stderr and exits.

Subcommand synopsis

addresourceattr "[resource resource_name] [resourcemap value*resource_name] …"

join primary_host_name [-f]

masterlist host_name[,host_name, …]

mghost shared_top [-f]

mghost shared_top user_account password [-f]

mghost soam [-f]

mghost soam [user_account] [password] [-f]

setbaseport base_port_no

setentitlement entitlement_file

setpassword [-x password | -i password_file] [-f]

unsetmghost [-f]

addresourceattr "[resource `resource_name`] [resourcemap value*`resource_name`] …"

Adds a resource attribute tag to the parameter EGO_LOCAL_RESOURCES in ego.conf on the local host. The attribute tag is later referenced when you create a resource group and want to add hosts to it that share the same resource attribute.

Notes:

Before running egoconfig addresourceattr, the resource attributes must exist in ego.shared. Ensure that the resource attribute is first added to ego.shared, before running this command.
This command cannot be run on management hosts.

resource: Keyword required by EGO_LOCAL_RESOURCES to signify that the name of the resource attribute tag is boolean.
resourcemap: Keyword required by EGO_LOCAL_RESOURCES to signify that the name of the resource attribute tag is either numeric or string. The name is preceded by a numeric value for a numeric resource attribute or a string value for a string resource attribute to form a name-value pair.
resource_name: Specifies the name of the resource attribute tag that identifies this type of host. For example, the resource attribute tag cloudprovider could be used to create a resource group for hosts that join your cluster from the cloud; the resource attribute tag scvg could be used for harvesting-ready hosts.

join `primary_host_name` [-f]

For use on Linux® only. Adds the local Linux host to the cluster that has the specified primary host.

primary_host_name: Specifies the host name of the primary host.
-f: Suppresses confirmation of the command.
Use this option when running this command from a script.

masterlist `host_name`[,`host_name`, …]

Specifies the list of primary candidates, starting with the primary host, and including all of the candidates, in the order of failover priority.

host_name: Specifies the name of the primary host and each of the primary candidates. Ensure that you do not specify compute hosts in this list.
CAUTION:
Be sure to include all primary candidates in the list when you issue this command, as issuing this command overwrites the existing list.

mghost `shared_top` [-f]

For use on Linux only. Specifies to ignore the local configuration directory and look in the shared location for the configuration information and common files so the management hosts use a common set of files. Issuing this command adds this host to the management hosts resource group.

Important: Stop all services and shut down the cluster before running this command. Otherwise, LIM cannot access the configuration in the shared directory.

After issuing this command, you need to source your environment. Running this command creates an entry for the local host in ego.cluster.cluster_name.

shared_top: Specifies the path to the shared file location where configuration information is accessed by the management hosts in the cluster.
-f: Suppresses confirmation of the command.
Use this option when running this command from a script.

mghost `shared_top` `user_account` `password` [-f]

Log on using the installation OS account, or with the same permissions as the account you used to install on the host. For example, if you installed without Windows system administrator permissions, log on as cluster administrator. If you installed with Windows system administrator permissions on the local host, log on using any account that has Windows system administrator permissions on the local host.

For use on Windows. Specifies to ignore the local configuration directory and look in the shared location for the configuration information and common files so the management hosts use a common set of files. Issuing this command adds this host to the management hosts resource group.

Important: Stop all services and shut down the cluster before running this command. Otherwise, LIM cannot access the configuration in the shared directory.

Issuing this command changes the behavior of Windows services on this host to run under the cluster administrator account rather than the local service account. Running this command creates an entry for the local host in ego.cluster.cluster_name.

shared_top: Specifies the path to the shared file location where configuration information is accessed by the management hosts in the cluster.
user_account: Specifies the cluster administrator OS user account. The format is DOMAIN\user_name.
password: Specifies the password to use to authenticate the user account (input the actual password of the cluster administrator OS account).
-f: Suppresses confirmation of the command.
Use this option when running this command from a script.

mghost soam [-f]

For use on Linux. Use this command when adding IBM® Spectrum Symphony to an existing cluster. Specifies to ignore the local configuration directory and use the shared directory instead. Issue this command only on the primary host so that IBM Spectrum Symphony can use shared location configurations.

After issuing this command, you need to source your environment.

-f: Suppresses confirmation of the command.
Use this option when running this command from a script.

mghost soam [`user_account`] [`password]` [-f]

For use on Windows. Use this command when adding IBM Spectrum Symphony to an existing cluster. Specifies to ignore the local configuration directory and use the shared directory instead. Issue this command only on the primary host so that IBM Spectrum Symphony can use shared location configurations.

user_account: Specifies the cluster administrator OS user account. The format is DOMAIN\user_name.
password: Specifies the password to use to authenticate the user account (input the actual password of the cluster administrator OS account).
-f: Suppresses confirmation of the command.
Use this option when running this command from a script.

setbaseport `base_port_no`

Changes the port number for the EGO_LIM service or daemon to the specified port number.

CAUTION:

Shut down the cluster before issuing this command.

The following port numbers are also changed as a result of issuing this command:

EGO_LIM_PORT
EGO_KD_PORT
EGO_PEM_PORT
ESC_PORT
REPOSITORY_SERVICE_PORT
SD_ADMIN_PORT
SD_SDK_PORT

base_port_no

Specifies an unused port number. The default base connection port is 7869.

IBM Spectrum Symphony always uses seven consecutive ports starting from the base port. By default, IBM Spectrum Symphony uses ports 7869 to 7875.

Valid base port numbers are between 1025 and 65531, inclusive.

setentitlement `entitlement_file`

Applies a new edition or add-on entitlement to the cluster.

entitlement_file: Specifies the full path to the entitlement file including the file name.

setpassword [-x `password` | -i `password_file`] [-f]

Sets the password for the built-in Admin user. Complete this password setting during a fresh installation of IBM Spectrum Symphony on your Linux primary host, including the installations of IBM Spectrum Symphony with the multicluster feature. This command is not applicable to installing on management or compute hosts, nor to upgrading on any host.

password | password_file: Set a new password for the built-in Admin user by either typing in the new password, or you providing the full path and file name of a password file to use to authenticate the user account. If you do not specify either -x password or -i password_file, you are prompted to provide the password instead.
The password can be up to 40 alphanumeric characters, including special characters. The password file can consist of only a single line, with a password that does not exceed 40 alphanumerical, including special characters.
-f: Suppresses confirmation of the command.
Use this option when running this command from a script.

unsetmghost [-f]

Demotes the local management host to a compute host.

Specifies to look in the local configuration directory for configuration information and common files. This command cannot be run on the primary host.

Before running this command, ensure the host's LIM is not running (you may need to shut down the host first). Be sure to restart the primary host after running this command for the change to take effect. Running this command removes the host entry from ego.cluster.cluster_name.

-f: Suppresses confirmation of the command.
Use this option when running this command from a script.