SoftLayer Network Vlan::getPrivateVlanByIpAddress

From SoftLayer Development Network Wiki

getPrivateVlanByIpAddress is a member of the SoftLayer_Network_Vlan service.

Contents 1 Overview 2 Return Type 3 Headers 3.1 Required Headers 4 Parameters 4.1 ipAddress 5 Error Handling 6 Associated Methods 7 See Also

Overview

Retrieve the private network VLAN associated with an IP address.

Return Type

getPrivateVlanByIpAddress returns the SoftLayer_Network_Vlan data type.

Headers

Required Headers

getPrivateVlanByIpAddress requires the following headers:

• authenticate

Parameters

getPrivateVlanByIpAddress takes the following parameters:

ipAddress

The IPv4 address to search for

• Type: string

Error Handling

getPrivateVlanByIpAddress throws the following exceptions:

• SoftLayer_Exception

Throw the exception "You must provide a valid IP address." if the ipAddress parameter is not a valid IPv4 address.

• SoftLayer_Exception

Throw the exception "Unable to find a subnet" if the API is unable to locate any subnets on this VLAN.

• SoftLayer_Exception

Throw the exception "Unable to find a valid network component for this IP address." if the API is unable to locate any network components on this VLAN.

Associated Methods

• SoftLayer_Network_Vlan::getVlanForIpAddress

See Also

• SoftLayer_Network_Subnet
• SoftLayer_Network_Component