8.4.7 Fields: Job Templates

See the associated 4.10  Job Templates resource section for more information on how to use this resource and supported operations.

Additional References

Type Value Additional Information
Permissions resource job-templates Permissions
Hooks filename job-templates.groovy Pre- and Post-Processing Hooks
Distinct query-supported No Distinct

JobTemplate

This class represents a job template in the Moab Workload Manager. Job templates are used for two primary purposes: (1) to provide a means of generically matching and categorizing jobs, and (2) to provide a means of setting arbitrary default or forced attributes for certain jobs.

Field Name Type Description
id String

The unique identifier for this job template.
account String

The account under which this job will run for billing purposes.
args String

Command-line arguments that get passed to commandFile.
commandFile String

The path to the file that is executed when the job runs. This is the script that will actually call all the work of the job. Can be null.
description String

The description of the job.
durationRequested Long

The amount of time (in seconds) requested for the job.
genericSystemJob Boolean

True if this template will instantiate a generic system job.
inheritResources Boolean

True if jobs instantiated from this template inherit resources.
jobDependencies Set<JobTemplateDependency>

The list of dependencies for this job template.
jobFlags Set<JobFlag>

Job flags for this template.
jobTemplateFlags Set<JobTemplateFlag>

Job template flags for this template.
jobTemplateRequirements Set<JobTemplateRequirement>

The requirements for this job template.
priority Long

Relative job priority.
qos String

The Quality of Service for the job.
queue String

The class or queue in which the job will run.
select Boolean

True if job template can be directly requested by job at submission.
trigger Trigger

The trigger that is typically assigned to generic system jobs.

JobTemplateDependency

Field Name Type Description
name String

The name of the template on which this template depends.
type JobDependencyTypeVersion1

The type of the dependency.

JobDependencyTypeVersion1

Value Description
JOBSTART Job can start at any time after specified jobs have started execution.
JOBSUCCESSFULCOMPLETE Job can be start at any time after all specified jobs have successfully completed.
JOBFAILEDCOMPLETE Job can start at any time after any specified jobs have completed unsuccessfully.
JOBCOMPLETE Job can start at any time after all specified jobs have completed regardless of completion status.
BEFORE

Job can start at any time before specified jobs have started execution. Note: Only reported to Moab and then reported back. Moab currently cannot internally handle this type of dependency.
BEFOREANY

Job can start at any time before all specified jobs have completed regardless of completion status. Note: Only reported to Moab and then reported back. Moab currently cannot internally handle this type of dependency.
BEFOREOK

Job can start at any time before all specified jobs have successfully completed. Note: Only reported to Moab and then reported back. Moab currently cannot internally handle this type of dependency.
BEFORENOTOK

Job can start at any time before any specified jobs have completed unsuccessfully. Note: Only reported to Moab and then reported back. Moab currently cannot internally handle this type of dependency.
HIBERNATE Job was set to Hibernate mode.
SYNCWITH Job will wait until it can start simultaneously with a master job.
SYNCCOUNT This job will wait until it can start simultaneously with synccount jobs of type syncwith that have all specified this synccount job is their master job.
SET Job will wait until a variable on a Moab object is set before starting.

JobFlag

This enumeration specifies the flag types of a job.

Value Description
NONE  
BACKFILL The job is using backfill to run.
COALLOC The job can use resources from multiple resource managers and partitions.
ALLOWPOWERADJUSTMENT Allow system to dynamically adjust power.
ADVRES The job requires the use of a reservation.
NOQUEUE The job will attempt to execute immediately or fail.
ARRAYJOB The job is part of a job array.
ARRAYJOBPARLOCK This array job will only run in one partition.
ARRAYJOBPARSPAN This array job will span partitions (default).
ARRAYMASTER This job is the master of a job array.
BESTEFFORT The job will succeed if even partial resources are available.
RESTARTABLE The job is restartable.
SUSPENDABLE The job is suspendable.
HASPREEMPTED This job preempted other jobs to start.
PREEMPTEE The job is a preemptee and therefore can be preempted by other jobs.
PREEMPTOR The job is a preemptor and therefore can preempt other jobs.
RSVMAP The job is based on a reservation.
SPVIOLATION The job was started with a soft policy violation.
IGNNODEPOLICIES The job will ignore node policies.
IGNPOLICIES The job will ignore idle, active, class, partition, and system policies.
IGNNODESTATE The job will ignore node state in order to run.
IGNIDLEJOBRSV The job can ignore idle job reservations. The job granted access to all idle job reservations.
INTERACTIVE The job needs interactive input from the user to run.
FSVIOLATION The job was started with a fairshare violation.
GLOBALQUEUE The job is directly submitted without doing any authentication.
NORESOURCES The job is a system job that does not need any resources.
NORMSTART The job will not query a resource manager to run.
CLUSTERLOCKED The job is locked into the current cluster and cannot be migrated elsewhere. This is for grid mode.
FRAGMENT The job can be run across multiple nodes in individual chunks.
FORCEPROVISION Job will provision nodes, whether they already have OS or not.
SYSTEMJOB The job is a system job, which simply runs on the same node that Moab is running on. This is usually used for running scripts and other executables in workflows.
ADMINSETIGNPOLICIES The IGNPOLICIES flag was set by an admin.
EXTENDSTARTWALLTIME The job duration (walltime) was extended at job start.
SHAREDMEM The job will share its memory across nodes.
BLOCKEDBYGRES The job's generic resource requirement caused the job to start later.
GRESONLY The job is requesting only generic resources, no compute resources.
TEMPLATESAPPLIED The job has had all applicable templates applied to it.
META META job, just a container around resources.
WIDERSVSEARCHALGO This job prefers the wide search algorithm.
DESTROYTEMPLATESUBMITTED A destroy job has already been created from the template for this job.
PROCSPECIFIED The job requested processors on the command line.
CANCELONFIRSTFAILURE Cancel job array on first array job failure.
CANCELONFIRSTSUCCESS Cancel job array on first array job success.
CANCELONANYFAILURE Cancel job array on any array job failure.
CANCELONANYSUCCESS Cancel job array on any array job success.
CANCELONEXITCODE Cancel job array on a specific exit code.
VCMASTER Job is the master of a virtual container.
USEMOABJOBID Whether to use the Moab job ID or the resource manager's job ID.
JOINSTDERRTOSTDOUT Join the stderr file to the stdout file.
JOINSTDOUTTOSTDERR Join the stdout file to the stderr file.
PURGEONSUCCESSONLY Only purge the job if it completed successfully.
ALLPROCS Each job compute task requests all the procs on its node.
COMMLOCAL Each job communications are localized, with minimal routing outside job shape.
COMMTOLERANT Each job communications are low-intensity and insensitive to interference.
COMMTRANSPARENT Job does not generate network communication.

JobTemplateFlag

This enumeration specifies the flag types of a job template.

Value Description
GLOBALRSVACCESS
HIDDEN
HWJOB
PRIVATE
SYNCJOBID
TEMPLATEISDYNAMIC True if the template is dynamic (not specified via moab.cfg).
SELECT True if a job can select this template.

JobTemplateRequirement

Field Name Type Description
architecture String

The architecture requirement.
diskRequirement Integer

The amount of disk space required (in MB).
genericResources Map<String, Integer>

Consumable generic attributes associated with individual nodes or the special pseudo-node global, which provides shared cluster (floating) consumable resources.
nodeAccessPolicy NodeAccessPolicy

The node access policy. How node resources will be shared by a job.
operatingSystem String

The operating system requirement.
requiredDiskPerTask Integer

Disk space (in MB).
requiredFeatures Set<String>

The features required by this template.
requiredMemoryPerTask Integer

Memory (in MB).
requiredProcessorsPerTask Integer

Number of processors.
requiredSwapPerTask Integer

Swap space (in MB).
taskCount Integer

The number of tasks required.

NodeAccessPolicy

This enumeration describes how node resources will be shared by various tasks.

Value Description
NONE  
SHARED Tasks from any combination of jobs can utilize available resources.
SHAREDONLY Only jobs requesting shared node access can utilize available resources.
SINGLEJOB Tasks from a single job can utilize available resources.
SINGLETASK A single task from a single job can run on the node.
SINGLEUSER Tasks from any jobs owned by the same user can utilize available resources.
UNIQUEUSER Any number of tasks from a single job can allocate resources from a node but only if the user has no other jobs running on that node.
SINGLEGROUP Any number of tasks from the same group can utilize node.
SINGLEACCOUNT Any number of tasks from the same account can utilize node.
SINGLECLASS Any number of tasks from the same class can utilize node.
SINGLEQOS Any number of tasks from the same QOS (quality of service) can utilize node.

Trigger

Field Name Type Description
id String

Trigger id - internal ID used by Moab to track triggers.
action String

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).
actionType TriggerActionType

 
blockTime Date

Time (in seconds) Moab will suspend normal operation to wait for trigger execution to finish. Use caution as Moab will completely stop normal operation until BlockTime expires.
description String  
eventType TriggerEventType  
expireTime Date

Time when trigger should be terminated if it has not already been activated.
failOffset Date

Time (in seconds) that the threshold condition must exist before the trigger fires.
flags Set<TriggerFlag>

 
interval Boolean

When used in conjunction with MultiFire and RearmTime trigger will fire at regular intervals. Can be used with TriggerEventType: EPOCH to create a Standing Trigger. Defaults to false.
maxRetry Integer

The number of times Action will be attempted before the trigger is designated a failure.
multiFire Boolean

Whether this trigger can fire multiple times. Defaults to false.
name String

Trigger name - can be auto assigned by Moab or requested. Alphanumeric up to 16 characters in length.
objectId String

The ID of the object that this is attached to.
objectType String

The type of object that this is attached to.
offset Date

Relative time offset from event when trigger can fire.
period TriggerPeriod

Can be used in conjunction with Offset to have a trigger fire at the beginning of the specified period. Can be used with EType epoch to create a standing trigger.
rearmTime Date

Time between MultiFire triggers. Rearm time is enforced from the trigger event time.
requires String

Variables this trigger requires to be set or not set before it will fire. Preceding the string with an exclamation mark (!) indicates this variable must NOT be set. Used in conjunction with sets to create trigger dependencies.
sets String

Variable values this trigger sets upon success or failure. 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.
threshold String

Reservation usage threshold. When reservation usage drops below Threshold, trigger will fire. 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 'Threshold Triggers' in the Moab Workload Manager Administrator Guide for more information.
timeout Date

Time allotted to this trigger before it is marked as unsuccessful and its process (if any) killed.
type TriggerType

The type of the trigger.
unsets String

Variable this trigger destroys upon success or failure.

TriggerActionType

This enumeration specifies the action type of a trigger.

Value Description
CANCEL Only apply to reservation triggers.
CHANGE_PARAM Run changeparam (NOT PERSISTENT).
JOB_PREEMPT Indicates that the trigger should preempt all jobs currently allocating resources assigned to the trigger's parent object. Only apply to reservation triggers.
MAIL Sends an email.
INTERNAL Modifies an object internally in Moab. This can be used to set a job hold, for example.
EXEC Execute the trigger action. Typically used to run a script.
MODIFY Can modify object that trigger is attached to.
QUERY
RESERVE
SUBMIT

TriggerEventType

This enumeration specifies the event type of a trigger.

Value
CANCEL
CHECKPOINT
CREATE
END
EPOCH
FAIL
HOLD
MIGRATE
MODIFY
PREEMPT
STANDING
START
THRESHOLD
DISCOVER
LOGROLL

TriggerFlag

This enumeration specifies a flag belonging to a trigger.

Value Description
ATTACH_ERROR 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 a Trigger' in the Moab Workload Manager Administrator Guide for more information.
GLOBAL_VARS 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 fire multiple times.
OBJECT_XML_STDIN Trigger passes its parent's object XML information into the trigger's stdin. This only works for exec triggers with reservation type parents.
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 can be explicitly specified using the format user+<username>, for example, flags=user+john:
GLOBAL_TRIGGER The trigger will be (or was) inserted into the global trigger list.
ASYNCHRONOUS An asynchronous trigger.
LEAVE_FILES Do not remove stderr and stdout files.
PROBE The trigger's stdout will be monitored.
PROBE_ALL The trigger's stdout will be monitored.
GENERIC_SYSTEM_JOB The trigger belongs to a generic system job (for checkpointing).
REMOVE_STD_FILES The trigger will delete stdout/stderr files after it has been reset.
RESET_ON_MODIFY The trigger resets if the object it is attached to is modified, even if multifire is not set.
SOFT_KILL

By default, a SIGKILL (kill -9) signal is sent to kill the script when a trigger times out. This flag will instead send a SIGTERM (kill -15) signal to kill the script. The SIGTERM signal will allow the script to trap the signal so that the script can clean up any residual information on the system (instead of just dying, as with the SIGKILL signal). Note: A timed-out trigger will only receive one kill signal. This means that if you specify this flag, a timed-out trigger will only receive the SIGTERM signal, and never the SIGKILL signal.

TriggerPeriod

This enumeration specifies the period of a trigger.

Value
MINUTE
HOUR
DAY
WEEK
MONTH

TriggerType

This enumeration specifies the type of the trigger.

Value Description
generic Generic trigger type.
elastic Elastic computing trigger type.

JobTemplate

This class represents a job template in the Moab Workload Manager. Job templates are used for two primary purposes: (1) to provide a means of generically matching and categorizing jobs, and (2) to provide a means of setting arbitrary default or forced attributes for certain jobs.

Field Name Type Description
id String

The unique identifier for this job template.
account String

The account under which this job will run for billing purposes.
args String

Command-line arguments that get passed to commandFile.
commandFile String

The path to the file that is executed when the job runs. This is the script that will actually call all the work of the job. Can be null.
description String

The description of the job.
durationRequested Long

The amount of time (in seconds) requested for the job.
genericSystemJob Boolean

True if this template will instantiate a generic system job.
inheritResources Boolean

True if jobs instantiated from this template inherit resources.
jobDependencies Set<JobTemplateDependency>

The list of dependencies for this job template.
jobFlags Set<JobFlag>

Job flags for this template.
jobTemplateFlags Set<JobTemplateFlag>

Job template flags for this template.
jobTemplateRequirements Set<JobTemplateRequirement>

The requirements for this job template.
priority Long

Relative job priority.
qos String

The Quality of Service for the job.
queue String

The class or queue in which the job will run.
select Boolean

True if job template can be directly requested by job at submission.
trigger Trigger

The trigger that is typically assigned to generic system jobs.

JobTemplateDependency

Field Name Type Description
name String

The name of the template on which this template depends.
type JobDependencyTypeVersion1

The type of the dependency.

JobDependencyTypeVersion1

Value Description
JOBSTART Job can start at any time after specified jobs have started execution.
JOBSUCCESSFULCOMPLETE Job can be start at any time after all specified jobs have successfully completed.
JOBFAILEDCOMPLETE Job can start at any time after any specified jobs have completed unsuccessfully.
JOBCOMPLETE Job can start at any time after all specified jobs have completed regardless of completion status.
BEFORE

Job can start at any time before specified jobs have started execution. Note: Only reported to Moab and then reported back. Moab currently cannot internally handle this type of dependency.
BEFOREANY

Job can start at any time before all specified jobs have completed regardless of completion status. Note: Only reported to Moab and then reported back. Moab currently cannot internally handle this type of dependency.
BEFOREOK

Job can start at any time before all specified jobs have successfully completed. Note: Only reported to Moab and then reported back. Moab currently cannot internally handle this type of dependency.
BEFORENOTOK

Job can start at any time before any specified jobs have completed unsuccessfully. Note: Only reported to Moab and then reported back. Moab currently cannot internally handle this type of dependency.
HIBERNATE Job was set to Hibernate mode.
SYNCWITH Job will wait until it can start simultaneously with a master job.
SYNCCOUNT This job will wait until it can start simultaneously with synccount jobs of type syncwith that have all specified this synccount job is their master job.
SET Job will wait until a variable on a Moab object is set before starting.

JobFlag

This enumeration specifies the flag types of a job.

Value Description
NONE
BACKFILL The job is using backfill to run.
COALLOC The job can use resources from multiple resource managers and partitions.
ALLOWPOWERADJUSTMENT Allow system to dynamically adjust power.
ADVRES The job requires the use of a reservation.
NOQUEUE The job will attempt to execute immediately or fail.
ARRAYJOB The job is part of a job array.
ARRAYJOBPARLOCK This array job will only run in one partition.
ARRAYJOBPARSPAN This array job will span partitions (default).
ARRAYMASTER This job is the master of a job array.
BESTEFFORT The job will succeed if even partial resources are available.
RESTARTABLE The job is restartable.
SUSPENDABLE The job is suspendable.
HASPREEMPTED This job preempted other jobs to start.
PREEMPTEE The job is a preemptee and therefore can be preempted by other jobs.
PREEMPTOR The job is a preemptor and therefore can preempt other jobs.
RSVMAP The job is based on a reservation.
SPVIOLATION The job was started with a soft policy violation.
IGNNODEPOLICIES The job will ignore node policies.
IGNPOLICIES The job will ignore idle, active, class, partition, and system policies.
IGNNODESTATE The job will ignore node state in order to run.
IGNIDLEJOBRSV The job can ignore idle job reservations. The job granted access to all idle job reservations.
INTERACTIVE The job needs interactive input from the user to run.
FSVIOLATION The job was started with a fairshare violation.
GLOBALQUEUE The job is directly submitted without doing any authentication.
NORESOURCES The job is a system job that does not need any resources.
NORMSTART The job will not query a resource manager to run.
CLUSTERLOCKED The job is locked into the current cluster and cannot be migrated elsewhere. This is for grid mode.
FRAGMENT The job can be run across multiple nodes in individual chunks.
FORCEPROVISION Job will provision nodes, whether they already have OS or not.
SYSTEMJOB The job is a system job, which simply runs on the same node that Moab is running on. This is usually used for running scripts and other executables in workflows.
ADMINSETIGNPOLICIES The IGNPOLICIES flag was set by an admin.
EXTENDSTARTWALLTIME The job duration (walltime) was extended at job start.
SHAREDMEM The job will share its memory across nodes.
BLOCKEDBYGRES The job's generic resource requirement caused the job to start later.
GRESONLY The job is requesting only generic resources, no compute resources.
TEMPLATESAPPLIED The job has had all applicable templates applied to it.
META META job, just a container around resources.
WIDERSVSEARCHALGO This job prefers the wide search algorithm.
DESTROYTEMPLATESUBMITTED A destroy job has already been created from the template for this job.
PROCSPECIFIED The job requested processors on the command line.
CANCELONFIRSTFAILURE Cancel job array on first array job failure.
CANCELONFIRSTSUCCESS Cancel job array on first array job success.
CANCELONANYFAILURE Cancel job array on any array job failure.
CANCELONANYSUCCESS Cancel job array on any array job success.
CANCELONEXITCODE Cancel job array on a specific exit code.
VCMASTER Job is the master of a virtual container.
USEMOABJOBID Whether to use the Moab job ID or the resource manager's job ID.
JOINSTDERRTOSTDOUT Join the stderr file to the stdout file.
JOINSTDOUTTOSTDERR Join the stdout file to the stderr file.
PURGEONSUCCESSONLY Only purge the job if it completed successfully.
ALLPROCS Each job compute task requests all the procs on its node.
COMMLOCAL Each job communications are localized, with minimal routing outside job shape.
COMMTOLERANT Each job communications are low-intensity and insensitive to interference.
COMMTRANSPARENT Job does not generate network communication.

JobTemplateFlag

This enumeration specifies the flag types of a job template.

Value Description
GLOBALRSVACCESS
HIDDEN
HWJOB
PRIVATE
SYNCJOBID
TEMPLATEISDYNAMIC True if the template is dynamic (not specified via moab.cfg).
SELECT True if a job can select this template.

JobTemplateRequirement

Field Name Type Description
architecture String

The architecture requirement.
diskRequirement Integer

The amount of disk space required (in MB).
genericResources Map<String, Integer>

Consumable generic attributes associated with individual nodes or the special pseudo-node global, which provides shared cluster (floating) consumable resources.
nodeAccessPolicy NodeAccessPolicy

The node access policy. How node resources will be shared by a job.
operatingSystem String

The operating system requirement.
requiredDiskPerTask Integer

Disk space (in MB).
requiredFeatures Set<String>

The features required by this template.
requiredMemoryPerTask Integer

Memory (in MB).
requiredProcessorsPerTask Integer

Number of processors.
requiredSwapPerTask Integer

Swap space (in MB).
taskCount Integer

The number of tasks required.

NodeAccessPolicy

This enumeration describes how node resources will be shared by various tasks.

Value Description
NONE
SHARED Tasks from any combination of jobs can utilize available resources.
SHAREDONLY Only jobs requesting shared node access can utilize available resources.
SINGLEJOB Tasks from a single job can utilize available resources.
SINGLETASK A single task from a single job can run on the node.
SINGLEUSER Tasks from any jobs owned by the same user can utilize available resources.
UNIQUEUSER Any number of tasks from a single job can allocate resources from a node but only if the user has no other jobs running on that node.
SINGLEGROUP Any number of tasks from the same group can utilize node.
SINGLEACCOUNT Any number of tasks from the same account can utilize node.
SINGLECLASS Any number of tasks from the same class can utilize node.
SINGLEQOS Any number of tasks from the same QOS (quality of service) can utilize node.

Trigger

Field Name Type Description
id String

Trigger id - internal ID used by Moab to track triggers.
action String

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).
actionType TriggerActionType

blockTime Date

Time (in seconds) Moab will suspend normal operation to wait for trigger execution to finish. Use caution as Moab will completely stop normal operation until BlockTime expires.
description String  
eventType TriggerEventType  
expireTime Date

Time when trigger should be terminated if it has not already been activated.
failOffset Date

Time (in seconds) that the threshold condition must exist before the trigger fires.
flags Set<TriggerFlag>

 
interval Boolean

When used in conjunction with MultiFire and RearmTime trigger will fire at regular intervals. Can be used with TriggerEventType: EPOCH to create a Standing Trigger. Defaults to false.
maxRetry Integer

The number of times Action will be attempted before the trigger is designated a failure.
multiFire Boolean

Whether this trigger can fire multiple times. Defaults to false.
name String

Trigger name - can be auto assigned by Moab or requested. Alphanumeric up to 16 characters in length.
objectId String

The ID of the object that this is attached to.
objectType String

The type of object that this is attached to.

offset Date

Relative time offset from event when trigger can fire.
period TriggerPeriod

Can be used in conjunction with Offset to have a trigger fire at the beginning of the specified period. Can be used with EType epoch to create a standing trigger.
rearmTime Date

Time between MultiFire triggers. Rearm time is enforced from the trigger event time.
requires String

Variables this trigger requires to be set or not set before it will fire. Preceding the string with an exclamation mark (!) indicates this variable must NOT be set. Used in conjunction with sets to create trigger dependencies.
sets String

Variable values this trigger sets upon success or failure. 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.
threshold String

Reservation usage threshold. When reservation usage drops below Threshold, trigger will fire. 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 'Threshold Triggers' in the Moab Workload Manager Administrator Guide for more information.
timeout Date

Time allotted to this trigger before it is marked as unsuccessful and its process (if any) killed.
type TriggerType

The type of the trigger.
unsets String

Variable this trigger destroys upon success or failure.

TriggerActionType

This enumeration specifies the action type of a trigger.

Value Description
CANCEL Only apply to reservation triggers.
CHANGE_PARAM Run changeparam (NOT PERSISTENT).
JOB_PREEMPT Indicates that the trigger should preempt all jobs currently allocating resources assigned to the trigger's parent object. Only apply to reservation triggers.
MAIL Sends an email.
INTERNAL Modifies an object internally in Moab. This can be used to set a job hold, for example.
EXEC Execute the trigger action. Typically used to run a script.
MODIFY Can modify object that trigger is attached to.
QUERY
RESERVE
SUBMIT

TriggerEventType

This enumeration specifies the event type of a trigger.

Value
CANCEL
CHECKPOINT
CREATE
END
EPOCH
FAIL
HOLD
MIGRATE
MODIFY
PREEMPT
STANDING
START
THRESHOLD
DISCOVER
LOGROLL

TriggerFlag

This enumeration specifies a flag belonging to a trigger.

Value Description
ATTACH_ERROR 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 a Trigger' in the Moab Workload Manager Administrator Guide for more information.
GLOBAL_VARS 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 fire multiple times.
OBJECT_XML_STDIN Trigger passes its parent's object XML information into the trigger's stdin. This only works for exec triggers with reservation type parents.
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 can be explicitly specified using the format user+<username>, for example, flags=user+john:
GLOBAL_TRIGGER The trigger will be (or was) inserted into the global trigger list.
ASYNCHRONOUS An asynchronous trigger.
LEAVE_FILES Do not remove stderr and stdout files.
PROBE The trigger's stdout will be monitored.
PROBE_ALL The trigger's stdout will be monitored.
GENERIC_SYSTEM_JOB The trigger belongs to a generic system job (for checkpointing).
REMOVE_STD_FILES The trigger will delete stdout/stderr files after it has been reset.
RESET_ON_MODIFY The trigger resets if the object it is attached to is modified, even if multifire is not set.
SOFT_KILL

By default, a SIGKILL (kill -9) signal is sent to kill the script when a trigger times out. This flag will instead send a SIGTERM (kill -15) signal to kill the script. The SIGTERM signal will allow the script to trap the signal so that the script can clean up any residual information on the system (instead of just dying, as with the SIGKILL signal). Note: A timed-out trigger will only receive one kill signal. This means that if you specify this flag, a timed-out trigger will only receive the SIGTERM signal, and never the SIGKILL signal.

TriggerPeriod

This enumeration specifies the period of a trigger.

Value
MINUTE
HOUR
DAY
WEEK
MONTH

TriggerType

This enumeration specifies the type of the trigger.

Value Description
generic Generic trigger type.
elastic Elastic computing trigger type.

Related Topics