consumer

The egosh consumer sub-command manages the consumer tree in your cluster.

consumer add consumer_path [-e execution_user] [-a admin[,admin…]] [-u user [,user…]] [-g resource_group [,resource_group…]] [-r reclaim_grace] [-R rebalance]

Adds a new consumer.

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

consumer_path
Specifies the path of the consumer.
  • The consumer name must be unique, and can be the name of a department or project in your structure.
  • The consumer name must start with a letter.
  • The consumer name can only contain the following characters: 0 to 9, lowercase letters, uppercase letters, hyphens (-), or underscores (_). It cannot contain these characters: \ / : * ? \ " < > | '
  • The consumer name can be a maximum of 128 characters.
-e execution_user
Specifies the execution user for the consumer.
-a admin[,admin...]
Lists the administrators for the consumer. Default is empty.
-u user[,user...]
Lists the users for the consumer. Default is empty.
-g resource_group[resource_group...]
Lists the resource groups for the consumer. Default is empty.
-r reclaim_grace
The grace period to reclaim resources in seconds. Default is 0.
-R rebalance
Specifies to rebalance the consumer after the resource plan or time interval changes. Default is false.

consumer addrg consumer_path -g resource_group [,resource_group]

Adds a resource group to a consumer a new consumer.

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

-g resource_group [resource_group]
Lists the resource groups for the consumer. Default is empty.

consumer adduser consumer_path [-a admin[,admin…]] [-u user [,user…]]

Adds administrators and/or users to a consumer a new consumer.

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

-a admin[,admin...]
Lists the administrators for the consumer. Default is empty.
-u user[,user...]
Lists the users for the consumer. Default is empty.

consumer alloc [-g] [-l] [-MDS -P plan_name] [consumer_name …]

Displays allocation and demand information for each consumer.
-g
Displays resource group details.
-l
Displays the same information with a longer name field, if some field names are truncated when -l is not specified.
-MDS
Displays allocation information from multidimensional scheduling.
-P plan_name
Specifies the resource plan name.
consumer_name
Specifies the name of the consumers for which you want to display information.

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

Enables the resource plan specified in the file path. Once you apply it, the plan is enabled and 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.

Note: The egosh consumer applyresplan and egosh consumer exportresplan subcommands are applicable to slot-base resource plans without calendar-based information. Once you create a calendar-based resource plan using the egosh resplancal subcommand, or the cluster management console, use that subcommand instead of the egosh consumer applyresplan and egosh consumer exportresplan ones.
-c
Checks the resource plan for validity without applying it.
-e error_log_directory
Specifies the directory where stderr with error messages outputs.
-f
Forces the resource plan to update and overwrites the current resource plan. Use this option if there is a conflict between more than one user updating a resource plan, and you want to overwrite the resource plan with your changes.
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 delete consumer_path

Deletes a consumer.

consumer exportresplan file_path

Exports the slot-based resource plan that is used in the cluster as an XML file to a directory of your choice. Use this command to export the resource plan to a specified directory and modify it as required. After you are done, import the modified file back to the system (with the egosh consumer applyresplan command).

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

Note: The egosh consumer applyresplan and egosh consumer exportresplan subcommands are applicable to slot-base resource plans without calendar-based information. create a calendar-based resource plan using the egosh resplancal subcommand, or the cluster management console, use that subcommand instead of the egosh consumer applyresplan and egosh consumer exportresplan ones.
file_path
Specifies the directory to which you want to export the resource plan as an XML file.

consumer list [-l] [-ll] [-o alert_attribute][-n]

Displays a list of the full paths to the consumers in the cluster, and lists the administrators and execution users assigned to each consumer. You can optionally show SNMP events preferences at the consumer level.

-l
Provides the same information with a longer name field, if some are truncated when -l is not specified.
-ll
Provides the same information as the -l option, and in comma-separated values (CSV) format.
-o alert_attribute
Specifies the SNMP event (alert) attributes to include in the display. Valid values are ALERTMINIMUM, ALERTTIMEOUT, or all:
  • ALERTMINIMUM: Displays the minimum number of resources (slots) allocated for each consumer. When the minimum allocation is not met, the system sends an SNMP event.
  • ALERTTIMEOUT: Displays the duration to wait before sending an SNMP event for the consumer.
  • all: Displays both the minimum slots allocated, and the wait time before sending an SNMP event, for the consumer.
-n
Specifies not to list the administrators assigned to each consumer. For best performance, use this option if you have many administrators and are running the egosh consumer list command.

consumer modify consumer_path [-a admin[,admin…]] [-u user [,user…]] [-g resource_group [,resource_group…]] [-r reclaim_grace] [-R rebalance]

Modifies an existing consumer.

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

-p consumer path
Specifies the path of the consumer.
-a admin[,admin...]
Lists the administrators for the consumer. Default is empty.
-u user[,user...]
Lists the users for the consumer. Default is empty.
-g resource_group[resource_group...]
Lists the resource groups for the consumer. Default is empty.
-r reclaim_grace
The grace period to reclaim resources in seconds. Default is 0.
-R rebalance
Specifies to rebalance the consumer after the resource plan or time interval changes. Default is false.

consumer removerg consumer_path -g resource_group [,resource_group]

Removes a resource group from a consumer a new consumer.

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

-g resource_group [resource_group]
Lists the resource groups for the consumer. Default is empty.

consumer removeuser consumer_path [-a admin[,admin…]] [-u user [,user…]]

Removes administrators and/or users from a consumer a new consumer.

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

-a admin[,admin...]
Lists the administrators for the consumer. Default is empty.
-u user[,user...]
Lists the users for the consumer. Default is empty.

consumer view [-MDS -P resplan_name] [-l] [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. Also displays the enabled resource plan policy if you have created a calendar-based resource plan (using the egosh resplancal add subcommand, or the cluster management console).

-MDS
Display consumers defined in multidimensional distribution tree.
-P resplan_name
Specifies resource plan name as a filter.
-l
Displays more detailed information.
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 in this format: 
/first-level_consumer_name/. . . /leaf_consumer_name