getVlans

Classes SoftLayer_Resource_Metadata
Tags method sldn resource

SoftLayer_Resource_Metadata::getVlans

A list of VLAN numbers for a network component

Description

The getVlans method returns a list of VLAN numbers for the network component matching the provided MAC address associated with the resource. For each return, the native VLAN will appear first, followed by any trunked VLANs associated with the network component.

Parameters

Name Type Description
macAddress string The MAC address to obtain the VLAN numbers for

Required Headers

Optional Headers

  • None

Return Values

  • int[]

Error Handling

  • Thrown when a network component is not found for the provided MAC address
  • Thrown when VLANs are not found for the network component
  • Thrown when the MAC address provided is invalid 
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Resource_Metadata/{SoftLayer_Resource_MetadataID}/getVlans'