(Click to open topic with navigation)

Fields: Jobs

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

Additional references

Type Value Additional information
Permissions resource jobs Permissions
Hooks filename jobs.groovy Pre and post-processing hooks
Distinct query-supported Yes Distinct
ClosedAPI version 3

Job

This class represents a job in the Moab Workload Manager. A job is a request for compute resources (CPUs, memory, storage) with which the requester can do work for a given amount of time. In an HPC environment, this might be a batch script to perform a Monte Carlo simulation. In a cloud environment, this would be a virtual machine and its associated storage. Moab will evaluate the request and assign the requested resources to the requester based on policies, current demand, and other factors in the data center. A job will also usually have some process that Moab starts automatically at the assigned start time. In an HPC environment, this can be starting a batch script on the assigned nodes. In a cloud environment, this can be starting provisioning processes to create the virtual machine and storage and install software on it.

Field Name Type POST PUT Description
id String No No

The unique identifier of this job. Note: this field is not user-assigned and is generated by the database.
arrayIndex Long No No

If this job is a sub-job of a JobArray, this field contains the index of this job in the array. For example, if this job is Moab.1[2], the array index would be 2.
arrayMasterName String No No

If this job is a sub-job of a JobArray, this field contains the name of the job array master. For example, if this job is Moab.1[2], the array master name would be Moab.1.
attributes Set<String> Yes No

The list of generic attributes associated with this job.
blocks Set<JobBlock> No No

Reasons the job is blocked from running.
bypassCount Integer No No

The number of times the job has been backfilled.
cancelCount Integer No No

The number of times a job has received a cancel request.
commandFile String Yes No

The path to the file that is executed when this job runs. This is the script that will call all the work of this job.
commandLineArguments String Yes No

The command line arguments passed to the commandFile.
completionCode Integer No No

The exit code from this job.
cpuTime Long No No

CPU usage time in seconds as reported by the resource manager.
credentials JobCredentials Yes Yes

The credentials (user and group, for example) associated with this job.
customName String Yes Yes

The user-specified name of this job.
dates JobDates Yes Yes

Various dates associated with this job.
deferCount Integer No No

The number of times a job has been deferred.
dependencies Set<JobDependency> Yes No

Dependencies that must be fulfilled before the job can start.
description String No No

The description of the job. Can be set only in a job template.
duration Long Yes Yes

The length of time in seconds requested for the job. Note that it is possible to set duration to "INFINITY" if the AllowInfiniteJobs flag is set on the scheduler in the moab.cfg.
durationActive Long No No

The length of time in seconds the job has been active or running.
durationQueued Long No No

The length of time in seconds the job has been eligible to run in the queue.
durationRemaining Long No No

An estimate of the time remaining, in seconds, before the job will complete.
durationSuspended Long No No

The length of time in seconds the job has been suspended.
emailNotifyAddresses Set<String> Yes No

The list of addresses to whom email is sent by the execution server.
emailNotifyTypes Set<JobEmailNotifyType> Yes No

The list of email notify types attached to the job.
environmentRequested Boolean Yes No

Setting this field to true tells the Moab Workload Manager to set various variables, if populated, in the job's environment.
environmentVariables Map<String, Map> Yes No

The list of environment variables for this job.
epilogScript String Yes No

The path to the TORQUE epilog script.
flags Set<JobFlag> Yes Yes

The flags that are set on this job.
holdDate Date No No

The date the most recent hold was placed on the job.
holdReason JobHoldReason No No

The reason the job is on hold.
holds Set<JobHoldType> Yes Yes

The holds that are set on the job. The "User" hold type is valid during POST.
initialWorkingDirectory String Yes No

The path to the directory in which the job will be started.
isActive Boolean No No

True if the job is active, false if the job is complete.
jobGroup String Yes No

The job group to which this job belongs (different from credentials.group).
masterNode DomainProxy No No

The first node in the list of allocated nodes for this job. For TORQUE jobs, this represents the "mother superior."
memorySecondsDedicated Double No No

The memory seconds dedicated to the job as reported by its resource manager. Not all resource managers provide this information.
memorySecondsUtilized Double No No

The memory seconds utilized by the job as reported by its resource manager. Not all resource managers provide this information.
messages Set<Message> No Yes

The list of messages associated with the job. The "message" field is valid during PUT.
migrateCount Integer No No

The number of times the job has been migrated.
minimumPreemptTime Long No No

The minimum length of time, in seconds, an active job must be running before it is eligible for preemption.
mwmName String No No

The name of the Moab Workload Manager instance that owns this job.
name String No No

The name of this job. This name is unique per instance of Moab Workload Manager (i.e. not globally).
nodesExcluded Set<DomainProxy> Yes No

The list of nodes that should not be considered for this job.
nodesRequested Set<DomainProxy> Yes No

The exact set, superset, or subset of nodes on which this job must run. (See also: nodesRequestedPolicy.)

nodesRequestedPolicy JobHostListMode Yes No

Indicates an exact set, superset, or subset of nodes on which the job must run. Only relevant if nodesRequested is provided. (See also: nodesRequested.)

partitionAccessList Set<String> No No

The list of partitions that this job can access.
partitionAccessListRequested Set<String> Yes Yes

The list of partitions that this job has requested.
preemptCount Integer No No

The number of times the job has been preempted.
priorities JobPriority Yes Yes

The list of priorities for the job.
processorSecondsDedicated Double No No

The processor seconds dedicated to the job as reported by its resource manager. Not all resource managers provide this information.
processorSecondsLimit Double No No

The limit for processorSecondsUtilized.
processorSecondsUtilized Double No No

The processor seconds utilized by the job as reported by its resource manager. Not all resource managers provide this information.
prologScript String Yes No

The path to the TORQUE prolog script.
queueStatus JobQueueStatus No No

The status of the job in its queue.
rejectPolicies Set<JobRejectPolicy> No No

The list of policies enabled when a job is rejected.
requirements Set<JobRequirement> Yes Yes

The list of items required for this job to run. Only JobRequirement.features is valid during PUT.
reservationRequested DomainProxy Yes Yes

The reservation that the job requested.
resourceFailPolicy JobResourceFailPolicyType Yes No

The policy that dictates what should happen to the job if it is running and at least one of the resources it is using fails.
resourceManagerExtension String Yes No

If provided during POST, this string will be added to the resource manager extension section of the job submission. Example: "bandwidth=120;queuejob=false"
Note that the delimiter between resourceManagerExtension elements is the semicolon.
resourceManagers Set<ResourceManager> No No

The list of resource managers associated with this job.
rmStandardErrorFilePath String No No

The path to the remote file containing the standard error of the job.
rmStandardOutputFilePath String No No

The path to the remote file containing the standard output of the job.
standardErrorFilePath String Yes No

The path to the file containing the standard error of the job.
standardOutputFilePath String Yes No

The path to the file containing the standard output of the job.
startCount Integer No No

The number of times the job has been started.
states JobStateInformation No No

Information about the state of the job.
submitHost String Yes No

The host from which the job was submitted.
systemJobAction String No No

The action the system job will take.
systemJobType JobSystemJobType No No

The type of system job. In the Moab Cloud Suite, this will usually be "vmtracking" or "generic."
targetedJobAction JobActionType No No

The action that this job is performing on another job.
targetedJobName String No No

The name of the job on which this job is performing the targetedJobAction.
templates Set<DomainProxy> Yes No

The list of all job templates to be set on this job.
triggers Set<String> No No

The list of triggers associated with this job.
variables Map<String, Map> Yes Yes

The list of variables that this job owns or sets on completion.
virtualContainers Set<DomainProxy> Yes No

When submitting this job, add it to the specified existing virtual container. Valid during POST, but only one virtual container can be specified.
virtualMachines Set<DomainProxy> No No

The list of virtual machines that are allocated to this job.
vmUsagePolicy VMUsagePolicy Yes No

The requested Virtual Machine Usage Policy for this job.

JobBlock

Field Name Type POST PUT Description
category JobBlockCategory No No

message String No No

type JobBlockType No No

JobBlockCategory

Value Description
depend
jobBlock
migrate

JobBlockType

Value Description
ActivePolicy
BadUser
Dependency
EState
FairShare
Hold
IdlePolicy
LocalPolicy
NoClass
NoData
NoResource
NoTime
PartitionAccess
Priority
RMSubmissionFailure
StartDate
State
SysLimits

JobCredentials

Moab Workload Manager supports the concept of credentials, which provide a means of attributing policy and resource access to entities such as users and groups. These credentials allow specification of job ownership, tracking of resource usage, enforcement of policies, and many other features.

Field Name Type POST PUT Description
account String Yes Yes

The account credential is also referred to as the project. This credential is generally associated with a group of users along the lines of a particular project for accounting and billing purposes.
group String Yes No

The group credential represents an aggregation of users. User-to-group mappings are often specified by the operating system or resource manager and typically map to a user's UNIX group ID. However, user-to-group mappings may also be provided by a security and identity management service, or you can specify such directly within Moab.
jobClass String Yes Yes

The concept of the class credential is derived from the resource manager class or queue object. Classes differ from other credentials in that they more directly impact job attributes. In standard HPC usage, a user submits a job to a class and this class imposes a number of factors on the job. The attributes of a class may be specified within the resource manager or directly within Moab.
qos String No No

The quality of service assigned to this job.

The concept of a quality of service (QoS) credential is unique to Moab and is not derived from any underlying concept or peer service. In most cases, the QoS credential is used to allow a site to set up a selection of service levels for end-users to choose from on a long-term or job-by-job basis. QoS's differ from other credentials in that they are centered around special access where this access may allow use of additional services, additional resources, or improved responsiveness. Unique to this credential, organizations may also choose to apply different charge rates to the varying levels of service available within each QoS. As QoS is an internal credential, all QoS configuration occurs within Moab.
qosRequested String Yes Yes

The quality of service requested for this job.
user String Yes No

The user credential is the fundamental credential within a workload manager; each job requires an association with exactly one user. In fact, the user credential is the only required credential in Moab; all others are optional. In most cases, the job's user credential is configured within or managed by the operating system itself, although Moab may be configured to obtain this information from an independent security and identity management service.

JobDates

Field Name Type POST PUT Description
completedDate Date No No

createdDate Date No No

deadlineDate Date Yes No

The deadline for completion of the job.
dispatchedDate Date No No

earliestRequestedStartDate Date Yes Yes

The job will start no sooner than this date.
earliestStartDate Date No No

eligibleDate Date No No

lastCanceledDate Date No No

lastChargedDate Date No No

lastPreemptedDate Date No No

lastUpdatedDate Date No No

startDate Date No No

submitDate Date No No

terminationDate Date No No

JobDependency

Field Name Type POST PUT Description
name String Yes No

The name of the object on on which the job is dependent.
type JobDependencyType Yes No

The type of job dependency. Only set is valid for POST.
value String No No

JobDependencyType

Represents the type of a job dependency. For now, only the "set" type is supported.

Value Description
set

JobEmailNotifyType

Value Description
JobStart
JobEnd
JobFail
All

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.
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 to 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.
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 administrator.
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.
VMTRACKING The job is a VMTracking job for an externally-created VM (via job template).
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.
NOVMMIGRATE Do not migrate the virtual machine that this job sets up.
PURGEONSUCCESSONLY Only purge the job if it completed successfully

JobHoldReason

Value Description
Admin
NoResources
SystemLimitsExceeded
BankFailure
CannotDebitAccount
InvalidAccount
RMFailure
RMReject
PolicyViolation
CredAccess
CredHold
PreReq
Data
Security
MissingDependency

JobHoldType

Value Description
User
System
Batch
Defer
All

DomainProxy

A reference to an object contained within an object. For example, a Virtual Machine object contains a reference to the Node on which it is running. That reference is represented by this class.

Field Name Type POST PUT Description
name String Yes No

The name of the object.

Message

Field Name Type POST PUT Description
count Integer No No

The number of times this message has occurred.
createdDate Date No No

The date this message was created.
expireDate Date No No

The date this message expires.
message String No Yes

The message itself.

JobHostListMode

Value Description
superset
subset
exactset

JobPriority

Field Name Type POST PUT Description
run Long No No

start Long No No

system Long No No

user Long Yes Yes

The user-requested priority for the job. By default, the range is between -1024 and 0. To enable priority range from -1024 to +1023, set ENABLEPOSUSERPRIORITY in the moab.cfg file.

JobQueueStatus

Value Description
active
blocked
completed
eligible

JobRejectPolicy

Value Description
CANCEL
HOLD
IGNORE
MAIL
RETRY

JobRequirement

Field Name Type POST PUT Description
architecture String Yes No

The architecture required by the job.
attributes Map<String, JobRequirementAttribute> Yes No

Required node attributes with version number support.
features Set<String> No Yes

The list of node features the job is scheduled against.
featuresExcluded Set<String> Yes No

Excluded node features. That is, do not select nodes with these features. (See also: featuresExcludedMode.)

featuresExcludedMode JobRequirementFeaturesMode Yes No

Indicates whether excluded features should be AND'ed or OR'd. The default is AND. Only relevant if featuresExcluded is provided. (See also: featuresExcluded.)

featuresRequested Set<String> Yes No

Requested node features. (See also: featuresRequestedMode.)

featuresRequestedMode JobRequirementFeaturesMode Yes No

Indicates whether requested features should be AND'ed or OR'd. The default is AND. Only relevant if featuresRequested is provided. (See also: featuresRequested.)

image String Yes No

The image required by the job.
index Integer No No

The index of the requirement, starting with 0.
metrics Map<String, Double> No No

Generic metrics associated with the job as reported by the resource manager.
nodeAccessPolicy NodeAccessPolicy Yes No

Specifies how node resources should be accessed. Note: If the job requirements array has more than one element that contains nodeAccessPolicy, only the first occurrence will be used.
nodeAllocationPolicy NodeAllocationPolicy Yes No

Specifies how node resources should be selected and allocated to the job. Note: If the job requirements array has more than one element that contains nodeAllocationPolicy, only the first occurrence will be used.
nodeCount Integer Yes No

The number of nodes required by the job.
nodeSet String Yes No

The requested node set of the job. This must follow the format SETSELECTION:SETTYPE[:SETLIST]

  • SETSELECTION - ANYOF, ONEOF, or FIRSTOF
  • SETTYPE - FEATURE or VARATTR
  • SETLIST - For FEATURE, a comma-separated list of features. For VARATTR, a key=value pair.
Examples:
  • ONEOF:FEATURE:fastos,hiprio,bigmem
  • FIRSTOF:VARATTR:datacenter=Provo:datacenter=SaltLake
nodes Set<AllocatedNode> No No

Nodes that have been allocated to meet this requirement.
reservation DomainProxy No No

The allocated reservation (assigned after the job has a reservation).
resourcesPerTask Map<String, JobResource> Yes No

Contains requirements for disk, memory, processors, swap, and generic resources. For disk, memory, and swap, the unit is MB. For each resource, the "dedicated" field can be set during POST.
taskCount Integer Yes No

The number of tasks (processors) required by this job.
tasksPerNode Integer Yes No

The number of tasks to map to each node.

JobRequirementAttribute

Field Name Type POST PUT Description
comparator String Yes No

The comparison operator. Valid values:

  • >= - Greater than or equal to
  • > - Greater than
  • <= - Less than
  • < - Less than
  • %= - Equals
  • %! - Not equals
  • Null - Defaults to %=
  • = - (Deprecated) Equivalent to %=
displayValue String Yes No

The display value for the required attribute.
restriction JobRequirementAttributeRestriction Yes No

The restriction of this attribute. May be null, but defaults to JobRequirementAttributeRestriction.must.
value String Yes No

The value of the required attribute. During POST, if value is missing, blank, or null, do not provide a comparator.

JobRequirementAttributeRestriction

Represents a restriction for a job requirement attribute.

Value Description
must

JobRequirementFeaturesMode

Value Description
OR
AND

NodeAccessPolicy

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

Value Description
NONE
SHARED Tasks from any combination of jobs may utilize available resources.
SHAREDONLY Only jobs requesting shared node access may utilize available resources.
SINGLEJOB Tasks from a single job may utilize available resourceses.
SINGLETASK A single task from a single job may run on the node.
SINGLEUSER Tasks from any jobs owned by the same user may utilize available resources.
UNIQUEUSER Any number of tasks from a single job may 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 may utilize node.
SINGLEACCOUNT Any number of tasks from the same account may utilize node.

NodeAllocationPolicy

Node Allocation enumeration.

Value Description
FIRSTSET
MINGLOBAL
MINLOCAL
PLUGIN
NONE No node allocation policy is specified. Moab defaults to MINRESOURCE when this is the case.
FIRSTAVAILABLE Simple first come, first served algorithm where nodes are allocated in the order they are presented by the resource manager. This is a very simple, very fast algorithm.
LASTAVAILABLE This algorithm selects resources so as to minimize the amount of time after the job and before the trailing reservation. This algorithm is a best fit in time algorithm which minimizes the impact of reservation based node-time fragmentation. It is useful in systems where a large number of reservations (job, standing, or administrative) are in place.
MINRESOURCE This algorithm prioritizes nodes according to the configured resources on each node. Those nodes with the fewest configured resources which still meet the job's resource constraints are selected.
CPULOAD Nodes are selected which have the maximum amount of available, unused cpu power, i.e. [# of CPU's] - [CPU load]. Good algorithm for timesharing node systems. This algorithm is only applied to jobs starting immediately. For the purpose of future reservations, the MINRESOURCE algorithm is used.
LOCAL This will call the locally created contrib node allocation algorithm.
CONTIGUOUS This algorithm will allocate nodes in contiguous (linear) blocks as required by the Compaq RMS system.
MAXBALANCE This algorithm will attempt to allocate the most 'balanced' set of nodes possible to a job. In most cases, but not all, the metric for balance of the nodes is node speed. Thus, if possible, nodes with identical speeds will be allocated to the job. If identical speed nodes cannot be found, the algorithm will allocate the set of nodes with the minimum node speed 'span' or range.
PRIORITY This algorithm allows a site to specify the priority of various static and dynamic aspects of compute nodes and allocate them with preference for higher priority nodes. It is highly flexible allowing node attribute and usage information to be combined with reservation affinity.
FASTEST This algorithm will select nodes in 'fastest node first' order. Nodes will be selected by node speed if specified. If node speed is not specified, nodes will be selected by processor speed. If neither is specified, nodes will be selected in a random order.
PROCESSORLOAD Alias for CPULOAD.
NODESPEED Alias for FASTEST.
INREPORTEDORDER Alias for FIRSTAVAILABLE.
INREVERSEREPORTEDORDER Alias for LASTAVAILABLE.
CUSTOMPRIORITY Alias for PRIORITY.
PROCESSORSPEEDBALANCE Alias for MAXBALANCE.
MINIMUMCONFIGUREDRESOURCES Alias for MINRESOURCE.

AllocatedNode

Field Name Type POST PUT Description
name String No No

taskCount Integer No No

JobResource

Represents counts of dedicated and utilized resources.

Field Name Type POST PUT Description
dedicated Integer No No

The amount of this resource that has been allocated for running workload.
utilized Integer No No

The amount of this resource that is currently reported as utilized by resource managers.

JobResourceFailPolicyType

Value Description
CANCEL
FAIL
HOLD
IGNORE
NOTIFY
REQUEUE

ResourceManager

Field Name Type POST PUT Description
isDestination Boolean No No

isSource Boolean No No

jobName String No No

name String No No

JobStateInformation

Field Name Type POST PUT Description
state JobState No No

stateExpected JobState No No

stateLastUpdatedDate Date No No

subState JobSubState No No

JobState

Value Description
Idle
Starting
Running
Removed
Completed
Hold
Deferred
Vacated
NotQueued
Unknown
Staging
Suspended
Blocked

JobSubState

Value Description
Epilogue
Migrated
Preempted
Prologue

JobSystemJobType

Value Description
generic
osprovision
osprovision2
poweroff
poweron
reset
storage
vmmap
vmmigrate
vmtracking

JobActionType

Value Description
DESTROY
MIGRATE
MODIFY

VMUsagePolicy

This enumeration describes the virtual machine requirements of a job

Value Description
REQUIREPM Requires a physical machine.
PREFPM Prefers a physical machine.
CREATEVM Creates a virtual machine.
CREATEPERSISTENTVM Creates a virtual machine that doesn't go away after the job is done.
REQUIREVM Requires a virtual machine.
PREFVM Prefers a virtual machine.
ClosedAPI version 2

Job

This class represents a job in the Moab Workload Manager. A job is a request for compute resources (CPUs, memory, storage) with which the requester can do work for a given amount of time. In an HPC environment, this might be a batch script to perform a Monte Carlo simulation. In a cloud environment, this would be a virtual machine and its associated storage. Moab will evaluate the request and assign the requested resources to the requester based on policies, current demand, and other factors in the data center. A job will also usually have some process that Moab starts automatically at the assigned start time. In an HPC environment, this can be starting a batch script on the assigned nodes. In a cloud environment, this can be starting provisioning processes to create the virtual machine and storage and install software on it.

Field Name Type POST PUT Description
id String No No

The unique identifier of this job. Note: this field is not user-assigned and is generated by the database.
arrayIndex Long No No

If this job is a sub-job of a JobArray, this field contains the index of this job in the array. For example, if this job is Moab.1[2], the array index would be 2.
arrayMasterName String No No

If this job is a sub-job of a JobArray, this field contains the name of the job array master. For example, if this job is Moab.1[2], the array master name would be Moab.1.
attributes Set<String> Yes No

The list of generic attributes associated with this job.
blocks Set<JobBlock> No No

Reasons the job is blocked from running.
bypassCount Integer No No

The number of times the job has been backfilled.
cancelCount Integer No No

The number of times a job has received a cancel request.
commandFile String Yes No

The path to the file that is executed when this job runs. This is the script that will call all the work of this job.
commandLineArguments String Yes No

The command line arguments passed to the commandFile.
completionCode Integer No No

The exit code from this job.
cpuTime Long No No

CPU usage time in seconds as reported by the resource manager.
credentials JobCredentials Yes Yes

The credentials (user and group, for example) associated with this job.
customName String Yes Yes

The user-specified name of this job.
dates JobDates Yes Yes

Various dates associated with this job.
deferCount Integer No No

The number of times a job has been deferred.
dependencies Set<JobDependency> Yes No

Dependencies that must be fulfilled before the job can start.
description String No No

The description of the job. Can be set only in a job template.
duration Long Yes Yes

The length of time in seconds requested for the job. Note that it is possible to set duration to "INFINITY" if the AllowInfiniteJobs flag is set on the scheduler in the moab.cfg.
durationActive Long No No

The length of time in seconds the job has been active or running.
durationQueued Long No No

The length of time in seconds the job has been eligible to run in the queue.
durationRemaining Long No No

An estimate of the time remaining, in seconds, before the job will complete.
durationSuspended Long No No

The length of time in seconds the job has been suspended.
emailNotifyAddresses Set<String> Yes No

The list of addresses to whom email is sent by the execution server.
emailNotifyTypes Set<JobEmailNotifyType> Yes No

The list of email notify types attached to the job.
environmentRequested Boolean Yes No

Setting this field to true tells the Moab Workload Manager to set various variables, if populated, in the job's environment.
environmentVariables Map<String, Map> Yes No

The list of environment variables for this job.
epilogScript String Yes No

The path to the TORQUE epilog script.
flags Set<JobFlag> Yes Yes

The flags that are set on this job.
holdDate Date No No

The date the most recent hold was placed on the job.
holdReason JobHoldReason No No

The reason the job is on hold.
holds Set<JobHoldType> Yes Yes

The holds that are set on the job. The "User" hold type is valid during POST.
initialWorkingDirectory String Yes No

The path to the directory in which the job will be started.
isActive Boolean No No

True if the job is active, false if the job is complete.
jobGroup String Yes No

The job group to which this job belongs (different from credentials.group).
masterNode DomainProxy No No

The first node in the list of allocated nodes for this job. For TORQUE jobs, this represents the "mother superior."
memorySecondsDedicated Double No No

The memory seconds dedicated to the job as reported by its resource manager. Not all resource managers provide this information.
memorySecondsUtilized Double No No

The memory seconds utilized by the job as reported by its resource manager. Not all resource managers provide this information.
messages Set<Message> No Yes

The list of messages associated with the job. The "message" field is valid during PUT.
migrateCount Integer No No

The number of times the job has been migrated.
minimumPreemptTime Long No No

The minimum length of time, in seconds, an active job must be running before it is eligible for preemption.
mwmName String No No

The name of the Moab Workload Manager instance that owns this job.
name String No No

The name of this job. This name is unique per instance of Moab Workload Manager (i.e. not globally).
nodesExcluded Set<DomainProxy> Yes No

The list of nodes that should not be considered for this job.
nodesRequested Set<DomainProxy> Yes No

The exact set, superset, or subset of nodes on which this job must run. (See also: nodesRequestedPolicy.)

nodesRequestedPolicy JobHostListMode Yes No

Indicates an exact set, superset, or subset of nodes on which the job must run. Only relevant if nodesRequested is provided. (See also: nodesRequested.)

partitionAccessList Set<String> No No

The list of partitions that this job can access.
partitionAccessListRequested Set<String> Yes Yes

The list of partitions that this job has requested.
preemptCount Integer No No

The number of times the job has been preempted.
priorities JobPriority Yes Yes

The list of priorities for the job.
processorSecondsDedicated Double No No

The processor seconds dedicated to the job as reported by its resource manager. Not all resource managers provide this information.
processorSecondsLimit Double No No

The limit for processorSecondsUtilized.
processorSecondsUtilized Double No No

The processor seconds utilized by the job as reported by its resource manager. Not all resource managers provide this information.
prologScript String Yes No

The path to the TORQUE prolog script.
queueStatus JobQueueStatus No No

The status of the job in its queue.
rejectPolicies Set<JobRejectPolicy> No No

The list of policies enabled when a job is rejected.
requirements Set<JobRequirement> Yes Yes

The list of items required for this job to run. Only JobRequirement.features is valid during PUT.
reservationRequested DomainProxy Yes Yes

The reservation that the job requested.
resourceFailPolicy JobResourceFailPolicyType Yes No

The policy that dictates what should happen to the job if it is running and at least one of the resources it is using fails.
resourceManagerExtension String Yes No

If provided during POST, this string will be added to the resource manager extension section of the job submission. Example: "bandwidth=120;queuejob=false"
Note that the delimiter between resourceManagerExtension elements is the semicolon.
resourceManagers Set<ResourceManager> No No

The list of resource managers associated with this job.
rmStandardErrorFilePath String No No

The path to the remote file containing the standard error of the job.
rmStandardOutputFilePath String No No

The path to the remote file containing the standard output of the job.
standardErrorFilePath String Yes No

The path to the file containing the standard error of the job.
standardOutputFilePath String Yes No

The path to the file containing the standard output of the job.
startCount Integer No No

The number of times the job has been started.
states JobStateInformation No No

Information about the state of the job.
submitHost String Yes No

The host from which the job was submitted.
systemJobAction String No No

The action the system job will take.
systemJobType JobSystemJobType No No

The type of system job. In the Moab Cloud Suite, this will usually be "vmtracking" or "generic."
targetedJobAction JobActionType No No

The action that this job is performing on another job.
targetedJobName String No No

The name of the job on which this job is performing the targetedJobAction.
templates Set<DomainProxy> Yes No

The list of all job templates to be set on this job.
triggers Set<String> No No

The list of triggers associated with this job.
variables Map<String, Map> Yes Yes

The list of variables that this job owns or sets on completion.
virtualContainers Set<DomainProxy> Yes No

When submitting this job, add it to the specified existing virtual container. Valid during POST, but only one virtual container can be specified.
virtualMachines Set<DomainProxy> No No

The list of virtual machines that are allocated to this job.
vmUsagePolicy VMUsagePolicy Yes No

The requested Virtual Machine Usage Policy for this job.

JobBlock

Field Name Type POST PUT Description
category JobBlockCategory No No

message String No No

type JobBlockType No No

JobBlockCategory

Value Description
depend
jobBlock
migrate

JobBlockType

Value Description
ActivePolicy
BadUser
Dependency
EState
FairShare
Hold
IdlePolicy
LocalPolicy
NoClass
NoData
NoResource
NoTime
PartitionAccess
Priority
RMSubmissionFailure
StartDate
State
SysLimits

JobCredentials

Moab Workload Manager supports the concept of credentials, which provide a means of attributing policy and resource access to entities such as users and groups. These credentials allow specification of job ownership, tracking of resource usage, enforcement of policies, and many other features.

Field Name Type POST PUT Description
account String Yes Yes

The account credential is also referred to as the project. This credential is generally associated with a group of users along the lines of a particular project for accounting and billing purposes.
group String Yes No

The group credential represents an aggregation of users. User-to-group mappings are often specified by the operating system or resource manager and typically map to a user's UNIX group ID. However, user-to-group mappings may also be provided by a security and identity management service, or you can specify such directly within Moab.
jobClass String Yes Yes

The concept of the class credential is derived from the resource manager class or queue object. Classes differ from other credentials in that they more directly impact job attributes. In standard HPC usage, a user submits a job to a class and this class imposes a number of factors on the job. The attributes of a class may be specified within the resource manager or directly within Moab.
qos String No No

The quality of service assigned to this job.

The concept of a quality of service (QoS) credential is unique to Moab and is not derived from any underlying concept or peer service. In most cases, the QoS credential is used to allow a site to set up a selection of service levels for end-users to choose from on a long-term or job-by-job basis. QoS's differ from other credentials in that they are centered around special access where this access may allow use of additional services, additional resources, or improved responsiveness. Unique to this credential, organizations may also choose to apply different charge rates to the varying levels of service available within each QoS. As QoS is an internal credential, all QoS configuration occurs within Moab.
qosRequested String Yes Yes

The quality of service requested for this job.
user String Yes No

The user credential is the fundamental credential within a workload manager; each job requires an association with exactly one user. In fact, the user credential is the only required credential in Moab; all others are optional. In most cases, the job's user credential is configured within or managed by the operating system itself, although Moab may be configured to obtain this information from an independent security and identity management service.

JobDates

Field Name Type POST PUT Description
completedDate Date No No

createdDate Date No No

deadlineDate Date Yes No

The deadline for completion of the job.
dispatchedDate Date No No

earliestRequestedStartDate Date Yes Yes

The job will start no sooner than this date.
earliestStartDate Date No No

eligibleDate Date No No

lastCanceledDate Date No No

lastChargedDate Date No No

lastPreemptedDate Date No No

lastUpdatedDate Date No No

startDate Date No No

submitDate Date No No

terminationDate Date No No

JobDependency

Field Name Type POST PUT Description
name String Yes No

The name of the object on on which the job is dependent.
type JobDependencyType Yes No

The type of job dependency. Only set is valid for POST.
value String No No

JobDependencyType

Represents the type of a job dependency. For now, only the "set" type is supported.

Value Description
set

JobEmailNotifyType

Value Description
JobStart
JobEnd
JobFail
All

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.
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 to 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.
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 administrator.
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.
VMTRACKING The job is a VMTracking job for an externally-created VM (via job template).
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.
NOVMMIGRATE Do not migrate the virtual machine that this job sets up.
PURGEONSUCCESSONLY Only purge the job if it completed successfully

JobHoldReason

Value Description
Admin
NoResources
SystemLimitsExceeded
BankFailure
CannotDebitAccount
InvalidAccount
RMFailure
RMReject
PolicyViolation
CredAccess
CredHold
PreReq
Data
Security
MissingDependency

JobHoldType

Value Description
User
System
Batch
Defer
All

DomainProxy

A reference to an object contained within an object. For example, a Virtual Machine object contains a reference to the Node on which it is running. That reference is represented by this class.

Field Name Type POST PUT Description
name String Yes No

The name of the object.

Message

Field Name Type POST PUT Description
count Integer No No

The number of times this message has occurred.
createdDate Date No No

The date this message was created.
expireDate Date No No

The date this message expires.
message String No Yes

The message itself.

JobHostListMode

Value Description
superset
subset
exactset

JobPriority

Field Name Type POST PUT Description
run Long No No

start Long No No

system Long No No

user Long Yes Yes

The user-requested priority for the job. By default, the range is between -1024 and 0. To enable priority range from -1024 to +1023, set ENABLEPOSUSERPRIORITY in the moab.cfg file.

JobQueueStatus

Value Description
active
blocked
completed
eligible

JobRejectPolicy

Value Description
CANCEL
HOLD
IGNORE
MAIL
RETRY

JobRequirement

Field Name Type POST PUT Description
architecture String Yes No

The architecture required by the job.
attributes Map<String, JobRequirementAttribute> Yes No

Required node attributes with version number support.
features Set<String> No Yes

The list of node features the job is scheduled against.
featuresExcluded Set<String> Yes No

Excluded node features. That is, do not select nodes with these features. (See also: featuresExcludedMode.)

featuresExcludedMode JobRequirementFeaturesMode Yes No

Indicates whether excluded features should be AND'ed or OR'd. The default is AND. Only relevant if featuresExcluded is provided. (See also: featuresExcluded.)

featuresRequested Set<String> Yes No

Requested node features. (See also: featuresRequestedMode.)

featuresRequestedMode JobRequirementFeaturesMode Yes No

Indicates whether requested features should be AND'ed or OR'd. The default is AND. Only relevant if featuresRequested is provided. (See also: featuresRequested.)

image String Yes No

The image required by the job.
index Integer No No

The index of the requirement, starting with 0.
metrics Map<String, Double> No No

Generic metrics associated with the job as reported by the resource manager.
nodeAccessPolicy NodeAccessPolicy Yes No

Specifies how node resources should be accessed. Note: If the job requirements array has more than one element that contains nodeAccessPolicy, only the first occurrence will be used.
nodeAllocationPolicy NodeAllocationPolicy Yes No

Specifies how node resources should be selected and allocated to the job. Note: If the job requirements array has more than one element that contains nodeAllocationPolicy, only the first occurrence will be used.
nodeCount Integer Yes No

The number of nodes required by the job.
nodeSet String Yes No

The requested node set of the job. This must follow the format SETSELECTION:SETTYPE[:SETLIST]

  • SETSELECTION - ANYOF, ONEOF, or FIRSTOF
  • SETTYPE - FEATURE or VARATTR
  • SETLIST - For FEATURE, a comma-separated list of features. For VARATTR, a key=value pair.
Examples:
  • ONEOF:FEATURE:fastos,hiprio,bigmem
  • FIRSTOF:VARATTR:datacenter=Provo:datacenter=SaltLake
nodes Set<AllocatedNode> No No

Nodes that have been allocated to meet this requirement.
reservation DomainProxy No No

The allocated reservation (assigned after the job has a reservation).
resourcesPerTask Map<String, JobResource> Yes No

Contains requirements for disk, memory, processors, swap, and generic resources. For disk, memory, and swap, the unit is MB. For each resource, the "dedicated" field can be set during POST.
taskCount Integer Yes No

The number of tasks (processors) required by this job.
tasksPerNode Integer Yes No

The number of tasks to map to each node.

JobRequirementAttribute

Field Name Type POST PUT Description
comparator String Yes No

The comparison operator. Valid values:

  • >= - Greater than or equal to
  • > - Greater than
  • <= - Less than
  • < - Less than
  • %= - Equals
  • %! - Not equals
  • Null - Defaults to %=
  • = - (Deprecated) Equivalent to %=
displayValue String Yes No

The display value for the required attribute.
restriction JobRequirementAttributeRestriction Yes No

The restriction of this attribute. May be null, but defaults to JobRequirementAttributeRestriction.must.
value String Yes No

The value of the required attribute. During POST, if value is missing, blank, or null, do not provide a comparator.

JobRequirementAttributeRestriction

Represents a restriction for a job requirement attribute.

Value Description
must

JobRequirementFeaturesMode

Value Description
OR
AND

NodeAccessPolicy

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

Value Description
NONE
SHARED Tasks from any combination of jobs may utilize available resources.
SHAREDONLY Only jobs requesting shared node access may utilize available resources.
SINGLEJOB Tasks from a single job may utilize available resourceses.
SINGLETASK A single task from a single job may run on the node.
SINGLEUSER Tasks from any jobs owned by the same user may utilize available resources.
UNIQUEUSER Any number of tasks from a single job may 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 may utilize node.
SINGLEACCOUNT Any number of tasks from the same account may utilize node.

NodeAllocationPolicy

Node Allocation enumeration.

Value Description
FIRSTSET
MINGLOBAL
MINLOCAL
PLUGIN
NONE No node allocation policy is specified. Moab defaults to MINRESOURCE when this is the case.
FIRSTAVAILABLE Simple first come, first served algorithm where nodes are allocated in the order they are presented by the resource manager. This is a very simple, very fast algorithm.
LASTAVAILABLE This algorithm selects resources so as to minimize the amount of time after the job and before the trailing reservation. This algorithm is a best fit in time algorithm which minimizes the impact of reservation based node-time fragmentation. It is useful in systems where a large number of reservations (job, standing, or administrative) are in place.
MINRESOURCE This algorithm prioritizes nodes according to the configured resources on each node. Those nodes with the fewest configured resources which still meet the job's resource constraints are selected.
CPULOAD Nodes are selected which have the maximum amount of available, unused cpu power, i.e. [# of CPU's] - [CPU load]. Good algorithm for timesharing node systems. This algorithm is only applied to jobs starting immediately. For the purpose of future reservations, the MINRESOURCE algorithm is used.
LOCAL This will call the locally created contrib node allocation algorithm.
CONTIGUOUS This algorithm will allocate nodes in contiguous (linear) blocks as required by the Compaq RMS system.
MAXBALANCE This algorithm will attempt to allocate the most 'balanced' set of nodes possible to a job. In most cases, but not all, the metric for balance of the nodes is node speed. Thus, if possible, nodes with identical speeds will be allocated to the job. If identical speed nodes cannot be found, the algorithm will allocate the set of nodes with the minimum node speed 'span' or range.
PRIORITY This algorithm allows a site to specify the priority of various static and dynamic aspects of compute nodes and allocate them with preference for higher priority nodes. It is highly flexible allowing node attribute and usage information to be combined with reservation affinity.
FASTEST This algorithm will select nodes in 'fastest node first' order. Nodes will be selected by node speed if specified. If node speed is not specified, nodes will be selected by processor speed. If neither is specified, nodes will be selected in a random order.
PROCESSORLOAD Alias for CPULOAD.
NODESPEED Alias for FASTEST.
INREPORTEDORDER Alias for FIRSTAVAILABLE.
INREVERSEREPORTEDORDER Alias for LASTAVAILABLE.
CUSTOMPRIORITY Alias for PRIORITY.
PROCESSORSPEEDBALANCE Alias for MAXBALANCE.
MINIMUMCONFIGUREDRESOURCES Alias for MINRESOURCE.

AllocatedNode

Field Name Type POST PUT Description
name String No No

taskCount Integer No No

JobResource

Represents counts of dedicated and utilized resources.

Field Name Type POST PUT Description
dedicated Integer No No

The amount of this resource that has been allocated for running workload.
utilized Integer No No

The amount of this resource that is currently reported as utilized by resource managers.

JobResourceFailPolicyType

Value Description
CANCEL
FAIL
HOLD
IGNORE
NOTIFY
REQUEUE

ResourceManager

Field Name Type POST PUT Description
isDestination Boolean No No

isSource Boolean No No

jobName String No No

name String No No

JobStateInformation

Field Name Type POST PUT Description
state JobState No No

stateExpected JobState No No

stateLastUpdatedDate Date No No

subState JobSubState No No

JobState

Value Description
Idle
Starting
Running
Removed
Completed
Hold
Deferred
Vacated
NotQueued
Unknown
Staging
Suspended
Blocked

JobSubState

Value Description
Epilogue
Migrated
Preempted
Prologue

JobSystemJobType

Value Description
generic
osprovision
osprovision2
poweroff
poweron
reset
storage
vmmap
vmmigrate
vmtracking

JobActionType

Value Description
DESTROY
MIGRATE
MODIFY

VMUsagePolicy

This enumeration describes the virtual machine requirements of a job

Value Description
REQUIREPM Requires a physical machine.
PREFPM Prefers a physical machine.
CREATEVM Creates a virtual machine.
CREATEPERSISTENTVM Creates a virtual machine that doesn't go away after the job is done.
REQUIREVM Requires a virtual machine.
PREFVM Prefers a virtual machine.
ClosedAPI version 1

JobVersion1

Field Name Type POST PUT Description
id String No No

The unique ID of the job.
account String Yes Yes

The account under which this job runs for billing purposes.
activeDuration Long No No

The duration in seconds the job has spent active or running.
allocatedNodes Set<DomainProxyVersion1> No No

The nodes that are allocated to this job.
allocatedVMs Set<DomainProxyVersion1> No No

The list of VMs that are allocated to this job.
arrayIndex Long No No

If this job is a sub-job of a JobArray, this field contains the index of this job in the array. For example, if this job is Moab.1[2], the array index would be 2.
arrayMasterName String No No

If this job is a sub-job of a JobArray, this field contains the name of the job array master. For example, if this job is Moab.1[2], the array master name would be Moab.1.
arraySubJobs Set<JobArraySubJob> No No

If this job is the job array master, this field contains information concerning the array's sub-jobs.
blockReason JobBlockReasonVersion1 No No

The reason the job is blocked.
bypass Integer No No

The number of times the job has been backfilled.
commandFile String Yes No

The path to the file that is executed when the job runs. This is the script that will call all the work of the job.
commandLineArguments String Yes No

The command line arguments passed in when the job is run.
completionCode Integer No No

The exit code from the job.
completionDate Date No No

The date the job completed. If null, the job hasn't completed yet.
dedicatedProcessorSeconds Double No No

Number of processor seconds dedicated to the job.
dependencies Set<JobDependencyVersion1> Yes No

The list of dependencies for this job. Valid during POST, but only JobDependencyTypeVersion1.SET dependencies are supported. Not defined during GET.
destinationRmJobId String No No

The ID of the job as known by the destination resource manager.
durationRequested Long Yes Yes

The amount of time (in seconds) requested for the job. Note that it is possible to set durationRequested to "INFINITY" if the AllowInfiniteJobs flag is set on the scheduler in the moab.cfg.
earliestStartDate Date No No

Is usually the same as earliestStartDateRequested. Reported by Moab and cannot be changed by the user.
earliestStartDateRequested Date Yes Yes

Used in job creation or modification to set the minimum start time.
effectivePartitionAccessList Set<String> No No

The list of partitions that this job can access.
effectiveQueueDuration Long No No

The duration in seconds the job has been eligible to run in the queue.
emailNotifyTypes Set<JobEmailNotifyTypeVersion1> Yes No

The set of email notify types attached to the job.
emailNotifyUsers Set<String> Yes No

The list of users to whom email is sent by the execution server.
environmentRequested Boolean Yes No

Setting this field to true tells Moab to set various variables, if populated, to the job's environment. Not defined during GET.
environmentVariables Map<String, Map> Yes No

The set of environment variables for this job.
expectedState JobStateVersion1 No No

The expected state of the job based on scheduler action.
flags Set<JobFlag> Yes Yes

The flags that are set on this job.
genericAttributes Set<String> No No

The list of generic attributes the job has requested.
group String Yes No

The group under which the job is run.
holds Set<JobHoldTypeVersion1> Yes Yes

The holds that are set on the job. During POST, only the USER hold type is supported.
hosts Set<String> Yes No

The set of hosts/nodes the job is running on.
initialWorkingDirectory String Yes No

The path to the directory in which the job will be started.
latestCompletedDateRequested Date No No

The latest completion date requested by the job.
masterHost String No No

The node/host that the primary task will run on.
memoryRequested Integer No No

The amount of memory in MB requested by the job.
messages Set<MessageVersion1> No Yes

The list of system and user messages.
name String Yes Yes

The user-specified name of the job.
os String Yes No

The operating system required for the job.
partitionAccessList Set<String> No No

The list of partitions that this job has requested.
qos String No No

The QoS under which the job is running.
qosRequested String Yes Yes

The QoS the job requested. This may not be the QoS the job is given based on policies.
queue String Yes Yes

The class or queue in which the job is running.
queueStatus JobQueueStatusVersion1 No No

The status of the job in its queue.
requirements Set<JobRequirementVersion1> Yes Yes

The list of items required for this job to run. Only JobRequirementVersion1.requiredPartition is valid during PUT.
reservationRequested String Yes Yes

The reservation that the job requested.
reservationStartDate Date No No

The start date of the reservation in which the job is running.
rmExtension String No No

The resource manager extension String that describes information passed to the the resource manager accounting for the job.
rmName String No No

The name of the resource manager that is reporting this job.
rmStandardErrorFilePath String No No

The path to the remote file containing the standard error of the job.
rmStandardInputFilePath String No No

The path to the file containing the standard input of the job.
rmStandardOutputFilePath String No No

The path to the file containing the standard output of the job.
runPriority Long No No

The priority to start running the job.
sourceRmJobId String No No

The ID of the job as known by the source resource manager.
standardErrorFilePath String Yes No

The path to the file containing the standard error of the job.
standardOutputFilePath String Yes No

The path to the file containing the standard output of the job.
startCount Integer No No

The number of times the job has been started.
startDate Date No No

The date the job started.
startPriority Long No No

The priority used when the job is first starting.
state JobStateVersion1 No No

The job's state.
submitDate Date No No

The time when this job was submitted to Moab.
submitHost String Yes No

The host from which the job was submitted.
suspendDuration Long No No

The duration for which the job has been suspended.
systemPriority Long No No

Administrator-specified system priority level.
templateList Set<String> Yes No

The list of all job templates to be set on this job. Not defined during GET.
trigger String No Yes

Add this trigger to the specified job. Not defined during GET.
user String Yes No

The user that is running the job.
userPriority Long Yes Yes

The user-specified priority for the job.
variables Map<String, Map> Yes Yes

The set of variables this job "owns" or sets on completion.
virtualContainers Set<VirtualContainer> Yes No

When submitting this job, add it to the specified existing virtual container. Valid during POST, but only one virtual container can be specified.
vmUsagePolicy VMUsagePolicy Yes No

The requested VM Usage Policy for this job.

DomainProxyVersion1

Field Name Type POST PUT Description
id String No No

The id of the object.

JobArraySubJob

Represents information about a job array sub-job. This is used in retrieving Job information only. See JobArray for the fields used when creating a job array. This class exists only in MWS API version 1.

Field Name Type POST PUT Description
id String No No

The ID of this sub-job.
arrayIndex Long No No

The index of this sub-job. For example, if the job ID is Moab.1[4], the array index would be 4.
state JobStateVersion1 No No

The current state of this sub-job.

JobStateVersion1

Value Description
IDLE Eligible according to all resource manager constraints.
STARTING Job launching, executing prolog.
RUNNING Job is executing.
REMOVED Job canceled before executing.
COMPLETED Job successfully completed execution.
HOLD Job is blocked by hold.
DEFERRED
VACATED Job canceled after partial execution.
NOT_QUEUED Job not eligible for execution.
UNKNOWN
STAGING Staging of input/output data is currently underway.
SUSPENDED
BLOCKED State used only by database for job that is idle but has a block reason.

JobBlockReasonVersion1

Field Name Type POST PUT Description
message String No No

The message associated with the the reason the job is blocked.
type JobBlockReasonTypeVersion1 No No

The reason type.

JobBlockReasonTypeVersion1

Value Description
ACTIVEPOLICY
BADUSER
DEPENDENCY
ESTATE
FAIRSHARE
HOLD
IDLEPOLICY
LOCALPOLICY
NOCLASS
NODATA
NONE
NORESOURCE
NOTIME
PARTITIONACCESS
PRIORITY
RMSUBMISSIONFAILURE
STARTDATE
STATE
SYSLIMITS

JobDependencyVersion1

Field Name Type POST PUT Description
dependentJobsCount Integer No No

The number of dependent jobs.
type JobDependencyTypeVersion1 No No

The dependency type.

JobDependencyTypeVersion1

Value Description
JOBSTART Job may start at any time after specified jobs have started execution.
JOBSUCCESSFULCOMPLETE Job may be start at any time after all specified jobs have successfully completed.
JOBFAILEDCOMPLETE Job may start at any time after any specified jobs have completed unsuccessfully.
JOBCOMPLETE Job may start at any time after all specified jobs have completed regardless of completion status.
BEFORE Job may 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 may 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 may 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 may 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.

JobEmailNotifyTypeVersion1

Value Description
END An email will be sent out when the job successfully ends.
FAIL An email will be sent out when the job fails.
START An email will be sent out when the job starts.

JobStateVersion1

Value Description
IDLE Eligible according to all resource manager constraints.
STARTING Job launching, executing prolog.
RUNNING Job is executing.
REMOVED Job canceled before executing.
COMPLETED Job successfully completed execution.
HOLD Job is blocked by hold.
DEFERRED
VACATED Job canceled after partial execution.
NOT_QUEUED Job not eligible for execution.
UNKNOWN
STAGING Staging of input/output data is currently underway.
SUSPENDED
BLOCKED State used only by database for job that is idle but has a block reason.

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.
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 to 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.
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 administrator.
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.
VMTRACKING The job is a VMTracking job for an externally-created VM (via job template).
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.
NOVMMIGRATE Do not migrate the virtual machine that this job sets up.
PURGEONSUCCESSONLY Only purge the job if it completed successfully

JobHoldTypeVersion1

Value Description
NONE The job does not have a hold.
USER The user has manually specified a hold on a job.
SYSTEM Moab has put a hold on the job.
BATCH The batch queue has placed a hold on the job.
DEFER The job has been deferred.
ALL The job has all holds applied to it.

MessageVersion1

Field Name Type POST PUT Description
author String No No

The author of the message.
creationTime Date No No

The time the message was created in epoch time.
expireTime Date No No

The time the message will be deleted in epoch time.
index Integer No No

The index of the message relative to other messages in Moab's memory.
message String No Yes

The comment information itself.
messageCount Integer No No

The number of times this message has been displayed.
priority Double No No

An optional priority that can be attached to the comment.

JobQueueStatusVersion1

Value Description
ACTIVE A job is actively running in a queue.
BLOCKED A job has been blocked because of policy violation or resource requirements cannot be met.
COMPLETED A job has completed running.
ELIGIBLE A job is eligible to run, but has not started yet.
NONE A job's state type is unknown.

JobRequirementVersion1

Field Name Type POST PUT Description
allocatedNodes Set<DomainProxyVersion1> No No

The set of nodes to which the requirement is allocated.
allocatedPartition String No No

The partition allocated to the requirement.
genericResources Map<String, Integer> Yes No

The set of generic resources for this job. Each generic resource has a name and an associated amount.
nodeAccessPolicy NodeAccessPolicy Yes No

The node access policy the requirement asks for.
preferredNodeFeatures Set<String> No No

The list of preferred node features.
requiredArchitecture String Yes No

The required architecture.
requiredClass String No No

The required class/queue.
requiredDiskPerTask Integer Yes No

Required disk per task, in MB.
requiredMemoryPerTask Integer Yes No

Required memory per task, in MB.
requiredNetwork String No No

The required network.
requiredNodeCountMinimum Integer No No

The minimum number of nodes called for by the requirement.
requiredNodeDisk Integer No No

The required disk space in MB across all nodes.
requiredNodeFeatures Set<String> Yes No

The list of required node features.
requiredNodeMemory Integer No No

The required memory in MB across all nodes.
requiredNodeProcessors Integer No No

The required processors needed on a per node basis.
requiredNodeSwap Integer No No

The required swap in MB across all nodes.
requiredPartition String Yes Yes

A colon-separated list that specifies the partition (or partitions) in which the job must run.
requiredProcessorCountMinimum Integer Yes No

The minimum task count for this requirement.
requiredProcessorsPerTask Integer Yes No

Required processors per task.
requiredSwapPerTask Integer Yes No

Required swap per task, in MB.
tasksPerNode Integer Yes No

The number of tasks to map to each node.

NodeAccessPolicy

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

Value Description
NONE
SHARED Tasks from any combination of jobs may utilize available resources.
SHAREDONLY Only jobs requesting shared node access may utilize available resources.
SINGLEJOB Tasks from a single job may utilize available resourceses.
SINGLETASK A single task from a single job may run on the node.
SINGLEUSER Tasks from any jobs owned by the same user may utilize available resources.
UNIQUEUSER Any number of tasks from a single job may 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 may utilize node.
SINGLEACCOUNT Any number of tasks from the same account may utilize node.

VirtualContainer

A virtual container is a logical grouping of objects with a shared variable space and applied policies. Containers can hold virtual machines, physical machines, jobs, reservations, and/or nodes and req node sets. Containers can also be nested inside other containers.

Field Name Type POST PUT Description
id String No No

The unique ID of this virtual container.
aclRules Set<AclRule> No No

The set of access control rules associated with this virtual container.
createDate Date No No

The date/time that the virtual container was created.
creator String No No

The creator of the virtual container.
description String Yes Yes

A user-defined string that acts as a label.
flags Set<VirtualContainerFlag> No Yes

The flags on this virtual container.
jobs Set<DomainProxyVersion1> No Yes

The set of jobs in this virtual container.
nodes Set<DomainProxyVersion1> No Yes

The set of nodes in this virtual container.
owner EmbeddedCredential Yes Yes

The owner of the virtual container.
reservations Set<Reservation> No Yes

The set of reservations in this virtual container.
variables Map<String, Map> No Yes

Variables associated with the virtual container.
virtualContainers Set<VirtualContainer> No Yes

The set of virtual containers in this virtual container.
virtualMachines Set<DomainProxyVersion1> No Yes

The set of virtual machines in this virtual container.

AclRule

This class represents a rule that can be in Moab's access control list (ACL) mechanism.

The basic AclRule information is the object's name and type. The type directly maps to an AclType value. The default mechanism Moab uses to check the ACL for a particular item is if the user or object coming in has ANY of the values in the ACL, then the user or object is given access. If no values match the user or object in question, the user or object is rejected access.

Field Name Type POST PUT Description
affinity AclAffinity No Yes

Reservation ACLs allow or deny access to reserved resources but they may also be configured to affect a job's affinity for a particular reservation. By default, jobs gravitate toward reservations through a mechanism known as positive affinity. This mechanism allows jobs to run on the most constrained resources leaving other, unreserved resources free for use by other jobs that may not be able to access the reserved resources. Normally this is a desired behavior. However, sometimes, it is desirable to reserve resources for use only as a last resort-using the reserved resources only when there are no other resources available. This last resort behavior is known as negative affinity.

Defaults to AclAffinity.POSITIVE.
comparator ComparisonOperator No Yes

The type of comparison to make against the ACL object.

Defaults to ComparisonOperator.EQUAL.
type AclType No Yes

The type of the object that is being granted (or denied) access.
value String No Yes

The name of the object that is being granted (or denied) access.

AclAffinity

This enumeration describes the values available for describing how a rule is used in establishing access to an object in Moab. Currently, these ACL affinities are used only for granting access to reservations.

Value Description
NEGATIVE Access to the object is repelled using this rule until access is the last choice.
NEUTRAL Access to the object is not affected by affinity.
POSITIVE Access to the object is looked at as the first choice.
PREEMPTIBLE Access to the object given the rule gives preemptible status to the accessor. Supported only during GET.
REQUIRED The rule in question must be satisified in order to gain access to the object. Supported only during GET.
UNAVAILABLE The rule does not have its affinity available. Supported only during GET.

ComparisonOperator

This enumeration is used when Moab needs to compare items. One such use is in Access Control Lists (ACLs).

Value Description
GREATER_THAN Valid values: ">", "gt"
GREATER_THAN_OR_EQUAL Valid values: ">=", "ge"
LESS_THAN Valid values: "<", "lt"
LESS_THAN_OR_EQUAL Valid values: "<=", "le"
EQUAL Valid values: "==", "eq", "="
NOT_EQUAL Valid values: "!=", "ne", "<>"
LEXIGRAPHIC_SUBSTRING Valid value: "%<"
LEXIGRAPHIC_NOT_EQUAL Valid value: "%!"
LEXIGRAPHIC_EQUAL Valid value: "%="

AclType

This enumeration describes the values available for the type of an ACL Rule.

Value Description
USER User
GROUP Group
ACCOUNT Account or Project
CLASS Class or Queue
QOS Quality of Service
CLUSTER Cluster
JOB_ID Job ID
RESERVATION_ID Reservation ID
JOB_TEMPLATE Job Template
JOB_ATTRIBUTE Job Attribute
DURATION Duration in Seconds
PROCESSOR_SECONDS Processor Seconds
JPRIORITY Not supported
MEMORY Not supported
NODE Not supported
PAR Not supported
PROC Not supported
QTIME Not supported
QUEUE Not supported
RACK Not supported
SCHED Not supported
SYTEM Not supported
TASK Not supported
VC Not supported
XFACTOR Not supported

VirtualContainerFlag

This enumeration specifies the flag types of a virtual container.

Value Description
DESTROYOBJECTS Destroy reservations, jobs, and virtual machines in virtual container when the virtual container is destroyed.
DESTROYWHENEMPTY Destroy virtual container when it contains no objects.
DELETING Virtual container has started removal process -- might be waiting on workflows, etc. to finish.
HASSTARTED Virtual container has jobs that have started -- workflows only.
HOLDJOBS Virtual container will place a hold on jobs that are submitted to it while this flag is set .
WORKFLOW Virtual container for a workflow -- maximum of one workflow virtual container per workflow.

EmbeddedCredential

Field Name Type POST PUT Description
name String No No

type CredentialType No No

CredentialType

Value Description
USER
GROUP
ACCOUNT
CLASS
QOS
NOT_SPECIFIED

Reservation

A reservation is the mechanism by which Moab guarantees the availability of a set of resources at a particular time. Each reservation consists of three major components: (1) a set of resources, (2) a time frame, and (3) an access control list. It is a scheduler role to ensure that the access control list is not violated during the reservation's lifetime (that is, its time frame) on the resources listed. For example, a reservation may specify that node002 is reserved for user Tom on Friday. The scheduler is thus constrained to make certain that only Tom's jobs can use node002 at any time on Friday.

Field Name Type POST PUT Description
id String No No

The unique ID of the reservation.
accountingAccount String Yes No

Accountable Account.
accountingGroup String Yes No

Accountable Group.
accountingQOS String Yes No

Accountable QOS.
accountingUser String Yes No

Accountable User.
aclRules Set<AclRule> Yes No

The set of access control rules associated with this reservation.
allocatedNodeCount Integer No No

The number of allocated nodes for this reservation.
allocatedNodes Set<DomainProxyVersion1> No No

The nodes allocated to the reservation.
allocatedProcessorCount Integer No No

The number of allocated processors.
allocatedTaskCount Integer No No

The number of allocated tasks.
comments String Yes No

Reservation's comments or description.
creationDate Date No No

Creation date. Automatically set by Moab when a user creates the reservation.
duration Long Yes No

The duration of the reservation (in seconds).
endDate Date Yes No

The end date of the reservation. This is especially useful for one-time reservations, which have an exact time for when a reservation ends.
excludeJobs Set<String> Yes No

The list of jobs to exclude. Client must also set the IGNJOBRSV reservation flag. Otherwise, results are undefined. Used only during reservation creation.
expireDate Date No No

The date/time when the reservation expires and vacates.
flags Set<ReservationFlag> Yes No

The flags associated with the reservation.
globalId String No No

Global reservation ID.
hostListExpression String Yes No

The list of nodes a user can select to reserve. This may or may not be the nodes that are currently allocated to this reservation. Note: Either hostListExpression or taskCount must be set to create a reservation.
idPrefix String Yes No

The user-specified prefix for this reservation. If provided, Moab combines the idPrefix with an integer, and the combination is the unique identifier for this reservation.
isActive Boolean No No

State whether or not this reservation is currently active.
isTracked Boolean No No

States whether reservation resource usage is tracked.
label String Yes No

When a label is assigned to a reservation, the reservation can then be referenced by that label as well as by the reservation name.
maxTasks Integer No No

The maximum number of tasks for this reservation.
messages Set<MessageVersion1> No No

Messages for the reservation.
owner EmbeddedCredential Yes No

The owner of the reservation
partitionId String Yes No

The ID of the partition this reservation is for.
profile String Yes No

The profile that this reservation is using. A profile is a specification of attributes that all reservations share. Used only during reservation creation.
requirements ReservationRequirement Yes No

The reservation's requirements.
reservationGroup String Yes No

The reservation group to which the reservation belongs.
resources Map<String, Integer> Yes No

The reservation's resources. This field is a map, where the key is PROCS, MEM DISK, SWAP, or one or more user-defined keys.
startDate Date Yes No

The start time for the reservation. This is especially useful for one-time reservations, which have an exact time for when a reservation starts.
statistics ReservationStatistics No No

The reservation's statistical information.
subType String Yes No

The reservation sub-type.
taskCount Integer No No

The number of tasks that must be allocated to satisfy the reservation request. Note: Either hostListExpression or taskCount must be set to create a reservation.
trigger Trigger Yes No

Trigger for reservation. Used only during reservation creation.
triggerIds Set<String> No No

The IDs of the triggers attached to this reservation.
uniqueIndex String No No

The globally-unique reservation index.
variables Map<String, Map> Yes Yes

The set of variables for this reservation.

ReservationFlag

The flag types of a reservation.

Value Description
ALLOWJOBOVERLAP Allows jobs to overlap this Reservation, but not start during it (unless they have ACL access).
APPLYPROFRESOURCES Only apply resource allocation info from profile.
DEADLINE Reservation should be scheduled against a deadline.
IGNIDLEJOBS Ignore idle job reservations.
IGNJOBRSV Ignore job reservations, but not user or other reservations.
CHARGE Charge the idle cycles in the accounting manager.
NOVMMIGRATIONS Override the VM Migration Policy and don't migrate VMs that overlap this reservation.
OWNERPREEMPTIGNOREMINTIME Owner ignores preemptmintime for this reservation.
PROVISION Reservation should be capable of provisioning.
NOACLOVERLAP Reservation will not look at ACLs to overlap job (when using exclusive).
ADVRES If set, the reservation is created in advance of needing it.
ADVRESJOBDESTROY Cancel any jobs associated with the reservation when it is released.
ALLOWGRID The reservation is set up for use in a grid environment.
ALLOWPRSV Personal reservations can be created within the space of this standing reservation (and ONLY this standing reservation). By default, when a standing reservation is given the flag ALLOWPRSV, it is given the ACL rule USER==ALL+ allowing all jobs and all users access.
BYNAME Reservation only allows access to jobs that meet reservation ACLs and explicitly request the resources of this reservation using the job ADVRES flag.
DEDICATEDNODE If set, only one active reservation is allowed on a node.
DEDICATEDRESOURCE The reservation is only placed on resources that are not reserved by any other reservation, including jobs and other reservations.
EXCLUDEJOBS Makes a reservation job exclusive, where only one job can run in the reservation.
ENDTRIGHASFIRED A trigger has finished firing.
ENFORCENODESET Enforce node sets when creating reservation.
EXCLUDEALLBUTSB Reservation only shares resources with sandboxes.
EXCLUDEMYGROUP Exclude reservations within the same group.
IGNRSV Forces the reservation onto nodes regardless of whether there are other reservations currently residing on the nodes.
IGNSTATE Request ignores existing resource reservations, allowing the reservation to be forced onto available resources even if this conflicts with other reservations.
ISACTIVE If set, the reservation is currently active.
ISCLOSED If set, the reservation is closed.
ISGLOBAL If set the reservation applies to all resources.
OWNERPREEMPT The owner of the reservation is given preemptor status for resources contained in the reservation.
PARENTLOCK The reservation can only be destroyed by destroying its parent.
PREEMPTEE The reservation is preemptible.
PLACEHOLDER The reservation is a placeholder for resources.
PRSV The reservation is a non-adminstrator, non-standing reservation, user-created reservation.
REQFULL The reservation will fail if all resources requested cannot be allocated.
SCHEDULEVCRSV The reservation was created as part of a schedule VC command. This pertains to reservations creating while scheduling MWS Services, and these are filtered from the MWS output of reservations.
SINGLEUSE The reservation is automatically removed after completion of the first job to use the reserved resources.
SPACEFLEX The reservation is allowed to adjust resources allocated over time in an attempt to optimize resource utilization.
STANDINGRSV If set, the reservation was created by a standing reservation instance.
STATIC Makes a reservation ineligible to modified or canceled by an administrator.
SYSTEMJOB The reservation was created by a system job.
TIMEFLEX The reservation is allowed to adjust the reserved time frame in an attempt to optimize resource utilization.
TRIGHASFIRED The reservation has one or more triggers that have fired on it.
WASACTIVE The reservation was previously active.
EVACVMS Evacuate virtual machines on the node when the reservation starts.

ReservationRequirement

Represents all the types of requirements a user can request while creating a reservation.

Field Name Type POST PUT Description
architecture String Yes No

Required architecture.
featureList Set<String> Yes No

The list of features required for this reservation.
featureMode String No No

Required feature mode.
memory Integer Yes No

Required node memory, in MB.
nodeCount Integer No No

Required number of nodes.
nodeIds Set<String> No No

The list of node IDs required for this reservation.
os String Yes No

Required Operating System.
taskCount Integer Yes No

Required task count.

ReservationStatistics

Represents some basic statistical information that is kept about the usage of reservations. All metrics that are kept track relate to processor-seconds usage.

Field Name Type POST PUT Description
caps Double No No

The current active processor-seconds in the last reported iteration.
cips Double No No

The current idle processor-seconds in the last reported iteration.
taps Double No No

The total active processor-seconds over the life of the reservation.
tips Double No No

The total idle processor-seconds over the life of the reservation.

Trigger

Field Name Type POST PUT Description
id String No No

Trigger id - internal ID used by moab to track triggers
action String No No

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 No No

blockTime Date No No

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 No No

eventType TriggerEventType No No

expireTime Date No No

Time at which trigger should be terminated if it has not already been activated.
failOffset Date No No

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

interval Boolean No No

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 No No

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

Specifies whether this trigger can fire multiple times. Defaults to false.
name String No No

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

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

The type of object which this is attached to. Possible values:

  • vm - Virtual Machine
offset Date No No

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

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 No No

Time between MultiFire triggers; rearm time is enforced from the trigger event time.
requires String No No

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 No No

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 No No

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 documentation for more information.
timeout Date No No

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

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
JOB_PREEMPT This indicates that the trigger should preempt all jobs currently allocating resources assigned to the trigger's parent object. Only apply to reservation triggers.
MAIL
THRESHOLD
INTERNAL
EXEC

TriggerEventType

This enumeration specifies the event type of a trigger.

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

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 documentation 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 may 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 the 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 Description
MINUTE
HOUR
DAY
WEEK
MONTH

VMUsagePolicy

This enumeration describes the virtual machine requirements of a job

Value Description
REQUIREPM Requires a physical machine.
PREFPM Prefers a physical machine.
CREATEVM Creates a virtual machine.
CREATEPERSISTENTVM Creates a virtual machine that doesn't go away after the job is done.
REQUIREVM Requires a virtual machine.
PREFVM Prefers a virtual machine.

Related topics 

© 2014 Adaptive Computing