SoftLayer Hardware Server::getSensorData

From SoftLayer Development Network Wiki

getSensorData is a member of the SoftLayer_Hardware_Server service.

Contents 1 Overview 2 User Access 3 Return Type 4 Headers 4.1 Required Headers 4.2 Optional Headers 5 Error Handling

Overview

Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires.

User Access

Users wishing to execute getSensorData must have the following permissions assigned to their account:

• Reboot
• View Hardware Details

Return Type

getSensorData returns the SoftLayer_Container_RemoteManagement_SensorReadingArray data type.

Headers

Required Headers

getSensorData requires the following headers set:

• authenticate
• SoftLayer_Hardware_ServerInitParameter

Optional Headers

getSensorData takes the following optional headers:

• resultLimit
• SoftLayer_Hardware_ServerObjectMask

Error Handling

getSensorData throws the following exceptions:

• SoftLayer_Exception

Throw the exception "Unable to locate the management component for this server." if the API is unable to locate the server's remote management component.