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.
Terminates all activities for the specified allocation, consumer or client.
Signals are operating-system dependent. Refer to the list of signals available for your operating system.
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:
Specifies the name of the client to which this action applies.
Lists all activities in the cluster.
Provides the same information with a longer name field, if some are truncated when -l is not specified.
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".
Lists all activities that belong to the specified allocation.
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:
Specifies the name of the client to which this action applies.
Lists all the activities that are using the specified resource.
Starts an activity on the specified host.
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.
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:
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:
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:
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:
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:
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:
Specifies the maximum number of open file descriptors this activity may use.
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:
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.
Redirects standard out and standard error of the activity to the specified files.
Specify an absolute or relative path. If you specify a relative path, the path will be relative to the execution working directory of the activity process creating/operning the file.
If you use relative paths on Windows, the path will be relative to the execution working directory of the parent PEM. ????
If the files do not exist, they are created. If the files exist, information is appended to the files. Once the files are created, it is your responsibility to maintain them.
For file naming limitations and conventions, refer to the specific operating-system documentation. In addition, take into account the following when naming files:
Do not use semi-colon (;) or quotation marks (" ’) in the file name.
Do not use UNC paths. For example, //hostA/mountpoing/myfile. You will need to mount the network accessible mount point as a local drive instead of using an UNC path.
Spaces in file names are allowed as long as the whole argument is enclosed in quotes. For example: -f "IN=myfile;OUT=outfile".
Frees all allocations for the specified consumer or client, returning resources to the cluster and removing the allocation names.
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:
Specifies the name of the client to which the allocation was made.
Lists all allocations in the cluster, listing the allocation ID, consumer, client, resource groups and resources used by each allocation.
Provides the same information with a longer name field, if some are truncated when -l is not specified.
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:
Requests an increased number of resources for an existing allocation.
Specifies the minimum number of slots to be allocated, or the minimum additional slots to be allocated, depending on if -delta is specified.
Specifies the maximum number of slots to be allocated, or the maximum additional slots to be allocated, depending on if -delta is specified.
Specifies that the minimum and maximum slots requested are in addition to the existing allocation for this consumer.
Requests a new resource allocation for the specified consumer from the specified resource group.
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:
Specifies a name to identify the new allocation request.
Specify a name that is unique within the cluster. Specify up to 40 alphanumeric characters.
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.
Specifies the resource group from which to allocate resources.
Specifies the number of slots per host required (on both single- and multi-CPU hosts).
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 &&.
>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:
Reduces an allocation by the specified number of hosts or slots.
Specifies the ID of the allocation from which to release the slots.
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.
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.
Automatically decrements the allocation request by the number of slots being released. The -autoadjust option takes precedence over the -modify option.
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.
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.
Specifies to register the client with a specific identifier.
Specify a name that is unique within the cluster. Specify up to 40 ASCII characters.
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.
Specifies the client TTL (time to live) in minutes. If the option is not set, default TTL is 900 minutes.
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.
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. For a complete list of log classes, refer to the Troubleshooting section of the Cluster and Application Management Guide.
To specify multiple log classes, separate the log classes with a space, and enclose the string in double quotes.
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.
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.
Turns on debugging of the lim daemons on all hosts in the cluster.
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.
Sets the logging level to LOG_TRACE, which logs all program steps.
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. For a complete list of log classes, refer to the Troubleshooting section of the Cluster and Application Management Guide.
To specify multiple log classes, separate the log classes with a space, and enclose the string in double quotes.
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.
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.
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.
Turns on debugging of the pem daemons on all hosts in the cluster.
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.
Sets the logging level to LOG_TRACE, which logs all program steps.
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. For a complete list of log classes, refer to the Troubleshooting section of the Cluster and Application Management Guide.
To specify multiple log classes, separate the log classes with a space and enclose the string in double quotes.
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.
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.
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.
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.
Specifies the fully-qualified Windows user name of the execution account to register the password for.
Specifies the password to register for the Windows execution user account.
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.
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 such as 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.
You must be logged on to Windows as the local systems OS account administrator, or logged on to Linux as the root OS account.
Specifies whether to enable host scavenging with grace period (on), enable host scavenging without grace period (fastrelease), or disable (off) host scavenging 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>,<Adjusted_CPU_utilization_threshold_in_percentage>,<CPU_idle_time_threshold_in_minutes>.
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, Adjusted CPU utilization threshold (cu_t) to 30%, and CPU idle time threshold (cit_t) to 1.67 minutes (or 100 seconds).
Specifies processes that will cause the host to be closed if the processses are running. A process name can be specified either with or without a path; if specified without a path, it must be unique; if specified with a path, the path cannot include spaces. The list of process names is limited to 256 characters.
Specifies the processes to be excluded from the calculation of Adjusted CPU utilization for one or more hosts. A process name can be specified either with or without a path; if specified without a path, it must be unique; if specified with a path, the path cannot include spaces. The list of process names is limited to 256 characters.
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.
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.
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.
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.
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.
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.
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.
Stops EGO on all hosts in the cluster.
You cannot use this option from a compute host unless the master host is up and running.
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.
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.
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.
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.
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.
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”.
Specifies a reason why this action was requested. The reason can comprise up to 1024 alphanumeric or special characters, except control characters (Ctrl + key) and multi-byte characters. The description must be enclosed in double quotes (" ") if it contains spaces.
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.
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.
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.
Specifies the name of the resource group for which you want information displayed. For example, ManagementHosts.
Displays information about the resources in the cluster, listing each host and information about the resources on each host.
Provides the same information with a longer name field, if some are truncated when -l is not specified.
Displays the list of failover candidate hosts in the cluster and identifies which host is currently the master.
Displays summaries of the hosts in the cluster, including information on host states and resource utilization.
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
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)
processpri: The OS process priority of cluster workloads (either normal or lowest)
Displays information about the resources that match the resource requirement string specified.
>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:
Specifies the name of the resource you want to list.
Displays information about the resource with the specified name.
Removes the specified host from the cluster. EGO is also shut down if the host is closed. To remove a host, it must have joined the cluster dynamically and is now either unavailable or closed without running workload.
This is an administrative subcommand. You must first log on as cluster administrator before you can issue this subcommand.
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.
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).
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).
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).
Specifies the telephone number of the user to whom this account belongs.
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.
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.
Specifies the user account to assign the role to. The user account specified must already exist prior to issuing this command.
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.
Specifies the consumer for which this user is assigned the specified role.
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.
Specifies the name of the user account to modify. You cannot modify the name itself.
Specifies the new password to be used to authenticate the user when this user account is accessed.
Specify one to sixteen alphanumeric or special characters. Certain special characters such as greater than (>) and less than (<) are not valid when used with the -x option. In such cases, enter the new password at the prompt after issuing the user modify command instead of using the -x option.
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).
Specifies the telephone number of the user to whom this account belongs.
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.
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. For users with custom roles, the consumer is not listed.
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 predefined roles, a consumer_name is required. The consumer_name option does not apply to custom roles.
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.