Groovy Documentation

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 an ID, will typically report an OS, and have a list of operating systems that it can run.


Field Summary
private Set aliases

(String collection) The list of aliases that refer to this VM.

private Integer availableDisk

The amount of disk space available on this VM.

private Integer availableMemory

The amount of memory available on this VM.

private Integer availableProcessors

The number of processors available on this VM.

private Double cpuLoad

The CPU load for this VM.

private String description

A description of this VM.

private Long effectiveTimeToLive

Time (in seconds) that this VM has to run (0 means not set).

private Set flags

(VMFlag collection) The flags associated with this VM.

private Set genericEvents

(GenericEvent collection) The list of generic events reported on this VM.

private Map genericMetrics

(Map of String => Double) The values for the generic metrics for this VM.

private String id

The unique ID of the VM.

private Date lastMigrationDate

The date when this VM was last migrated.

private String lastSubstate

Last reported substate (substate is not always reported).

private Date lastSubstateModificationDate

Date/time that lastSubstate was modified.

private Date lastUpdateDate

The date of when this VM was last updated.

private Integer migrationCount

The number of times this VM has been migrated.

private String networkAddress

The network address of this VM.

private Node node

The physical node on which this VM is running.

private String os

The current operating system of the VM.

private Set osList

(String collection) The list of operating systems that the VM can run.

private NodePower powerSelectState

The selected power state of this VM.

private NodePower powerState

The power state of this VM.

private Integer rack

The rack of the VM inside a given node.

private Long requestedTimeToLive

User-specified time (in seconds) that this VM has to run (0 means not set).

private Integer slot

The slot of the VM inside a given node.

private Boolean sovereign

This causes Moab to reserve the VM's memory and processors on the hypervisor, and treats the VM as the workload.

private Date startDate

Date/time that this VM was started (ready and usable)

private NodeState state

The state of the VM.

private String storage

Storage request (not OS disk storage).

private String substate

The substate that will give more information about the status of the VM.

private String template

Job template for the VM.

private Integer totalDisk

The amount of disk space configured in MB.

private Integer totalMemory

The amount of memory configured in MB.

private Integer totalProcessors

The number of virtual processors in the VM.

private Job trackingJob

The tracking job for this VM.

private Set triggers

(Trigger collection) The list of triggers on this VM.

private Map variables

(Map of String => String) Variables associated with this VM.

 
Constructor Summary
VirtualMachine()

 
Method Summary
Set getAliases()

(String collection) The list of aliases that refer to this VM.

Integer getAvailableDisk()

The amount of disk space available on this VM.

Integer getAvailableMemory()

The amount of memory available on this VM.

Integer getAvailableProcessors()

The number of processors available on this VM.

Double getCpuLoad()

The CPU load for this VM.

String getDescription()

A description of this VM.

Long getEffectiveTimeToLive()

Time (in seconds) that this VM has to run (0 means not set).

Set getFlags()

(VMFlag collection) The flags associated with this VM.

Set getGenericEvents()

(GenericEvent collection) The list of generic events reported on this VM.

Map getGenericMetrics()

(Map of String => Double) The values for the generic metrics for this VM.

String getId()

The unique ID of the VM.

Date getLastMigrationDate()

The date when this VM was last migrated.

String getLastSubstate()

Last reported substate (substate is not always reported).

Date getLastSubstateModificationDate()

Date/time that lastSubstate was modified.

Date getLastUpdateDate()

The date of when this VM was last updated.

Integer getMigrationCount()

The number of times this VM has been migrated.

String getNetworkAddress()

The network address of this VM.

Node getNode()

The physical node on which this VM is running.

String getOs()

The current operating system of the VM.

Set getOsList()

(String collection) The list of operating systems that the VM can run.

NodePower getPowerSelectState()

The selected power state of this VM.

NodePower getPowerState()

The power state of this VM.

Integer getRack()

The rack of the VM inside a given node.

Long getRequestedTimeToLive()

User-specified time (in seconds) that this VM has to run (0 means not set).

Integer getSlot()

The slot of the VM inside a given node.

Boolean getSovereign()

This causes Moab to reserve the VM's memory and processors on the hypervisor, and treats the VM as the workload.

Date getStartDate()

Date/time that this VM was started (ready and usable)

NodeState getState()

The state of the VM.

String getStorage()

Storage request (not OS disk storage).

String getSubstate()

The substate that will give more information about the status of the VM.

String getTemplate()

Job template for the VM.

Integer getTotalDisk()

The amount of disk space configured in MB.

Integer getTotalMemory()

The amount of memory configured in MB.

Integer getTotalProcessors()

The number of virtual processors in the VM.

Job getTrackingJob()

The tracking job for this VM.

Set getTriggers()

(Trigger collection) The list of triggers on this VM.

Map getVariables()

(Map of String => String) Variables associated with this VM.

void setAliases(Set aliases)

(String collection) The list of aliases that refer to this VM.

void setAvailableDisk(Integer availableDisk)

The amount of disk space available on this VM.

void setAvailableMemory(Integer availableMemory)

The amount of memory available on this VM.

void setAvailableProcessors(Integer availableProcessors)

The number of processors available on this VM.

void setCpuLoad(Double cpuLoad)

The CPU load for this VM.

void setDescription(String description)

A description of this VM.

void setEffectiveTimeToLive(Long effectiveTimeToLive)

Time (in seconds) that this VM has to run (0 means not set).

void setFlags(Set flags)

(VMFlag collection) The flags associated with this VM.

void setGenericEvents(Set genericEvents)

(GenericEvent collection) The list of generic events reported on this VM.

void setGenericMetrics(Map genericMetrics)

(Map of String => Double) The values for the generic metrics for this VM.

void setId(String id)

The unique ID of the VM.

void setLastMigrationDate(Date lastMigrationDate)

The date when this VM was last migrated.

void setLastSubstate(String lastSubstate)

Last reported substate (substate is not always reported).

void setLastSubstateModificationDate(Date lastSubstateModificationDate)

Date/time that lastSubstate was modified.

void setLastUpdateDate(Date lastUpdateDate)

The date of when this VM was last updated.

void setMigrationCount(Integer migrationCount)

The number of times this VM has been migrated.

void setNetworkAddress(String networkAddress)

The network address of this VM.

void setNode(Node node)

The physical node on which this VM is running.

void setOs(String os)

The current operating system of the VM.

void setOsList(Set osList)

(String collection) The list of operating systems that the VM can run.

void setPowerSelectState(NodePower powerSelectState)

The selected power state of this VM.

void setPowerState(NodePower powerState)

The power state of this VM.

void setRack(Integer rack)

The rack of the VM inside a given node.

void setRequestedTimeToLive(Long requestedTimeToLive)

User-specified time (in seconds) that this VM has to run (0 means not set).

void setSlot(Integer slot)

The slot of the VM inside a given node.

void setSovereign(Boolean sovereign)

This causes Moab to reserve the VM's memory and processors on the hypervisor, and treats the VM as the workload.

void setStartDate(Date startDate)

Date/time that this VM was started (ready and usable)

void setState(NodeState state)

The state of the VM.

void setStorage(String storage)

Storage request (not OS disk storage).

void setSubstate(String substate)

The substate that will give more information about the status of the VM.

void setTemplate(String template)

Job template for the VM.

void setTotalDisk(Integer totalDisk)

The amount of disk space configured in MB.

void setTotalMemory(Integer totalMemory)

The amount of memory configured in MB.

void setTotalProcessors(Integer totalProcessors)

The number of virtual processors in the VM.

void setTrackingJob(Job trackingJob)

The tracking job for this VM.

void setTriggers(Set triggers)

(Trigger collection) The list of triggers on this VM.

void setVariables(Map variables)

(Map of String => String) Variables associated with this VM.

String toString()

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Field Detail

aliases

private Set aliases
(String collection) The list of aliases that refer to this VM.
See Also:
String


availableDisk

private Integer availableDisk
The amount of disk space available on this VM.


availableMemory

private Integer availableMemory
The amount of memory available on this VM.


availableProcessors

private Integer availableProcessors
The number of processors available on this VM.


cpuLoad

private Double cpuLoad
The CPU load for this VM.


description

private String description
A description of this VM.


effectiveTimeToLive

private Long effectiveTimeToLive
Time (in seconds) that this VM has to run (0 means not set).


flags

private Set flags
(VMFlag collection) The flags associated with this VM.
See Also:
VMFlag


genericEvents

private Set genericEvents
(GenericEvent collection) The list of generic events reported on this VM. Valid during PUT.
See Also:
GenericEvent


genericMetrics

private Map genericMetrics
(Map of String => Double) The values for the generic metrics for this VM. Valid during PUT.
See Also:
Double


id

private String id
The unique ID of the VM. Valid during POST.


lastMigrationDate

private Date lastMigrationDate
The date when this VM was last migrated.


lastSubstate

private String lastSubstate
Last reported substate (substate is not always reported).


lastSubstateModificationDate

private Date lastSubstateModificationDate
Date/time that lastSubstate was modified.


lastUpdateDate

private Date lastUpdateDate
The date of when this VM was last updated.


migrationCount

private Integer migrationCount
The number of times this VM has been migrated.


networkAddress

private String networkAddress
The network address of this VM.


node

private Node node
The physical node on which this VM is running. Valid during PUT. Valid during POST.


os

private String os
The current operating system of the VM. Valid during PUT. Valid during POST.


osList

private Set osList
(String collection) The list of operating systems that the VM can run.
See Also:
String


powerSelectState

private NodePower powerSelectState
The selected power state of this VM.


powerState

private NodePower powerState
The power state of this VM. Valid during PUT.


rack

private Integer rack
The rack of the VM inside a given node.


requestedTimeToLive

private Long requestedTimeToLive
User-specified time (in seconds) that this VM has to run (0 means not set). Valid during POST.


slot

private Integer slot
The slot of the VM inside a given node.


sovereign

private Boolean sovereign
This causes Moab to reserve the VM's memory and processors on the hypervisor, and treats the VM as the workload. Additional workload cannot be scheduled on the VM. Valid during POST. Not defined during GET.


startDate

private Date startDate
Date/time that this VM was started (ready and usable)


state

private NodeState state
The state of the VM. Valid during PUT.


storage

private String storage
Storage request (not OS disk storage). Valid during POST. Not defined during GET. Storage is a percent sign-delimited list of storage requests with the following form: <type>:<size>@'<mountPoint>'.

You can define advanced storage options with the following syntax: <type>:<size>@'<mountPoint>'#'<mountOptions>^<mountOwner>%... where mountOptions and mountOwner are Linux mount parameters which are passed directly and are not processed or parsed by Moab.

Multiple storage requests are allowed and are delimited by the percent symbol (%).


substate

private String substate
The substate that will give more information about the status of the VM.


template

private String template
Job template for the VM. The VM create job inherits the template. Valid during POST. Not defined during GET.


totalDisk

private Integer totalDisk
The amount of disk space configured in MB. Valid during POST.


totalMemory

private Integer totalMemory
The amount of memory configured in MB. Valid during POST.


totalProcessors

private Integer totalProcessors
The number of virtual processors in the VM. Valid during POST.


trackingJob

private Job trackingJob
The tracking job for this VM.


triggers

private Set triggers
(Trigger collection) The list of triggers on this VM. Valid during PUT. Valid during POST.
See Also:
Trigger


variables

private Map variables
(Map of String => String) Variables associated with this VM. Valid during PUT. Valid during POST.
See Also:
Map


 
Constructor Detail

VirtualMachine

VirtualMachine()


 
Method Detail

getAliases

Set getAliases()
(String collection) The list of aliases that refer to this VM.
See Also:
String


getAvailableDisk

Integer getAvailableDisk()
The amount of disk space available on this VM.


getAvailableMemory

Integer getAvailableMemory()
The amount of memory available on this VM.


getAvailableProcessors

Integer getAvailableProcessors()
The number of processors available on this VM.


getCpuLoad

Double getCpuLoad()
The CPU load for this VM.


getDescription

String getDescription()
A description of this VM.


getEffectiveTimeToLive

Long getEffectiveTimeToLive()
Time (in seconds) that this VM has to run (0 means not set).


getFlags

Set getFlags()
(VMFlag collection) The flags associated with this VM.
See Also:
VMFlag


getGenericEvents

Set getGenericEvents()
(GenericEvent collection) The list of generic events reported on this VM. Valid during PUT.
See Also:
GenericEvent


getGenericMetrics

Map getGenericMetrics()
(Map of String => Double) The values for the generic metrics for this VM. Valid during PUT.
See Also:
Double


getId

String getId()
The unique ID of the VM. Valid during POST.


getLastMigrationDate

Date getLastMigrationDate()
The date when this VM was last migrated.


getLastSubstate

String getLastSubstate()
Last reported substate (substate is not always reported).


getLastSubstateModificationDate

Date getLastSubstateModificationDate()
Date/time that lastSubstate was modified.


getLastUpdateDate

Date getLastUpdateDate()
The date of when this VM was last updated.


getMigrationCount

Integer getMigrationCount()
The number of times this VM has been migrated.


getNetworkAddress

String getNetworkAddress()
The network address of this VM.


getNode

Node getNode()
The physical node on which this VM is running. Valid during PUT. Valid during POST.


getOs

String getOs()
The current operating system of the VM. Valid during PUT. Valid during POST.


getOsList

Set getOsList()
(String collection) The list of operating systems that the VM can run.
See Also:
String


getPowerSelectState

NodePower getPowerSelectState()
The selected power state of this VM.


getPowerState

NodePower getPowerState()
The power state of this VM. Valid during PUT.


getRack

Integer getRack()
The rack of the VM inside a given node.


getRequestedTimeToLive

Long getRequestedTimeToLive()
User-specified time (in seconds) that this VM has to run (0 means not set). Valid during POST.


getSlot

Integer getSlot()
The slot of the VM inside a given node.


getSovereign

Boolean getSovereign()
This causes Moab to reserve the VM's memory and processors on the hypervisor, and treats the VM as the workload. Additional workload cannot be scheduled on the VM. Valid during POST. Not defined during GET.


getStartDate

Date getStartDate()
Date/time that this VM was started (ready and usable)


getState

NodeState getState()
The state of the VM. Valid during PUT.


getStorage

String getStorage()
Storage request (not OS disk storage). Valid during POST. Not defined during GET. Storage is a percent sign-delimited list of storage requests with the following form: <type>:<size>@'<mountPoint>'.

You can define advanced storage options with the following syntax: <type>:<size>@'<mountPoint>'#'<mountOptions>^<mountOwner>%... where mountOptions and mountOwner are Linux mount parameters which are passed directly and are not processed or parsed by Moab.

Multiple storage requests are allowed and are delimited by the percent symbol (%).


getSubstate

String getSubstate()
The substate that will give more information about the status of the VM.


getTemplate

String getTemplate()
Job template for the VM. The VM create job inherits the template. Valid during POST. Not defined during GET.


getTotalDisk

Integer getTotalDisk()
The amount of disk space configured in MB. Valid during POST.


getTotalMemory

Integer getTotalMemory()
The amount of memory configured in MB. Valid during POST.


getTotalProcessors

Integer getTotalProcessors()
The number of virtual processors in the VM. Valid during POST.


getTrackingJob

Job getTrackingJob()
The tracking job for this VM.


getTriggers

Set getTriggers()
(Trigger collection) The list of triggers on this VM. Valid during PUT. Valid during POST.
See Also:
Trigger


getVariables

Map getVariables()
(Map of String => String) Variables associated with this VM. Valid during PUT. Valid during POST.
See Also:
Map


setAliases

void setAliases(Set aliases)
(String collection) The list of aliases that refer to this VM.
See Also:
String


setAvailableDisk

void setAvailableDisk(Integer availableDisk)
The amount of disk space available on this VM.


setAvailableMemory

void setAvailableMemory(Integer availableMemory)
The amount of memory available on this VM.


setAvailableProcessors

void setAvailableProcessors(Integer availableProcessors)
The number of processors available on this VM.


setCpuLoad

void setCpuLoad(Double cpuLoad)
The CPU load for this VM.


setDescription

void setDescription(String description)
A description of this VM.


setEffectiveTimeToLive

void setEffectiveTimeToLive(Long effectiveTimeToLive)
Time (in seconds) that this VM has to run (0 means not set).


setFlags

void setFlags(Set flags)
(VMFlag collection) The flags associated with this VM.
See Also:
VMFlag


setGenericEvents

void setGenericEvents(Set genericEvents)
(GenericEvent collection) The list of generic events reported on this VM. Valid during PUT.
See Also:
GenericEvent


setGenericMetrics

void setGenericMetrics(Map genericMetrics)
(Map of String => Double) The values for the generic metrics for this VM. Valid during PUT.
See Also:
Double


setId

void setId(String id)
The unique ID of the VM. Valid during POST.


setLastMigrationDate

void setLastMigrationDate(Date lastMigrationDate)
The date when this VM was last migrated.


setLastSubstate

void setLastSubstate(String lastSubstate)
Last reported substate (substate is not always reported).


setLastSubstateModificationDate

void setLastSubstateModificationDate(Date lastSubstateModificationDate)
Date/time that lastSubstate was modified.


setLastUpdateDate

void setLastUpdateDate(Date lastUpdateDate)
The date of when this VM was last updated.


setMigrationCount

void setMigrationCount(Integer migrationCount)
The number of times this VM has been migrated.


setNetworkAddress

void setNetworkAddress(String networkAddress)
The network address of this VM.


setNode

void setNode(Node node)
The physical node on which this VM is running. Valid during PUT. Valid during POST.


setOs

void setOs(String os)
The current operating system of the VM. Valid during PUT. Valid during POST.


setOsList

void setOsList(Set osList)
(String collection) The list of operating systems that the VM can run.
See Also:
String


setPowerSelectState

void setPowerSelectState(NodePower powerSelectState)
The selected power state of this VM.


setPowerState

void setPowerState(NodePower powerState)
The power state of this VM. Valid during PUT.


setRack

void setRack(Integer rack)
The rack of the VM inside a given node.


setRequestedTimeToLive

void setRequestedTimeToLive(Long requestedTimeToLive)
User-specified time (in seconds) that this VM has to run (0 means not set). Valid during POST.


setSlot

void setSlot(Integer slot)
The slot of the VM inside a given node.


setSovereign

void setSovereign(Boolean sovereign)
This causes Moab to reserve the VM's memory and processors on the hypervisor, and treats the VM as the workload. Additional workload cannot be scheduled on the VM. Valid during POST. Not defined during GET.


setStartDate

void setStartDate(Date startDate)
Date/time that this VM was started (ready and usable)


setState

void setState(NodeState state)
The state of the VM. Valid during PUT.


setStorage

void setStorage(String storage)
Storage request (not OS disk storage). Valid during POST. Not defined during GET. Storage is a percent sign-delimited list of storage requests with the following form: <type>:<size>@'<mountPoint>'.

You can define advanced storage options with the following syntax: <type>:<size>@'<mountPoint>'#'<mountOptions>^<mountOwner>%... where mountOptions and mountOwner are Linux mount parameters which are passed directly and are not processed or parsed by Moab.

Multiple storage requests are allowed and are delimited by the percent symbol (%).


setSubstate

void setSubstate(String substate)
The substate that will give more information about the status of the VM.


setTemplate

void setTemplate(String template)
Job template for the VM. The VM create job inherits the template. Valid during POST. Not defined during GET.


setTotalDisk

void setTotalDisk(Integer totalDisk)
The amount of disk space configured in MB. Valid during POST.


setTotalMemory

void setTotalMemory(Integer totalMemory)
The amount of memory configured in MB. Valid during POST.


setTotalProcessors

void setTotalProcessors(Integer totalProcessors)
The number of virtual processors in the VM. Valid during POST.


setTrackingJob

void setTrackingJob(Job trackingJob)
The tracking job for this VM.


setTriggers

void setTriggers(Set triggers)
(Trigger collection) The list of triggers on this VM. Valid during PUT. Valid during POST.
See Also:
Trigger


setVariables

void setVariables(Map variables)
(Map of String => String) Variables associated with this VM. Valid during PUT. Valid during POST.
See Also:
Map


toString

String toString()


 

Groovy Documentation