Software
SoftLayer_Software_Description

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_Component_Swsoft_Plesk object.

Local Properties

controlPanel

This is set to '1' if this Software Description describes a Control Panel.

Type:

integer

id

An ID number to identify this Software Description.

Type:

integer

licenseTermUnit

The unit of measurement (day, month, or year) for license registration. Used in conjunction with licenseTermValue to determine overall license registration length of a new license.

Type:

string

licenseTermValue

The number of units (licenseTermUnit) a new license is valid for at the time of registration.

Type:

integer

longDescription

The manufacturer, name and version of a piece of software.

Type:

string

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

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

operatingSystem

This is set to '1' if this Software Description describes an Operating System.

Type:

integer

referenceCode

A reference code is structured as three tokens separated by underscores. The first token represents the product, the second is the version of the product, and the third is whether the software is 32 or 64bit.

Type:

string

upgradeSoftwareDescriptionId

Contains the ID of the suggested upgrade from this Software_Description to a more powerful software installation.

Type:

integer

upgradeSwDescId

Contains the ID of the suggested upgrade from this Software_Description to a more powerful software installation. (Deprecated - Use upgradeSoftwareDescriptionId)

Type:

integer

version

The version of this specific piece of software.

Type:

string

virtualizationPlatform

This is set to '1' if this Software Description a platform for hosting virtual servers.

Type:

integer

virtualLicense

This is set to '1' if this Software Description can be licensed to a Virtual Machine (an IP address).

Type:

integer

Relational & Count Properties

Relational Properties can be queried by object mask
attributeCount

A count of

Type:

unsignedLong

averageInstallationDuration

The average amount of time that a software description takes to install.

Type:

integer

compatibleSoftwareDescriptionCount

A count of a list of the software descriptions that are compatible with this software description.

Type:

unsignedLong

compatibleSoftwareDescriptions

A list of the software descriptions that are compatible with this software description.

featureCount

A count of the feature attributes of a software description.

Type:

unsignedLong

features

The feature attributes of a software description.

latestVersion

The latest version of a software description.

latestVersionCount

A count of the latest version of a software description.

Type:

unsignedLong

productItemCount

A count of the various product items to which this software description is linked.

Type:

unsignedLong

productItems

The various product items to which this software description is linked.

provisionTransactionGroup

This details the provisioning transaction group for this software. This is only valid for Operating System software.

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.

requiredUser

The default user created for a given a software description.

Type:

string

softwareLicenseCount

A count of software Licenses that govern this Software Description.

Type:

unsignedLong

softwareLicenses

Software Licenses that govern this Software Description.

upgradeSoftwareDescription

A suggestion for an upgrade path from this Software Description

upgradeSwDesc

A suggestion for an upgrade path from this Software Description (Deprecated - Use upgradeSoftwareDescription)

validFilesystemTypeCount

A count of

Type:

unsignedLong