SoftLayer_Hardware_Server::getPrivateVlan

Retrieve the backend VLAN for the primary IP address of the server.

Description

Parameters

None

Required Headers

• Authenticate
• SoftLayer_Hardware_ServerInitParameters

Optional Headers

• SoftLayer_Hardware_ServerObjectMask

Return Values

• SoftLayer_Network_Vlan

Error Handling

• Throw the exception “No public network components found for hardware.” a server does not have any private network components installed.
• Throw the exception “No IP address found for public network component” if there is no backend primary IP address for the network components on a server.
• Throw the exception “Unable to find a public subnet.” if there are no backend subnets the network components are associated with.

REST Example

curl -g -u $SL_USER:$SL_APIKEY -X GET \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrivateVlan'