SoftLayer Network Backbone (type)
From SoftLayer Development Network Wiki
This page refers to the SoftLayer_Network_Backbone data type. For information on the SoftLayer_Network_Backbone service please see SoftLayer_Network_Backbone.
Contents |
Overview
A SoftLayer_Network_Backbone represents a single backbone connection from SoftLayer to the public Internet, from the Internet to the SoftLayer private network, or a link that connects the private networks between SoftLayer's datacenters. The SoftLayer_Network_Backbone data type is a collection of data associated with one of those connections.
| 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
capacity
The numeric portion of the bandwidth capacity of a SoftLayer backbone. For instance, if a backbone is rated at "1 GigE" capacity then the capacity property of the backbone is 1.
- Type: integer
- Length: 22 digits
capacityUnits
The unit portion of the bandwidth capacity of a SoftLayer backbone. For instance, if a backbone is rated at "10 G" capacity then the capacityUnits property of the backbone is "G".
- Type: string
- Length: 10 characters
id
A backbone's internal identifier.
- Type: integer
name
A backbone's name. This is usually the name of the backbone's network provider followed by a number in case SoftLayer uses more than one backbone from a provider. Backbone provider numbers start with the number one and increment from there.
- Type: string
- Length: 50 characters
networkComponentId
The internal identifier of the network component that backbone is connected to.
- Type: integer
- Length: 22 digits
type
Whether a SoftLayer backbone connects to the public Internet, to the private network, or connecting the private networks of SoftLayer's datacenters. Type is either the string "public", "private", or "private-interconnect".
- Type: string
- Length: 50 characters
Relational Properties
health
A backbone's status.
health must be a unique value.
- Type: string
location
Which of the SoftLayer datacenters a backbone is connected to.
location must be a unique value.
- Type: SoftLayer_Location
networkComponent
A backbone's primary network component.
networkComponent can be queried by object mask.
networkComponent must be a unique value.
