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

flash-device-get-iter flash-device-list-info flash-get-thresholds flash-thresholds-get-iter | The Flash Management Module (FMM) is the management interface to access information about flash devices in the system.

NetApp Manage ONTAP

flash-device-get-iter | [top]

> Iterate over a list of Flash Cache device info objects.

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

> Errno | Description
> EINTERNALERROR |  |

flash-device-list-info | [top]

> This API is used to retrieve information about the flash devices in the controller registered with Flash Management Module (FMM).

> Input Name | Range | Type | Description
> node |  | string | The name of the system where the flash device is installed.
> slot-number | [1..255] | integer optional | PCI-e slot number of the flash device. If not provided, information of all the registered devices will be given.
> Output Name | Range | Type | Description
> flash-device-info |  | flash-device-info[] optional | List of registered flash devices.

> Errno | Description
> ENOFMMDEVICES |  |
> EINTERNALERROR |  |

flash-get-thresholds | [top]

> Get threshold profiles available in Flash Management Module.

> Input Name | Range | Type | Description
> node |  | string | The name of the system to which the flash thresholds apply.
> profile |  | string optional | Name of the threshold profile. If not provided, all available profiles will be printed.
> Output Name | Range | Type | Description
> flash-threshold-profile |  | flash-threshold-profile[] optional | A collection of failure threshold entries.

flash-thresholds-get-iter | [top]

> Iterate over a list of Flash Cache threshold profiles objects.

> Input Name | Range | Type | Description
> desired-attributes |  | flash-threshold-profile 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 |  | flash-threshold-profile optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the Flash Cache threshold profiles object. All Flash Cache threshold profiles 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 |  | flash-threshold-profile[] optional | The list of attributes of Flash Cache threshold profiles objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more Flash Cache threshold profiles objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

Element definition: flash-device-info | [top]

> Flash device information.

> Name | Range | Type | Description
> average-erase-cycle-count | [0..2^63-1] | integer | Average number of executed erase cycles.
> capacity | [0..2^31-1] | integer | Advertised capacity of the device, in gigabytes.
> firmware-revision |  | string | Firmware revision of FPGA on the flash device.
> last-change-time | [0..2^31-1] | integer | Seconds since Midnight 1/1/1970 UTC when status changed.
> model-name |  | string | Model name of the flash device in XXXXXX-XX format.
> node |  | string | The name of the system where the flash device is installed.
> part-number |  | string | Part number of the flash device in XXX-XXXXX format.
> percent-online | [0..100] | integer | Percentage of device capacity that is currently online.
> serial-number |  | string | 10-digit serial number of the flash device.
> service-time | [0..2^31-1] | integer | Total number of hours the device was operational.
> slot-number | [1..255] | integer | PCI-e slot number of the flash device.
> status |  | string | The current status of the device. Possible values: "online", "offline_failed", or "offline_threshold".
> threshold-profile |  | string | The name of the threshold profile being used for this flash device.

Element definition: flash-threshold-profile | [top]

> A definition for a threshold element

> Name | Range | Type | Description
> flash-threshold |  | flash-threshold[] | The list of threshold entries for this profile.
> node |  | string | The name of the system to which the flash thresholds apply.
> profile |  | string | The name of the profile in plain text.

Element definition: flash-threshold | [top]

> A definition for a threshold element. Each threshold specifies what level of errors or failures the specified domain can sustain before the specified action is taken.

> Name | Range | Type | Description
> action |  | string | Action to be taken if this threshold is exceeded. Possible values: "log an EMS event", "log an EMS_event, and disable the 'domain'", "log an EMS event, and send an AutoSupport message", "log an EMS event, send an AutoSupport message, and disable the 'domain'"
> domain |  | string | The type of domain. Possible values: "card", "bank", "chip" (in Data ONTAP 7.3.x to 8.1) or "lun" (from Data ONTAP 8.2 onwards).
> threshold-units |  | string | The metric for threshold. Possible values: "count", or "percentage".
> threshold-value | [0..2^31-1] | integer | Threshold value in 'threshold-units'.
> time-slice |  | string | The time slice. Available if the 'threshold-unit' is "count". If not, output will say 'none'. Possible values: "none", "seconds", "minutes", or "hours".