Classes SoftLayer_Virtual_Guest
Tags method sldn virtual

SoftLayer_Virtual_Guest::findByIpAddress

Find CCI by its primary public or private IP (ipv4) address.

Description

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

---

Parameters

Name	Type	Description
ipAddress	string	An IP (ipv4) address by which to search for CCI

Required Headers

• Authenticate

Optional Headers

• SoftLayer_Virtual_GuestObjectMask

Return Values

• SoftLayer_Virtual_Guest

Error Handling

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