egosh

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.

Subcommand synopsis

Activity synopsis

activity kill [-s signal] -t activity_ID | -a alloc_ID | -p consumer_name | -c client_name
activity list [-l] [-f] [ -t activity_ID | -a alloc_ID | -p consumer_name | -c client_name |-r resource_name]
activity start -a alloc_ID -r resource_name [-t activity_name] [-d CWD] [-C CPU_limit] [-F file_limit] [-D data_limit] [-S stack_limit] [-O core_limit] [-R rss_limit] [-N nofile_limit] [-A as_limit] [-e env_name=value[;env_name=value]…]
activity view [activity_ID …]

Allocation synopsis

alloc free -a alloc_ID |-p consumer_name | -c client_name
alloc list [-l] [-a alloc_ID] [-p consumer_name] [-c client_name] [-r resource_name] [-t activity_ID]
alloc modify -a alloc_ID [-m min_slots] -M max_slots [-delta]
alloc new -p consumer_name -M max_slots [-m min_slots] [-a alloc_name] [-exclusive] [-g resource_group] [-s slots_per_host] [-R res_req]
alloc release -a alloc_ID [-block] [-autoadjust] [-modify] host_name:nslots
alloc unblock -a alloc_ID -n nhosts host_name …
alloc view [alloc_ID]

Client synopsis

client list [-l] [-c client_name] [-a alloc_ID] [-p consumer_name] [-r resource_name] [-t activity_ID]
client reg -c client_name [-d description] [-t TTL]
client rm client_name
client unreg
client view [client_name …]
client whoami

Consumer synopsis

consumer alloc [-l] [consumer_name …]
consumer applyresplan [-c] [-e error_log_directory] file_path
consumer list [-l]
consumer view [consumer_name …]

Debug synopsis

debug limoff host_name …| all
debug limon [-c log_class] [-p timing_level] [-f log_file] host_name …| all
debug pemoff host_name …| all
debug pemon [-t] [-c log_class] [-p timing_level] [-f log_file] [[-o "key=value"] …] host_name …| all
debug vemkdoff
debug vemkdon [-t] [-c log_class] [-p timing_level] [-f log_file] [[-o "key=value"]…]

EGO synopsis

ego elimrestart env_suffix env_value [-f] [host_name … | all]
ego execpasswd -u user_name -x password [-noverify]
ego info
ego restart [-f] [host_name …| all]
ego shutdown [-f] [host_name …| all]
ego start [-f] [host_name …| all]

Quit synopsis

quit

Resource synopsis

resource close [-reclaim] resource_name
(resource group) | rg [-l] [group_name …]
resource list [-l] [-m | -s | -t | -a | -o attribute,…] [-R res_req] [resource_name …]
resource open resource_name
resource setpriority -lowest | -normal resource_name …
resource view [resource_name …]

Service synopsis

service list [-l] [-s service_name] [-a alloc_ID] [-p consumer_name] [-r resource_name]
service start service_name … | all
service stop service_name … | all
service view [service_name …]

User synopsis

user add -u user_account -x password [-e email] [-t telephone] [-d description]
user assignrole -u user_account -r role [-p consumer_name]
user delete -u user_account
user list [-l]
user logoff
user logon -u user_account -x password
user modify -u user_account [-x password] [-e email] [-t telephone] [-d description]
user roles4user -u user_account
user users4role -r role [-p consumer_name]
user unassignrole -u user_account -r role [-p consumer_name]
user view [user_account …]

activity kill [-s signal] -t activity_ID | -a alloc_ID | -p consumer_name | -c client_name

Terminates all activities for the specified allocation, consumer or client.

-s signal

Sends a specific signal.

Signals are operating-system dependent. Refer to the list of signals available for your operating system.

-t activity_ID

Specifies the activity to terminate.

-a alloc_ID

Specifies the allocation to which this action applies.

-p consumer_name

Terminates all activities for the specified consumer.

Specify the unique consumer name, or the full path to the consumer name. Specify as many levels within the consumer tree as required to uniquely identify the consumer, as follows:

/top-level_consumer_name/. . . /leaf_consumer_name

-c client_name

Specifies the name of the client to which this action applies.

activity list [-l] [-f] [ -t activity_ID | -a alloc_ID | -p consumer_name | -c client_name |-r resource_name]

Lists all activities in the cluster.

-l

Provides the same information with a longer name field, if some are truncated when -l is not specified.

-f

Lists the failed activities. These activities are in the finish state and the exit reason is not "None", "Terminated by SIGKILL", "Terminated by job controller" or "Terminated by SIGKILL, job controller does not exist or failed".

-t activity_ID

Specifies the activity to list.

-a alloc_ID

Lists all activities that belong to the specified allocation.

-p consumer_name

Lists all activities for the specified consumer.

Specify the unique consumer name, or the full path to the consumer name. Specify as many levels within the consumer tree as required to uniquely identify the consumer, as follows:

/top-level_consumer_name/. . . /leaf_consumer_name

-c client_name

Specifies the name of the client to which this action applies.

-r resource_name

Lists all the activities that are using the specified resource.

activity start -a alloc_ID -r resource_name [-t activity_name] [-d CWD] [-C CPU_limit] [-F file_limit] [-D data_limit] [-S stack_limit] [-O core_limit] [-R rss_limit] [-N nofile_limit] [-A as_limit] [-e env_name=value[;env_name=value] …] command

Starts an activity on the specified host.

-a alloc_ID

Specifies the allocation this activity belongs to.

-r resource_name

Specifies the host on which to start the activity.

-t activity_name

Specifies to start the activity using the name specified.

-d CWD

Specifies the current working directory from which the activity is started.

If you do not specify a directory, /tmp is used on UNIX systems, and %TEMP% is used on Windows systems.

-C CPU_limit

Specifies the maximum amount of CPU time this activity may use before being terminated by the system.

After specifying a value, specify the units for measuring CPU time:

  • s: seconds. For example, 20s specifies a CPU limit of 20 seconds.

  • m: minutes. For example, 40m specifies a CPU limit of 40 minutes.

  • h: hours. For example, 2h specifies a CPU limit of two hours.

-F file_limit

Specifies the maximum file size this activity may use before being terminated by the system.

After specifying a maximum file size, specify one of the following values:

  • b: bytes. For example, 400b specifies a limit of 400 bytes.

  • k: kilobytes. For example, 40k specifies a limit of 40 kilobytes.

  • m: megabytes. For example, 4m specifies a limit of 4 megabytes.

  • g: gigabytes. For example, 4g specifies a limit of 4 gigabytes.

-D data_limit

Specifies the maximum data segment size limit for each of the processes belonging to the activity. If this limit is exceeded, the activity is terminated by the system.

After specifying a value, specify the units for measuring the data limit:

  • b: bytes. For example, 400b specifies a limit of 400 bytes.

  • k: kilobytes. For example, 40k specifies a limit of 40 kilobytes.

  • m: megabytes. For example, 4m specifies a limit of 4 megabytes.

  • g: gigabytes. For example, 4g specifies a limit of 4 gigabytes.

-S stack_limit

Specifies the maximum stack segment size for each of the processes belonging to the activity. If this limit is exceeded, the activity is terminated by the system.

After specifying a value, specify the units for measuring the stack limit:

  • b: bytes. For example, 400b specifies a limit of 400 bytes.

  • k: kilobytes. For example, 40k specifies a limit of 40 kilobytes.

  • m: megabytes. For example, 4m specifies a limit of 4 megabytes.

  • g: gigabytes. For example, 4g specifies a limit of 4 gigabytes.

-O core_limit

Specifies the maximum core file size for all the processes belonging to the activity. If this limit is exceeded, the activity is terminated by the system.

After specifying a value, specify the units for measuring the core size limit:

  • b: bytes. For example, 400b specifies a limit of 400 bytes.

  • k: kilobytes. For example, 40k specifies a limit of 40 kilobytes.

  • m: megabytes. For example, 4m specifies a limit of 4 megabytes.

  • g: gigabytes. For example, 4g specifies a limit of 4 gigabytes.

-R rss_limit

Specifies the maximum resident set size, limiting physical memory usage for each process belonging to the activity. If this limit is exceeded, the activity is terminated by the system.

After specifying a value, specify the units for measuring the physical memory limit:

  • b: bytes. For example, 400b specifies a limit of 400 bytes.

  • k: kilobytes. For example, 40k specifies a limit of 40 kilobytes.

  • m: megabytes. For example, 4m specifies a limit of 4 megabytes.

  • g: gigabytes. For example, 4g specifies a limit of 4 gigabytes.

-N nofile_limit

Specifies the maximum number of open file descriptors this activity may use.

-A as_limit

Specifies the maximum process size (address space) for each process belonging to the activity.

After specifying a value, specify the units for measuring the address space limit:

  • b: bytes. For example, 400b specifies a limit of 400 bytes.

  • k: kilobytes. For example, 40k specifies a limit of 40 kilobytes.

  • m: megabytes. For example, 4m specifies a limit of 4 megabytes.

  • g: gigabytes. For example, 4g specifies a limit of 4 gigabytes.

-e env_name=value …

Sets the environment variables for this activity. Specify as many environment variable/value pairs as required to define the environment.

To specify multiple environment variable/value pairs, separate the pairs with a space.

command

Specifies the command to run.

The command to run must always be specified last.

activity view [activity_ID …]

Displays detailed information about the activities in the cluster, including its resources, allocations, current status, start time, and so on.

activity_ID …

Specifies the ID for the activity for which you want detailed information.

alloc free -a alloc_ID | -p consumer_name | -c client_name

Frees all allocations for the specified consumer or client, returning resources to the cluster and removing the allocation names.

-a alloc_ID

Specifies the ID of the allocation to free.

-p consumer_name

Frees all activities for the specified consumer.

Specify the unique consumer name, or the full path to the consumer name. Specify as many levels within the consumer tree as required to uniquely identify the consumer, as follows:

/top-level_consumer_name/. . . /leaf_consumer_name

-c client_name

Specifies the name of the client to which the allocation was made.

alloc list [-l] [-a alloc_ID] [-p consumer_name] [-c client_name]| [-r resource_name] [-t activity_ID]

Lists all allocations in the cluster, listing the allocation ID, consumer, client, resource groups and resources used by each allocation.

-l

Provides the same information with a longer name field, if some are truncated when -l is not specified.

-a alloc _ID

Lists the allocated resources for the specified allocation.

-p consumer_name

Lists all activities for the specified consumer.

Specify the unique consumer name, or the full path to the consumer name. Specify as many levels within the consumer tree as required to uniquely identify the consumer, as follows:

/top-level_consumer_name/. . . /leaf_consumer_name

-c client_name

Lists the resources allocated to the specified client.

-r resource_name

Lists all allocations that include the specified resource.

-t activity_ID

Lists all allocations that include the specified activity.

alloc modify -a alloc_ID [-m min_slots] -M max_slots [-delta]

Requests an increased number of resources for an existing allocation.

-a alloc_ID

Specifies the ID of the allocation to change.

-m min_slots

Specifies the minimum number of slots to be allocated, or the minimum additional slots to be allocated, depending on if -delta is specified.

-M max_slots

Specifies the maximum number of slots to be allocated, or the maximum additional slots to be allocated, depending on if -delta is specified.

-delta

Specifies that the minimum and maximum slots requested are in addition to the existing allocation for this consumer.

alloc new -p consumer_name -M max_slots [-m min_slots] [ -a alloc_name] [-exclusive] [-g resource_group] [-s slots_per_host] [-R res_req]

Requests a new resource allocation for the specified consumer from the specified resource group.

-p consumer_name

Specifies the consumer to allocate the resources to.

Specify the unique consumer name, or the full path to the consumer name. Specify as many levels within the consumer tree as required to uniquely identify the consumer, as follows:

/top-level_consumer_name/. . . /leaf_consumer_name

-M max_slots

Specifies the maximum number of slots to be allocated.

-m min_slots

Specifies the minimum number of slots to be allocated.

-a alloc_name

Specifies a name to identify the new allocation request.

Specify a name that is unique within the cluster. Specify up to 40 alphanumeric characters.

-exclusive

Specifies that this allocation request is for the exclusive use of these resources by this consumer.

Note that a host may still be distributed to several allocations if it appears in multiple host groups, despite indicating exclusive usage.

-g resource_group

Specifies the resource group from which to allocate resources.

-s slots_per_host

Specifies the number of slots per host required (on both single- and multi-CPU hosts).

-R res_req

Specifies the resource requirement to use to select the most appropriate host for this allocation.

Specify name value pairs for the resource requirement(s). Multiple resource requirements are separated with the characters &&.

Important:
If the command is issued in whole from the shell console or the requirement has white space in it , enclose the requirement in double quotation marks. For example:
>egosh resource list -R "select(mem>100 && it>1)"

If the command is issued from the egosh console, do not use quotation marks. For example:

>egosh
>resource list -R select(mem>100)

alloc release -a alloc_ID [-block] [-autoadjust] [-modify] host_name:nslots

Reduces an allocation by the specified number of hosts or slots.

-a alloc_ID

Specifies the ID of the allocation from which to release the slots.

-block

Releases the slots and prevents this host from being allocated to this consumer again.

Use this option if a host is not behaving properly. You can reverse this option later using the alloc unblock subcommand.

-autoadjust

Automatically adjusts the allocation request to match the current number of slots. This prevents the resources from being assigned back to the current allocation.

Issuing this command without specifying a number of slots removes any unfulfilled slot requests for this allocation, and modifies the request to the current number of slots.

Use this option when you do not expect to need the slots anymore.

-modify

Automatically decrements the allocation request by the number of slots being released. The -autoadjust option takes precedence over the -modify option.

host_name:nslots …

Releases the specified number of slots from the specified hosts.

Specify the name of the host followed by the number of slots to release from that host.

To specify multiple hosts and numbers of slots, separate the host and slot combinations with a space.

alloc unblock -a alloc_ID -n nhosts host_name

Specifies to allow blocked hosts to be allocated to this consumer again. Use this command to undo a previous alloc release -block subcommand.

-a alloc_ID

Specifies the ID of the allocation from which to unblock the host.

-n nhosts

Specifies the number of hosts to unblock, allowing the hosts to be allocated to this consumer again.

host_name …

Specifies the host names to unblock.

To specify multiple hosts, separate the hosts with a space.

alloc view [alloc_ID …]

Displays detailed information about all allocations, including the allocation ID, current users, consumer, resource groups, resource requirements, minimum and maximum slots requested, whether it has exclusive use of the host, names of the allocated hosts, and any blocked hosts.

alloc_ID …

Displays information about the specified allocation.

client list [-l] [-c client_name] [-a alloc_ID] [-p consumer_name] [-r resource_name] [-t activity_ID]

Displays a list of the registered clients in the cluster, and information about each client, including the host name and port number, the channel, and whether the client is connected. Client names are truncated to 12 characters.

-l

Provides the same information with a longer name field, if some are truncated when -l is not specified.

-c client_name

Specifies the client to which this action applies.

-a alloc_ID

Lists the client who has allocated to the specified allocation.

-p consumer_name

Lists all the clients for the specified consumer.

-r resource_name

Lists all the clients that are using the specified resource.

-t activity_ID

Lists the client that has started the specified activities.

client reg -c client_name [-d description] [-t TTL]

Registers the current EGO client with the system so that it can start sending requests to EGO for resources. Following registration, the client may be assigned allocations. The client is assigned a unique identifier such as autoAssignedClient 0 or autoAssignedClient1.

-c client_name

Specifies to register the client with a specific identifier.

Specify a name that is unique within the cluster. Specify up to 40 ASCII characters.

-d description

Specifies a description for the client being registered. This description appears with the information displayed using the client view subcommand. Enclose description in quotation marks if there are spaces within it.

-t TTL

Specifies the client TTL (time to live) in minutes. If the option is not set, default TTL is 900 minutes.

client rm client_name

Removes and unregisters the specified client from the system. Use this command to remove a client that is not responding.

client_name …

Specifies the name of the client to be removed.

client unreg

Unregisters the current client from the system. Once this operation completes, the client can no longer request resources from EGO.

After unregistration, all allocations to this client are released.

client view [client_name …]

Displays a list of the registered clients in the cluster, and information about each client, including the host name and port number, the channel, and whether the client is connected.

client_name …

Specifies the name of one or more clients you want to view.

client whoami

Prints the user name associated with the current client.

consumer alloc [-l] [consumer_name …]

Displays allocation and demand information for each leaf consumer.
-l

Provides the same information with a longer name field, if some are truncated when -l is not specified.

consumer_name

Specifies the name of the consumer(s) for which you want to display information.

consumer applyresplan [-c] [-e error_log_directory] file_path

Applies the resource plan specified in the file path. Once you apply it, the plan is in effect immediately.

This is an administrative subcommand. You must first log on as cluster administrator or consumer administrator before you can issue this subcommand.

-c

Checks the resource plan for validity and well formedness without applying it.

-e error_log_directory

Specifies the directory where stderr with error messages outputs.

file_path

Specifies the resource plan file you want in effect immediately. The file must be XML, valid, and well-formed. If it is rejected for any reason, the previously applied resource plan stays in effect.

consumer list [-l]

Displays a list of the full paths to the consumers in the cluster, and lists the administrators assigned to each consumer.

-l

Provides the same information with a longer name field, if some are truncated when -l is not specified.

consumer view [consumer_name …]

Displays a list of the consumers in the cluster, and detailed information about each consumer, including the administrators assigned to that consumer and the resource policies applied to each consumer.

consumer_name

Displays information about the specified consumer.

Specify the unique consumer name without the full path or, if it is not unique, specify the full path to the consumer name.

/top-level_consumer_name/. . . /leaf_consumer_name

debug limoff host_name … | all

Turns off debugging of the lim daemon on the specified hosts.

This is an administrative subcommand. You must first log on as cluster administrator before you can issue this subcommand.

host_name

Turns off debugging of the lim daemon on the specified host.

all

Turns off debugging of the lim daemon on all hosts in the cluster.

debug limon [-c log_class] [-p timing_level] [-f log_file] host_name …| all

Turns on debugging of the lim daemon to LOG_DEBUG level on the specified host.

This is an administrative subcommand. You must first log on as cluster administrator before you can issue this subcommand.

-c log_class

Specifies a log class, which limits the messages collected to specific types, or limits debugging to specific components. Use this option to filter out and reduce the amount of data kept.

To specify multiple log classes, separate the log classes with a space, and enclose the string in double quotes.

-p timing_level

Specifies function performance timing level to specify the number of layers of components to measure the time a process takes. Specify a number from 1 (time the process at the top component level) to 5 (time the processes at five layers depth). If no value is specified, timing is disabled.

-f log_file

Specifies the path and file name to where the log files are to be written. For example, if you specify -f /tmp/debuglog, the messages are logged to /tmp/debuglog.lim.log.hostname

If you do not specify a file name and path, defaults to the current log file.

host_name

Turns on debugging of the lim daemon on the specified host.

all

Turns on debugging of the lim daemons on all hosts in the cluster.

debug pemoff host_name … | all

Turns off debugging of the pem daemon on the specified hosts.

This is an administrative subcommand. You must first log on as cluster administrator before you can issue this subcommand.

host_name

Turns off debugging of the pem daemon on the specified host.

all

Turns off debugging of the pem daemon on all hosts in the cluster.

debug pemon [-t] [-c log_class] [-p timing_level] [-f log_file] [[-o "key=value"] …] host_name …| all

Turns on debugging of the pem daemon to LOG_DEBUG level on the specified host.

This is an administrative subcommand. You must first log on as cluster administrator before you can issue this subcommand.

-t

Sets the logging level to LOG_TRACE, which logs all program steps.

-c log_class

Specifies a log class, which limits the messages collected to specific types, or limits debugging to specific components. Use this option to filter out and reduce the amount of data kept.

To specify multiple log classes, separate the log classes with a space, and enclose the string in double quotes.

-p timing_level

Specifies function performance timing level to specify the number of layers of components to measure the time a process takes. Specify a number from 1 (time the process at the top component level) to 5 (time the processes at five layers depth). If no value is specified, timing is disabled.

-f log_file

Specifies the path and file name to where the log files are to be written. For example, if you specify -f /tmp/debuglog, the messages are logged to /tmp/debuglog.pem.log.hostname

If you do not specify a file name and path, defaults to the current log file.

-o "key=value"

Specifies the debug object class and identifier. The format is key=value, where valid values for key are ACTIVITY and ALLOC and value is the ID of the activity or allocation.

To specify multiple key and value pairs, specify -o for each object class and separate the options with a space.

host_name

Turns on debugging of the pem daemon on the specified host.

all

Turns on debugging of the pem daemons on all hosts in the cluster.

debug vemkdoff

Turns off dynamic debugging of the EGO kernel daemon vemkd.

This is an administrative subcommand. You must first log on as cluster administrator before you can issue this subcommand.

debug vemkdon [-t] [-c log_class] [-p timing_level] [-f log_file] [[-o "key=value"] …]

Turns on dynamic debugging of the EGO kernel daemon vemkd to LOG_DEBUG level.

This is an administrative subcommand. You must first log on as cluster administrator before you can issue this subcommand.

-t

Sets the logging level to LOG_TRACE, which logs all program steps.

-c log_class

Specifies a log class, which limits the messages collected to specific types, or limits debugging to specific components. Use this option to filter out and reduce the amount of data kept.

To specify multiple log classes, separate the log classes with a space and enclose the string in double quotes.

-p timing_level

Specifies function performance timing level to specify the number of layers of components to measure the time a process takes. Specify a number from 1 (time the process at the top component level) to 5 (time the processes at five layers depth). If no value is specified, timing is disabled.

-f log_file

Specifies the path to where the log files are to be written. For example, if you specify -f /tmp/debuglog, the messages are logged to /tmp/debuglog.vemkd.log.hostname

If you do not specify a file name and path, defaults to the current log file.

-o "key=value"

Specifies the debug object class and identifier. The format is key=value, where valid values for key are ACTIVITY and ALLOC and value is the ID of the activity or allocation.

To specify multiple key and value pairs, specify -o for each object class and separate the options with a space.

ego execpasswd -u user_name -x password [-noverify]

Registers and verifies the password for a Windows execution user account.

Registering the password allows EGO to use the account to run work on Windows hosts.

This is an administrative command. You must be cluster administrator to issue this command. In addition, to verify the password, you must be logged on to Windows as the OS account administrator, egoadmin.

-u user_name

Specifies the fully-qualified Windows user name of the execution account to register the password for.

-x password

Specifies the password to register for the Windows execution user account.

-noverify

Registers the password without verification. This option is required if you run this command from a UNIX host. Only a Windows host can verify this password.

ego elimrestart env_suffix env_value [-f] [host_name … | all]

Restarts/reconfigures external load information manager(s) with an environment variable (elim.sa). Generally used for host scavenging feature. During restart, the lim passes along configuration information to the scavenging agent about the thresholds of resources that are used to evaluate trigger conditions, whether the host is currently enabled for scavenging, and whether the grace period is disabled.

Note:

After running this command, it takes several seconds for the new configuration to take effect, dependent upon how frequently EGO refreshes host information (as set in EGO_RESOURCE_UPDATE_INTERVAL in ego.conf).

You must be logged on to Windows as the local systems OS account administrator, or logged on to Linux as the root OS account.

env_suffix

Always specify SA (scavenging agent) to indicate the host scavenging feature.

env_value

Specifies if host scavenging is currently enabled with grace period (on), enabled without grace period (fastrelease), or disabled (off) on this host.

Specifies the thresholds of load indices used to evaluate host workload and to trigger host scavenging.

Enter the environment value in this format, delimited by commas without any spaces: <scavenging_flag>,<user_idle_time_threshold_in_minutes>,<CPU_utilization_threshold_in_percentage>,<CPU_idle_time_threshold_in_minutes>.

For example:
egosh ego elimrestart SA fastrelease,2,0.3,1.67 all

This example enables (turns “on”) host scavenging on all hosts, disables the grace period, sets the user idle time threshold (uit_t) to 2 minutes, CPU utilization threshold (cu_t) to 30%, and CPU idle time threshold (cit_t) to 1.67 minutes (or 100 seconds).

Note:

Threshold values are specified by numbers greater than zero. They do not need to be whole numbers.

-f

Executes command immediately without asking for confirmation. Use this option when you are issuing egosh ego elimrestart from within a script and do not want the script to stop running to respond to prompts.

host_name …

Specifies the name of the host or hosts on which to restart/reconfigure the external load information manager(s).

To specify multiple hosts, separate the host names with a space.

If no host name is given, then control is assumed to be local.

all

Restarts/reconfigures the external load information manager (elim) on all hosts in the cluster.

ego info

Displays information about the cluster, including the cluster name, the name of the master host, and the version of EGO.

ego restart [-f] [host_name … | all]

Restarts EGO on the local host, or, if issued from the master host, restarts EGO on all the hosts in the cluster. Does not affect running work or services.

This is an administrative subcommand. On UNIX, you must be logged on with root permissions to issue this command. On Windows, you must be logged on as cluster administrator to issue this command.

-f

Forces the action on the host without validating the configuration file. Use this option when you are issuing the command from within a script and do not want the script to stop running to respond to prompts.

host_name …

Specifies the name of the host or hosts on which to restart EGO.

To specify multiple hosts, separate the host names with a space.

You cannot use this option from a compute host unless the master host is up and running.

all

Restarts EGO on all hosts in the cluster.

You cannot use this option from a compute host unless the master host is up and running.

ego shutdown [-f] [host_name … | all]

Stops EGO on the local host, or, if issued from the master host, stops EGO on all the hosts in the cluster.

This is an administrative subcommand. On UNIX, you must be logged on with root permissions to issue this command. On Windows, you must be logged on as cluster administrator to issue this command.

-f

Forces the action on the host without validating the configuration file. Use this option when you are issuing the command from within a script and do not want the script to stop running to respond to prompts.

host_name …

Specifies the name of the host or hosts on which to stop EGO.

To specify multiple hosts, separate the host names with a space.

You cannot use this option from a compute host unless the master host is up and running.

all

Stops EGO on all hosts in the cluster.

CAUTION:

Never use this option to shut down the cluster. To shut down the entire cluster, run the egoshutdown command.

You cannot use this option from a compute host unless the master host is up and running.

ego start [-f] [host_name … | all]

Starts EGO on the local host or, if issued from the master host, starts EGO on all the hosts in the cluster.

This is an administrative subcommand. On UNIX, you must be logged on with root permissions to issue this command. On Windows, you must be logged on as cluster administrator to issue this command.

-f

Forces the action on the host without validating the configuration file. Use this option when you are issuing the command from within a script and do not want the script to stop running to respond to prompts.

host_name …

Specifies the name of the host or hosts on which to start EGO.

To specify multiple hosts, separate the host names with a space.

You cannot use this option from a compute host unless the master host is up and running.

To use this option on UNIX, you must have root permission on each host and have rsh configured for your account for each host. You may need to add an entry for the local host in the .rhosts file for root.

Note:

You cannot start EGO on a UNIX host from a Windows host, or vice versa.

all

Starts EGO on all hosts in the cluster. Use this option when you want to start the entire cluster.

You cannot use this option from a compute host unless the master host is up and running.

To use this option on UNIX, you must have root permission on each host and have rsh configured for your account. You may need to add an entry for the local host in the .rhosts file for root.

Note:

You cannot start EGO on UNIX hosts from a Windows host, or vice versa.

quit | q

Closes the interactive command console. If you are logged on to EGO, quit does not log you off when it closes the command console. Alias: q.

resource close [-reclaim] resource_name

Closes a resource, preventing further allocation. Closing a resource does not change its allocation status. If the resource is currently allocated to a consumer, the resource remains allocated until the consumer returns it voluntarily. If the resource is not currently allocated to a consumer, the resource remains in its unallocated state. Existing workload finishes running before closing.

This is an administrative subcommand. You must first log on as cluster administrator before you can issue this subcommand.

-reclaim

EGO reclaims the host before it closes; running workload terminates as per the configured grace period. The host is prevented from further allocation. If the resource is currently allocated to a consumer, it is reclaimed. Once reclaimed, it is not allocated to another consumer.

After issuing this command, the host status changes to CLOSED; the reported reason is “cluster administrator closes and reclaims host”.

resource_name …

Specifies the name of the resource or resources to close.

To close multiple resources, separate the resource names with a space.

(resource group) | rg [-l] [group_name ... ]

Displays information about all of the resource groups in the cluster including the number of hosts in the group, the total number of slots, the number of free and allocated slots, and detailed usage information describing distribution among consumers.

rg

Is an alias to the resource group subcommand. You can use this as a shortcut instead of typing the full subcommand name.

  • ALLOCATED: Indicates the total number of resources allocated to a consumer.

  • FREE: Indicates the total number of unused resources, including unused owned and unused shared (guaranteed), as per the resource plan

  • OWN: Indicates the configured ownership numbers, as per the resource plan.

  • SHARE: Indicates the configured share percentage among siblings, as per the resource plan.

-l

Lists values for allocated and free slots within resource groups. Detailed usage information includes breakdown of owned, shared, and borrowed slots (both in-use and unused slots) in the cluster:

  • OWN_USE: Indicates number of owned resources assigned to consumer.

  • SHARE_USE: Indicates number of resources assigned to consumer from share pool.

  • BORROW_USE: Indicates number of resources borrowed from other consumers.

  • OWN_FREE: Indicates number of remaining (unused) owned resources as guaranteed from resource plan.

  • SHARE_FREE: Indicates number of remaining (unused) share pool resources as guaranteed from resource plan.

Note:

Values for OWN_FREE and SHARE_FREE may not add up to the actual "free" or total number of resources for the resource group. Some resources reflected in the number may be reclaimed resources.

group_name

Specifies the name of the resource group for which you want information displayed. For example, ManagementHosts.

resource list [-l ] [-m | -s | -t | -a | -o attribute,…] [-R res_req] [resource_name …]

Displays information about the resources in the cluster, listing each host and information about the resources on each host.

-l

Provides the same information with a longer name field, if some are truncated when -l is not specified.

-m

Displays the list of failover candidate hosts in the cluster and identifies which host is currently the master.

-s

Displays summaries of the hosts in the cluster, including information on host states and resource utilization.

-t

Displays a list of host types defined in the cluster.

-a

Displays all load indices for all resources.

-o attribute,…

Specifies the attributes to include in the display. Use this option to customize the output, including only those attributes you are interested in. For example:

resource list -o status,type,ncpus

Specify one (or more) of the following:
  • status: Current state of the host

  • type: Type of host

  • ncpus: Number of CPUs as seen by EGO (value used to determine the number of slots; can be overridden by resource group configuration)

  • nprocs: Number of physical processors (if ncpus defined as procs, then ncpus = nprocs)

  • ncores: Number of cores per processor (if ncpus defined as cores, then ncpus = nprocs * ncores)

  • nthreads: Number of threads per core (if ncpus defined as threads, then ncpus = nprocs * ncores * nthreads)

  • ut: CPU utilization

  • mem: Available memory

  • swp: Available swap space

  • pg: Paging rate

  • io: Disk I/O rate

  • slot: Number of slots

  • freeslot: Number of free slots

  • r15s: 15-second load

  • r15m: 15-minute load

  • r1m: 1-minute load

  • model: The host model

  • cpuf: The CPU factor

  • maxmem: Maximum memory

  • maxswp: Maximum swap space

  • tmp: Available temp space

  • maxtmp: Maximum space in /tmp

  • ndisks: Number of local disks

  • it: Idle time

  • ls: Logon users

  • resourceattr: Resource attributes assigned to this host

  • processpri: The OS process priority of cluster workloads (either normal or lowest)

Note:

You cannot use this command option to view global ncpu settings. This information can only be viewed directly in the shared copy of ego.conf.

-R res_req

Displays information about the resources that match the resource requirement string specified.

Specify name value pairs for the resource requirement(s). Multiple resource requirements are separated with the characters &&.
Important:
If the command is issued in whole from the shell console or the requirement has white space, enclose the requirement in double quotation marks. For example:
>egosh resource list -R "select(mem>100 && it>1)"

If the command is issued from the egosh console, do not use quotation marks. For example:

>egosh
>resource list -R select(mem>100)
resource _name …

Specifies the name of the resource you want to list.

Displays information about the resource with the specified name.

resource open resource_name

Opens the specified resource, allowing it to accept requests.

This is an administrative subcommand. You must first log on as cluster administrator before you can issue this subcommand.

resource _name …

Specifies the name of the resource or resources to open.

To open multiple resources, separate the resource names with a space.

resource setpriority -lowest | -normal resource_name

Sets the OS process priority of cluster workloads running on scavenge-capable hosts.

This is an administrative subcommand. You must first log on as cluster administrator before you can issue this subcommand.

-lowest

Specifies to set the process priority to lowest. EGO allocates this resource to run workload at the lowest process priority as controlled by the operating system.

-normal

Specifies to set the process priority to normal (default). EGO allocates this resource to run workload at normal process priority as controlled by the operating system.

resource _name …

Specifies the name of the resource or resources on which to set the OS process priority.

Separate multiple resource names with a space.

resource view [resource_name …]

Displays all the information about all resources.

resource _name …

Specifies the name of the resource or resources you want to view.

Displays information about the specified resource or resources.

To view multiple resources, separate the resource names with a space.

service list [-l] [-s service_name] [-a alloc_ID] [-p consumer_name] [-r resource_name]

Lists registered service(s) defined in EGO service controller.

-l

Provides the same information with a longer name field, if some are truncated when -l is not specified.

-s service_name

Specifies the service to which this action applies.

-a alloc_ID

Lists all services that belong to the specified allocation.

-p consumer_name

Lists all the services for the specified consumer.

-r resource_name

Lists all the services that are using the specified resource.

service start service_name … | all

Starts registered service(s) defined in EGO service controller. If this is a service that is configured to start automatically, enables the service to be started automatically.

This is an administrative subcommand. You must first log on as cluster administrator before you can issue this subcommand.

service_name …

Starts the specified service(s).

all

Starts all registered services.

service stop service_name … | all

Stops registered service(s) defined in EGO service controller.

This is an administrative subcommand. You must first log on as cluster administrator before you can issue this subcommand.

service_name …

Stops the specified service(s).

all

Stops all registered services.

service view [service_name ...]

Displays registered service(s) defined in EGO service controller.

service_name …

Displays information about the specified service(s).

user add -u user_account -x password [-e email] [-t telephone] [-d description]

Creates a new user account in the EGO user database with the specified name.

This is an administrative subcommand. You must first log on as cluster administrator before you can issue this subcommand.

-u user_account

Specifies the name of the user account to create.

Specify a unique name with up to 32 alphanumeric or special characters, except greater than (>), less than (<), ampersand (&), or control characters (Ctrl + key).

-x password

Specifies the password to be used to authenticate the user when this user account is accessed.

Specify one to eight alphanumeric or special characters, except greater than (>), less than (<), ampersand (&), or control characters (Ctrl + key).

-e email

Specifies the email address of the user to whom this account belongs.

Specify up to 64 alphanumeric or special characters, except greater than (>), less than (<), ampersand (&), or control characters (Ctrl + key).

-t telephone

Specifies the telephone number of the user to whom this account belongs.

Specify up to 20 numbers and spaces.

-d description

Specifies any additional information about the user account or the user to whom this account belongs.

Specify up to 200 alphanumeric or special characters, except control characters (Ctrl + key). Enclose description in quotation marks if there are spaces within it.

user assignrole -u user_account -r role [-p consumer_name]

Assigns the specified role to the specified user account, and optionally specifies the consumer this role applies to.

This is an administrative subcommand. You must first log on as cluster administrator or consumer administrator before you can issue this subcommand.

-u user_account

Specifies the user account to assign the role to. The user account specified must already exist prior to issuing this command.

-r role
Specifies the role to assign. Specify one of the following:
  • CLUSTER_ADMIN

  • CONSUMER_ADMIN

  • CONSUMER_USER

Specify CLUSTER_ADMIN to assign a user account the role of cluster administrator, with administrative authority for all consumers in the cluster. You do not need to specify a path.

Specify CONSUMER_ADMIN to assign a user account the role of consumer administrator for the specified consumer. You must specify the full path to the consumer name over which this user account should have administrative authority.

Specify CONSUMER_USER to assign a user account the role of consumer user. This role has no administrative authority, but is authorized to use resources allocated to the specified consumer. You must specify the full path to the consumer name when specifying this role.

-p consumer_name

Specifies the consumer for which this user is assigned the specified role.

Examples:

The following example assigns George Smith the role of cluster administrator:

egoadmin@egosh> user assignrole -u gsmith -r CLUSTER_ADMIN

The following example assigns Karen Dayton the role of consumer administrator for the UAT consumer and all of its descendants:

egoadmin@egosh> user assignrole -u kdayton -r CONSUMER_ADMIN -p testcluster/UAT

The following example assigns Mark Chase the role of consumer user for the bugtest application, which is a descendant of the UAT consumer:

egoadmin@egosh> user assignrole -u mchase -r CONSUMER_USER -p testcluster/UAT/bugtest

user delete -u user_account

Deletes a user account from the EGO user database.

This is an administrative subcommand. You must first log on as cluster administrator before you can issue this subcommand.

-u user_account

Specifies the name of the user account to be deleted.

user list [-l]

Displays all user accounts in the EGO user database and the values specified for phone, email, and description.

-l

Provides the same information with a longer name field, if some are truncated when -l is not specified.

user logoff

Logs off the current user account from EGO. Logging off does not close the interactive command interface session but does prevent the user from issuing administrative subcommands.

user logon -u user_account -x password

Initiates the log on sequence to EGO, prompting for user account and password.

Note:

You are automatically logged off of EGO after 8 hours. To perform another administrative command after expiry, you are required to log on again. The logon expiry time is not configurable.

-u user_account

Specifies the EGO user account to use to log on.

-x password

Specifies the password to use to authenticate the log on sequence.

user modify -u user_account [-x password] [-e email] [-t telephone] [-d description]

Changes user account values to those specified for a user account defined in the EGO user database.

This is an administrative subcommand. You must first log on as cluster administrator before you can issue this subcommand.

-u user_account

Specifies the name of the user account to modify. You cannot modify the name itself.

-x password

Specifies the new password to be used to authenticate the user when this user account is accessed.

Specify one to eight alphanumeric or special characters, except greater than (>), less than (<), ampersand (&), or control characters (Ctrl + key).

-e email

Specifies a new email address of the user to whom this account belongs.

Specify up to 64 alphanumeric or special characters, except greater than (>), less than (<), ampersand (&), or control characters (Ctrl + key).

-t telephone

Specifies the telephone number of the user to whom this account belongs.

Specify up to 20 numbers and spaces.

-d description

Specifies any additional information about the user account or the user to whom this account belongs.

Specify up to 200 alphanumeric or special characters, except control characters (Ctrl + key). Enclose description in quotation marks if there are spaces within it.

user roles4user -u user_account

Lists the roles assigned to a user account.

-u user_account

Specifies the user account for which to list the roles.

user users4role -r role [-p consumer_name]

Lists all user accounts in the EGO user database that have the specified role. For consumer administrators, this command also lists the consumer this user can administer. For consumer users, this command also lists the consumer to which the user has access.

-r role
-r role
Specifies the role to list all users for. Specify one of the following:
  • CLUSTER_ADMIN

  • CONSUMER_ADMIN

Specifies the role to list all users for. Specify one of the following:
  • CLUSTER_ADMIN

  • CONSUMER_ADMIN

  • CONSUMER_USER

-p consumer_name

Lists all users’ accounts and their roles for the specified consumer. If you specified the role CLUSTER_ADMIN, a consumer_name is not needed. If you specified either of the other two roles, a consumer_name is required.

user unassignrole -u user_account -r role [-p consumer_name]

Removes the specified role from the specified user account. Optionally, specifies the consumer to which this action applies or removes this role from all descendants of the specified consumer.

This is an administrative subcommand. You must first log on as cluster administrator or consumer administrator before you can issue this subcommand.

-u user_account

Specifies the user account to remove the role from.

-r role
Specifies the role to remove. Specify one of the following:
  • CLUSTER_ADMIN

  • CONSUMER_ADMIN

  • CONSUMER_USER

-p consumer_name

Specifies the consumer for which this role is removed from the user account.

user view [user_account …]

Displays a list of EGO user accounts.

user_account

Specifies the name of the specific user account(s) to view.