SoftLayer Network Bandwidth Version1 Allotment (type)

From SoftLayer Development Network Wiki

This page refers to the SoftLayer_Network_Bandwidth_Version1_Allotment data type. For information on the SoftLayer_Network_Bandwidth_Version1_Allotment service please see SoftLayer_Network_Bandwidth_Version1_Allotment.

Contents 1 Overview 2 Local Properties 2.1 accountId 2.2 bandwidthAllotmentTypeId 2.3 id 2.4 name 3 Relational Properties 3.1 account 3.2 details 3.3 hardware 3.4 nextBillingHardware 4 Count Properties 4.1 detailCount 4.2 hardwareCount 4.3 nextBillingHardwareCount 5 Associated Methods

Overview

The SoftLayer_Network_Bandwidth_Version1_Allotment class provides methods and data structures necessary to work with an array of hardware objects associated with a single Virtual Dedicated Rack (VDR).

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

accountId

User account Id associated with this allotment.

• Type: integer
• Length: 10 digits

---

bandwidthAllotmentTypeId

Identifier marking this allotment as public or private.

• Type: integer
• Length: 10 digits

---

id

Internal identifier for the allotment.

• Type: integer

---

name

Text name assigned to this VDR.

• Type: string
• Length: 200 characters

Relational Properties

account

Account associated with this VDR.
account can be queried by object mask.
account must be a unique value.

• Type: SoftLayer_Account

---

details

The bandwidth allotment detail records associated with this VDR.
details can be queried by object mask.

• Type: SoftLayer_Network_Bandwidth_Version1_Allotment_DetailArray

---

hardware

Array of servers for this VDR.
hardware can be queried by object mask.

• Type: SoftLayer_HardwareArray

---

nextBillingHardware

Array of servers for this VDR.
nextBillingHardware can be queried by object mask.

• Type: SoftLayer_HardwareArray

Count Properties

detailCount

A count of the bandwidth allotment detail records associated with this VDR.
detailCount must be a unique value.

• Type: unsigned long

---

hardwareCount

A count of array of servers for this VDR.
hardwareCount must be a unique value.

• Type: unsigned long

---

nextBillingHardwareCount

A count of array of servers for this VDR.
nextBillingHardwareCount must be a unique value.

• Type: unsigned long

Associated Methods

• bool::createObject
• bool::deleteObject
• [[SoftLayer_Container_Network_Bandwidth_Version1_Usage[]::getBackendBandwidthByHour]]
• [[SoftLayer_Network_Bandwidth_Version1_Usage_Detail[]::getBackendBandwidthUse]]
• SoftLayer_Container_Bandwidth_GraphOutputs::getBandwidthImage
• [[SoftLayer_Container_Network_Bandwidth_Version1_Usage[]::getFrontendBandwidthByHour]]
• [[SoftLayer_Network_Bandwidth_Version1_Usage_Detail[]::getFrontendBandwidthUse]]
• bool::reassignServers
• bool::unassignServers