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

Fields: Virtual Machines

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

Additional references

Type	Value	Additional information
Permissions resource	vms	Permissions
Hooks filename	vms.groovy	Pre- and Post-Processing Hooks
Tenant-supported	Yes	Tenants
Distinct query-supported	Yes	Distinct

API version 3

VirtualMachine

This class represents a virtual machine: a software implementation of a computer that executes programs like a physical machine (i.e. like a node). A virtual machine, therefore, requires a host machine, usually called a hypervisor, which partitions its resources to be used by the one or many virtual machines it hosts.

A virtual machine needs to have a name, will typically report an OS, and have a list of operating systems that it can run.

Field Name	Type	PUT	Description
id	String	No	The unique identifier of the virtual machine. Note: this field is not user-assigned and is generated by the database.
attributes	Map<String, JobRequirementAttribute>	No	A copy of the attributes from the tracking job associated with this VM.
description	String	No	A description of this VM.
host	DomainProxy	Yes	The physical machine (hypervisor) on which this VM is running.
hostnames	Set<String>	No	The set of host names (aliases) that refer to this VM.
ipAddress	String	No	This VM's IPv4 address.
lastMigrationDate	Date	No	The date when this VM was last migrated.
lastUpdatedDate	Date	No	The timestamp of the last moment when this VM was updated. There is no guarantee that all user modifications to a VM would be picked up. This will also be changed every RMPOLLINTERVAL even if a resource manager does not report information on this VM.
metrics	Map<String, Double>	Yes	Metrics are the measurable, quantitative, and changing aspects of this VM. 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 VM. This value is defined at the resource manager layer, but is generally defined on a per-operating system basis. i.e. 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.
migrationCount	Integer	No	The number of times this VM has been migrated.
migrationDisabled	Boolean	Yes	True if migration is disabled for this VM, false otherwise.
name	String	No	The name of the virtual machine. This name is unique per instance of Moab Workload Manager (i.e. not globally).
operatingSystem	VMOperatingSystemInformation	Yes	Describes the current or expected operating system image information for this VM.
requiredFeatures	Set<String>	No	The set of features required by this VM.
resourceManagers	Set<NodeResourceManager>	No	The resource managers that are reporting or have previously reported this VM. 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.
startDate	Date	No	Date that this VM was started (ready and usable).
states	NodeStateInformation	Yes	State information for this VM.
trackingJob	DomainProxy	No	The tracking job for this VM.
triggers	Set<DomainProxy>	Yes	The set of triggers associated with this VM.
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 VM.
virtualContainers	Set<DomainProxy>	No	The set of virtual containers that directly (not recursively) contain this VM.

JobRequirementAttribute

Field Name	Type	PUT	Description
comparator	String	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	No	The display value for the required attribute.
restriction	JobRequirementAttributeRestriction	No	The restriction of this attribute. May be null, but defaults to JobRequirementAttributeRestriction.must.
value	String	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

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.

VMOperatingSystemInformation

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

Field Name	Type	PUT	Description
image	String	No	The name of the image currently running on this VM. 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 VM. 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 VM was modified.
imagesAvailable	Set<String>	No	The list of image names which can be applied to this VM. In cloud mode, these correspond 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

API version 2