APIs in Category: storage-array | Cluster-Mode API version 1.21

storage-array-get-config-summary storage-array-list-info storage-array-modify storage-array-port-modify storage-array-ports-list-info storage-array-rename | Storage arrays are external units that supply storage to NetApp systems. These APIs allow us to define, manipulate and map the storage arrays to the services they provide.

NetApp Manage ONTAP

storage-array-get-config-summary | [top]

> Generates a high level summary of array LUN pathing (connectivity) information.

> Input Name | Range | Type | Description
> node |  | string optional | Obtain array LUN pathing information for a specified node.
> ownership-type |  | string optional | Option that allows the user to select which array LUNs are displayed. Valid values for ownership-type are 'assigned', 'unassigned' and 'all'. If ownership-type is set to 'assigned' only assigned array LUNs are displayed. If ownership-type is set to 'unassigned' only unassigned array LUNs are displayed. If ownership-type is set to 'all', all array LUNs are displayed. Default: 'all'.
> Output Name | Range | Type | Description
> config-summary |  | storage-array-config-summary[] optional | A summary of array LUN connectivity for each attached array.

> Errno | Description
> EINTERNALERROR |  |

storage-array-list-info | [top]

> Retrieves a list of all array profiles known to the controller.

> Input Name | Range | Type | Description
> array-name |  | string optional | When specified, only the named array profile record will be returned. (28 chars)
> Output Name | Range | Type | Description
> array-profiles |  | storage-array-profile[] | A list of arrays (and their details)

> Errno | Description
> EINTERNALERROR |  |
> EARRAYNOTFOUND |  |

storage-array-modify | [top]

> Update an array profile with new or changed information.

> Input Name | Range | Type | Description
> array-name |  | string | The name of the array profile to update. (28 chars max)
> is-upgrade-pending |  | boolean optional | Used to indicate that the specified array will under go an upgrade in the near future.
> lun-queue-depth |  | integer optional | The queue depth assigned to array LUNs from this array.
> max-queue-depth |  | integer optional | The target port queue depth for all target ports on this array.
> model |  | string optional | The model of the array. (16 chars max)
> options |  | string optional | Array profile specific options. (comma separated list of name/value pairs) (127 chars max)
> prefix |  | string optional | A unique user supplied 4 character code used to refer to this array and used in naming the array's LUNs.
> vendor |  | string optional | The name of the array's manufacturer. (8 chars max)

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

storage-array-port-modify | [top]

> Update an array port with new or changed information.

> Input Name | Range | Type | Description
> array-name |  | string | The name of the array profile to update. (28 chars max)
> max-queue-depth |  | integer optional | The target port queue depth for this target port.
> wwnn |  | string | World wide node name of array's target port (64 chars).
> wwpn |  | string | World wide port name of array's target port (64 chars).

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

storage-array-ports-list-info | [top]

> generate a list of online array ports and their associated arrays

> Input Name | Range | Type | Description
> array-name |  | string optional | When supplied, only port records for the named array are returned. (28 chars)
> Output Name | Range | Type | Description
> array-ports |  | storage-array-port[] optional | A list of all array ports, or just the ports for the named array

> Errno | Description
> EINTERNALERROR |  |
> EARRAYNOTFOUND |  |

storage-array-rename | [top]

> Rename an array profile

> Input Name | Range | Type | Description
> array-name |  | string | The name of the array profile to update. (28 chars max)
> new-name |  | string | The new name to assign to this array profile. (28 chars max)

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

Element definition: storage-array-config-summary | [top]

> A summary of array LUN connectivity for each attached array.

> Name | Range | Type | Description
> array-name |  | string | The name assigned to the array this group of array LUNs is exported from. 28 character string, no spaces.
> device-type |  | string optional | Type of LUN device. Describes the type of lun device or tape library. Possible Values are: "array_lun" - Array LUN type "tape_mc" - Tape Drive or Media Changer/library type "unknown" - Unknown device type
> group-number |  | integer | A unique number associated with a set of array LUNs that share the exact same pathing/connectivity information. Range: [0..65535]
> initiator-port |  | string | Initiator port name, e.g. 0a.
> lun-count |  | integer | The number of array LUNs assigned to this group. Range: [0..65535]
> switch-port |  | string | Name of switch port connected to the HBA (controller's initiator port), or UNKNOWN if direct attached.
> target-side-switch-port |  | string | Name of switch port connected to target array, or UNKNOWN if direct attached.
> target-wwpn |  | string | World wide port name of array's target port (64 chars).

Element definition: storage-array-port | [top]

> Maps array definition to target port

> Name | Range | Type | Description
> array-id |  | integer | Primary key (system defined) for the array record. Range: [0..2^64-1]
> array-name |  | string | Name of the array in the array record. (28 char max)
> connection-type |  | string optional | Describes the type of connection between the controller and the back end storage. Possible values are: "direct" - Direct Attached "fabric" - Fabric Attached
> max-queue-depth |  | integer optional | The target port queue depth for this target port. Range: [0..2048]
> port-stat-info |  | storage-array-port-stats[] optional | Contains statistics about each array port.
> switch-port |  | string optional | For fabric attached connections, the switch port the array target port is connected to. N/A for direct attached.
> target-port-speed |  | string optional | The speed that the target port has negotiated with its connected switch port, or initiator port if direct attached.
> wwnn |  | string | World wide node name of array's target port (64 chars).
> wwpn |  | string | World wide port name of array's target port (64 chars).

Element definition: storage-array-profile | [top]

> data describing characteristics/parameters of/about a storage array

> Name | Range | Type | Description
> affinity |  | string | Describes the affinity model supported by the array. Possible values are: "none" - None "aaa" - Active/Active Asymmettric "ap" - Active/Passive "mixed" - This array is presenting different affinity models to different controllers within the cluster.
> array-id |  | integer | primary key (system defined) for the array record. Range: [0..2^64-1]
> errors |  | storage-array-error-info[] optional | A list of all errors for the requested array.
> firmware |  | string | The firmware revision of the array. (64 chars max)
> is-upgrade-pending |  | boolean | The is-upgrade-pending status for the array.
> lun-queue-depth |  | integer | The default queue depths assigned to array LUNs from this array. Range: [3..32]
> max-queue-depth |  | integer | The target port queue depth for all target ports on this array. Range: [8..2048]
> model |  | string | The model name of the array. (16 chars max)
> name |  | string | A unique node-level user supplied name for the array. (28 char max)
> network-address |  | string | IP address/node name of the array's SNMP management port. (1024 char max)
> optimization-policy |  | string | Describes the I/O optimization policy used by this array. Possible values are: "ialua" - The array supports iALUA. "ealua" - The array supports eALUA. "symmetric" - All ports on the array will be treated equally. "proprietary" - A vendor specific optimization is supported for this array. "mixed" - This array supports multiple optimization policies, one per node. "unknown" - No known optimization method is supported for this array (will be treated as if Symmetric)
> options |  | string | A comma separated list of name value pairs of array specific settings. (128 chars max)
> port-failover-type |  | string | The pathing failover supported by the array, either ACTIVE-ACTIVE or ACTIVE-PASSIVE.
> prefix |  | string | A unique user supplied 5 character code used to refer to this array and used in naming the array's LUNs.
> serial-number |  | string | The serial number of the array. (17 char max)
> vendor |  | string | The name of the array's vendor, e.g. NetApp. (8 chars max)

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

> Contains error messages associated with array.

> Name | Range | Type | Description
> 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 |  | string | Enum describing type of error. ARRAY_INCONSISTENT_LUN_ADDRESSING_METHOD - 1. Array is using inconsistent LUN addressing schemes. ARRAY_DEVTYPE_ERROR - 2. Array has encountered a device class error.

Element definition: storage-array-port-stats | [top]

> Contains statistics about an array port.

> Name | Range | Type | Description
> average-latency-per-iop |  | integer | The average latency for I/O operations performed by this controller on this target port. Range: [0..2^32-1]
> average-pending |  | integer | An average over time of how many commands are on the outstanding queue. Range: [0..2^32-1]
> average-waiting |  | integer | An average over time of how many commands are on the waiting queue. Range: [0..2^32-1]
> initiator-port |  | string | Initiator port name, e.g. 0a.
> max-pending |  | integer | The largest number of commands observed on the outstanding queue. Range: [0..2^32-1]
> max-waiting |  | integer | The largest number of commands observed on the waiting queue. Range: [0..2^32-1]
> node |  | string | Node name of array's target port.
> path-link-errors |  | integer | Number of link errors reported on the path. Range: [0..2^32-1]
> percent-busy |  | integer | The percentage of time I/Os are outstanding on the port. Range: [0..100]
> percent-waiting |  | integer | The percentage of time there are I/Os waiting on the waiting queue on the target port. Range: [0..100]
> 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]