SoftLayer_Software_Description


SoftLayer_Software_Description

Description

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.

seeAlso

Local


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


virtualLicense

This is set to ‘1’ if this Software Description can be licensed to a Virtual Machine (an IP address).
Type: integer


virtualizationPlatform

This is set to ‘1’ if this Software Description a platform for hosting virtual servers.
Type: integer

Relational


averageInstallationDuration

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


compatibleSoftwareDescriptions

A list of the software descriptions that are compatible with this software description.
Type: SoftLayer_Software_Description[]


features

The feature attributes of a software description.
Type: SoftLayer_Software_Description_Feature[]


latestVersion

The latest version of a software description.
Type: SoftLayer_Software_Description[]


productItems

The various product items to which this software description is linked.
Type: SoftLayer_Product_Item[]


provisionTransactionGroup

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


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.
Type: SoftLayer_Provisioning_Version1_Transaction_Group


requiredUser

The default user created for a given a software description.
Type: string


softwareLicenses

Software Licenses that govern this Software Description.
Type: SoftLayer_Software_License[]


upgradeSoftwareDescription

A suggestion for an upgrade path from this Software Description
Type: SoftLayer_Software_Description


upgradeSwDesc

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

Count


attributeCount

A count of
Type: unsigned long


compatibleSoftwareDescriptionCount

A count of a list of the software descriptions that are compatible with this software description.
Type: unsigned long


featureCount

A count of the feature attributes of a software description.
Type: unsigned long


latestVersionCount

A count of the latest version of a software description.
Type: unsigned long


productItemCount

A count of the various product items to which this software description is linked.
Type: unsigned long


softwareLicenseCount

A count of software Licenses that govern this Software Description.
Type: unsigned long


validFilesystemTypeCount

A count of
Type: unsigned long



© SoftLayer 2020
Built with Hugo