Network
SoftLayer_Network_Bandwidth_Version1_Allotment

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 Bandwidth Pooling.

Local Properties

accountId

The user account identifier associated with this allotment.

Type:

integer

bandwidthAllotmentTypeId

An identifier marking this allotment as a virtual private rack (1) or a bandwidth pooling(2).

Type:

integer

createDate

Creation date for an allotment.

Type:

dateTime

endDate

End date for an allotment.

Type:

dateTime

id

A virtual rack's internal identifier.

Type:

integer

locationGroupId

Location Group Id for an allotment

Type:

integer

name

Text A virtual rack's name.

Type:

string

serviceProviderId

Service Provider Id for an allotment

Type:

integer

Relational & Count Properties

Relational Properties can be queried by object mask
account

The account associated with this virtual rack.

activeDetailCount

A count of the bandwidth allotment detail records associated with this virtual rack.

Type:

unsignedLong

activeDetails

The bandwidth allotment detail records associated with this virtual rack.

applicationDeliveryControllerCount

A count of the Application Delivery Controller contained within a virtual rack.

Type:

unsignedLong

applicationDeliveryControllers

The Application Delivery Controller contained within a virtual rack.

averageDailyPublicBandwidthUsage

The average daily public bandwidth usage for the current billing cycle.

Type:

float

bandwidthAllotmentType

The bandwidth allotment type of this virtual rack.

bareMetalInstanceCount

A count of the bare metal server instances contained within a virtual rack.

Type:

unsignedLong

bareMetalInstances

The bare metal server instances contained within a virtual rack.

billingCycleBandwidthUsage

A virtual rack's raw bandwidth usage data for an account's current billing cycle. One object is returned for each network this server is attached to.

billingCycleBandwidthUsageCount

A count of a virtual rack's raw bandwidth usage data for an account's current billing cycle. One object is returned for each network this server is attached to.

Type:

unsignedLong

billingCyclePrivateBandwidthUsage

A virtual rack's raw private network bandwidth usage data for an account's current billing cycle.

billingCyclePublicBandwidthUsage

A virtual rack's raw public network bandwidth usage data for an account's current billing cycle.

billingCyclePublicUsageTotal

The total public bandwidth used in this virtual rack for an account's current billing cycle.

Type:

unsigned integer

billingItem

A virtual rack's billing item.

currentBandwidthSummary

An object that provides commonly used bandwidth summary components for the current billing cycle.

detailCount

A count of the bandwidth allotment detail records associated with this virtual rack.

Type:

unsignedLong

details

The bandwidth allotment detail records associated with this virtual rack.

hardware

The hardware contained within a virtual rack.

hardwareCount

A count of the hardware contained within a virtual rack.

Type:

unsignedLong

inboundPublicBandwidthUsage

The total public inbound bandwidth used in this virtual rack for an account's current billing cycle.

Type:

decimal

locationGroup

The location group associated with this virtual rack.

managedBareMetalInstanceCount

A count of the managed bare metal server instances contained within a virtual rack.

Type:

unsignedLong

managedBareMetalInstances

The managed bare metal server instances contained within a virtual rack.

managedHardware

The managed hardware contained within a virtual rack.

managedHardwareCount

A count of the managed hardware contained within a virtual rack.

Type:

unsignedLong

managedVirtualGuestCount

A count of the managed Virtual Server contained within a virtual rack.

Type:

unsignedLong

managedVirtualGuests

The managed Virtual Server contained within a virtual rack.

metricTrackingObject

A virtual rack's metric tracking object. This object records all periodic polled data available to this rack.

metricTrackingObjectId

The metric tracking object id for this allotment.

Type:

integer

outboundPublicBandwidthUsage

The total public outbound bandwidth used in this virtual rack for an account's current billing cycle.

Type:

decimal

overBandwidthAllocationFlag

Whether the bandwidth usage for this bandwidth pool for the current billing cycle exceeds the allocation.

Type:

integer

privateNetworkOnlyHardware

The private network only hardware contained within a virtual rack.

privateNetworkOnlyHardwareCount

A count of the private network only hardware contained within a virtual rack.

Type:

unsignedLong

projectedOverBandwidthAllocationFlag

Whether the bandwidth usage for this bandwidth pool for the current billing cycle is projected to exceed the allocation.

Type:

integer

projectedPublicBandwidthUsage

The projected public outbound bandwidth for this virtual server for the current billing cycle.

Type:

float

serviceProvider
totalBandwidthAllocated

The combined allocated bandwidth for all servers in a virtual rack.

Type:

unsigned long

virtualGuestCount

A count of the Virtual Server contained within a virtual rack.

Type:

unsignedLong

virtualGuests

The Virtual Server contained within a virtual rack.