November 23, 2017

Retrieve VLAN details such as primary router and subnet.

Retrieve the primary router and subnet for a determinate VLAN
associated with a SoftLayer customer account
We do this with a call to the getObject() method in the
SoftLayer_Network_Vlan API service using an object mask to retrieve
associated subnets and primary router records. See below for more details.

Important manual pages:

Author: SoftLayer Technologies, Inc. <>
import SoftLayer.API
from pprint import pprint as pp

# Your SoftLayer API username and key.
USERNAME = 'set me'
API_KEY = 'set me'

# The VLAN id you wish to see its details
vlanId = 557984

# Declare the API client
client = SoftLayer.Client(username=USERNAME, api_key=API_KEY)
networkVlanService = client['SoftLayer_Network_Vlan']

Declaring an object mask to get more information about the VLAN
such as the primaryRouter and the subnets
objectMask = "mask[primaryRouter, subnets[ipAddresses]]"

# Send the request to get the VLAN
    result = networkVlanService.getObject(id=vlanId, mask=objectMask)
except SoftLayer.SoftLayerAPIError as e:
    print("Unable to get VLAN details. faultCode=%s, faultString=%s"
          % (e.faultCode, e.faultString))


We would love to hear it
Open an issue