SoftLayer_Network_Bandwidth_Version1_Allotment


SoftLayer_Network_Bandwidth_Version1_Allotment

Description

Every SoftLayer Bandwidth Pooling, Virtual Datacenter, Virtual Private Rack(VPR) is defined in the SoftLayer_Network_Bandwidth_Version1_Allotment service as an allotment. SoftLayer allotments are a collection of servers that share all of the servers allocated bandwidth together.

Virtual Private Rack Each server is by default a part of your Virtual Private Rack. Bandwidth overages are billed individually per server for all hardware in your Virtual Private Rack. If any one server uses more bandwidth than it is allocated, an overage charge will result.

Bandwidth Pooling Bandwidth Pooling allow you to optimize your bandwidth usage by “pooling” all of the bandwidth together for servers in a Bandwidth Pooling. Bandwidth overages for servers in a Bandwidth Pooling are summed up as a whole and overages are calculated only if the total bandwidth of all servers exceeds the total allocated bandwidth for all servers.

For example, if you had 5 servers, each with 2000 GB of bandwidth, and one server used 3000 GB of bandwidth while the other used only 1500 GB of bandwidth, you would not be billed for an overage because your total usage would be 9000 GB and your total allocated would be 10000 GB.

Methods

createObject
create a new allotment by passing in a allotment object.
editObject
Edit a bandwidth allotment
getAccount
Retrieve the account associated with this virtual rack.
getActiveDetails
Retrieve the bandwidth allotment detail records associated with this virtual rack.
getApplicationDeliveryControllers
Retrieve the Application Delivery Controller contained within a virtual rack.
getAverageDailyPublicBandwidthUsage
Retrieve the average daily public bandwidth usage for the current billing cycle.
getBackendBandwidthByHour
return a collection of private usage objects that contain hourly incoming and outgoing network traffic amounts for a 24 hour period.
getBackendBandwidthUse
return a collection of private usage objects that contain hourly incoming and outgoing network traffic amounts for a customer date period.
getBandwidthAllotmentType
Retrieve the bandwidth allotment type of this virtual rack.
getBandwidthForDateRange
Retrieve bandwidth data from a tracking object.
getBandwidthImage
generate a graph image of all the bandwidth usage for an entire allotment of servers.
getBareMetalInstances
Retrieve the bare metal server instances contained within a virtual rack.
getBillingCycleBandwidthUsage
Retrieve 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.
getBillingCyclePrivateBandwidthUsage
Retrieve a virtual rack's raw private network bandwidth usage data for an account's current billing cycle.
getBillingCyclePublicBandwidthUsage
Retrieve a virtual rack's raw public network bandwidth usage data for an account's current billing cycle.
getBillingCyclePublicUsageTotal
Retrieve the total public bandwidth used in this virtual rack for an account's current billing cycle.
getBillingItem
Retrieve a virtual rack's billing item.
getCurrentBandwidthSummary
Retrieve an object that provides commonly used bandwidth summary components for the current billing cycle.
getCustomBandwidthDataByDate
Retrieve bandwidth graph by date.
getDetails
Retrieve the bandwidth allotment detail records associated with this virtual rack.
getFrontendBandwidthByHour
return a collection of public usage objects that contain hourly incoming and outgoing network traffic amounts for a 24 hour period.
getFrontendBandwidthUse
return a collection of public usage objects that contain hourly incoming and outgoing network traffic amounts for a 24 hour period.
getHardware
Retrieve the hardware contained within a virtual rack.
getInboundPublicBandwidthUsage
Retrieve the total public inbound bandwidth used in this virtual rack for an account's current billing cycle.
getLocationGroup
Retrieve the location group associated with this virtual rack.
getManagedBareMetalInstances
Retrieve the managed bare metal server instances contained within a virtual rack.
getManagedHardware
Retrieve the managed hardware contained within a virtual rack.
getManagedVirtualGuests
Retrieve the managed Virtual Server contained within a virtual rack.
getMetricTrackingObject
Retrieve a virtual rack's metric tracking object. This object records all periodic polled data available to this rack.
getMetricTrackingObjectId
Retrieve the metric tracking object id for this allotment.
getObject
Retrieve a SoftLayer_Network_Bandwidth_Version1_Allotment record.
getOutboundPublicBandwidthUsage
Retrieve the total public outbound bandwidth used in this virtual rack for an account's current billing cycle.
getOverBandwidthAllocationFlag
Retrieve whether the bandwidth usage for this bandwidth pool for the current billing cycle exceeds the allocation.
getPrivateNetworkOnlyHardware
Retrieve the private network only hardware contained within a virtual rack.
getProjectedOverBandwidthAllocationFlag
Retrieve whether the bandwidth usage for this bandwidth pool for the current billing cycle is projected to exceed the allocation.
getProjectedPublicBandwidthUsage
Retrieve the projected public outbound bandwidth for this virtual server for the current billing cycle.
getTotalBandwidthAllocated
Retrieve the combined allocated bandwidth for all servers in a virtual rack.
getVdrMemberRecurringFee
Gets the monthly recurring fee of a pooled server.
getVirtualGuests
Retrieve the Virtual Server contained within a virtual rack.
reassignServers
reassign a collection of servers to a different allotment.
requestVdrCancellation
cancel a bandwidth pooling and assign contents, if any, to bandwidth pool.
requestVdrContentUpdates
Move servers into our out of a bandwidth pool.
setVdrContent
Update bandwidth pool.
unassignServers
unassign a collection of servers from an allotment and insert them into the accounts VPR.
voidPendingServerMove
Void a pending server removal from this bandwidth pooling.
voidPendingVdrCancellation
Void a pending cancellation on a bandwidth pool.

/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/