SoftLayer_Network_Component


SoftLayer_Network_Component

Description

Every piece of hardware running in SoftLayer’s datacenters connected to the public, private, or management networks (where applicable) have a corresponding network component. These network components are modeled by the SoftLayer_Network_Component data type. These data types reflect the servers’ local ethernet and remote management interfaces.

associatedMethods

Local

duplexModeId
A network component's Duplex mode.
Type:

string

hardwareId
The internal identifier of the hardware that a network component belongs to.
Type:

integer

id
A network component's internal identifier.
Type:

integer

ipmiIpAddress
The IP address of an IPMI-based management network component.
Type:

string

ipmiMacAddress
The MAC address of an IPMI-based management network component.
Type:

string

macAddress
A network component's unique MAC address. IPMI-based management network interfaces may not have a MAC address.
Type:

string

maxSpeed
A network component's maximum allowed speed, measured in Mbit per second. ''maxSpeed'' is determined by the capabilities of the network interface and the port speed purchased on your SoftLayer server.
Type:

integer

modifyDate
The date a network component was last modified.
Type:

dateTime

name
A network component's short name. For most servers this is the string "eth" for ethernet ports or "mgmt" for remote management ports. Use this in conjunction with the ''port'' property to identify a network component. For instance, the "eth0" interface on a server has the network component name "eth" and port 0.
Type:

string

networkVlanId
The unique internal id of the network VLAN that the port belongs to.
Type:

integer

port
A network component's port number. Most hardware has more than one network interface. The port property separates these interfaces. Use this in conjunction with the ''name'' property to identify a network component. For instance, the "eth0" interface on a server has the network component name "eth" and port 0.
Type:

integer

primaryIpAddress
A network component's primary IP address. IPMI-based management network interfaces may not have an IP address.
Type:

string

speed
A network component's speed, measured in Mbit per second.
Type:

integer

status
A network component's status. This can take one of four possible values: "ACTIVE", "DISABLE", "USER_OFF", or "MACWAIT". "ACTIVE" network components are enabled and in use on a servers. "DISABLE" status components have been administratively disabled by SoftLayer accounting or abuse. "USER_OFF" components have been administratively disabled by you, the user. "MACWAIT" components only exist on network components that have not been provisioned. You should never see a network interface in MACWAIT state. If you happen to see one please contact SoftLayer support.
Type:

string

Relational

activeCommand
Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card.
Type:
downlinkComponent
The network component linking this object to a child device
Type:
duplexMode
The duplex mode of a network component.
Type:
hardware
The hardware that a network component resides in.
Type:
interface
A hardware switch's interface to the bandwidth pod.
Type:
ipAddressBindings
The records of all IP addresses bound to a network component.
Type:
lastCommand
Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server's remote management card.
Type:
metricTrackingObject
The metric tracking object for this network component.
Type:
networkComponentFirewall
The upstream network component firewall.
Type:
networkComponentGroup
A network component's associated group.
Type:
networkHardware
All network devices in SoftLayer's network hierarchy that this device is connected to.
Type:
networkVlan
The VLAN that a network component's subnet is associated with.
Type:
networkVlanTrunks
The VLANs that are trunked to this network component.
Type:
primaryIpAddressRecord
The primary IPv4 Address record for a network component.
Type:
primarySubnet
The subnet of the primary IP address assigned to this network component.
Type:
primaryVersion6IpAddressRecord
The primary IPv6 Address record for a network component.
Type:
recentCommands
The last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card.
Type:
redundancyCapableFlag
Indicates whether the network component is participating in a group of two or more components capable of being operationally redundant, if enabled.
Type:

boolean

redundancyEnabledFlag
Indicates whether the network component is participating in a group of two or more components which is actively providing link redundancy.
Type:

boolean

remoteManagementUsers
User(s) credentials to issue commands and/or interact with the server's remote management card.
Type:
router
A network component's routers.
Type:
storageNetworkFlag
Whether a network component's primary ip address is from a storage network subnet or not.
Type:

boolean

subnets
A network component's subnets. A subnet is a group of IP addresses
Type:
uplinkComponent
The network component linking this object to parent
Type:
uplinkDuplexMode
The duplex mode of the uplink network component linking to this object
Type:

Count

ipAddressBindingCount
A count of the records of all IP addresses bound to a network component.
Type:

unsignedLong

ipAddressCount
A count of
Type:

unsignedLong

networkHardwareCount
A count of all network devices in SoftLayer's network hierarchy that this device is connected to.
Type:

unsignedLong

networkVlanTrunkCount
A count of the VLANs that are trunked to this network component.
Type:

unsignedLong

recentCommandCount
A count of the last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card.
Type:

unsignedLong

remoteManagementUserCount
A count of user(s) credentials to issue commands and/or interact with the server's remote management card.
Type:

unsignedLong

subnetCount
A count of a network component's subnets. A subnet is a group of IP addresses
Type:

unsignedLong


/reference/datatypes/SoftLayer_Network_Component/