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

dashboard-alarm-get dashboard-alarm-get-iter dashboard-alarm-get-total-records dashboard-alarm-threshold-get dashboard-alarm-threshold-get-iter dashboard-alarm-threshold-get-total-records dashboard-alarm-threshold-modify | This set of APIs provides visibility into the Alarm Dashboard feature of the system. The Alarm Dashboard allows the system administrator to proactively monitor the health of each node in the cluster by exposing various storage and performance metrics. The administrator may configure this dashboard to alert users in the event a performance metric crosses a predetermined threshold. The following metrics are monitored by the Alarm Dashboard: average client latency (performance of NFS and CIFS operations) CPU utilization data network health (ratio of packet errors over total packets) data port utilization storage space utilization The APIs are divided into the following major features: Alarms: view storage and performance metrics Alarm Thresholds: manage warning / critical thresholds, polling intervals, and user notifications

NetApp Manage ONTAP

dashboard-alarm-get | [top]

> Get alarm monitoring data for the given node object.

> Input Name | Range | Type | Description
> dashboard-metric-type |  | dashboard-metric-type | The type of metric being monitored. Possible values: "cpu_busy" - CPU Utilization, "port_util" - Port Utilization, "op_latency" - Average Client Latency of NFS and CIFS operations, "aggregate_used" - Storage Aggregate Utilization, "port_problems" - Packet Error Ratio
> desired-attributes |  | dashboard-alarm-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.
> node |  | string | Name of the node associated with the alarm metrics.
> object-name |  | string | Name associated with the object being monitored. For example, the object-name is the name of the node if the dashboard-metric-type is cpu-busy.
> Output Name | Range | Type | Description
> attributes |  | dashboard-alarm-info | The attributes of the dashboard-alarm.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

dashboard-alarm-get-iter | [top]

> Get alarm monitoring data for all objects in the cluster.

> Input Name | Range | Type | Description
> desired-attributes |  | dashboard-alarm-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.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | dashboard-alarm-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the dashboard-alarm object. All dashboard-alarm objects matching this query up to 'max-records' will be returned.
> 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.
> Output Name | Range | Type | Description
> attributes-list |  | dashboard-alarm-info[] optional | The list of attributes of dashboard-alarm objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more dashboard-alarm objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

dashboard-alarm-get-total-records | [top]

> Return the total number of records.

> Output Name | Range | Type | Description
> count | [0..2^64-1] | integer | The total number of dashboard-alarm objects.

dashboard-alarm-threshold-get | [top]

> Get alarm threshold settings for the given metric group.

> Input Name | Range | Type | Description
> dashboard-metric-type |  | dashboard-metric-type | The type of metric being monitored. Possible values: "cpu_busy" - CPU Utilization, "port_util" - Port Utilization, "op_latency" - Average Client Latency of NFS and CIFS operations, "aggregate_used" - Storage Aggregate Utilization, "port_problems" - Packet Error Ratio
> desired-attributes |  | dashboard-alarm-threshold-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.
> Output Name | Range | Type | Description
> attributes |  | dashboard-alarm-threshold-info | The attributes of the dashboard-alarm-threshold.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

dashboard-alarm-threshold-get-iter | [top]

> Get alarm threshold settings for all metric groups.

> Input Name | Range | Type | Description
> desired-attributes |  | dashboard-alarm-threshold-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.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | dashboard-alarm-threshold-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the dashboard-alarm-threshold object. All dashboard-alarm-threshold objects matching this query up to 'max-records' will be returned.
> 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.
> Output Name | Range | Type | Description
> attributes-list |  | dashboard-alarm-threshold-info[] optional | The list of attributes of dashboard-alarm-threshold objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more dashboard-alarm-threshold objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

dashboard-alarm-threshold-get-total-records | [top]

> Return the total number of records.

> Output Name | Range | Type | Description
> count | [0..2^64-1] | integer | The total number of dashboard-alarm-threshold objects.

dashboard-alarm-threshold-modify | [top]

> Modify alarm threshold settings for the given metric group.

> Input Name | Range | Type | Description
> critical-threshold |  | string optional | The threshold value that must be reached to generate a critical alarm for this type of metric. Get request is returned with % sign for percent values and ms for milliseconds value. Example : 95%, 500ms
> dashboard-metric-type |  | dashboard-metric-type | The type of metric being monitored. Possible values: "cpu_busy" - CPU Utilization, "port_util" - Port Utilization, "op_latency" - Average Client Latency of NFS and CIFS operations, "aggregate_used" - Storage Aggregate Utilization, "port_problems" - Packet Error Ratio
> is-user-notification-enabled |  | boolean optional | Specifies whether user notifications are enabled.
> polling-interval | [60..6000] | integer optional | The refresh interval for the alarm dashboard metrics (in seconds).
> threshold-units |  | threshold-unit optional | Threshold Units Possible values: "none" - none, "ms" - milliseconds, "percent" - percent
> warning-threshold |  | string optional | The threshold value that must be reached to generate a warning alarm for this type of metric. Get request is returned with % sign for percent values and ms for milliseconds value. Example : 85%, 200ms

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

Element definition: dashboard-alarm-info | [top]

> Alarm monitoring data 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
> dashboard-metric-type |  | dashboard-metric-type optional | The type of metric being monitored. Attributes: key, non-creatable, non-modifiable Possible values: "cpu_busy" - CPU Utilization, "port_util" - Port Utilization, "op_latency" - Average Client Latency of NFS and CIFS operations, "aggregate_used" - Storage Aggregate Utilization, "port_problems" - Packet Error Ratio
> high-value |  | string optional | The highest value recorded so far for this metric. Attributes: non-creatable, non-modifiable
> last-value |  | string optional | The last value recorded for this metric. Attributes: non-creatable, non-modifiable
> node |  | string optional | Name of the node associated with the alarm metrics. Attributes: key, non-creatable, non-modifiable
> object-name |  | string optional | Name associated with the object being monitored. For example, the object-name is the name of the node if the dashboard-metric-type is cpu-busy. Attributes: key, non-creatable, non-modifiable
> state |  | alarm-state optional | The current alarm state of the object being monitored. Attributes: non-creatable, non-modifiable Possible values: "ok" , "warning" , "critical"

Element definition: dashboard-alarm-threshold-info | [top]

> Alarm threshold configuration settings 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-threshold |  | string optional | The threshold value that must be reached to generate a critical alarm for this type of metric. Get request is returned with % sign for percent values and ms for milliseconds value. Example : 95%, 500ms Attributes: optional-for-create, modifiable
> dashboard-metric-type |  | dashboard-metric-type optional | The type of metric being monitored. Attributes: key, required-for-create, non-modifiable Possible values: "cpu_busy" - CPU Utilization, "port_util" - Port Utilization, "op_latency" - Average Client Latency of NFS and CIFS operations, "aggregate_used" - Storage Aggregate Utilization, "port_problems" - Packet Error Ratio
> is-user-notification-enabled |  | boolean optional | Specifies whether user notifications are enabled. Attributes: required-for-create, modifiable
> polling-interval | [60..6000] | integer optional | The refresh interval for the alarm dashboard metrics (in seconds). Attributes: required-for-create, modifiable
> threshold-units |  | threshold-unit optional | Threshold Units Attributes: optional-for-create, modifiable Possible values: "none" - none, "ms" - milliseconds, "percent" - percent
> warning-threshold |  | string optional | The threshold value that must be reached to generate a warning alarm for this type of metric. Get request is returned with % sign for percent values and ms for milliseconds value. Example : 85%, 200ms Attributes: required-for-create, modifiable

Element definition: dashboard-metric-type | [top]

> Metric Type Possible values: "cpu_busy" - CPU Utilization, "port_util" - Port Utilization, "op_latency" - Average Client Latency of NFS and CIFS operations, "aggregate_used" - Storage Aggregate Utilization, "port_problems" - Packet Error Ratio

> [none]

Element definition: threshold-unit | [top]

> Dashboard Threshold Units Possible values: "none" - none, "ms" - milliseconds, "percent" - percent

> [none]

Element definition: alarm-state | [top]

> Alarm Monitoring State Possible values: "ok" , "warning" , "critical"

> [none]