Appliance

Description

An Appliance is the object holding the image template. It consists of five layers, namely:

  • Install Profile (mandatory) - specific information for the first time the image boots
  • OS Profile (mandatory) - 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
  • Projects (optional) - a list of Project software components chosen from the Organization's Project Catalog
  • My Software (optional) - a list of software components chosen from the User's protected "Software Library"
  • Configuration (optional) - configuration information including boot scripts and/or other software components to manage the image after provisioning

Specifications

Download XSD schema for Appliance.

Attributes Summary

TypeNameDescription
StringarchName

The arch name of the distribution the Appliance is based on.

URIbaseCloneUri

The URI to clone the Appliance.

URIbaseImagesStatusUri

The URI to get all the statuses of the Appliance images.

URIbaseImagesUri

The URI to get all the Image objects.

URIbaseLogsUri

The URI to get the Appliance Logs.

URIbaseMySoftwareUri

The URI to get all the MySoftware objects.

URIbaseOasPackageUri

The URI to get the deployment package Open Appliance Studio.Please refer to the OAS documentation.

URIbaseOsProfileUri

The URI to get the Appliance OSProfile.

URIbaseProjectsUri

The URI to get all the Project objects included in the Appliance.

URIbasePublishImagesStatusUri

The URI to get all the statuses of the Appliance published to various infrastructures (virtual, cloud...).

URIbasePublishImagesUri

The URI to get all PublishImage objects.

UriListbootScriptUris

The list of boot script URI included in the Appliance.

URIbootScriptsUri

The URI to get all the bootscript objects.

longcompleteInstalledSize

The Appliance size. Uncompressed size of the appliance is equal to the size of the uncompressed packages included in the OSProfile + size of the uncompressed dependencies + size of the included Project, MySoftware and Configuration compressed packages

longcompleteSize

The Appliance compressed image size. Compressed size of the appliance is equal to the size of the compressed packages included in the OSProfile + size of the compressed dependencies + size of the compressed Project, MySoftware and Configuration packages.You can check this metric with the field size. By comparing these, you will see the impact of the dependencies on the size.

UriListconfMgmtPlatformUris

The list of ConfMgmgPlatform URIs.

URIconfMgmtPlatformsUri

The URI to get all the ConfMgmtPlatform objects.

Datecreated

The date the Appliance object is created.

Stringdescription

The Appliance description.

Stringdigest

Object hash. Used for Client caching.

StringdistributionName

The name of the distribution the Appliance is based on.

URIdistributionUri

The URI of the distribution used in the Appliance.

UriListimageUris

The list of Appliance image URI.

URIinstallProfileUri

The URI to get the InstallProfile.

longinstalledSize

The Appliance uncompressed image size. Uncompressed size of the appliance is equal to the size of the uncompressed packages included in the OSProfile (Warning: without dependencies) + size of the uncompressed Project, MySoftware and Configuration packages.You can check this metric with the field completeInstalledSize. By comparing these, you will see the impact of the dependencies on the size.

URIlastLogUri

The URI of the latest log available for the Appliance.

DatelastModified

The date the object was last modified.

DatelastPkgUpdate

The Appliance time machine date. All the distribution packages included in the Appliance will have timestamps less or equal to this date.

Logologo

The logo of the Appliance.

UriListmySoftwareUris

The list of included MySoftware URI.

Stringname

The Appliance name. Please note that name and version should not exceed 48 characters.

intnbUpdates

The number of updates available for this appliance OSProfile (all updates are Distribution Pkg updates). This is based on the date of the Appliance update (time machine). 0 or -1 means there are no updates.

OASPkgoasPackage

The Open Appliance Studio package (used for deployments and last-mile appliance configuration) attached to the Appliance.

URIoasPackageUri

The URI to get the deployment package Open Appliance Studio.Please refer to the OAS documentation.

Orgorg

The Org this appliance belongs to.

URIorgUri

The Org URI the Appliance is based on.

DistribProfileosProfile

The Appliance OSProfile.

URIosProfileUri

The URI to get the Appliance OSProfile.

URIparentAppliance

The URI of the Appliance used to create this one.

UriListprojectUris

The list of Project URIs used.

UriListpublishImageUris

The list of PublishImage URIs.

intrevision

The appliance revision.

longsize

The Appliance size. Theoretical compressed size of the appliance is equal to the size of the compressed packages included in the OSProfile (Warning: without dependencies) + size of the included Project, MySoftware and Configuration compressed packages.You can check this metric with the field installedSize. By comparing these, you will see the impact of the dependencies on the size.

URIuri

The URI of the Appliance.

Stringversion

The Appliance version. Please note that name and version should not exceed 48 characters.