com.ace.mws.vms
[Groovy] Class VirtualMachine

java.lang.Object
  com.ace.mws.vms.VirtualMachine

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

description

private String description

A description of this VM.

host

private DomainProxy host

The physical machine (hypervisor) on which this VM is running. Valid during PUT.

hostnames

private Set hostnames

(String collection) The set of host names (aliases) that refer to this VM.

See Also:

String

id

private String id

The unique identifier of the virtual machine. Note: this field is not user-assigned and is generated by the database.

ipAddress

private String ipAddress

This VM's IPv4 address.

lastMigrationDate

private Date lastMigrationDate

The date when this VM was last migrated.

lastUpdatedDate

private Date lastUpdatedDate

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

private Map metrics

(Map of String => Double) 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:
  • Unix-based OS's using some aspect of the Unix load average, as reported by the resource manager layer
  • Windows-based OS's using CPU utilization

Valid during PUT.

See Also:

Double

migrationCount

private Integer migrationCount

The number of times this VM has been migrated.

migrationDisabled

private Boolean migrationDisabled

True if migration is disabled for this VM, false otherwise.

name

private String name

The name of the virtual machine. This name is unique per instance of Moab Workload Manager (i.e. not globally).

operatingSystem

private VMOperatingSystemInformation operatingSystem

Describes the current or expected operating system image information for this VM. Valid during PUT.

requiredFeatures

private Set requiredFeatures

(String collection) The set of features required by this VM.

See Also:

String

resourceManagers

private Set resourceManagers

(NodeResourceManager collection) The resource managers that are reporting or have previously reported this VM. Each object also contains information on the resource manager reports.

See Also:

NodeResourceManager

resources

private Map resources

(Map of String => Resource) 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.

See Also:

Resource

startDate

private Date startDate

Date that this VM was started (ready and usable).

states

private NodeStateInformation states

State information for this VM. Valid during PUT.

trackingJob

private DomainProxy trackingJob

The tracking job for this VM.

triggers

private Set triggers

(DomainProxy collection) The set of triggers associated with this VM. Valid during PUT.

See Also:

DomainProxy

variables

private Map variables

(Map of String => String) 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. Valid during PUT.

See Also:

Map

virtualContainers

private Set virtualContainers

(DomainProxy collection) The set of virtual containers that directly (not recursively) contain this VM.

See Also:

DomainProxy

VirtualMachine

VirtualMachine()

getDescription

String getDescription()

A description of this VM.

getHost

DomainProxy getHost()

The physical machine (hypervisor) on which this VM is running. Valid during PUT.

getHostnames

Set getHostnames()

(String collection) The set of host names (aliases) that refer to this VM.

See Also:

String

getId

String getId()

The unique identifier of the virtual machine. Note: this field is not user-assigned and is generated by the database.

getIpAddress

String getIpAddress()

This VM's IPv4 address.

getLastMigrationDate

Date getLastMigrationDate()

The date when this VM was last migrated.

getLastUpdatedDate

Date getLastUpdatedDate()

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.

getMetrics

Map getMetrics()

(Map of String => Double) 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:
  • Unix-based OS's using some aspect of the Unix load average, as reported by the resource manager layer
  • Windows-based OS's using CPU utilization

Valid during PUT.

See Also:

Double

getMigrationCount

Integer getMigrationCount()

The number of times this VM has been migrated.

getMigrationDisabled

Boolean getMigrationDisabled()

True if migration is disabled for this VM, false otherwise.

getName

String getName()

The name of the virtual machine. This name is unique per instance of Moab Workload Manager (i.e. not globally).

getOperatingSystem

VMOperatingSystemInformation getOperatingSystem()

Describes the current or expected operating system image information for this VM. Valid during PUT.

getRequiredFeatures

Set getRequiredFeatures()

(String collection) The set of features required by this VM.

See Also:

String

getResourceManagers

Set getResourceManagers()

(NodeResourceManager collection) The resource managers that are reporting or have previously reported this VM. Each object also contains information on the resource manager reports.

See Also:

NodeResourceManager

getResources

Map getResources()

(Map of String => Resource) 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.

See Also:

Resource

getStartDate

Date getStartDate()

Date that this VM was started (ready and usable).

getStates

NodeStateInformation getStates()

State information for this VM. Valid during PUT.

getTrackingJob

DomainProxy getTrackingJob()

The tracking job for this VM.

getTriggers

Set getTriggers()

(DomainProxy collection) The set of triggers associated with this VM. Valid during PUT.

See Also:

DomainProxy

getVariables

Map getVariables()

(Map of String => String) 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. Valid during PUT.

See Also:

Map

getVirtualContainers

Set getVirtualContainers()

(DomainProxy collection) The set of virtual containers that directly (not recursively) contain this VM.

See Also:

DomainProxy

setDescription

void setDescription(String description)

A description of this VM.

setHost

void setHost(DomainProxy host)

The physical machine (hypervisor) on which this VM is running. Valid during PUT.

setHostnames

void setHostnames(Set hostnames)

(String collection) The set of host names (aliases) that refer to this VM.

See Also:

String

setId

void setId(String id)

The unique identifier of the virtual machine. Note: this field is not user-assigned and is generated by the database.

setIpAddress

void setIpAddress(String ipAddress)

This VM's IPv4 address.

setLastMigrationDate

void setLastMigrationDate(Date lastMigrationDate)

The date when this VM was last migrated.

setLastUpdatedDate

void setLastUpdatedDate(Date lastUpdatedDate)

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.

setMetrics

void setMetrics(Map metrics)

(Map of String => Double) 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:
  • Unix-based OS's using some aspect of the Unix load average, as reported by the resource manager layer
  • Windows-based OS's using CPU utilization

Valid during PUT.

See Also:

Double

setMigrationCount

void setMigrationCount(Integer migrationCount)

The number of times this VM has been migrated.

setMigrationDisabled

void setMigrationDisabled(Boolean migrationDisabled)

True if migration is disabled for this VM, false otherwise.

setName

void setName(String name)

The name of the virtual machine. This name is unique per instance of Moab Workload Manager (i.e. not globally).

setOperatingSystem

void setOperatingSystem(VMOperatingSystemInformation operatingSystem)

Describes the current or expected operating system image information for this VM. Valid during PUT.

setRequiredFeatures

void setRequiredFeatures(Set requiredFeatures)

(String collection) The set of features required by this VM.

See Also:

String

setResourceManagers

void setResourceManagers(Set resourceManagers)

(NodeResourceManager collection) The resource managers that are reporting or have previously reported this VM. Each object also contains information on the resource manager reports.

See Also:

NodeResourceManager

setResources

void setResources(Map resources)

(Map of String => Resource) 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.

See Also:

Resource

setStartDate

void setStartDate(Date startDate)

Date that this VM was started (ready and usable).

setStates

void setStates(NodeStateInformation states)

State information for this VM. Valid during PUT.

setTrackingJob

void setTrackingJob(DomainProxy trackingJob)

The tracking job for this VM.

setTriggers

void setTriggers(Set triggers)

(DomainProxy collection) The set of triggers associated with this VM. Valid during PUT.

See Also:

DomainProxy

setVariables

void setVariables(Map variables)

(Map of String => String) 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. Valid during PUT.

See Also:

Map

setVirtualContainers

void setVirtualContainers(Set virtualContainers)

(DomainProxy collection) The set of virtual containers that directly (not recursively) contain this VM.

See Also:

DomainProxy

toString

String toString()

Groovy Documentation