SoftLayer Software Description
From SoftLayer Development Network Wiki
Contents |
Overview
This class holds a description for a specific installation of a Software Component.
SoftLayer_Software_Licenses tie a Software Component (A specific installation on a piece of hardware) to it's description.
The "Manufacturer" and "Name" properties of a SoftLayer_Software_Description are used by the framework to factory specific objects, objects that may have special methods for that specific piece of software, or objects that contain application specific data, such as default ports. For example, if you create a SoftLayer_Software_Component who's SoftLayer_Software_License points to the SoftLayer_Software_Description for "Swsoft" "Plesk", you'll actually get a SoftLayer_Software_Compoenent_Swsoft_Plesk object.
| Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties. |
Local Properties
controlPanel
This is set to '1' if this Software Description describes a Control Panel.
- Type: integer
- Length: 1 digit
id
An ID number to identify this Software Description.
- Type: integer
manufacturer
The name of the manufacturer for this specific piece of software. This name is used by SoftLayer_Software_Component to tailor make (factory) specific types of Software Components that know details like default ports.
- Type: string
- Length: 100 characters
name
The name of this specific piece of software. This name is used by SoftLayer_Software_Component to tailor make (factory) specific types of Software Components that know details like default ports.
- Type: string
- Length: 100 characters
operatingSystem
This is set to '1' if this Software Description describes an Operating System.
- Type: integer
- Length: 1 digit
requiredUser
If this software has a required user (such as "root") this string contains it's name.
- Type: string
- Length: 50 characters
upgradeSwDescId
Contains the ID of the suggested upgrade from this Software_Description to a more powerful software installation.
- Type: integer
- Length: 10 digits
version
The version of this specific piece of software.
- Type: string
- Length: 100 characters
virtualLicense
This is set to '1' if this Software Description can be licensed to a Virtual Machine (an IP address).
- Type: integer
- Length: 1 digit
virtualizationPlatform
This is set to '1' if this Software Description a platform for hosting virtual servers.
- Type: integer
- Length: 1 digit
Relational Properties
averageInstallationDuration
The average amount of time that a software description takes to install.
averageInstallationDuration can be queried by object mask.
averageInstallationDuration must be a unique value.
- Type: integer
features
The feature attributes of a software description.
features can be queried by object mask.
latestVersion
The latest version of a software description.
latestVersion can be queried by object mask.
- Type: SoftLayer_Software_DescriptionArray
provisionTransactionGroup
This details the provisioning transaction group for this software. This is only valid for Operating System software.
provisionTransactionGroup can be queried by object mask.
provisionTransactionGroup must be a unique value.
reloadTransactionGroup
The transaction group that a software description belongs to. A transaction group is a sequence of transactions that must be performed in a specific order for the installation of software.
reloadTransactionGroup can be queried by object mask.
reloadTransactionGroup must be a unique value.
softwareLicenses
Software Licenses that govern this Software Description.
softwareLicenses can be queried by object mask.
upgradeSwDesc
A suggestion for an upgrade path from this Software Description
upgradeSwDesc can be queried by object mask.
upgradeSwDesc must be a unique value.
- Type: SoftLayer_Software_Description
Count Properties
featureCount
A count of the feature attributes of a software description.
featureCount must be a unique value.
- Type: unsigned long
latestVersionCount
A count of the latest version of a software description.
latestVersionCount must be a unique value.
- Type: unsigned long
softwareLicenseCount
A count of software Licenses that govern this Software Description.
softwareLicenseCount must be a unique value.
- Type: unsigned long
