SoftLayer Network Component

From SoftLayer Development Network Wiki

Jump to: navigation, search

Contents

Overview

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.

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

hardwareId

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

  • Type: integer
  • Length: 10 digits


id

A network component's internal identifier.

  • Type: integer


ipmiIpAddress

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

  • Type: string
  • Length: 15 characters


ipmiMacAddress

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

  • Type: string
  • Length: 20 characters


macAddress

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

  • Type: string
  • Length: 20 characters


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
  • Length: 5 digits


modifyDate

The date a network component was last modified.


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
  • Length: 30 characters


networkVlanId

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

  • Type: integer
  • Length: 10 digits


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
  • Length: 3 digits


primaryIpAddress

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

  • Type: string
  • Length: 15 characters


speed

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

  • Type: integer
  • Length: 5 digits


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
  • Length: 20 characters


Relational Properties

activeCommand

Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card.
activeCommand can be queried by object mask.
activeCommand must be a unique value.


downlinkComponent

The network component linking this object to child
downlinkComponent can be queried by object mask.
downlinkComponent must be a unique value.

  • Type: SoftLayer_Network_Component


hardware

The hardware that a network component resides in.
hardware can be queried by object mask.
hardware must be a unique value.


interface

A hardware switch's interface to the bandwidth pod.
interface can be queried by object mask.
interface must be a unique value.


ipAddressBindings

The records of all IP addresses bound to a network component.
ipAddressBindings can be queried by object mask.


lastCommand

Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server's remote management card.
lastCommand can be queried by object mask.
lastCommand must be a unique value.


metricTrackingObject

The metric tracking object for this network component.
metricTrackingObject can be queried by object mask.
metricTrackingObject must be a unique value.


networkComponentFirewall

The upstream network component firewall.
networkComponentFirewall can be queried by object mask.
networkComponentFirewall must be a unique value.


networkVlan

The VLAN that a network component's subnet is associated with.
networkVlan can be queried by object mask.
networkVlan must be a unique value.


primaryIpAddressRecord

The primary IPv4 Address record for a network component.
primaryIpAddressRecord can be queried by object mask.
primaryIpAddressRecord must be a unique value.


primarySubnet

A network component's subnet for its primary IP address
primarySubnet can be queried by object mask.
primarySubnet must be a unique value.


primaryVersion6IpAddressRecord

The primary IPv6 Address record for a network component.
primaryVersion6IpAddressRecord can be queried by object mask.
primaryVersion6IpAddressRecord must be a unique value.


recentCommands

The last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card.
recentCommands can be queried by object mask.


remoteManagementUsers

User(s) credentials to issue commands and/or interact with the server's remote management card.
remoteManagementUsers can be queried by object mask.


storageNetworkFlag

Whether a network component's primary ip address is from a storage network subnet or not.
storageNetworkFlag can be queried by object mask.
storageNetworkFlag must be a unique value.

  • Type: boolean


subnets

A network component's subnets. A subnet is a group of IP addresses
subnets can be queried by object mask.


uplinkComponent

The network component linking this object to parent
uplinkComponent can be queried by object mask.
uplinkComponent must be a unique value.

  • Type: SoftLayer_Network_Component


Count Properties

ipAddressBindingCount

A count of the records of all IP addresses bound to a network component.
ipAddressBindingCount must be a unique value.

  • Type: unsigned long


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.
recentCommandCount must be a unique value.

  • Type: unsigned long


remoteManagementUserCount

A count of user(s) credentials to issue commands and/or interact with the server's remote management card.
remoteManagementUserCount must be a unique value.

  • Type: unsigned long


subnetCount

A count of a network component's subnets. A subnet is a group of IP addresses
subnetCount must be a unique value.

  • Type: unsigned long

Associated Methods

External Links

Retrieved from "http://sldn.softlayer.com/wiki/index.php/SoftLayer_Network_Component"
Personal tools