Retrieve environment sensors
Retrieves environment sensors to access data on the current status and readings from the sensors in your ONTAP system. This information helps you monitor environmental conditions and ensure system health.
HTTP method and endpoint
GET /cluster/sensors
Introduced in
ONTAP 9.11
Usage notes
Retrieve Environment Sensors
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
warning_high_threshold |
integer |
query |
False |
Filter by warning_high_threshold |
value_units |
string |
query |
False |
Filter by value_units |
value |
integer |
query |
False |
Filter by value |
type |
string |
query |
False |
Filter by type |
critical_high_threshold |
integer |
query |
False |
Filter by critical_high_threshold |
warning_low_threshold |
integer |
query |
False |
Filter by warning_low_threshold |
discrete_value |
string |
query |
False |
Filter by discrete_value |
index |
integer |
query |
False |
Filter by index |
critical_low_threshold |
integer |
query |
False |
Filter by critical_low_threshold |
name |
string |
query |
False |
Filter by name |
discrete_state |
string |
query |
False |
Filter by discrete_state |
threshold_state |
string |
query |
False |
Filter by threshold_state |
node.name |
string |
query |
False |
Filter by node.name |
node.uuid |
string |
query |
False |
Filter by node.uuid |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of Records |
records |
array[sensors] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"critical_high_threshold": 0,
"critical_low_threshold": 0,
"discrete_state": "normal",
"discrete_value": "ok",
"index": 0,
"name": "PVCCSA CPU FD",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"threshold_state": "normal",
"type": "string",
"value": 831,
"value_units": "mV",
"warning_high_threshold": 0,
"warning_low_threshold": 0
}
]
}
Error
Status: Default, Error
| Name | Type | Description |
|---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
collection_links
| Name | Type | Description |
|---|---|---|
next |
||
self |
self_link
| Name | Type | Description |
|---|---|---|
self |
_links
| Name | Type | Description |
|---|---|---|
self |
node
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
sensors
Environment Sensors
| Name | Type | Description |
|---|---|---|
_links |
||
critical_high_threshold |
integer |
Value above which the sensor goes into a critically high state. |
critical_low_threshold |
integer |
Value below which the sensor goes into a critically low state. |
discrete_state |
string |
Used to determine whether the sensor is in a normal state or any other failed state based on the value of "discrete_value" field. This field is only applicable for discrete sensors. |
discrete_value |
string |
Applies to discrete sensors which do not have an integer value. It can have values like on, off, good, bad, ok. |
index |
integer |
Provides the sensor ID. |
name |
string |
Name of the sensor. |
node |
||
threshold_state |
string |
Used to determine whether the sensor is in a normal state or any other failed state. |
type |
string |
Used to detrmine the type of the sensor. |
value |
integer |
Provides the sensor reading. |
value_units |
string |
Units in which the "value" is measured. Some examples of units are mV, mW*hr, C, RPM. |
warning_high_threshold |
integer |
Value above which the sensor goes into a warning high state. |
warning_low_threshold |
integer |
Value below which the sensor goes into a warning low state. |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |