November 23, 2017


 * Retrieve a list of switch port statistics for a server's network interfaces.
 * This script makes a single call to the getPortStatistics() method in the
 * SoftLayer_Network_Component API service
 * for each of a server's network components to query port statistics for that
 * interface from SoftLayer's switches. Port statistics are modeled by the
 * SoftLayer__Container_Network_Port_Statistic data type
 * See below for more details.
 * Important manual pages:
 * License:
 * Author: SoftLayer Technologies, Inc. <>
require_once ('SoftLayer/SoapClient.class.php');

// Your SoftLayer API username and key.
$apiUsername = 'set me';
$apiKey = 'set me';

# Your server's id. Call the getHardware() method in the SoftLayer_Account API
# service (
# to get a list of your account's hardware records.
$serverId = 87165;

// Declaring the API client
$hardwareServerService = Softlayer_SoapClient::getClient('SoftLayer_Hardware_Server', null, $apiUsername, $apiKey);
$networkComponentService = Softlayer_SoapClient::getClient('SoftLayer_Network_Component', null, $apiUsername, $apiKey);

# Switchport statistics are measured off the server's network components. Use
# an object mask to network component records along with our server record.
$objectMask = new SoftLayer_ObjectMask();


try {
    # Making the call to retrieve our hardware record. Once we have that we can query
    # the server's network components.
    $server = $hardwareServerService->getObject();
} catch (Exception $e) {
    die('Unable to retrieve server record. ' . $e->getMessage());

# Separating our network components for easier processing later.
$networkComponents = $server->{'networkComponents'};
print ("Switchport statistics for " . $server->{'fullyQualifiedDomainName'});

# Loop through our server's network components. For each NIC make a call to the
# SoftLayer_Network_Component API service method getPortStatics() to get a list
# of switchport statistics retrieved from the switch on the other side of your
# NIC. Print a simple report per NIC.
foreach  ($networkComponents as &$networkComponent) {
    # Skipping the management network component.
    if ($networkComponent->{'name'} != 'mgmt'){
        try {
            # Retrieving switchport statistics for the NIC.
            $stats = $networkComponentService->getPortStatistics();
            print_r ($stats);
        } catch (Exception $e) {
            die('Unable to retrieve switchport statics for . ' . $e->getMessage());


If this article contains any error, or leaves any of your questions unanswered, please help us out by opening up a github issue.
Open an issue