Fields: Nodes

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

Additional references

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

API version 3

Node

This class represents a node in the Moab Workload Manager. Moab recognizes a node as a collection of resources with a particular set of associated attributes. This definition is similar to the traditional notion of a node found in a Linux cluster or supercomputer wherein a node is defined as one or more CPUs, associated memory, and possibly other compute resources such as local disk, swap, network adapters, and software licenses. Additionally, this node is described by various attributes such as an architecture type or operating system. Nodes range in size from small uniprocessor PCs to large symmetric multiprocessing (SMP) systems where a single node may consist of hundreds of CPUs and massive amounts of memory.

Field Name	Type	PUT	Description
id	String	No	The unique identifier of this node. Note: this field is not user-assigned and is generated by the database.
architecture	String	No	This node's processor architecture.
attributes	Map<String, Map>	No	Attributes is a map of attribute names to tuples (maps) that describe the scheduling attributes of a node. Each tuple should contain the following entries: value - the attribute value displayValue - the attribute display value
classes	Set<String>	No	The classes that this node can be scheduled for.
featuresCustom	Set<String>	Yes	The features this node advertises which are customizable at run-time. This can be used to define node sets. (See also: featuresReported.)
featuresReported	Set<String>	No	The features this node advertises which are reported by resource managers or are present in the Moab Workload Manager configuration. This can be used to define node sets. (See also: featuresCustom.)
index	Integer	No	The index for this node as reported by the resource manager.
ipAddress	String	No	This node's IPv4 address.
isHypervisor	Boolean	No	True if the node is a hypervisor, false otherwise. This is based on the NodeOperatingSystemInformation.hypervisorType field. If hypervisorType is present, the node is a hypervisor. If it is null, then it is not a hypervisor.
jobs	Set<DomainProxy>	No	Jobs associated with this node.
lastUpdatedDate	Date	No	The timestamp of the last moment when this node was updated. There is no guarantee that all user modifications to a node would be picked up. This will also be changed every RMPOLLINTERVAL even if a resource manager does not report information on this node.
messages	Set<Message>	Yes	The list of messages attached to this node. They can be attached by admins, the resource manager layer, or triggers.
metrics	Map<String, Double>	Yes	Metrics are the measurable, quantitative, and changing aspects of this node. They are used to define workload placement, attach triggers, etc. There are some built-in metrics: speed - A number from 0.0 to 1.0 describing the relative speed of the system for computational tasks. This is a composite metric, and is defined on a per-site basis. cpuLoad - This is the CPU load on this node. This value is defined at the resource manager layer, but is generally defined on a per-operating system basis. For example, Unix-based OS's use some aspect of the Unix load average, as reported by the resource manager layer, while Windows-based OS's use CPU utilization.
migrationDisabled	Boolean	No	True if VM migration is disabled on this node.
name	String	No	The name of this node. This name is unique per instance of Moab Workload Manager (i.e. not globally).
operatingSystem	NodeOperatingSystemInformation	Yes	Describes the current or expected operating system image information for this node. The operatingSystem.image field can be changed using PUT.
partition	String	Yes	The partition this node belongs to.
processorSpeed	Integer	No	The speed, in MHz, or the processors on this node.
profilingEnabled	Boolean	No	Indicates whether historical data gathering and reporting is enabled for this node. This is also controlled by the same setting on the default node (i.e. all nodes). If set to false (default), node statistics are not gathered.
rack	Integer	No	The rack where this node is located in the datacenter/cluster.
reservations	Set<DomainProxy>	No	Reservations associated with this node.
resourceManagerMessages	Map<String, Map>	No	The resource manager messages for this node. Each key is the name of a resource manager, and the value is the message that the resource manager has posted onto the node.
resourceManagers	Set<NodeResourceManager>	No	The resource managers that are reporting or have previously reported this node. Each object also contains information on the resource manager reports.
resources	Map<String, Resource>	No	Contains references of a string representing a resource name to a resource object detailing the amount of the resource that is available, configured, etc. Each key is the name of the resource, which equates to the generic resource identifier or one of "processors", "memory", "disk", or "swap". This name may be used as an id in the resource types web service.
slot	Integer	No	The slot in the rack where this node is located.
states	NodeStateInformation	Yes	This node's state. The states.powerState and states.state fields can be changed using PUT.
triggers	Set<DomainProxy>	No	Triggers associated with this node.
type	NodeType	No	The type of this node is governed by the types of resources it offers.
variables	Map<String, Map>	Yes	Variables is a map of key-value pairs, synonymous, but not directly related to, environment variables. They provide the mechanism to store arbitrary metdata which is useful to external systems in memory on this node.
virtualContainers	Set<DomainProxy>	No	The set of virtual containers that directly (not recursively) contain this node.
virtualMachines	Set<DomainProxy>	No	Virtual machines associated with this node.

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	PUT	Description
name	String	No	The name of the object.

Message

Field Name	Type	PUT	Description
count	Integer	No	The number of times this message has occurred.
createdDate	Date	No	The date this message was created.
expireDate	Date	No	The date this message expires.
message	String	Yes	The message itself.

NodeOperatingSystemInformation

Describes the current or expected operating system image information for a node.

Field Name	Type	PUT	Description
hypervisorType	String	No	The hypervisor technology that this node uses. May be null if the node is not a hypervisor.
image	String	Yes	The name of the operating system currently running on this node. In cloud mode, this corresponds to the ID or name of an image in the image management API in MWS. (See also: Image.id, Image.name.)
imageExpected	String	No	The name of the image that was requested to run on this node (i.e. with `mnodectl -m os=myOs`). In cloud mode, this corresponds to the ID or name of an image in the image management API in MWS. (See also: Image.id, Image.name.)
imageLastUpdatedDate	Date	No	The last time the image of this node was modified.
imagesAvailable	Set<String>	No	The list of image names that can be applied to this node. In cloud mode, this corresponds to IDs or names of images in the image management API in MWS. (See also: Image.id, Image.name.)
virtualMachineImages	Set<String>	No	The list of virtual machine image names the node is capable of supporting. In cloud mode, this corresponds to IDs or names of images in the image management API in MWS. (See also: Image.id, Image.name.)

NodeResourceManager

Field Name	Type	PUT	Description
isMaster	Boolean	No	Indicates whether this resource manager is the "master" of this Node. If true, it means that this resource manager has the final say on all properties reported about this Node. Note that the first resource manager to report a node is the master resource manager.
name	String	No	The name of the resource manager, according to Moab. This name appears in both the RMCFG parameter, and when diagnosing resource managers (e.g. `mdiag -R`).
stateReported	NodeState	No	The state reported by this resource manager. See the State section for more details.

NodeState

This enumeration tracks the state of a node.

Value	Description
NONE	The node is set to none by the resource manager.
DOWN	The node is not available for workload.
IDLE	The node is available for workload but is not running anything.
BUSY	The node is running workload and cannot accept more.
RUNNING	The node is running workload and can accept more.
DRAINED	The node has been sent the drain request and has no workload on it.
DRAINING	The node has been sent the drain request, but still has workload on it.
FLUSH	The node is being reprovisioned.
RESERVED	The node is being reserved. This is an internal Moab state.
UNKNOWN	The state of the node is unknown.

Resource

Represents counts of resources available, configured, etc.

Field Name	Type	PUT	Description
available	Integer	No	The amount of this resource that is currently available for allocation to workload.
configured	Integer	No	The amount of this resource that is considered possible to schedule. Overcommit specifically applies to this, in other words, `configured = overcommitFactor * real`.
dedicated	Integer	No	The amount of this resource that has been allocated for running workload. When used in a job submission, this number is the amount of the resource required by the job.
real	Integer	No	The amount of this resource that physically exists on the node. Overcommit specifically doesn't apply to this. Note that overcommit currently only applies to "processors" and "memory", and so, for most cases, real and configured will always be the same.
utilized	Integer	No	The amount of this resource that is currently reported as utilized by resource managers.

NodeStateInformation

Field Name	Type	PUT	Description
powerState	NodePower	Yes	The state of the node's power system, as reported by the RM layer. Modifying the powerState is possible, and, if Moab is configured properly, a request will be made to modify the power state accordingly.
powerStateExpected	NodePower	No	The expected state of the node's power system. If a user has requested that a node be powered off (e.g. by modifying the powerState attribute to NodePower.OFF), the requested state will be shown in this field until the state change is completed. If there is no pending power change request, this will be null.
state	NodeState	Yes	The scheduling state of the Node, as reported by the resource management layer.
stateExpected	NodeState	No	The scheduling state of the Node, as expected by Moab. For example, Moab may think that a Node is "Busy" because it has allocated all configured resources, but a resource manager may report the state as "Running" based on actual utilization of the resources.
stateLastUpdatedDate	Date	No	A timestamp recording when the state of the Node was last modified.
subState	String	No	A text description of the state of the Node, with the intention of giving more details. Resource Managers may use this field to further describe the state being reported. Resource Managers should provide documented meaning to the possible sub-states that they can report.
subStateLast	String	No	The previous sub-state of the Node as reported by the resource management layer.
subStateLastUpdatedDate	Date	No	A timestamp recording when the sub-state was last modified.

NodePower

Represents the various options for a Node's power state.

Value	Description
NONE
ON
OFF

NodeType

Represents the type of node as reported by a resource manager.

Value	Description
Compute
License
Network
Storage

API version 2

Node

Field Name	Type	PUT	Description
id	String	No	The unique identifier of this node. Note: this field is not user-assigned and is generated by the database.
architecture	String	No	This node's processor architecture.
attributes	Map<String, Map>	No	Attributes is a map of attribute names to tuples (maps) that describe the scheduling attributes of a node. Each tuple should contain the following entries: value - the attribute value displayValue - the attribute display value
classes	Set<String>	No	The classes that this node can be scheduled for.
featuresCustom	Set<String>	Yes	The features this node advertises which are customizable at run-time. This can be used to define node sets. (See also: featuresReported.)
featuresReported	Set<String>	No	The features this node advertises which are reported by resource managers or are present in the Moab Workload Manager configuration. This can be used to define node sets. (See also: featuresCustom.)
index	Integer	No	The index for this node as reported by the resource manager.
ipAddress	String	No	This node's IPv4 address.
isHypervisor	Boolean	No	True if the node is a hypervisor, false otherwise. This is based on the NodeOperatingSystemInformation.hypervisorType field. If hypervisorType is present, the node is a hypervisor. If it is null, then it is not a hypervisor.
jobs	Set<DomainProxy>	No	Jobs associated with this node.
lastUpdatedDate	Date	No	The timestamp of the last moment when this node was updated. There is no guarantee that all user modifications to a node would be picked up. This will also be changed every RMPOLLINTERVAL even if a resource manager does not report information on this node.
messages	Set<Message>	Yes	The list of messages attached to this node. They can be attached by admins, the resource manager layer, or triggers.
metrics	Map<String, Double>	Yes	Metrics are the measurable, quantitative, and changing aspects of this node. They are used to define workload placement, attach triggers, etc. There are some built-in metrics: speed - A number from 0.0 to 1.0 describing the relative speed of the system for computational tasks. This is a composite metric, and is defined on a per-site basis. cpuLoad - This is the CPU load on this node. This value is defined at the resource manager layer, but is generally defined on a per-operating system basis. For example, Unix-based OS's use some aspect of the Unix load average, as reported by the resource manager layer, while Windows-based OS's use CPU utilization.
migrationDisabled	Boolean	No	True if VM migration is disabled on this node.
name	String	No	The name of this node. This name is unique per instance of Moab Workload Manager (i.e. not globally).
operatingSystem	NodeOperatingSystemInformation	Yes	Describes the current or expected operating system image information for this node. The operatingSystem.image field can be changed using PUT.
partition	String	Yes	The partition this node belongs to.
processorSpeed	Integer	No	The speed, in MHz, or the processors on this node.
profilingEnabled	Boolean	No	Indicates whether historical data gathering and reporting is enabled for this node. This is also controlled by the same setting on the default node (i.e. all nodes). If set to false (default), node statistics are not gathered.
rack	Integer	No	The rack where this node is located in the datacenter/cluster.
reservations	Set<DomainProxy>	No	Reservations associated with this node.
resourceManagerMessages	Map<String, Map>	No	The resource manager messages for this node. Each key is the name of a resource manager, and the value is the message that the resource manager has posted onto the node.
resourceManagers	Set<NodeResourceManager>	No	The resource managers that are reporting or have previously reported this node. Each object also contains information on the resource manager reports.
resources	Map<String, Resource>	No	Contains references of a string representing a resource name to a resource object detailing the amount of the resource that is available, configured, etc. Each key is the name of the resource, which equates to the generic resource identifier or one of "processors", "memory", "disk", or "swap". This name may be used as an id in the resource types web service.
slot	Integer	No	The slot in the rack where this node is located.
states	NodeStateInformation	Yes	This node's state. The states.powerState and states.state fields can be changed using PUT.
triggers	Set<DomainProxy>	No	Triggers associated with this node.
type	NodeType	No	The type of this node is governed by the types of resources it offers.
variables	Map<String, Map>	Yes	Variables is a map of key-value pairs, synonymous, but not directly related to, environment variables. They provide the mechanism to store arbitrary metdata which is useful to external systems in memory on this node.
virtualContainers	Set<DomainProxy>	No	The set of virtual containers that directly (not recursively) contain this node.
virtualMachines	Set<DomainProxy>	No	Virtual machines associated with this node.

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	PUT	Description
name	String	No	The name of the object.

Message

Field Name	Type	PUT	Description
count	Integer	No	The number of times this message has occurred.
createdDate	Date	No	The date this message was created.
expireDate	Date	No	The date this message expires.
message	String	Yes	The message itself.

NodeOperatingSystemInformation

Describes the current or expected operating system image information for a node.

Field Name	Type	PUT	Description
hypervisorType	String	No	The hypervisor technology that this node uses. May be null if the node is not a hypervisor.
image	String	Yes	The name of the operating system currently running on this node. In cloud mode, this corresponds to the ID or name of an image in the image management API in MWS. (See also: Image.id, Image.name.)
imageExpected	String	No	The name of the image that was requested to run on this node (i.e. with `mnodectl -m os=myOs`). In cloud mode, this corresponds to the ID or name of an image in the image management API in MWS. (See also: Image.id, Image.name.)
imageLastUpdatedDate	Date	No	The last time the image of this node was modified.
imagesAvailable	Set<String>	No	The list of image names that can be applied to this node. In cloud mode, this corresponds to IDs or names of images in the image management API in MWS. (See also: Image.id, Image.name.)
virtualMachineImages	Set<String>	No	The list of virtual machine image names the node is capable of supporting. In cloud mode, this corresponds to IDs or names of images in the image management API in MWS. (See also: Image.id, Image.name.)

NodeResourceManager

Field Name	Type	PUT	Description
isMaster	Boolean	No	Indicates whether this resource manager is the "master" of this Node. If true, it means that this resource manager has the final say on all properties reported about this Node. Note that the first resource manager to report a node is the master resource manager.
name	String	No	The name of the resource manager, according to Moab. This name appears in both the RMCFG parameter, and when diagnosing resource managers (e.g. `mdiag -R`).
stateReported	NodeState	No	The state reported by this resource manager. See the State section for more details.

NodeState

This enumeration tracks the state of a node.

Value	Description
NONE	The node is set to none by the resource manager.
DOWN	The node is not available for workload.
IDLE	The node is available for workload but is not running anything.
BUSY	The node is running workload and cannot accept more.
RUNNING	The node is running workload and can accept more.
DRAINED	The node has been sent the drain request and has no workload on it.
DRAINING	The node has been sent the drain request, but still has workload on it.
FLUSH	The node is being reprovisioned.
RESERVED	The node is being reserved. This is an internal Moab state.
UNKNOWN	The state of the node is unknown.

Resource

Represents counts of resources available, configured, etc.

Field Name	Type	PUT	Description
available	Integer	No	The amount of this resource that is currently available for allocation to workload.
configured	Integer	No	The amount of this resource that is considered possible to schedule. Overcommit specifically applies to this, in other words, `configured = overcommitFactor * real`.
dedicated	Integer	No	The amount of this resource that has been allocated for running workload. When used in a job submission, this number is the amount of the resource required by the job.
real	Integer	No	The amount of this resource that physically exists on the node. Overcommit specifically doesn't apply to this. Note that overcommit currently only applies to "processors" and "memory", and so, for most cases, real and configured will always be the same.
utilized	Integer	No	The amount of this resource that is currently reported as utilized by resource managers.

NodeStateInformation

Field Name	Type	PUT	Description
powerState	NodePower	Yes	The state of the node's power system, as reported by the RM layer. Modifying the powerState is possible, and, if Moab is configured properly, a request will be made to modify the power state accordingly.
powerStateExpected	NodePower	No	The expected state of the node's power system. If a user has requested that a node be powered off (e.g. by modifying the powerState attribute to NodePower.OFF), the requested state will be shown in this field until the state change is completed. If there is no pending power change request, this will be null.
state	NodeState	Yes	The scheduling state of the Node, as reported by the resource management layer.
stateExpected	NodeState	No	The scheduling state of the Node, as expected by Moab. For example, Moab may think that a Node is "Busy" because it has allocated all configured resources, but a resource manager may report the state as "Running" based on actual utilization of the resources.
stateLastUpdatedDate	Date	No	A timestamp recording when the state of the Node was last modified.
subState	String	No	A text description of the state of the Node, with the intention of giving more details. Resource Managers may use this field to further describe the state being reported. Resource Managers should provide documented meaning to the possible sub-states that they can report.
subStateLast	String	No	The previous sub-state of the Node as reported by the resource management layer.
subStateLastUpdatedDate	Date	No	A timestamp recording when the sub-state was last modified.

NodePower

Represents the various options for a Node's power state.

Value	Description
NONE
ON
OFF

NodeType

Represents the type of node as reported by a resource manager.

Value	Description
Compute
License
Network
Storage

API version 1

NodeVersion1

Field Name	Type	PUT	Description
id	String	No	The unique ID of the node.
accessPolicy	NodeAccessPolicy	No	The node's access policy.
aliases	Set<String>	No	Holds DNS aliases associated with the node
architecture	String	No	The node's processor architecture.
availableClasses	Set<String>	No	The classes that are available to the node.
availableDisk	Integer	No	The node's available disk space in MB.
availableEndDate	Date	No	The time when the node will stop being available.
availableGenericResources	Map<String, Integer>	No	The node's available generic resources. Stored as name and associated amount.
availableMemory	Integer	No	The node's available memory in MB.
availableProcessors	Integer	No	The node's available processors.
availableStartDate	Date	No	The time when the node will become available.
availableSwap	Integer	No	The node's available swap space in MB.
blockReason	String	No	The reason why jobs are blocked from running on the node.
comments	String	No	User-specified comments regarding the node.
configuredClasses	Set<String>	No	The classes reported by the resource manager for the node.
cpuLoad	Double	No	The current load of the node as a percentage.
dynamic	Boolean	No	If true, the node is associated with a dynamic resource manager.
externalLoad	Double	No	The load on the node not attributed to any batch queues.
features	Set<String>	No	The collection of any opaque node features used to describe and categorize the node.
flags	Set<NodeFlag>	No	The flags that are set on this node. Valid only during GET.
genericEvents	Set<GenericEvent>	Yes	The list of generic events reported on this node.
genericMetrics	Map<String, Double>	Yes	The values for the generic metrics for this node.
genericResources	Map<String, Integer>	No	The generic resources attached to this node. With each generic resource there is a name and an associated amount.
hypervisorType	String	No	The hypervisor type. Null if this is not a hypervisor.
iOLoad	Double	No	The load reported by the node on its I/O.
index	Integer	No	The index for this node as reported by the resource manager.
jobs	Set<DomainProxyVersion1>	No	The list of jobs on the node.
lastStateUpdateDate	Date	No	The date of the last resource manager update of the node's state.
lastUpdateDate	Date	No	The date of the last resource manager update
maxIOIn	Double	No	The maximum input as a percentage allowed for the node's I/O.
maxIOLoad	Double	No	The maximum total load as a percentage allowed for the node's I/O.
maxIOOut	Double	No	The maximum output as a percentage allowed for the node's I/O.
maxJob	Integer	No	The maximum number of jobs allowed to run on the node.
maxJobPerUser	Integer	No	The maximum number of jobs for a single user allowed to run on the node.
maxLoad	Double	No	The maximum total load as a percentage allowed on the node.
maxPEPerJob	Double	No	The maximum processor equivalence per job allowed on the node.
maxPageIn	Double	No	The maximum total page in allowed on the node.
maxPageOut	Double	No	The maximum total page out allowed on the node.
maxProc	Integer	No	The maximum number of processors available on the node.
maxProcPerClass	Integer	No	The maximum number of processors per class available on the node.
messages	Set<MessageVersion1>	Yes	The list of system and user messages on the node.
network	String	No	The name of the node's network.
networkAddress	String	No	The network (usually IP) address of this node.
networkLoad	Double	No	The load of the node's network as a percentage.
nextOS	String	No	If populated, the next operating system that is currently being provisioned.
operations	Set<NodeOperation>	No	The list of operations that can be performed on this node.
os	String	Yes	The operating system of the node.
osList	Set<String>	No	The list of potential operating systems for the node.
overcommit	OverCommitFactor	No	This is the coefficient that determines how much resources may be overutilized on this hypervisor. Will normally be null for non-hypervisor nodes.
partition	String	Yes	The partition this node belongs to.
power	NodePower	Yes	The node's power state according to the resource managers reporting this node.
powerPolicy	PowerPolicy	No	The power policy for this node. The default is static where the power is controlled manually.
powerSelected	NodePower	No	The node's power state that Moab is currently scheduling. This could be different from the actual node power itself.
priority	Double	No	The priority associated with the node.
priorityFunction	String	No	The function used to calculate this node's priority.
procSpeed	Integer	No	The node's processor speed in MHz.
profilingEnabled	Boolean	No	Indicates whether statistical profiling is enabled for this node. If set to false, node statistics will not be gathered. Defaults to false.
rack	Integer	No	The node's rack location.
reservationCount	Integer	No	The number of reservations on the node.
reservations	Set<String>	No	The list of reservations' names currently on this node.
rmAccessList	String	No	A comma-separated list of resource managers that have access to this node.
size	Integer	No	The number of slots or size units consumed by the node.
slot	Integer	No	The node's slot location.
speed	Double	No	The relative speed of the node. The speed must be between .1 and 100.0. The default value for speed is 1.0.
speedWeight	Double	No	The weight of the speed metric in the node's priority function
state	NodeState	Yes	The node's current state.
substate	String	No	The substate that will give more information about the status of the VM.
taskCount	Integer	No	The number of tasks currently running on the node.
totalActiveTime	Long	No	The epoch time in seconds that the node was tracked as being busy with jobs.
totalAvailableTime	Long	No	The epoch time in seconds that the node is available.
totalDisk	Integer	No	The node's total disk space in MB.
totalMemory	Integer	No	The node's total memory in MB.
totalProcessors	Integer	No	The node's total processors.
totalStatsTime	Long	No	The epoch time in seconds that stats have been tracked for the node.
totalSwap	Integer	No	The node's total swap space in MB.
totalUpTime	Long	No	The epoch time in seconds that the node was tracked as being up.
type	String	No	The type of the node. This is used for allocation management purposes.
variables	Map<String, Map>	Yes	Variables associated with the node.
virtualMachines	Set<VirtualMachineVersion1>	No	The list of virtual machines on the node.
vmOsList	Set<String>	No	The list of potential operating systems that can be used when creating a virtual machine on the 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.

NodeFlag

Represents the various flags for nodes.

Value	Description
NONE
GLOBAL_VARS	Node has variables available for triggers.
NO_VM_MIGRATIONS	Node is excluded from all virtual machine migration decisions.

GenericEvent

A GenericEvent is an event that is reported by a NodeResourceManager on a Node or VirtualMachine. Usually, there is some corresponding action defined in the moab.cfg file.

GenericEvents are defined by a "name" characteristic, which indicates the type of thing happened on the resource associated with it. For example, a "highcputemp" GenericEvent might be reported by a NodeResourceManager when it detects that the CPU temperature has risen about 50 degrees C.

Note that GenericEvents vary by configuration: one installation of Moab may report GenericEvents of "highcputemp" while another would report "cputemphigh". Although the meaning is the same, the type or name is different.

Field Name	Type	PUT	Description
date	Date	No	The timestamp of when this GenericEvent was reported to Moab
message	String	Yes	The message that goes with this GenericEvent
name	String	Yes	The name of the GenericEvent. In other words, the type.
severity	Integer	No	The severity level of the event (1-4, 1 is low severity, 0 is unset)

DomainProxyVersion1

Field Name	Type	PUT	Description
id	String	No	The id of the object.

MessageVersion1

Field Name	Type	PUT	Description
author	String	No	The author of the message.
creationTime	Date	No	The time the message was created in epoch time.
expireTime	Date	No	The time the message will be deleted in epoch time.
index	Integer	No	The index of the message relative to other messages in Moab's memory.
message	String	Yes	The comment information itself.
messageCount	Integer	No	The number of times this message has been displayed.
priority	Double	No	An optional priority that can be attached to the comment.

NodeOperation

This class represents an operation that can be taken on a given node.

Value	Description
CREATE_VM
MIGRATE_VM
MODIFY_OS
OFFLINE
ONLINE
POWER_ON
POWER_OFF
REBOOT

OverCommitFactor

This class represents the multipliers to use for over committing the basic grouping of resource types that Moab generally uses when scheduling and taking policy actions in a system These resources type are the following:

Disk
Memory
Processors
Swap

These over commit factors are used in multiplying the reported resources from an RM for servers. In addition, these factors are used in establishing when VMs are migrated away from a hypervisor.

Field Name	Type	PUT	Description
overcommitMap	Map<String, Double>	No

NodePower

Represents the various options for a Node's power state.

Value	Description
NONE
ON
OFF

PowerPolicy

This enumeration represents the power policy to take when deciding about resource power.

Value	Description
NONE
ONDEMAND	Moab will attempt to power the server off if there is no workload running on it.
STATIC	The power is handled manually.
GREEN

NodeState

This enumeration tracks the state of a node.

Value	Description
NONE	The node is set to none by the resource manager.
DOWN	The node is not available for workload.
IDLE	The node is available for workload but is not running anything.
BUSY	The node is running workload and cannot accept more.
RUNNING	The node is running workload and can accept more.
DRAINED	The node has been sent the drain request and has no workload on it.
DRAINING	The node has been sent the drain request, but still has workload on it.
FLUSH	The node is being reprovisioned.
RESERVED	The node is being reserved. This is an internal Moab state.
UNKNOWN	The state of the node is unknown.

VirtualMachineVersion1

Field Name	Type	PUT	Description
id	String	No	The unique ID of the VM.
aliases	Set<String>	No	The list of aliases that refer to this VM.
availableDisk	Integer	No	The amount of disk space available on this VM.
availableMemory	Integer	No	The amount of memory available on this VM.
availableProcessors	Integer	No	The number of processors available on this VM.
cpuLoad	Double	No	The CPU load for this VM.
description	String	No	A description of this VM.
effectiveTimeToLive	Long	No	Time (in seconds) that this VM has to run (0 means not set).
flags	Set<VMFlag>	Yes	The flags associated with this VM.
genericEvents	Set<GenericEvent>	Yes	The list of generic events reported on this VM.
genericMetrics	Map<String, Double>	Yes	The values for the generic metrics for this VM.
lastMigrationDate	Date	No	The date when this VM was last migrated.
lastSubstate	String	No	Last reported substate (substate is not always reported).
lastSubstateModificationDate	Date	No	Date/time that lastSubstate was modified.
lastUpdateDate	Date	No	The date of when this VM was last updated.
migrationCount	Integer	No	The number of times this VM has been migrated.
networkAddress	String	No	The network address of this VM.
node	DomainProxyVersion1	Yes	The physical node on which this VM is running.
os	String	Yes	The current operating system of the VM.
osList	Set<String>	No	The list of operating systems that the VM can run.
powerSelectState	NodePower	No	The selected power state of this VM.
powerState	NodePower	Yes	The power state of this VM.
rack	Integer	No	The rack of the VM inside a given node.
requestedTimeToLive	Long	No	User-specified time (in seconds) that this VM has to run (0 means not set).
slot	Integer	No	The slot of the VM inside a given node.
sovereign	Boolean	No
startDate	Date	No	Date/time that this VM was started (ready and usable)
state	NodeState	Yes	The state of the VM.
storage	String	No
substate	String	No	The substate that will give more information about the status of the VM.
template	String	No
totalDisk	Integer	No	The amount of disk space configured in MB.
totalMemory	Integer	No	The amount of memory configured in MB.
totalProcessors	Integer	No	The number of virtual processors in the VM.
trackingJob	DomainProxyVersion1	No	The tracking job for this VM.
triggers	Set<Trigger>	Yes	The list of triggers on this VM.
variables	Map<String, Map>	Yes	Variables associated with this VM.

VMFlag

This enumeration specifies the VM flag types of a virtual machine.

Value	Description
CAN_MIGRATE	VM may be directly migrated without direction from parent workload.
CANNOT_MIGRATE	This value is used to remove the CAN_MIGRATE flag.
CONSUMER	VM should be treated as resource consumer regardless of Moab-tracked workload.
CREATION_COMPLETED	VM creation completed.
DELETED	VM deleted.
DESTROY_PENDING	VM destroy requested.
DESTROYED	VM reported destroyed by Resource Manager (VM will be removed when resource manager no longer reports VM).
INITIALIZING	VM is initializing.
ONETIMEUSE	VM is was created for a job with vmusagepolicy=createvm.
SHARED	Multiple jobs can use VM resources simultaneously.
UTILIZATION_REPORTED

Trigger

Field Name	Type	PUT	Description
id	String	No	Trigger id - internal ID used by moab to track triggers
action	String	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
blockTime	Date	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
eventType	TriggerEventType	No
expireTime	Date	No	Time at which trigger should be terminated if it has not already been activated.
failOffset	Date	No	Specifies the time (in seconds) that the threshold condition must exist before the trigger fires.
flags	Set<TriggerFlag>	No
interval	Boolean	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	Specifies the number of times Action will be attempted before the trigger is designated a failure.
multiFire	Boolean	No	Specifies whether this trigger can fire multiple times. Defaults to false.
name	String	No	Trigger name - can be auto assigned by moab or requested. Alphanumeric up to 16 characters in length
objectId	String	No	The ID of the object which this is attached to.
objectType	String	No	The type of object which this is attached to. Possible values: vm - Virtual Machine
offset	Date	No	Relative time offset from event when trigger can fire.
period	TriggerPeriod	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	Time between MultiFire triggers; rearm time is enforced from the trigger event time.
requires	String	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	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	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	Time allotted to this trigger before it is marked as unsuccessful and its process (if any) killed.
unsets	String	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