SoftLayer Network Vlan::getPublicVlanByFqdn

From SoftLayer Development Network Wiki

getPublicVlanByFqdn 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 fqdn 5 Error Handling 6 External Links

Overview

Retrieve the VLAN that belongs to a server's public network interface, as described by a server's fully-qualified domain name. A server's FQDN is it's hostname, followed by a period then it's domain name.

Return Type

getPublicVlanByFqdn returns the SoftLayer_Network_Vlan data type.

Headers

Required Headers

getPublicVlanByFqdn requires the following headers:

• authenticate

Parameters

getPublicVlanByFqdn takes the following parameters:

fqdn

The fully-qualified domain name of the server you wish to search for. This follows the naming convention "{hostname}.{domain}".

• Type: string

Error Handling

getPublicVlanByFqdn throws the following exceptions:

• SoftLayer_Exception

Throw the exception "You must supply a valid fully-qualified domain name, for example www.example.org" if the fqdn parameter is not a valid fully-qualified domain name with at least two periods in it.

• SoftLayer_Exception

Throw the exception "Unable to find hardware with the fully-qualified domain name of '{fqdn}'" if the API is unable to locate a server with that fully-qualified domain name under your account.

External Links

• Fully qualified domain name at Wikipedia