appliance¶
Holds all the meta-data information of a software stack (known as an appliance template). It consists of five layers, namely:
- an Install Profile - specific information for the first time the image boots
- an OS Profile - a list of operating system packages. Each operating system within the organization provides one or more standard OS profiles to choose from when creating the OS Profile of the appliance template. It is also possible to create custom OS profiles
- Projects - a list of Project software components chosen from the Organization´s Project Catalog
- My Software - a list of software components chosen from the User´s private “Software Library”
- Configuration - configuration information including boot scripts and/or other software components to manage the image after provisioning
Appliance templates are then used to generate machine images
.
Attributes¶
The list of attributes for appliance
are:
applianceExports
: a list of applianceExport objects holding meta-data information for each time the appliance has been exported.archName
(string): the operating system architecture this appliance is based onbaseCloneUri
(anyURI): uri resource used to clone this appliancebaseImagesStatusUri
(anyURI): uri resource to retrieve machine images statusbaseImagesUri
(anyURI): uri resource to retrieve machine images generated from this appliancebaseMySoftwareUri
(anyURI): uri resource to retrieve the software components added to this appliancebaseOasPackageUri
(anyURI): uri resource to retrieve anyUForge Studio
package added to this appliancebaseOsProfileUri
(anyURI): uri resource to retrieve theOS Profile
for this appliancebaseProjectsUri
(anyURI): uri resource to retrieve any projects added to this appliancebasePublishImagesStatusUri
(anyURI): uri resource to retrieve published machine image statusbasePublishImagesUri
(anyURI): uri resource to retrieve published machine images from this appliancebaseTemplatesStatusUri
(anyURI): uri resource to retrieve the status for each time this appliance has been shared (to workspaces)baseTemplatesUri
(anyURI): uri resource to retrieve all the shared templates (to workspaces)bootScripts
: a list of bootScript objects added to this appliancebootScriptsUri
(anyURI): uri resource to get the boot scripts added to this appliancebootScriptUris
(UriList): a list of uris for the boots scripts added to this appliancedescription
(string): a description of the appliancedistributionName
(string): the operating system this appliance is based on (includes name and version)distributionUri
(anyURI): uri resource to get the details of the operating system this appliance is based onexportsUri
(anyURI): uri resource to get all the export objects for this applianceimageUris
(UriList): a list of uris for the machine images generated from this applianceimported
(boolean): boolean to determine if this appliance is an import (e.g. from ascan
)installedSize
(long): estimated disk size required to install the appliance’s softwareinstallProfile
(installProfile): the installProfile object for this applianceinstallProfileUri
(anyURI): uri resource to get theinstall profile
of the appliancelastPkgUpdate
(dateTime): theos profile
packages update date (this date is used to calculate if any new package updates are availablelogo
(logo): the logo object for the appliancemySoftwareList
: a list of mySoftware objects describing the software components added to this appliancemySoftwareUris
(UriList): a list of uris for the software components added to this appliancename
(string): the name of this appliancenbSecurityUpdates
(int): the number of security operating system packages available for updatenbUpdates
(int): the number of native package updates available for updateorgUri
(anyURI): the uri resource of the organization this appliance belongs toosProfile
(distribProfile): the distribProfile object describing the operating system profile of this applianceosProfileUri
(anyURI): the uri resource for the operating system profile of this applianceparentApplianceUri
(anyURI): the uri resource of the parent appliance. This is set if this appliance is a clone of another applianceparentTemplateUri
(anyURI): the uri resource of an parent appliance template. This is set of this appliance is a result of importing an appliance (e.g. from a workspace)projects
: a list of project objects added to this applianceprojectUris
(UriList): a list of uris for the projects added to this appliancepublishImages
: a list of publishImage objects for the machine images that have been registered to one or more cloud platformspublishImageUris
(UriList): a list of uris for the machine images that have been registered to one or more cloud platformsrevision
(int): the revision number of this applianceshared
(boolean): a boolean highlighting this appliance has been shared to at least one workspacesize
(long): the size (in bytes) of all the packages and software added to this appliancetag
(string): a tag for this applianceuri
(anyURI): the uri resource of this applianceversion
(string): the version of this appliancecreated
(dateTime): the created date of the objectdbId
(long): the database id of the objectdigest
(string): the digest value (used for etag)lastModified
(dateTime): the last modified date of this object