SoftLayer Network Vlan::getPrivateVlan

From SoftLayer Development Network Wiki

getPrivateVlan is a member of the SoftLayer_Network_Vlan service.

Contents 1 Overview 2 Return Type 3 Headers 3.1 Required Headers 4 Error Handling

Overview

Retrieve a VLAN's associated private network VLAN. getPrivateVlan gathers it's information by retrieving the private VLAN of a VLAN's primary hardware object.

Return Type

getPrivateVlan returns the SoftLayer_Network_Vlan data type.

Headers

Required Headers

getPrivateVlan requires the following headers:

• authenticate
• SoftLayer_Network_VlanInitParameters

Error Handling

getPrivateVlan throws the following exceptions:

• SoftLayer_Exception

Throw the exception "No network components found for VLAN." If a VLAN has no network components.

• SoftLayer_Exception

Throw the exception "No network connections found for network component." If a VLAN's network components have no network connections.

• SoftLayer_Exception

Throw the exception "No network components found for downlink network connection." If a VLAN 's downstream network connection has no network components.

• SoftLayer_Exception

Throw the exception "No hardware found for network components." If a VLAN's downstream network components have no associated hardware.