(Click to open topic with navigation)

Moab Web Services > References > Resource Reference > Fields: Virtual Containers

Fields: Virtual Containers

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

Additional references

Type Value Additional information
Permissions resource vcs Permissions
Hooks filename vcs.groovy Pre- and Post-Processing Hooks
Tenant-supported No Tenants
Distinct query-supported No Distinct
ClosedAPI version 3

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
SYSTEM 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.

DomainProxyVersion1

Field Name Type POST PUT Description
id String No No

The id of the object.

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.

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.

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

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

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

The total active processor-seconds over the life of the reservation.
tips Long 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.
type TriggerType No No

The type of the trigger.
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 Run changeparam (NOT PERSISTENT).
JOB_PREEMPT Indicates that the trigger should preempt all jobs currently allocating resources assigned to the trigger's parent object. Only apply to reservation triggers.
MAIL Sends an e-mail.
INTERNAL Modifies an object internally in Moab. This can be used to set a job hold for example.
EXEC Execute the trigger action. Typically used to run a script.
MODIFY Can modify object that trigger is attached to.
QUERY
RESERVE
SUBMIT

TriggerEventType

This enumeration specifies the event type of a trigger.

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

TriggerFlag

This enumeration specifies a flag belonging to a trigger.

Value Description
ATTACH_ERROR If the trigger outputs anything to stderr, Moab will attach this as a message to the trigger object.
CLEANUP If the trigger is still running when the parent object completes or is canceled, the trigger will be killed.
CHECKPOINT Moab should always checkpoint this trigger. See Checkpointing a Trigger in the Moab Workload Manager 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

TriggerType

This enumeration specifies the type of the trigger.

Value Description
generic
elastic
ClosedAPI version 2

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
SYSTEM 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.

DomainProxyVersion1

Field Name Type POST PUT Description
id String No No

The id of the object.

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.

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.

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

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

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

The total active processor-seconds over the life of the reservation.
tips Long 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.
type TriggerType No No

The type of the trigger.
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 Run changeparam (NOT PERSISTENT).
JOB_PREEMPT Indicates that the trigger should preempt all jobs currently allocating resources assigned to the trigger's parent object. Only apply to reservation triggers.
MAIL Sends an e-mail.
INTERNAL Modifies an object internally in Moab. This can be used to set a job hold for example.
EXEC Execute the trigger action. Typically used to run a script.
MODIFY Can modify object that trigger is attached to.
QUERY
RESERVE
SUBMIT

TriggerEventType

This enumeration specifies the event type of a trigger.

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

TriggerFlag

This enumeration specifies a flag belonging to a trigger.

Value Description
ATTACH_ERROR If the trigger outputs anything to stderr, Moab will attach this as a message to the trigger object.
CLEANUP If the trigger is still running when the parent object completes or is canceled, the trigger will be killed.
CHECKPOINT Moab should always checkpoint this trigger. See Checkpointing a Trigger in the Moab Workload Manager 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

TriggerType

This enumeration specifies the type of the trigger.

Value Description
generic
elastic

Related Topics 

© 2015 Adaptive Computing