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.

Local


duplexModeId

A network component’s Duplex mode.
Type: string


hardwareId

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


id

A network component’s internal identifier.
Type: int


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: int


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: int


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: int


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: int


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: SoftLayer_Hardware_Component_RemoteManagement_Command_Request


downlinkComponent

The network component linking this object to a child device
Type: SoftLayer_Network_Component


duplexMode

The duplex mode of a network component.
Type: SoftLayer_Network_Component_Duplex_Mode


hardware

The hardware that a network component resides in.
Type: SoftLayer_Hardware


highAvailabilityFirewallFlag

None
Type: boolean


ipAddressBindings

The records of all IP addresses bound to a network component.
Type: SoftLayer_Network_Component_IpAddress[]


lastCommand

Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server’s remote management card.
Type: SoftLayer_Hardware_Component_RemoteManagement_Command_Request


metricTrackingObject

The metric tracking object for this network component.
Type: SoftLayer_Metric_Tracking_Object


networkComponentFirewall

The upstream network component firewall.
Type: SoftLayer_Network_Component_Firewall


networkComponentGroup

A network component’s associated group.
Type: SoftLayer_Network_Component_Group


networkHardware

All network devices in SoftLayer’s network hierarchy that this device is connected to.
Type: SoftLayer_Hardware[]


networkVlan

The VLAN that a network component’s subnet is associated with.
Type: SoftLayer_Network_Vlan


networkVlanTrunks

The VLANs that are trunked to this network component.
Type: SoftLayer_Network_Component_Network_Vlan_Trunk[]


networkVlansTrunkable

The viable trunking targets of this component. Viable targets include accessible VLANs in the same pod and network as this component, which are not already natively attached nor trunked to this component.
Type: SoftLayer_Network_Vlan[]


primaryIpAddressRecord

The primary IPv4 Address record for a network component.
Type: SoftLayer_Network_Subnet_IpAddress


primarySubnet

The subnet of the primary IP address assigned to this network component.
Type: SoftLayer_Network_Subnet


primaryVersion6IpAddressRecord

The primary IPv6 Address record for a network component.
Type: SoftLayer_Network_Subnet_IpAddress


recentCommands

The last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server’s remote management card.
Type: SoftLayer_Hardware_Component_RemoteManagement_Command_Request[]


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: SoftLayer_Hardware_Component_RemoteManagement_User[]


router

A network component’s routers.
Type: SoftLayer_Hardware


storageNetworkFlag

Whether a network component’s primary ip address is from a storage network subnet or not. [Deprecated]
Type: boolean

Deprecated


subnets

A network component’s subnets. A subnet is a group of IP addresses
Type: SoftLayer_Network_Subnet[]


uplinkComponent

The network component linking this object to parent
Type: SoftLayer_Network_Component


uplinkDuplexMode

The duplex mode of the uplink network component linking to this object
Type: SoftLayer_Network_Component_Duplex_Mode

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