Product
SoftLayer_Product_Package

Overview

The SoftLayer_Product_Package data type contains information about packages from which orders can be generated. Packages contain general information regarding what is in them, where they are currently sold, availability, and pricing.

Local Properties

description

A generic description of the processor type and count. This includes HTML, so you may want to strip these tags if you plan to use it.

Type:

string

firstOrderStepId

This is only needed for step-based order verification. We use this for the order forms, but it is not required. This step is the first SoftLayer_Product_Package_Step for this package. Use this for for filtering which item categories are returned as a part of SoftLayer_Product_Package_Order_Configuration.

Type:

integer

id

A package's internal identifier. Everything regarding a SoftLayer_Product_Package is tied back to this id.

Type:

integer

isActive
Type:

integer

keyName

A unique key name for the package.

Type:

string

name

The description of the package. For server packages, this is usually a detailed description of processor type and count.

Type:

string

subDescription

This currently contains no information but is here for future use.

Type:

string

unitSize

The server unit size this package will match to.

Type:

integer

Relational & Count Properties

Relational Properties can be queried by object mask
accountRestrictedActivePresetCount

A count of the preset configurations available only for the authenticated account and this package.

Type:

unsignedLong

accountRestrictedActivePresets

The preset configurations available only for the authenticated account and this package.

accountRestrictedCategories

The results from this call are similar to getCategories, but these ONLY include account-restricted prices. Not all accounts have restricted pricing.

accountRestrictedCategoryCount

A count of the results from this call are similar to getCategories, but these ONLY include account-restricted prices. Not all accounts have restricted pricing.

Type:

unsignedLong

accountRestrictedPricesFlag

The flag to indicate if there are any restricted prices in a package for the currently-active account.

Type:

boolean

activePresetCount

A count of the available preset configurations for this package.

Type:

unsignedLong

activePresets

The available preset configurations for this package.

activeRamItemCount

A count of a collection of valid RAM items available for purchase in this package.

Type:

unsignedLong

activeRamItems

A collection of valid RAM items available for purchase in this package.

activeServerItemCount

A count of a collection of valid server items available for purchase in this package.

Type:

unsignedLong

activeServerItems

A collection of valid server items available for purchase in this package.

activeSoftwareItemCount

A count of a collection of valid software items available for purchase in this package.

Type:

unsignedLong

activeSoftwareItems

A collection of valid software items available for purchase in this package.

activeUsagePriceCount

A count of a collection of SoftLayer_Product_Item_Price objects for pay-as-you-go usage.

Type:

unsignedLong

activeUsagePrices

A collection of SoftLayer_Product_Item_Price objects for pay-as-you-go usage.

additionalServiceFlag

This flag indicates that the package is an additional service.

Type:

boolean

attributeCount

A count of

Type:

unsignedLong

availableLocationCount

A count of a collection of valid locations for this package. (Deprecated - Use getRegions)

Type:

unsignedLong

availableLocations

A collection of valid locations for this package. (Deprecated - Use getRegions)

availableStorageUnits

The maximum number of available disk storage units associated with the servers in a package.

Type:

unsigned integer

categories

This is a collection of categories (SoftLayer_Product_Item_Category) associated with a package which can be used for ordering. These categories have several objects prepopulated which are useful when determining the available products for purchase. The categories contain groups (SoftLayer_Product_Package_Item_Category_Group) that organize the products and prices by similar features. For example, operating systems will be grouped by their manufacturer and virtual server disks will be grouped by their disk type (SAN vs. local). Each group will contain prices (SoftLayer_Product_Item_Price) which you can use determine the cost of each product. Each price has a product (SoftLayer_Product_Item) which provides the name and other useful information about the server, service or software you may purchase.

configuration

The item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order.

configurationCount

A count of the item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order.

Type:

unsignedLong

defaultRamItemCount

A count of a collection of valid RAM items available for purchase in this package.

Type:

unsignedLong

defaultRamItems

A collection of valid RAM items available for purchase in this package.

deploymentCount

A count of the package that represents a multi-server solution. (Deprecated)

Type:

unsignedLong

deploymentNodeType

The node type for a package in a solution deployment.

Type:

string

deploymentPackageCount

A count of the packages that are allowed in a multi-server solution. (Deprecated)

Type:

unsignedLong

deploymentPackages

The packages that are allowed in a multi-server solution. (Deprecated)

deployments

The package that represents a multi-server solution. (Deprecated)

deploymentType

The solution deployment type.

Type:

string

disallowCustomDiskPartitions

This flag indicates the package does not allow custom disk partitions.

Type:

boolean

firstOrderStep

The Softlayer order step is optionally step-based. This returns the first SoftLayer_Product_Package_Order_Step in the step-based order process.

gatewayApplianceFlag

Whether the package is a specialized network gateway appliance package.

Type:

boolean

gpuFlag

This flag indicates that the package supports GPUs.

Type:

boolean

hourlyBillingAvailableFlag

Determines whether the package contains prices that can be ordered hourly.

Type:

boolean

itemConflicts

The item-item conflicts associated with a package.

itemCount

A count of a collection of valid items available for purchase in this package.

Type:

unsignedLong

itemLocationConflicts

The item-location conflicts associated with a package.

itemPriceCount

A count of a collection of SoftLayer_Product_Item_Prices that are valid for this package.

Type:

unsignedLong

itemPriceReferenceCount

A count of cross reference for item prices

Type:

unsignedLong

itemPriceReferences

cross reference for item prices

itemPrices

A collection of SoftLayer_Product_Item_Prices that are valid for this package.

items

A collection of valid items available for purchase in this package.

locationCount

A count of a collection of valid locations for this package. (Deprecated - Use getRegions)

Type:

unsignedLong

locations

A collection of valid locations for this package. (Deprecated - Use getRegions)

lowestServerPrice

The lowest server SoftLayer_Product_Item_Price related to this package.

maximumPortSpeed

The maximum available network speed associated with the package.

Type:

unsigned integer

minimumPortSpeed

The minimum available network speed associated with the package.

Type:

unsigned integer

mongoDbEngineeredFlag

This flag indicates that this is a MongoDB engineered package. (Deprecated)

Type:

boolean

orderPremiumCount

A count of the premium price modifiers associated with the SoftLayer_Product_Item_Price and SoftLayer_Location objects in a package.

Type:

unsignedLong

orderPremiums

The premium price modifiers associated with the SoftLayer_Product_Item_Price and SoftLayer_Location objects in a package.

popLocationAvailabilityFlag

This flag indicates if the package may be available in PoP locations in addition to Datacenters.

Type:

boolean

preconfiguredFlag

This flag indicates the package is pre-configured. (Deprecated)

Type:

boolean

presetConfigurationRequiredFlag

Whether the package requires the user to define a preset configuration.

Type:

boolean

preventVlanSelectionFlag

Whether the package prevents the user from specifying a Vlan.

Type:

boolean

privateHostedCloudPackageFlag

This flag indicates the package is for a private hosted cloud deployment. (Deprecated)

Type:

boolean

privateHostedCloudPackageType

The server role of the private hosted cloud deployment. (Deprecated)

Type:

string

privateNetworkOnlyFlag

Whether the package only has access to the private network.

Type:

boolean

quantaStorPackageFlag

Whether the package is a specialized mass storage QuantaStor package. (Deprecated)

Type:

boolean

raidDiskRestrictionFlag

This flag indicates the package does not allow different disks with RAID.

Type:

boolean

redundantPowerFlag

This flag determines if the package contains a redundant power supply product.

Type:

boolean

regionCount

A count of the regional locations that a package is available in.

Type:

unsignedLong

regions

The regional locations that a package is available in.

resourceGroupTemplate

The resource group template that describes a multi-server solution. (Deprecated)

topLevelItemCategoryCode

The top level category code for this service offering.

Type:

string

type

The type of service offering. This property can be used to help filter packages.