Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ace.mws.images
[Groovy] Class Image

java.lang.Object
  com.ace.mws.images.Image

class Image

An image is used to track the different types of operating systems and hypervisors available in a data center. If the image is a hypervisor, it can contain other images which are the available virtual machines of the hypervisor.

Field Summary
private Boolean active

If false, the image is flagged as inactive and should not be used.

private Map extensions

(Map of String => Map) A map containing maps which represent settings for provisioning managers.

private Set features

(String collection) The set of features used by the provisioning manager.
private Boolean hypervisor

Whether or not the image is a hypervisor.

private ImageHypervisorType hypervisorType

The type of the hypervisor, which is indicative of the hypervisor technology used in this image.

private String id

The unique ID of this image.
private String name

The unique human-readable name of this image.

private String osType

The type of the operating system such as 'Linux' or 'Windows'.

private Boolean supportsPhysicalMachine

Specifies whether the image can be used to provision a physical machine, defaults to false.

private Boolean supportsVirtualMachine

Specifies whether the image can be used to provision a virtual machine, defaults to false.

private String templateName

The VM template to use for this image.

private ImageType type

The type of the image.

private Set virtualizedImages

(Image collection) The set of images available on this hypervisor.
 
Constructor Summary
Image()

 
Method Summary
Boolean getActive()

If false, the image is flagged as inactive and should not be used.

Map getExtensions()

(Map of String => Map) A map containing maps which represent settings for provisioning managers.

Set getFeatures()

(String collection) The set of features used by the provisioning manager.
Boolean getHypervisor()

Whether or not the image is a hypervisor.

ImageHypervisorType getHypervisorType()

The type of the hypervisor, which is indicative of the hypervisor technology used in this image.

String getId()

The unique ID of this image.
String getName()

The unique human-readable name of this image.

String getOsType()

The type of the operating system such as 'Linux' or 'Windows'.

Boolean getSupportsPhysicalMachine()

Specifies whether the image can be used to provision a physical machine, defaults to false.

Boolean getSupportsVirtualMachine()

Specifies whether the image can be used to provision a virtual machine, defaults to false.

String getTemplateName()

The VM template to use for this image.

ImageType getType()

The type of the image.

Set getVirtualizedImages()

(Image collection) The set of images available on this hypervisor.
void setActive(Boolean active)

If false, the image is flagged as inactive and should not be used.

void setExtensions(Map extensions)

(Map of String => Map) A map containing maps which represent settings for provisioning managers.

void setFeatures(Set features)

(String collection) The set of features used by the provisioning manager.
void setHypervisor(Boolean hypervisor)

Whether or not the image is a hypervisor.

void setHypervisorType(ImageHypervisorType hypervisorType)

The type of the hypervisor, which is indicative of the hypervisor technology used in this image.

void setId(String id)

The unique ID of this image.
void setName(String name)

The unique human-readable name of this image.

void setOsType(String osType)

The type of the operating system such as 'Linux' or 'Windows'.

void setSupportsPhysicalMachine(Boolean supportsPhysicalMachine)

Specifies whether the image can be used to provision a physical machine, defaults to false.

void setSupportsVirtualMachine(Boolean supportsVirtualMachine)

Specifies whether the image can be used to provision a virtual machine, defaults to false.

void setTemplateName(String templateName)

The VM template to use for this image.

void setType(ImageType type)

The type of the image.

void setVirtualizedImages(Set virtualizedImages)

(Image collection) The set of images available on this hypervisor.
String toString()

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

Field Detail

active

private Boolean active
If false, the image is flagged as inactive and should not be used. Defaults to true.

extensions

private Map extensions
(Map of String => Map) A map containing maps which represent settings for provisioning managers. Only one extension may be present on an image at a time currently. Valid default provisioning manager specific extensions include 'xcat'.

Required properties for 'xcat' when hypervisor is false: Required properties for 'xcat' when hypervisor is true:
See Also:
Map

features

private Set features
(String collection) The set of features used by the provisioning manager.
See Also:
String

hypervisor

private Boolean hypervisor
Whether or not the image is a hypervisor. Required during POST.
Note that this is related to, but not the same as, supportsPhysicalMachine. Also, when this is false, no virtualizedImages may be specified for an image.

hypervisorType

private ImageHypervisorType hypervisorType
The type of the hypervisor, which is indicative of the hypervisor technology used in this image. Required if this image is a hypervisor image.

id

private String id
The unique ID of this image.

name

private String name
The unique human-readable name of this image. Required during POST.

osType

private String osType
The type of the operating system such as 'Linux' or 'Windows'. Required during POST.

supportsPhysicalMachine

private Boolean supportsPhysicalMachine
Specifies whether the image can be used to provision a physical machine, defaults to false. Either this or supportsVirtualMachine must be set to true.
Note that this is related to, but not the same as, hypervisor. Some images may not be hypervisors but can be provisioned on a physical machine.

supportsVirtualMachine

private Boolean supportsVirtualMachine
Specifies whether the image can be used to provision a virtual machine, defaults to false. Either this or supportsPhysicalMachine must be set to true.

templateName

private String templateName
The VM template to use for this image. Only valid if the type is set to a valid template type such as 'ImageType.LINKED_CLONE'.

type

private ImageType type
The type of the image. This property may affect the valid values to use for other fields. See ImageType for more information.
See Also:

virtualizedImages

private Set virtualizedImages
(Image collection) The set of images available on this hypervisor.
See Also:
Image

 
Constructor Detail

Image

Image()

 
Method Detail

getActive

Boolean getActive()
If false, the image is flagged as inactive and should not be used. Defaults to true.

getExtensions

Map getExtensions()
(Map of String => Map) A map containing maps which represent settings for provisioning managers. Only one extension may be present on an image at a time currently. Valid default provisioning manager specific extensions include 'xcat'.

Required properties for 'xcat' when hypervisor is false: Required properties for 'xcat' when hypervisor is true:
See Also:
Map

getFeatures

Set getFeatures()
(String collection) The set of features used by the provisioning manager.
See Also:
String

getHypervisor

Boolean getHypervisor()
Whether or not the image is a hypervisor. Required during POST.
Note that this is related to, but not the same as, supportsPhysicalMachine. Also, when this is false, no virtualizedImages may be specified for an image.

getHypervisorType

ImageHypervisorType getHypervisorType()
The type of the hypervisor, which is indicative of the hypervisor technology used in this image. Required if this image is a hypervisor image.

getId

String getId()
The unique ID of this image.

getName

String getName()
The unique human-readable name of this image. Required during POST.

getOsType

String getOsType()
The type of the operating system such as 'Linux' or 'Windows'. Required during POST.

getSupportsPhysicalMachine

Boolean getSupportsPhysicalMachine()
Specifies whether the image can be used to provision a physical machine, defaults to false. Either this or supportsVirtualMachine must be set to true.
Note that this is related to, but not the same as, hypervisor. Some images may not be hypervisors but can be provisioned on a physical machine.

getSupportsVirtualMachine

Boolean getSupportsVirtualMachine()
Specifies whether the image can be used to provision a virtual machine, defaults to false. Either this or supportsPhysicalMachine must be set to true.

getTemplateName

String getTemplateName()
The VM template to use for this image. Only valid if the type is set to a valid template type such as 'ImageType.LINKED_CLONE'.

getType

ImageType getType()
The type of the image. This property may affect the valid values to use for other fields. See ImageType for more information.
See Also:

getVirtualizedImages

Set getVirtualizedImages()
(Image collection) The set of images available on this hypervisor.
See Also:
Image

setActive

void setActive(Boolean active)
If false, the image is flagged as inactive and should not be used. Defaults to true.

setExtensions

void setExtensions(Map extensions)
(Map of String => Map) A map containing maps which represent settings for provisioning managers. Only one extension may be present on an image at a time currently. Valid default provisioning manager specific extensions include 'xcat'.

Required properties for 'xcat' when hypervisor is false: Required properties for 'xcat' when hypervisor is true:
See Also:
Map

setFeatures

void setFeatures(Set features)
(String collection) The set of features used by the provisioning manager.
See Also:
String

setHypervisor

void setHypervisor(Boolean hypervisor)
Whether or not the image is a hypervisor. Required during POST.
Note that this is related to, but not the same as, supportsPhysicalMachine. Also, when this is false, no virtualizedImages may be specified for an image.

setHypervisorType

void setHypervisorType(ImageHypervisorType hypervisorType)
The type of the hypervisor, which is indicative of the hypervisor technology used in this image. Required if this image is a hypervisor image.

setId

void setId(String id)
The unique ID of this image.

setName

void setName(String name)
The unique human-readable name of this image. Required during POST.

setOsType

void setOsType(String osType)
The type of the operating system such as 'Linux' or 'Windows'. Required during POST.

setSupportsPhysicalMachine

void setSupportsPhysicalMachine(Boolean supportsPhysicalMachine)
Specifies whether the image can be used to provision a physical machine, defaults to false. Either this or supportsVirtualMachine must be set to true.
Note that this is related to, but not the same as, hypervisor. Some images may not be hypervisors but can be provisioned on a physical machine.

setSupportsVirtualMachine

void setSupportsVirtualMachine(Boolean supportsVirtualMachine)
Specifies whether the image can be used to provision a virtual machine, defaults to false. Either this or supportsPhysicalMachine must be set to true.

setTemplateName

void setTemplateName(String templateName)
The VM template to use for this image. Only valid if the type is set to a valid template type such as 'ImageType.LINKED_CLONE'.

setType

void setType(ImageType type)
The type of the image. This property may affect the valid values to use for other fields. See ImageType for more information.
See Also:

setVirtualizedImages

void setVirtualizedImages(Set virtualizedImages)
(Image collection) The set of images available on this hypervisor.
See Also:
Image

toString

String toString()

 

Groovy Documentation