| Moab Workload Manager® |
19.3 Trigger Components
19.3.1 Trigger Attributes
Table1: Trigger Attributes| AType | |||
| Possible Values: | cancel, changeparam, jobpreempt, mail, exec, query, internal | ||
| Description: | Specifies what kind of action the trigger will take when it fires. | ||
| Usage Notes: | jobpreempt indicates that the trigger should preempt all jobs currently allocating resources assigned to
the trigger's parent object. cancel and jobpreempt only apply to reservation triggers. query allows a trigger to import variables from another object. |
||
| Action | |||
| Possible Values: | <STRING> | ||
| Description: | For exec atype triggers, signifies executable and arguments. For jobpreempt atype triggers, signifies PREEMPTPOLICY to apply to jobs that are running on allocated resources. For changeparam atype triggers, specifies the parameter to change and its new value (using the same syntax and behavior as the changeparam command). | ||
| Usage Notes: | |||
| BlockTime | |||
| Possible Values: | [[HH:]MM:]SS | ||
| Description: | Time (in seconds) Moab will suspend normal operation to wait for trigger execution to finish. | ||
| Usage Notes: | Use caution as Moab will completely stop normal operation until BlockTime expires. | ||
| Description | |||
| Possible Values: | <STRING> | ||
| Description: | Description of the trigger. | ||
| Usage Notes: | |||
| ExpireTime | |||
| Possible Values: | <INTEGER> | ||
| Description: | Time at which trigger should be terminated if it has not already been activated. | ||
| Usage Notes: | |||
| EType | |||
| Possible Values: | cancel, checkpoint, create, end, epoch, fail, hold, migrate, modify, preempt, standing, start, threshold | ||
| Description: | The type of event that signals that the trigger can fire. | ||
| Usage Notes: | The threshold value applies to reservation triggers and gmetrics on nodes. Cancel triggers are the only triggers to fire when the parent object is either canceled or deleted (though its dependencies, if any, must still be satisfied). Hold, preempt, and checkpoint only apply to job triggers. Standing allows regular periodic triggers that fire at regular offsets (standing triggers automatically set the interval and multifire attributes). | ||
| FailOffset | |||
| Possible Values: | [[HH:]MM:]SS | ||
| Description: | Specifies the time (in seconds) that the threshold condition must exist before the trigger fires. | ||
| Usage Notes: | |||
| Flags | |||
| Possible Values: | (See Table 2.) | ||
| Description: | Specifies various trigger behaviors and actions. | ||
| Usage Notes: | |||
| Interval | |||
| Possible Values: | <BOOLEAN> | ||
| Description: | When used in conjunction with MultiFire and RearmTime trigger will fire at regular intervals. | ||
| Usage Notes: | Can be used with EType epoch to create a Standing Trigger. | ||
| MaxRetry | |||
| Possible Values: | <INTEGER> | ||
| Description: | Specifies the number of times Action will be attempted before the trigger is designated a failure. | ||
| Usage Notes: | If Action fails, the trigger will be restarted immediately (up to MaxRetry times). If it fails more than MaxRetry times, the trigger will be considered to have failed. This restart ignores FailOffset and RearmTime. Multifire does not need to be specified in order to get this behavior. | ||
| MultiFire | |||
| Possible Values: | <BOOLEAN> | ||
| Description: | Specifies whether this trigger can fire multiple times. | ||
| Usage Notes: | |||
| Name | |||
| Possible Values: | <STRING> | ||
| Description: | Name of trigger | ||
| Usage Notes: | Because Moab uses its own internal ID to distinguish triggers, the Name need not be unique. Only the first 16 characters of Name are stored by Moab. | ||
| Offset | |||
| Possible Values: | [-][[HH:]MM:]SS | ||
| Description: | Relative time offset from event when trigger can fire. | ||
| Usage Notes: | Offset cannot be used with cancel.
|
||
| Period | |||
| Possible Values: | Hour, Day, Week, Month | ||
| Description: | Can be used in conjunction with Offset to have a trigger fire at the beginning of the specified period. | ||
| Usage Notes: | Can be used with EType epoch to create a standing trigger. | ||
| RearmTime | |||
| Possible Values: | [[HH:]MM:]SS | ||
| Description: | Time between MultiFire triggers; rearm time is enforced from the trigger event time. | ||
| Usage Notes: | |||
| Requires | |||
| Possible Values: | '.' delimited string | ||
| Description: | Variables this trigger requires to be set or not set before it will fire. | ||
| Usage Notes: | Preceding the string with an exclamation mark (!) indicates this variable must NOT be set. Used in conjunction with Sets to create trigger dependencies. | ||
| Sets | |||
| Possible Values: | '.' delimited string | ||
| Description: | Variable values this trigger sets upon success or failure. | ||
| Usage Notes: | Preceding the string with an exclamation mark (!) indicates this variable is set upon trigger failure. Preceding the string with a caret (^) indicates this variable is to be exported to the parent object when the current object is destroyed through a completion event. Used in conjunction with Requires to create trigger dependencies. | ||
| UnSets | |||
| Possible Values: | '.' delimited string | ||
| Description: | Variable this trigger destroys upon success or failure. | ||
| Usage Notes: | |||
| Threshold | |||
| Possible Values: | {<METRIC>[<METRICNAME>]}{> >= < <= == !=}<FLOAT> Where <METRIC> is one of:
|
||
| Description: | Reservation usage threshold - When reservation usage drops below Threshold, trigger will fire. | ||
| Usage Notes: | Threshold usage support is only enabled for reservations and applies to percent processor utilization. gmetric thresholds are supported with job, node, credential, and reservation triggers. See 19.4.3 Threshold Triggers for more information. | ||
| Timeout | |||
| Possible Values: | [+|-][[HH:]MM:]SS | ||
| Description: | Time allotted to this trigger before it is marked as unsuccessful and its process (if any) killed. | ||
| Usage Notes: | Specifying '+' or a '-' calculates the timeout relative to the parent object's duration. | ||
19.3.2 Trigger Flags
Table 2: Trigger Flag Values| Flag | Description |
|---|---|
| attacherror | If the trigger outputs anything to stderr, Moab will attach this as a message to the trigger object. |
| cleanup | If the trigger is still running when the parent object completes or is canceled, the trigger will be killed. |
| checkpoint | Moab should always checkpoint this trigger. See Checkpointing Triggers for more information. |
| globalvars | The trigger will look in the name space of all nodes with the globalvars flag in addition to its own name space. A specific node to search can be specified using the following format: globalvars+node_id |
| interval | Trigger is periodic. |
| multifire | Trigger can fired multiple times. |
| probe | The trigger's stdout will be monitored. |
| probeall | The trigger's stdout will be monitored. |
| user | The trigger will execute under the user ID of the object's owner. If the parent object is sched, the user to run under may be explicitly specified using the format user+<username>, for example flags=user+john: |
 |
When specifying multiple flags, each flag can be delimited by colons (:) or with square brackets ([ and ]); for example:
Flags=[user][cleanup][probe] or Flags=user:cleanup:probe |
See Also
- Event Handling Case Study
- Generic Metrics
- Generic Events