APIs in Category: ses | API version 1.13

storage-shelf-environment-list-info storage-shelf-list-info storage-shelf-set-led-state storage-shelf-update-fw

NetApp Manage ONTAP

storage-shelf-environment-list-info | [top]

> Returns the environmental information for a selected number of shelves, or optionally all shelves connected to a filer.

> Input Name | Range | Type | Description
> channel-name |  | string optional | Get environment information for shelves on this channel. shelf-id parameter can be specified to request data on a single shelf. If a channel-name is not specified, then data on all shelves on all channels will be returned. If an invalid channel-name is specified, then error code ECHANNELNOTFOUND will be returned.
> shelf-id |  | integer optional | Get environment information for the specified shelf-id on the specified channel-name. This parameter requires channel-name parameter as well. If shelf-id is specified without channel-name then the error code EINVALIDINPUTERROR will be returned. If shelf-id is not specified and a channel-name is specified, then data for all shelves on the channel-name is returned. If an invalid shelf-id is specified, then error code ESHELFNOTFOUND will be returned. Range: [0..255]
> Output Name | Range | Type | Description
> shelf-environ-channel-list |  | shelf-environ-channel-info[] | List of channels and associated environment information on the shelves in the channel. Only on-line channels that have shelves attached will be reported.

> Errno | Description
> EINTERNALERROR |  |
> ECHANNELNOTFOUND |  |
> ESHELFNOTFOUND |  |
> EINVALIDINPUTERROR |  |

storage-shelf-list-info | [top]

> This interface returns information about one or more shelves.

> Input Name | Range | Type | Description
> channel-name |  | string optional | The adapter number or switch name and the port number (together, called the channel). If missing, then information for all shelves on all channels will be presented. If missing, then shelf-id input is not allowed. Examples are 8a.1 and switch:5.1.
> shelf-id |  | integer optional | shelf-id is the shelf number for which shelf data is requested. This input requires that channel-name input also be specified. If a channel-name and shelf-id are both specified then information for the specified shelf will be presented (a single shelf). If channel-name is specified, but shelf-id is missing, then information for all shelves on the channel will be presented. If channel-name is not specified then shelf-id is not supported. In such case information for all shelves on all channels will be presented. Range: [0..8]
> Output Name | Range | Type | Description
> shelf-list |  | shelf-info[] | Each instance of shelf-list contains all available information on a shelf hub. This can be empty if there are no shelves attached or if shelves do not support hubs.

> Errno | Description
> EINTERNALERROR |  |
> EAPIMISSINGARGUMENT |  |
> EINVALIDINPUTERROR |  |

storage-shelf-set-led-state | [top]

> Set or clear the LED for a disk, shelf of disks or loop of shelves. LEDs to affect can be specified as: {channel-name}, {channel-name, shelf-id}, {channel-name, shelf-id, shelf-bay}, {channel-name, shelf-id, shelf-bay}, {channel-name, shelf-id, shelf-bay, lun}.

> Input Name | Range | Type | Description
> action |  | string required | This specifies the action to apply. Possible values are: on, and off. on: Turn the LED(s) on indefinitely. off: Turn the LED(s) off.
> channel-name |  | string | The channel to which the shelf or drive LED to be affected is connected. A list of channels can be obtained with storage-shelf-get-channel-list. A channel-name is the adapter number or switch name and the port number (together, called the channel). Examples are 8a and switch:5.
> duration |  | integer optional | This parameter allows the caller to specify the duration (in seconds) that the action will be applied. Note that the action 'on' is indefinite, while 'test' uses duration. 'blink' also uses duration.
> identify |  | boolean optional | This parameter allows the caller to specify the identify LED. The default is for the command to affect the fault LED. Not all disks have identify LEDs. In that case, the identify option is ignored and the fault LED is affected.
> lun |  | integer optional | Some targets have a logical unit number. In that case, the lun will be required to uniquely specify the LED to affect. Range : [0..255]
> shelf-bay |  | integer optional | If present, the shelf-bay indicates the specific drive where the LED affected resides. If shelf-id is supplied but shelf-bay is not, then the LEDs for all drives in the shelf will be affected. The list of shelf-bays within a shelf can be obtained with storage-shelf-get-shelf-bay-count. Range : [0..255]
> shelf-id |  | integer | If present, the shelf-id indicates which shelf has the drive or drives where the LEDs to affect reside. A list of shelves connected to a channel can be obtained with storage-shelf-get-shelf-list. Range : [0..2^24-1]

> Errno | Description
> EINTERNALERROR |  |
> EDISKNOTFOUND |  |
> EAPIMISSINGARGUMENT |  |
> EINVALIDINPUTERROR |  |

storage-shelf-update-fw | [top]

> Start shelf firmware download process to update firmware on disk shelves. This operation is asynchronous, and therefore returns no errors that might occur during the download process. This operation will only update firmware on shelves that do not have the latest firmware revision. The firmware revision on the shelves can be monitored via the storage-shelf-get-shelf-info API. NOT IMPLEMENTED YET.

> Input Name | Range | Type | Description
> channel-name |  | string optional | If present, will only update firmware on all shelves (or a single shlef depending on shelf-id) on the given channel. If not present, then all shelves on all channels are updated. Example: To update firmware on 2a.shelf1, channel should be 2a and shelf should be 1.
> shelf-id |  | string optional | If present, will only update firmware on the given shelf on specified channel. If not present, and a channel-name is specified, then all shelves on the channel will be updated. Example: To update firmware on 2a.shelf1, channel should be 2a and shelf should be 1.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |

Element definition: shelf-environ-channel-info | [top]

> Shelf environment information.

> Name | Range | Type | Description
> channel-name |  | string | Filer channel the shelf is connected to.
> is-channel-monitor-enabled |  | boolean | Indicates whether monitoring is enabled on this channel.
> is-shelf-channel-failure |  | boolean | Indicates whether any shelves on this channel have experienced a failure.
> shelf-environ-channel-address |  | shelf-environ-channel-address-map[] optional | A list of all the shelf assigned addresses assigned on this channel.
> shelf-environ-shelf-list |  | shelf-environ-shelf-info[] | List of shelves in the channel and associated environment information.
> shelves-present |  | integer | Number of shelves present on this channel. Range [0-255]

Element definition: shelf-info | [top]

> Describes a shelf.

> Name | Range | Type | Description
> channel-name |  | string | The channel the shelf (hub) is attached to. Example: 0c.
> firmware-rev-A |  | string optional | Shelf Module A firmware revision.
> firmware-rev-B |  | string optional | Shelf Module B firmware revision.
> module |  | string | The shelf module attachment. Possible values are: "a", "b".
> module-state |  | string | Current state of the IO module attached to the shelf port (if any). Possible values are: "ok", "missing", "transport error", "critical", "unreachable", "unknown".
> phy-expander-list |  | phy-expander-info[] optional | Each instance of phy-expander-list contains expander information about each port. This applies to shelves with SAS modules only.
> port-hub-list |  | port-hub-info[] optional | Each instance of port-hub-list contains hub information about each port. This applies to shelves with ESH modules only.
> shelf-bay-info |  | shelf-bay-info optional | Detailed information on populated shelf bays.
> shelf-id |  | integer | The shelf id switch setting. This is the shelf id switch that is used to uniquely identify the shelf on the filer node. Range: [0..7]
> shelf-name |  | string | Shelf name that the hub is attached to. This can also be considered as hub name. Example: 0c.shelf1.
> shelf-state |  | string | Current state of the shelf. Possible values are: "no status", "init required", "online", "offline", "missing", "unknown".
> shelf-type |  | string | Shelf module type. Some examples are: "esh2", and "at-fcx".
> shelf-uid |  | string | Similar to serial number, this is the shelf unique identifier that distinguishes it from any other shelf manufactured. Example: 50:05:0c:c0:02:10:64:26.
> termination-switch |  | string optional | State of the termination switch on the shelf. Possible values are: "on", "off" and "n/a".

Element definition: phy-expander-info | [top]

> Expander information of an individual port.

> Name | Range | Type | Description
> crc-error-count |  | integer | This field presents the number of CRC errors that have been seen in any address or data frames. The value will be the count kept by the expander since either power-on or since the counts have been reset. Range: [0..2^32]
> invalid-dword-count |  | integer | The number of invalid double words seen outside of the phy reset sequence. The value will be the count kept by the expander since either power-on or since the counts have been reset. Range: [0..2^32]
> link-rate |  | string optional | If port-state is "ok", then this is a floating number, representing SAS-1.1 defined negotiated link rate value for the phy in Gb/s. Example: 3.0. For all other port states, this field will not be available.
> loss-dword-count |  | integer | This field presents the number of times the phy has lost double-word synchronization and restarted the link reset sequence of the phy reset sequence. The value will be the count kept by the expander since either power-on or since the counts have been reset. Range: [0..2^32]
> pathway-timeout |  | integer | This field the partial pathway timeout value, in microseconds, being used for the phy. Range: [0..2^32]
> phy-change-count |  | integer | This field the number of times this logical phy has changed state. This count increments when the logical phy transitions from disabled to enabled. This count also increments when the logical phys transitions from enabled to disabled. The value will be the count kept by the expander since either power-on or since the counts have been reset. Range: [0..2^32]
> phy-reset-problem |  | integer | This field presents the number of times the phy reset sequence has failed. The value will be the count kept by the expander since either power-on or since the counts have been reset. Range: [0..2^32]
> port-id |  | string | Possible values are: port id in range [0..19] or "in0", "in1", "in2", "in3", "out0", "out1", "out2", "out3", representing one of the input or output ports.
> port-state |  | string | Current port state. Possible values are: "ok", "unkwn lnk", "unused", "unkwn", "empty", "dis/man", "dis/smp", "dis/loswd", "dis/dispa", "dis/invwd", "dis/reset", "dis/phchg", "dis/mir", "dis/crc", "dis/resv", "unknown".
> running-disparity-count |  | integer | The number of Dwords with a running disparity error seen outside the phy reset sequence. The value will be the count kept by the expander since either power-on or since the counts have been reset. Range: [0..2^32]

Element definition: port-hub-info | [top]

> Hub information for an individual port.

> Name | Range | Type | Description
> clock-delta |  | integer | The clock delta between this port in respect to ESH clock and other ports in the ESH. Range: [2^31-1..2^31]
> disk-bay |  | integer optional | If port-id is "in", "out", "aux1" or "aux2" then this is not populated, otherwise, it represents the shelf bay that the disk resides in. Range: [0..13]
> insert-count |  | integer | Number of times this port has been inserted into the loop. Range: [0..2^32]
> invalid-crc-count |  | integer | Number of times this port has seen a CRC error. Range: [0..2^32]
> invalid-word-count |  | integer | Number of times this port has seen invalid FC-AL words transmitted. Range: [0..2^32]
> lip-count |  | integer optional | Lip count, number of times loop initialization primitive has been generated. This field is not available on all shelf modules. Range: [0..2^32]
> loop-up-count |  | integer | Number of times this port has seen the loop come up/transition to up. Range: [0..2^32]
> port-id |  | string | Possible values are: port number in the range of 0 to 255 or "in", "out", "aux1" or "aux2" representing input, output or one of auxiliary ports. This is the same as FCAL ALPA for the port.
> port-state |  | string | Current port state. Possible values are: "ok", "empty", "byp/init", "byp/gen", "byp/man", "byp/xmit", "byp/lipf8", "byp/dto", "byp/rlos", "byp/clos", "byp/tbi", "byp/rprt", "byp/stall", "byp/wrd", "byp/crc", "byp/lip", "byp/osc", "byp/clk", "byp/mir", "byp/lipf7", "byp/self", "byp/flt", "byp/pwr", "byp/pcycl", "warn/lip", "warn/wrdb", "warn/wrd", "warn/crc", "warn/clk", "unknown", "term-err", "term", "autoterm".
> stall-count |  | integer | Number of times this port exceeded the OPN/CLS maximum threshold. Range: [0..2^32]
> utilization-percentage |  | integer | Relative utilization of this port vs. other ports in the ESH. Range: [0..100]

Element definition: shelf-bay-info | [top]

> Shelf bay information.

> Name | Range | Type | Description
> bay-count |  | integer | Disk bays are the slots into which disks are placed. The bays are numbered from 0 to bay-count-1. Bay 0 is the right most bay (when looking at the front of the shelf) and bay bay-count-1 is left most. These bay numbers can be used by other commands, including storage-shelf-set-led-state. Range: [0..255]
> bay-list |  | bay-info[] | A list of shelf-bay numbers which have disk drives. The bay-list field is not optional, but it may contain zero bay-info elements.

Element definition: shelf-environ-channel-address-map | [top]

> A list of all the shelf assigned addresses assigned on this channel.

> Name | Range | Type | Description
> address-map |  | string | A comma separated list of addresses assigned on this channel by the shelf specified in shelf-no output above.
> shelf-id |  | integer | Shelf number for presented address map. Range [0..255]

Element definition: shelf-environ-shelf-info | [top]

> Shelf environment information.

> Name | Range | Type | Description
> ariodata-specific-info |  | ariodata-specific-info optional | Vendor specific enclosure system information for Ariodata shelves.
> attached-shelf-bay-list |  | string | A list of bays numbers in this shelf that have disk devices installed. Al bays with disks installed will be listed. This is a comma separated list from high to low. Example: "13, 11, 10, 4, 3, 2, 1".
> control-writes-attempted |  | integer | Number of times attempted to write shelf controls. Range [0..2^32-1]
> control-writes-failed |  | integer | Number of times failed to write shelf controls. Range [0..2^32-1]
> controller-device-path |  | string | Device path to the shelf controller. Possible values: "embedded_access", "local_access", "unknown", "not_available".
> controller-device-path-port |  | integer optional | If controller-device-path is "local_access", then this presents the local access port number.
> cooling-element-list |  | cooling-element-info[] optional | Information on installed cooling elements in the shelf.
> es-electronics-list |  | es-electronics-info[] optional | Information on the installed enclosure services electronics.
> eurologic-specific-info |  | eurologic-specific-info optional | Vendor specific enclosure system information for Eurologic shelves.
> is-shelf-monitor-enabled |  | boolean | Indicates whether monitoring is enabled on this shelf.
> power-supply-list |  | power-supply-info[] optional | Information on installed power supplies in the shelf.
> ses-generic-info |  | ses-generic-info | Generic SES (scsi enclosure services) information.
> shelf-id |  | integer | Shelf number. Range: [0-255]
> shelf-status |  | string | Current shelf status. Possible values: "unrecoverable", "critical", "non_critical", "informational", "normal".
> shelf-type |  | string | Shelf type. Possible values: "edm", "vem", "esp", "lrc", "lrc2", "esh", "esh2", "esh4", "eshfx", "emu", "efh", "at_fc", "at_fc2", "at_fcx", "at_fcx2".
> status-reads-attempted |  | integer | Number of times attempted to read shelf status. Range [0..2^32-1]
> status-reads-failed |  | integer | Number of times failed to read shelf status. Range [0..2^32-1]
> temp-sensor-list |  | temp-sensor-info[] optional | Information on installed temperature sensors in the shelf.
> xyratex-specific-info |  | xyratex-specific-info optional | Vendor specific enclosure system information for Xyratex shelves.

Element definition: ariodata-specific-info | [top]

> Vendor specific enclosure system information for Ariodata shelf.

> Name | Range | Type | Description
> ariodata-serial-no |  | string | Serial number for Ariodata shelf.

Element definition: bay-info | [top]

> A list of shelf bay numbers which have disks.

> Name | Range | Type | Description
> lun |  | integer optional | The logical unit number within the target. This field will be present in some storage configurations. In some cases, devices with a logical unit number will have LEDs that can be affected. Range : [0..255]
> shelf-bay |  | integer | A shelf-bay number indicates the presence of a drive in that bay. Shelf bays are numbered starting at 0 which is the right most drive bay in the shelf when viewing the shelf from the front. Range: [0..255]

Element definition: cooling-element-info | [top]

> Information on individual cooling elements (fans).

> Name | Range | Type | Description
> cooling-element-is-error |  | boolean optional | Indicated whether cooling elements has failed or reported any errors.
> cooling-element-is-not-installed |  | boolean optional | Indicates the cooling elements is not installed. This will only be presented if the element is missing, and no further data for this element will be available.
> cooling-element-number |  | integer | Cooling element number. Range [0..255]

Element definition: es-electronics-info | [top]

> Information on the installed enclosure services electronics.

> Name | Range | Type | Description
> es-electronics-element-no |  | integer | Enclosure services electronics element number. Range [0..255]
> es-electronics-is-error |  | boolean optional | indicates whether this enclosure services electronics has reported any errors.
> es-electronics-is-not-installed |  | string optional | Indicates this enclosure services electronics is not installed. This will only be presented when the element is missing, no further data for this element will be presented.
> es-electronics-is-reporting-element |  | boolean optional | Indicated whether this is the element reporting. Even though there might be more than one element installed, only will be reporting at any time.
> es-electronics-serial-no |  | string optional | Serial number for the enclosure services electronics.
> esh-list |  | esh-info[] optional | Information on attached embedded switched hub, if any.

Element definition: eurologic-specific-info | [top]

> Vendor specific enclosure system information for Eurologic shelf.

> Name | Range | Type | Description
> eurologic-application-version |  | string | Application version for Eurologic shelf.
> eurologic-backplane-byte |  | string | Backplane byte for Eurologic shelf.
> eurologic-backplane-function |  | string | Backplane function for Eurologic shelf.
> eurologic-backplane-id |  | string | Backplane identifier for Eurologic shelf.
> eurologic-cabinet-id |  | string | Cabinet id for the Eurologic shelf.
> eurologic-kernel-version |  | string | Kernel version for Eurologic shelf.
> eurologic-serial-no |  | string optional | Serial number for the Eurologic shelf.

Element definition: power-supply-info | [top]

> Power supply information

> Name | Range | Type | Description
> power-supply-element-number |  | integer | Element number the power supply. Range [0..255]
> power-supply-is-error |  | boolean optional | Indicates whether the power supply has reported any errors.
> power-supply-is-not-installed |  | boolean optional | Indicates the power supply for this element is not installed. This will only be presented if the power supply is missing, in which case no further information for the element will be available.
> power-supply-serial-no |  | string optional | Power supply serial number.

Element definition: ses-generic-info | [top]

> Generic SES (scsi enclosure services) information.

> Name | Range | Type | Description
> ses-config-access |  | string optional | The method shelf configuration was obtained. Possible values: "via_embedded_ses", "via_scsi_from_shelf", "via_loop_from_shelf", "not_available".
> ses-config-access-shelf-id |  | string optional | If ses-config-access is either "via_SCSI_from_shelf" or "via_loop_from_shelf" then this would be the shelf id of the device the configuration was obtained from.
> ses-config-access-source-id |  | integer optional | If ses-config-access is either "via_scsi_from_shelf" or "via_loop_from_shelf" then this would be the SCSI or loop id of the device that the configuration was obtained from.
> ses-logical-id |  | string | Enclosure logical identifier.
> ses-product-id |  | string optional | Enclosure product identifier. Not available on all shelf types.
> ses-product-revision |  | string | Enclosure product revision.
> ses-vendor-id |  | string | Enclosure vendor identifier.

Element definition: temp-sensor-info | [top]

> information on the temperature sensors installed in the shelf.

> Name | Range | Type | Description
> temp-sensor-current-condition |  | string optional | Current temperature condition for this sensor. One of: "under_temperature_warning", "under_temperature_failure", "over_temperature_warning", "over_temperature_failure", "normal_temperature_range".
> temp-sensor-current-temperature |  | integer optional | Current temperature reading in degrees Celsius. Range [0..255]
> temp-sensor-element-no |  | integer | Element number for the temperature sensor. Range [0..255]
> temp-sensor-hi-critical |  | integer | High critical temperature in degree Celsius. Range [0..255]
> temp-sensor-hi-warning |  | integer | High warning temperature in degree Celsius. Range [0..255]
> temp-sensor-is-ambient |  | boolean optional | Indicates whether the temp-sensor-current-temp is the ambient temperature.
> temp-sensor-is-error |  | boolean optional | Indicates whether the sensor has indicated an error in temperature.
> temp-sensor-is-not-installed |  | string optional | Indicates the sensor for this element is not installed. This will only be presented if the sensor is missing, and no further data for this sensor will be presented.
> temp-sensor-low-critical |  | integer | Low critical temperature in degree Celsius. Range [0..255]
> temp-sensor-low-warning |  | integer | Low warning temperature in degree Celsius. Range [0..255]

Element definition: xyratex-specific-info | [top]

> Vendor specific enclosure system information for Xyratex shelf.

> Name | Range | Type | Description
> xyratex-option-setting |  | string | Option setting for the Xyratex shelf.
> xyratex-serial-no |  | string | serial number for Xyratex shelf.

Element definition: esh-info | [top]

> Information on individual ESH modules in the shelf.

> Name | Range | Type | Description
> esh-element-no |  | integer | ESH element number of installed ESH module Range [0..255]
> esh-is-error |  | string | Indicates whether the ESH module has reported any errors.