SoftLayer_Product_Package


SoftLayer_Product_Package

Description

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.

associatedMethods

Local


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


accountRestrictedActivePresets

The preset configurations available only for the authenticated account and this package.
Type: SoftLayer_Product_Package_Preset[]


accountRestrictedCategories

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


accountRestrictedPricesFlag

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


activePresets

The available preset configurations for this package.
Type: SoftLayer_Product_Package_Preset[]


activeRamItems

A collection of valid RAM items available for purchase in this package.
Type: SoftLayer_Product_Item[]


activeServerItems

A collection of valid server items available for purchase in this package.
Type: SoftLayer_Product_Item[]


activeSoftwareItems

A collection of valid software items available for purchase in this package.
Type: SoftLayer_Product_Item[]


activeUsagePrices

A collection of SoftLayer_Product_Item_Price objects for pay-as-you-go usage.
Type: SoftLayer_Product_Item_Price[]


additionalServiceFlag

This flag indicates that the package is an additional service.
Type: boolean


availableLocations

A collection of valid locations for this package. (Deprecated - Use SoftLayer_Product_Package::getRegions)
Type: SoftLayer_Product_Package_Locations[]


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.
Type: SoftLayer_Product_Item_Category[]


configuration

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


defaultBootCategoryCode

The default boot category code for the package.
Type: string


defaultRamItems

A collection of valid RAM items available for purchase in this package.
Type: SoftLayer_Product_Item[]


deploymentNodeType

The node type for a package in a solution deployment.
Type: string


deploymentPackages

The packages that are allowed in a multi-server solution. (Deprecated)
Type: SoftLayer_Product_Package[]


deploymentType

The solution deployment type.
Type: string


deployments

The package that represents a multi-server solution. (Deprecated)
Type: SoftLayer_Product_Package[]


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


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


hourlyOnlyOrders

Packages with this flag do not allow monthly orders.
Type: boolean


itemConflicts

The item-item conflicts associated with a package.
Type: SoftLayer_Product_Item_Resource_Conflict[]


itemLocationConflicts

The item-location conflicts associated with a package.
Type: SoftLayer_Product_Item_Resource_Conflict[]


itemPriceReferences

cross reference for item prices
Type: SoftLayer_Product_Package_Item_Prices[]


itemPrices

A collection of SoftLayer_Product_Item_Prices that are valid for this package.
Type: SoftLayer_Product_Item_Price[]


items

A collection of valid items available for purchase in this package.
Type: SoftLayer_Product_Item[]


locations

A collection of valid locations for this package. (Deprecated - Use SoftLayer_Product_Package::getRegions)
Type: SoftLayer_Location[]


lowestServerPrice

The lowest server SoftLayer_Product_Item_Price related to this package.
Type: SoftLayer_Product_Item_Price


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


noUpgradesFlag

Services ordered from this package cannot have upgrades or downgrades performed.
Type: boolean


nonEuCompliantFlag

Whether the package is not in compliance with EU support.
Type: boolean


orderPremiums

The premium price modifiers associated with the SoftLayer_Product_Item_Price and SoftLayer_Location objects in a package.
Type: SoftLayer_Product_Item_Price_Premium[]


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


regions

The regional locations that a package is available in.
Type: SoftLayer_Location_Region[]


resourceGroupTemplate

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


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

Count


accountRestrictedActivePresetCount

A count of the preset configurations available only for the authenticated account and this package.
Type: unsigned long


accountRestrictedCategoryCount

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


activePresetCount

A count of the available preset configurations for this package.
Type: unsigned long


activeRamItemCount

A count of a collection of valid RAM items available for purchase in this package.
Type: unsigned long


activeServerItemCount

A count of a collection of valid server items available for purchase in this package.
Type: unsigned long


activeSoftwareItemCount

A count of a collection of valid software items available for purchase in this package.
Type: unsigned long


activeUsagePriceCount

A count of a collection of SoftLayer_Product_Item_Price objects for pay-as-you-go usage.
Type: unsigned long


attributeCount

A count of
Type: unsigned long


availableLocationCount

A count of a collection of valid locations for this package. (Deprecated - Use SoftLayer_Product_Package::getRegions)
Type: unsigned long


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: unsigned long


defaultRamItemCount

A count of a collection of valid RAM items available for purchase in this package.
Type: unsigned long


deploymentCount

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


deploymentPackageCount

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


itemCount

A count of a collection of valid items available for purchase in this package.
Type: unsigned long


itemPriceCount

A count of a collection of SoftLayer_Product_Item_Prices that are valid for this package.
Type: unsigned long


itemPriceReferenceCount

A count of cross reference for item prices
Type: unsigned long


locationCount

A count of a collection of valid locations for this package. (Deprecated - Use SoftLayer_Product_Package::getRegions)
Type: unsigned long


orderPremiumCount

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


regionCount

A count of the regional locations that a package is available in.
Type: unsigned long



© SoftLayer 2020
Built with Hugo