NetApp Manage ONTAP

APIs in Category: environment | Cluster-Mode API version 1.21

environment-sensors-get-iter | Environmental subsystem is a module to monitor the system's environmental states by reading the hardware sensors on various components. According to the states of the sensors, the subsystem will take actions based on a predefined environmental policy. This category contains the APIs for the environmental subsystem.

environment-sensors-get-iter | [top]

> Returns the sensors information from the environmental subsystem.

> Input Name | Range | Type | Description
> desired-attributes |  | environment-sensors-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> discrete-sensor-state |  | sensor-state-enum optional | Discrete-valued sensor state
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 300
> query |  | environment-sensors-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the environment object. All environment objects matching this query up to 'max-records' will be returned.
> sensor-name |  | string optional | Name of the sensor in the environmental subsystem. The maximum length of the sensor name is 32
> sensor-type |  | sensor-type-enum optional | Type of the sensor. See sensor-type-enum for possible values
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> threshold-sensor-state |  | sensor-state-enum optional | Threshold-based sensor state
> Output Name | Range | Type | Description
> attributes-list |  | environment-sensors-info[] optional | The list of attributes of environment objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more environment objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

Element definition: environment-sensors-info | [top]

> Environment Sensor Info. The environmental subsystem monitors a set of hardware sensors in the system. Each sensor represents a pair of state and value that can be measured to reflect the physical state of device(s). Based on the values the sensors represent, the sensors can be grouped to discrete-valued sensors and threshold-based sensors. The discrete-valued sensors have a set of discrete values that represent states of sensors. The threshold-based sensors have a numeral value that represnts a value on an axis, and may have a set of thresholds (points on that axis) are used to define the state of the sensor (ranging from critically low to critically high). This typedef defines the information for both groups of sensors. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> critical-high-threshold | [-2^31..2^31-1] | integer optional | Critical high threshold Attributes: non-creatable, non-modifiable
> critical-low-threshold | [-2^31..2^31-1] | integer optional | Critical low threshold Attributes: non-creatable, non-modifiable
> discrete-sensor-state |  | sensor-state-enum optional | Discrete-valued sensor state Attributes: non-creatable, non-modifiable Possible values: "normal" - The device is normal, "warn_low" - The device state is lower than the warning low threshold and higher than the critical low threshold, "warn_high" - The device state is higher than the warning high threshold and lower than the critical high threshold, "crit_low" - The device state is lower than the critical low threshold, "crit_high" - The device state is higher than the critical higher threshold, "disabled" - The sensor is disabled, only available for SP-based filers, "uninitialized" - The sensor is not yet initialized, only available for SP-based filers, "init_failed" - The sensor failed to initialize, only available for SP-based filers, "not_available" - The sensor is temporarily not able to report status, only available for SP-based filers, "invalid" - The status returned from the sensor is not valid, only available for SP-based filers, "retry" - The sensor is in the rety state, only available for non SP-based filers, "bad" - The device is bad, only available for non SP-based filers, "not_present" - The device is not present, only available for non SP-based filers, "failed" - The sensor failed to report status, "ignored" - The sensor state is ignored, only available for SP-based filers, "unknown" - The sensor state is uknown
> discrete-sensor-value |  | string optional | Discrete-valued sensor value Attributes: non-creatable, non-modifiable
> node-name |  | node-name optional | Node name the sensor is associated with Attributes: key, non-creatable, non-modifiable
> sensor-name |  | string optional | Name of the sensor in the environmental subsystem. The maximum length of the sensor name is 32 Attributes: non-creatable, non-modifiable
> sensor-type |  | sensor-type-enum optional | Type of the sensor Attributes: non-creatable, non-modifiable Possible values: "fan" - FAN RPM sensors, "thermal" - Temerature sensors, "voltage" - Voltage measurement sensors, "current" - Current measurement sensors, "battlife" - Sensors report battery life, "discrete" - Discrete sensors, "fru" - FRU sensors, "nvmem" - Sensors on the NVMEM module, "counter" - Sensors report in counters, "minutes" - Sensors report by minutes, "percent" - Sensors report in percentage, "agent" - Sensors on or throught the Agent device, "unknown" - Unknown sensors
> threshold-sensor-state |  | sensor-state-enum optional | Threshold-based sensor state Attributes: non-creatable, non-modifiable Possible values: "normal" - The device is normal, "warn_low" - The device state is lower than the warning low threshold and higher than the critical low threshold, "warn_high" - The device state is higher than the warning high threshold and lower than the critical high threshold, "crit_low" - The device state is lower than the critical low threshold, "crit_high" - The device state is higher than the critical higher threshold, "disabled" - The sensor is disabled, only available for SP-based filers, "uninitialized" - The sensor is not yet initialized, only available for SP-based filers, "init_failed" - The sensor failed to initialize, only available for SP-based filers, "not_available" - The sensor is temporarily not able to report status, only available for SP-based filers, "invalid" - The status returned from the sensor is not valid, only available for SP-based filers, "retry" - The sensor is in the rety state, only available for non SP-based filers, "bad" - The device is bad, only available for non SP-based filers, "not_present" - The device is not present, only available for non SP-based filers, "failed" - The sensor failed to report status, "ignored" - The sensor state is ignored, only available for SP-based filers, "unknown" - The sensor state is uknown
> threshold-sensor-value | [-2^31..2^31-1] | integer optional | Threshold-based sensor value Attributes: non-creatable, non-modifiable
> value-units |  | string optional | The units of the threshold-based sensor value. More than 90 possible unit types. Refer to the "Sensor Unit Type Codes" in the IPMI spec for possible types. Attributes: non-creatable, non-modifiable
> warning-high-threshold | [-2^31..2^31-1] | integer optional | Warning high threshold Attributes: non-creatable, non-modifiable
> warning-low-threshold | [-2^31..2^31-1] | integer optional | Warning low threshold Attributes: non-creatable, non-modifiable

Element definition: sensor-state-enum | [top]

> The operating states of the sensors. Depends on the hardware architecture, the environmental subsystem is implemented in two different approaches: one for service processor (SP) based platforms and one for non SP based (RLM, BMC) platforms. Some of the following states are available for one type of filers but not the other. Possible values: "normal" - The device is normal, "warn_low" - The device state is lower than the warning low threshold and higher than the critical low threshold, "warn_high" - The device state is higher than the warning high threshold and lower than the critical high threshold, "crit_low" - The device state is lower than the critical low threshold, "crit_high" - The device state is higher than the critical higher threshold, "disabled" - The sensor is disabled, only available for SP-based filers, "uninitialized" - The sensor is not yet initialized, only available for SP-based filers, "init_failed" - The sensor failed to initialize, only available for SP-based filers, "not_available" - The sensor is temporarily not able to report status, only available for SP-based filers, "invalid" - The status returned from the sensor is not valid, only available for SP-based filers, "retry" - The sensor is in the rety state, only available for non SP-based filers, "bad" - The device is bad, only available for non SP-based filers, "not_present" - The device is not present, only available for non SP-based filers, "failed" - The sensor failed to report status, "ignored" - The sensor state is ignored, only available for SP-based filers, "unknown" - The sensor state is uknown

> [none]

Element definition: sensor-type-enum | [top]

> Type of the sensors the system can manage Possible values: "fan" - FAN RPM sensors, "thermal" - Temerature sensors, "voltage" - Voltage measurement sensors, "current" - Current measurement sensors, "battlife" - Sensors report battery life, "discrete" - Discrete sensors, "fru" - FRU sensors, "nvmem" - Sensors on the NVMEM module, "counter" - Sensors report in counters, "minutes" - Sensors report by minutes, "percent" - Sensors report in percentage, "agent" - Sensors on or throught the Agent device, "unknown" - Unknown sensors

> [none]

Element definition: node-name | [top]

> The node's name

> [none]