Moab Web Services > References > Resource Reference > Fields: Images

Fields: Images

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

Additional references

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

API version 3

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 Name	Type	POST	PUT	Description
id	String	No	No	The unique ID of this image.
active	Boolean	Yes	Yes	If false, the image is flagged as inactive and should not be used. Defaults to true.
extensions	Map<String, Map>	Yes	Yes	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: os - The name of the operating system according to xCAT architecture - The architecture, such as x86_64 profile - The xCAT profile to use for the image Required properties for 'xcat' when hypervisor is true: os - The name of the operating system according to xCAT architecture - The architecture, such as x86_64 profile - The xCAT profile to use for the image hvGroupName - The name of the xCAT hypervisor group vmGroupName - The name of the xCAT VM group
features	Set<String>	Yes	Yes	The set of features used by the provisioning manager.
hypervisor	Boolean	Yes	Yes	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	String	Yes	Yes	The type of the hypervisor, which is indicative of the hypervisor technology used in this image. Required if this image is a hypervisor image.
name	String	Yes	Yes	The unique human-readable name of this image. Required during POST.
osType	String	Yes	Yes	The type of the operating system such as 'Linux' or 'Windows'. Required during POST.
supportsPhysicalMachine	Boolean	Yes	Yes	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	Boolean	Yes	Yes	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	String	Yes	Yes	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	ImageType	Yes	Yes	The type of the image. This property may affect the valid values to use for other fields. See ImageType for more information. (See also: templateName.)
virtualizedImages	Set<Image>	Yes	Yes	The set of images available on this hypervisor.

ImageType

Represents an image type, such as stateful or stateless. This is used by provisioning managers and applications to correctly provision and represent the image.

Certain types are only valid for images configured as templates using the Image.templateName field. This currently includes ImageType.LINKED_CLONE and ImageType.FULL_CLONE.

Value	Description
STATEFUL
STATELESS
STATELITE
LINKED_CLONE	Template type. When this image type is used, the Image.hypervisor field must be set to false, Image.supportsVirtualMachine must be true, and Image.supportsPhysicalMachine must be false.
FULL_CLONE	Template type. When this image type is used, the Image.hypervisor field must be set to false, Image.supportsVirtualMachine must be true, and Image.supportsPhysicalMachine must be false.

API version 2

Image

Field Name	Type	POST	PUT	Description
id	String	No	No	The unique ID of this image.
active	Boolean	Yes	Yes	If false, the image is flagged as inactive and should not be used. Defaults to true.
extensions	Map<String, Map>	Yes	Yes	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: os - The name of the operating system according to xCAT architecture - The architecture, such as x86_64 profile - The xCAT profile to use for the image Required properties for 'xcat' when hypervisor is true: os - The name of the operating system according to xCAT architecture - The architecture, such as x86_64 profile - The xCAT profile to use for the image hvGroupName - The name of the xCAT hypervisor group vmGroupName - The name of the xCAT VM group
features	Set<String>	Yes	Yes	The set of features used by the provisioning manager.
hypervisor	Boolean	Yes	Yes	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	String	Yes	Yes	The type of the hypervisor, which is indicative of the hypervisor technology used in this image. Required if this image is a hypervisor image.
name	String	Yes	Yes	The unique human-readable name of this image. Required during POST.
osType	String	Yes	Yes	The type of the operating system such as 'Linux' or 'Windows'. Required during POST.
supportsPhysicalMachine	Boolean	Yes	Yes	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	Boolean	Yes	Yes	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	String	Yes	Yes	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	ImageType	Yes	Yes	The type of the image. This property may affect the valid values to use for other fields. See ImageType for more information. (See also: templateName.)
virtualizedImages	Set<Image>	Yes	Yes	The set of images available on this hypervisor.

ImageType

Value	Description
STATEFUL
STATELESS
STATELITE
LINKED_CLONE	Template type. When this image type is used, the Image.hypervisor field must be set to false, Image.supportsVirtualMachine must be true, and Image.supportsPhysicalMachine must be false.
FULL_CLONE	Template type. When this image type is used, the Image.hypervisor field must be set to false, Image.supportsVirtualMachine must be true, and Image.supportsPhysicalMachine must be false.