SoftLayer Hardware::findByIpAddress

From SoftLayer Development Network Wiki

findByIpAddress is a member of the SoftLayer_Hardware service.

Contents 1 Overview 2 Return Type 3 Headers 3.1 Required Headers 4 Parameters 4.1 ipAddress 5 Error Handling

Overview

Find hardware by only its primary public or private IP address. IP addresses within secondary subnets tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.

Return Type

findByIpAddress returns the SoftLayer_Hardware data type.

Headers

Required Headers

findByIpAddress requires the following headers:

• authenticate

Parameters

findByIpAddress takes the following parameters:

ipAddress

An IP (ipv4) address by which to search for hardware

• Type: string

Error Handling

findByIpAddress throws the following exceptions:

• SoftLayer_Exception

Throw the exception "Invalid IP address of {ipAddress} defined." when the IP given is not a valid ipv4 IP address.