APIs in Category: storage-initiator | Cluster-Mode API version 1.15

storage-initiator-balance storage-initiator-disk-path-list-info storage-initiator-errors-list-info storage-initiator-get-load storage-initiator-path-list-info storage-initiator-path-quiesce storage-initiator-path-resume | These APIs are used to get information on initiator ports as related to their role as a gateway to back end storage.

NetApp Manage ONTAP

storage-initiator-balance | [top]

> Balances primary/secondary array LUN paths across available initiator ports based on I/O load.

> Input Name | Range | Type | Description
> node |  | string | node to balance initiator ports on

> Errno | Description
> EINTERNALERROR |  |

storage-initiator-disk-path-list-info | [top]

> Returns path information and statistics for a given disk or all disks. We use the word disk to refer to an array lun, real disk, or Solid State Device

> Input Name | Range | Type | Description
> disk-name |  | string optional | The name of the disk to list path information for. If not supplied all paths to all attached targets are returned.
> Output Name | Range | Type | Description
> disk-path-info |  | disk-path-info[] | A table of per path statistics, errors and other related data for this disk

> Errno | Description
> EINTERNALERROR |  |
> EDISKNOTFOUND |  |

storage-initiator-errors-list-info | [top]

> Lists all known disk/configuration errors associated with an array or shelves acting like array.

> Input Name | Range | Type | Description
> array-name |  | string optional | The name of the array to list error information for. (29 chars)
> disk-name |  | string optional | The name of the disk or array lun to list error information for. If not specified, all errors for all disks/array LUNs will be returned.
> Output Name | Range | Type | Description
> errors |  | storage-error-info[] | A list of all errors for the requested array/shelf or disks/luns.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EARRAYNOTFOUND |  |
> EDISKNOTFOUND |  |

storage-initiator-get-load | [top]

> Gets disk I/O rates for a given fibre channel initiator port or for all initiator ports if no port is specified. The term disk refers to an array LUN, actual disk, or solid state device.

> Input Name | Range | Type | Description
> node |  | string optional | Obtain disk I/O rates for initiator ports on the specified node.
> port |  | string optional | Port to show load on, e.g. 0a.
> Output Name | Range | Type | Description
> load-info |  | storage-initiator-load-info[] | A table of per disk load related information for the named port.

storage-initiator-path-list-info | [top]

> Returns information and statistics on all known paths to back end storage.

> Input Name | Range | Type | Description
> node |  | string optional | Obtain back end storage path statistics for this node.
> Output Name | Range | Type | Description
> path-info |  | storage-initiator-path-info[] optional | A table of back end path statistics, errors and other related data.

> Errno | Description
> EINTERNALERROR |  |

storage-initiator-path-quiesce | [top]

> Quiesces an array LUN on a path. A quiesced array LUN will not be sent I/O on the specified path.

> Input Name | Range | Type | Description
> initiator |  | string | The initiator port of the path that I/O will be quiesced on.
> lun-number |  | integer | LU number. Range: [0..65535]
> node |  | string | The node name on which the quiesce is issued
> target-wwpn |  | string | The array target port of the path that I/O will be quiesced on. World wide port number has to be specified without colons.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDPATH |  |
> ECANTQUIESCELASTPATH |  |
> EDISKNOTFOUND |  |
> EINVALIDTARGET |  |
> EQUIESCEFAILED |  |
> ELUNQUIESCING |  |
> EQUIESCENOTSUPPORTED |  |

storage-initiator-path-resume | [top]

> Resumes I/O to array LUN on a path that was previously quiesced. Resuming I/O to a non-quiesced array LUN is a no-op and not an error.

> Input Name | Range | Type | Description
> initiator |  | string | The initiator port of the path that I/O will be resumed to.
> lun-number |  | integer | LU number. Range: [0..65535]
> node |  | string | The node name on which the resume is issued
> target-wwpn |  | string | The array target port of the path that I/O will be resumed to. World wide port number has to be specified without colons.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDPATH |  |
> EDISKNOTFOUND |  |
> EINVALIDTARGET |  |
> ERESUMEFAILED |  |

Element definition: disk-path-info | [top]

> Contains per path statistics, errors and other related data.

> Name | Range | Type | Description
> array-name |  | string | The name of the array providing the lun.
> disk-name |  | string | The name of the disk this path information is for
> disk-port |  | string optional | Disk port associated with this path. Possible values are "A" or "B". Omitted for non-disk target.
> disk-port-name |  | string optional | Disk port name associated with this path. This has the form <attachment-style>:<disk-port>, where <attachment-style> is either "FC" for FibreChannel, or "SA" for SAS, and <disk-port> is either "A" or "B". Omitted for non-disk target. Possible values: "FC:A" "FC:B" "SA:A" "SA:B"
> disk-uid |  | string | Disk's UID, as supplied by the hardware, used to uniquely identify this disk.
> initiator-io-kbps |  | integer | Rolling average of kilobytes per second read and written over this initiator port. Range: [0..2^64-1]
> initiator-iops |  | integer | Rolling average of I/O operations per second read and written over this initiator port. Range: [0..2^64-1]
> initiator-lun-in-use-count |  | integer | Number of LUNs in the IN-USE state on this initiator. Range: [0..2^64-1]
> initiator-port |  | string | Initiator port name, e.g. 0a.
> initiator-port-speed |  | string | The speed that the initiator port has negotiated with its connected switch, or target port if direct attached.
> initiator-side-switch-port |  | string | The name of the switch connected to the controller's initiator port, or N/A when using direct attach
> lun-io-kbps |  | integer | Rolling average of kilobytes per second read and written to this LUN. Range: [0..2^64-1]
> lun-iops |  | integer | Rolling average of I/O operations per second read and written to this LUN. Range: [0..2^64-1]
> lun-number |  | integer | LU number. Range: [0..65535]
> lun-path-use-state |  | string | ONTAP's use of this path INU - (In Use) This path is currently used for I/O. RDY - (Ready) This path is not being used for I/O currently, but might transition to INU if storge errors or load balancing cause it to transition to INU. ERR - (High Error) The weighted error total on this path is 20% or more of the error threshold. Load balancing will not use it, and the error handling code will only use it as a last resort. QNG - (Quiescing) : The disk is becoming quiesced on this path. QED - (Quiesced) : The disk is quiesced on this path.
> node |  | string | Controller with the initiator port for this path.
> path-io-kbps |  | integer | Rolling average of kilobytes per second read and written to this path. Range: [0..2^64-1]
> path-iops |  | integer | Rolling average of I/O operations per second read and written to this path. Range: [0..2^64-1]
> path-link-errors |  | integer | Number of link errors reported on the path. Range: [0..2^32-1]
> path-lun-in-use-count |  | integer | Number of LUNs in the IN-USE state on this path. Range: [0..2^64-1]
> path-quality |  | integer | The percentage of the error threshold. 0% NO ERROR 1-20% LOW ERROR, available to load balancing and error retry code. 21-99% MEDIUM ERROR, load balancing and error retry code will not switch to this path. 100-? HIGH_ERROR, Excessive errors EMS event will be logged Range: [0..2^32-1]
> target-io-kbps |  | integer | Rolling average of kilobytes per second read and written to this target port. Range: [0..2^64-1]
> target-iops |  | integer | Rolling average of I/O operations per second read and written to this target port. Range: [0..2^64-1]
> target-lun-in-use-count |  | integer | Number of LUNs in the IN-USE state on this target port. Range: [0..2^64-1]
> target-port-access-state |  | string | failover optimization type
> target-side-switch-port |  | string | Name of the switch port connected to the target array, or UNKNOWN if direct attached.
> target-wwpn |  | string | World Wide Port Name of target port providing the disk.
> tpgn |  | integer | The Target Port Group Number of the array's target port. Range: [0..2^64-1]

Element definition: storage-error-info | [top]

> Contains error messages associated with back end array/shelf/LUNs.

> Name | Range | Type | Description
> array-name |  | string | Name of the array/shelf with the configuration error.
> disk-name |  | string | The name of the disk or array lun this error information is for.
> disk-uid |  | string | Disk's UID, as supplied by the hardware, used to uniquely identify this disk.
> error-id |  | integer | A unique ID for each error returned. ID is unique on a per API call basis only. Range: [0..2^32-1]
> error-text |  | string | A description of the error being reported.
> error-type |  | integer | Enum describing type of error. Range: [0..2^32-1] MLM_ET_DEVICE_ONE_PATH - 1. Redundancy error, less than two paths to a disk. MLM_ET_DEVICE_ONE_DOMAIN - 2. Redundancy error, device is only accessible via a single fault domain, all paths go into the same target port group. MLM_ET_DEVICE_CONTROL - 3. Device is a control LUN. MLM_ET_DEVICE_TOO_BIG - 4. LUN too large, A LUN has been detected that is larger than the maximum size supported. MLM_ET_DEVICE_TOO_SMALL - 5. LUN too small, A LUN has been detected that is smaller than the minimum size supported. MLM_ET_DEVICE_INVALID_BS - 6. Invalid Block Size, A LUN has been detected that has an unsupported block size. MLM_ET_TARGET_ASYM_MAP - 7. A target port is accessable via multiple HBAs but the device to LUN id mappings aren't the same. MLM_ET_DEVICE_ASYM_MAP - 8. A device is presented at different LUN ids on different ports.
> lun-serial-number |  | string | The serial number of the lun the error occurs on, blank if the error is not lun related.
> node |  | string | The nodename reporting the disk or array lun with the error.

Element definition: storage-initiator-load-info | [top]

> Contains per port per disk load information.

> Name | Range | Type | Description
> initiator-port |  | string | Initiator port name, e.g. 0a. If port is not specified, data for all ports is returned.
> io-count |  | integer | Megabytes of data sent to this disk over this port. Range: [0..2^32-1]
> lun-number |  | integer | Logical Unit Number. Range: [0..65535]
> nodename |  | string | IP address of the node serving the port in dotted-decimal format (for example, "192.168.11.12").
> percent-io |  | string | Percentage of all I/O on this port sent to this disk. Range: [0..100]
> serial-number |  | string | Disk/LUN serial number. Maximum length of 129 characters.
> switch-name |  | string | The name of the switch connected to the controller's initiator port, or N/A when using direct attach.
> target-side-switch-port |  | string | Name of the switch port connected to the target array, or UNKNOWN if direct attached.
> target-wwpn |  | string | World Wide Port Name of array's target port.

Element definition: storage-initiator-path-info | [top]

> Contains per path statistics, errors and other related data.

> Name | Range | Type | Description
> array-name |  | string | The name of the array providing this path is connected to.
> initiator-io-kbps |  | integer | Rolling average of kilobytes per second read and written over this initiator port Range: [0..2^64-1]
> initiator-iops |  | integer | Rolling average of I/O operations per second over this initiator port Range: [0..2^64-1]
> initiator-lun-in-use-count |  | integer | Number of LUNs in the IN-USE state on this initiator. Range: [0..2^64-1]
> initiator-port |  | string | Initiator port name, e.g. 0a.
> initiator-port-speed |  | string | The speed that the initiator port has negotiated with its connected switch port, or target port if direct attached.
> initiator-side-switch-port |  | string | The name of the switch connected to the controller's initiator port, or N/A when using direct attach.
> path-io-kbps |  | integer | Rolling average of kilobytes per second read and written to this path. Range: [0..2^64-1]
> path-iops |  | integer | Rolling average of I/O operations per second read and written to this path. Range: [0..2^64-1]
> path-link-errors |  | integer | Number link errors reported on the path. Range: [0..2^32-1]
> path-lun-in-use-count |  | integer | Number of disks in the IN-USE state on this path. Range: [0..2^64-1]
> path-quality |  | integer | The percentage of the error threshold. 0% NO ERROR 1-20% LOW ERROR, available to load balancing and error retry code. 21-99% MEDIUM ERROR, load balancing and error retry code will not switch to this path. 100-? HIGH_ERROR, Excessive errors EMS event will be logged Range: [0..2^32-1]
> target-io-kbps |  | integer | Rolling average of kilobytes per second read and written to this target port. Range: [0..2^64-1]
> target-iops |  | integer | Rolling average of I/O operations per second read and written to this target port. Range: [0..2^64-1]
> target-lun-in-use-count |  | integer | Number of disks in the IN-USE state on this target port. Range: [0..2^64-1]
> target-side-switch-port |  | string | Name of the switch port connected to the target array, or UNKNOWN if direct attached.
> target-wwpn |  | string | World Wide Port Name of target port providing the disk.
> tpgn |  | integer | The Target Port Group Number of the array's target port. Range: [0..2^64-1]