APIs in Category: storage-array | 7-Mode API version 1.20

storage-array-get-config-summary storage-array-list-info storage-array-luns-list-info storage-array-ports-list-info storage-array-update | 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
> 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-luns-list-info | [top]

> Generate a list of array LUNs associated with the named array.

> Input Name | Range | Type | Description
> array-name |  | string | The name of the array profile to list array LUN information for. (28 chars)
> 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
> array-luns |  | disk-detail-info[] | A list of all array LUNs exported by the named array.

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

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-update | [top]

> Update an array profile with new or changed information. Arguments passed in will be used to update the profile. Arguments not passed will keep their existing values.

> Input Name | Range | Type | Description
> array-name |  | string | 28 character string, no spaces The name of the array profile to update.
> firmware |  | string optional | The firmware revision of the array being entered. (64 chars)
> model |  | string optional | The model number of the array. (16 chars)
> network-address |  | string optional | The I/O address of the array's SNMP management service in dotted-decimal format (for example, "192.168.11.12").
> new-array-name |  | string optional | 28 character string, no spaces The new name to assign to this array profile.
> options |  | string optional | Array profile specific options. (comma separated list of name/value pairs) (128 chars)
> prefix |  | string optional | A unique 5 character user defined code used to refer to this array.
> vendor |  | string optional | The name of the array's manufacturer. (8 chars)
> Output Name | Range | Type | Description
> array-profile |  | storage-array-profile | The updated array record.

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

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

> Disk status information.

> Name | Range | Type | Description
> aggregate |  | string optional | Aggregate that the disk resides on. Returned for disks contained on a flexible volume. Not returned for traditional volumes.
> bay |  | string | Disk bay. If disk bay can't be determined, value will be "?".
> blocks-read |  | integer | Number of blocks read since the controller was powered on last. Range: [0..2^64-1]
> blocks-written |  | integer | Number of blocks written since the controller was powered on last. Range: [0..2^64-1]
> broken-details |  | string optional | Reason for the disk failure, if raid-state is 'broken'. Possible values are 'unknown', 'failed', 'admin failed', 'labeled broken', 'init failed', 'admin removed', 'not responding', 'pulled', 'bad label', 'bypassed', 'SFO Disk' and 'not failed'. If raid-state is not 'broken', broken-details will be omitted in the ouput.
> bytes-per-sector |  | integer | Bytes per sector. Range : [0..2^31-1].
> checksum-compatibility |  | string | An indication of the checksum types that this disk is capable of supporting. Each possible return value represents one or more checksum types. Starting in Data ONTAP 8.1, "zoned/block" is no longer supported. Possible values are: "advanced_zoned" - Supports advanced_zoned checksum. "block" - Supports block checksum. "none" - No checksum support. "zoned/advanced_zoned" - Supports zoned and advanced_zoned checksum. "zoned/block" - Supports zoned and block checksum.
> copy-destination |  | string optional | The name of the disk selected as the destination to copy this disk when it must be replaced (is-prefailed or is-replacing is true). This element is not returned if the destination is not selected. The destination might not be present even when is-prefailed or is-replacing is true, if there is no appropriate spare, or other disk copy is in progress, or the destination was not yet selected, including immediately after disk-replace-start.
> copy-percent |  | integer optional | Percent of disk copy done, if disk is involved in Rapid RAID Recovery, either as the source (is-prefailed or is-replacing is true) or as the destination (raid-state is 'copy') of disk copy. This element is not returned if the destination is not selected yet. Range : [0..100].
> disk-model |  | string | Disk model.
> disk-type |  | string | Type of disk: ATA, BSAS, EATA, FCAL, FSAS, LUN, MSATA, SAS, SATA, SCSI, SSD, XATA, XSAS, or unknown.
> disk-uid |  | string | Disk unique identifier. Maximum length of 90 characters.
> effective-disk-type |  | string | Disks with same effective-disk-type are compatible, and they can be used in the same aggregate, even though their physical disk type, as reported by disk-type may be different. Possible values are the same as for disk-type: ATA, BSAS, EATA, FCAL, FSAS, LUN, MSATA, SAS, SATA, SCSI, SSD, XATA, XSAS, or unknown.
> firmware-revision |  | string | Firmware revision of disk. The format of the firmware revision will vary depending on the type of disk and its vendor.
> grown-defect-list-count |  | integer | Number of entries in the drive's grown defect list. Range: [0..2^64-1]
> host-adapter |  | string | Host adapter.
> id |  | integer | internal Id of disk. Range : [-2^31..2^31-1].
> is-dynamically-qualified |  | boolean | True if the drive was dynamically qualified.
> is-offline |  | boolean optional | True if the disk is offline. If the disk is not offline, this element will not be included with the output.
> is-prefailed |  | boolean optional | True if the disk is prefailed and undergoing disk copy (as the source) or waiting for such disk copy to be started, false otherwise.
> is-replacing |  | boolean optional | True if the disk is marked to be replaced with another disk and undergoing disk copy (as the source) or waiting for such disk copy to be started, false otherwise.
> is-zeroed |  | boolean optional | True if the disk is a spare and has already been zeroed, false otherwise. If disk is not a spare or if it is currently being zeroed, this element will not be included with the output.
> name |  | string | Name of the disk, e.g. v1.1
> node |  | string | Controller supplying this disk record.
> physical-blocks |  | integer | Number of 512-byte blocks on disk. Range : [0..2^64-1].
> physical-space |  | integer | Physical disk size in bytes. Range : [0..2^64-1].
> plex |  | string optional | Plex the disk belongs. Not returned if disk doesn't belong to any plex. Example : plex0.
> pool |  | string optional | Pool the disk is in. Example : pool0.
> port |  | string | Port of disk, e.g. A.
> port-name |  | string | The port name of the disk object, e.g. FC:A.
> poweron-hours |  | integer optional | Number of hours the drive has been powered on. Range: [0..2^64-1]
> raid-group |  | string optional | Raid group disk belongs. Not returned if disk doesn't belong to any raid group.
> raid-state |  | string | Raid state. Possible values are : partner, broken, zeroing, spare, copy, pending, reconstructing, present and unknown.
> raid-type |  | string | Raid type. Possible values are : pending, parity, dparity, data, and unowned.
> raw-disk-sectors |  | integer | Number of sectors on disk (as reported by the read capacity command). Range: [0..2^64-1].
> reconstruction-percent |  | integer optional | Percent of reconstruction done, if the disk is undergoing reconstruction (raid-state is 'reconstructing'). This element is not returned if the disk is not being reconstructed. Range : [0..100].
> rpm |  | integer optional | Rotational speed in revolutions per minute. Possible values are: 5400, 7200, 10000, and 15000. This element is not returned when the value is not known, or when it does not apply.
> scrub-count |  | integer | Number of times the drive was scrubbed since the controller was powered on last. Range: [0..2^64-1]
> scrub-last-done |  | integer | Number of seconds since the last time scrub was completed. Range: [0-2^64-1]
> secondary-host-adapter |  | string | Secondary Host adapter.
> secondary-name |  | string | Secondary name.
> secondary-port |  | string | Secondary port.
> serial-number |  | string | Disk serial number. Maximum length of 129 characters.
> shelf |  | string | Disk shelf. If disk shelf can't be determined, value will be "?".
> shm-time-interval |  | integer | Number of seconds we have been counting errors from SHM (Storage Health Monitor). Range: [0..2^64-1]
> ssd-info |  | storage-ssd-info optional | Info block for solid-state storage devices.
> used-blocks |  | integer | Number of 512-byte blocks used. Range : [0..2^64-1].
> used-space |  | integer | Used space in bytes. Range : [0..2^64-1].
> v-series-detail-info |  | v-series-detail-info optional | Lists LUN status from RAID array LUNs
> vendor-id |  | string | Vendor of this disk.
> volume |  | string optional | Volume the disks is used in. Not returned if disk isn't used in any volume or if the disk belongs to a partner or if the disk is in an aggregate.
> zeroing-percent |  | integer optional | Zeroing percentage done, if disk is being zeroed. Element is not returned if disk is not being zeroed. Range : [0..100].

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)
> 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
> array-id |  | integer | primary key (system defined) for the array record. Range: [0..2^64-1]
> firmware |  | string | The firmware revision of the array. (64 chars max)
> 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)
> 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-ssd-info | [top]

> Storage info block for solid-state storage devices.

> Name | Range | Type | Description
> percent-rated-life-used | [0..255] | integer optional | An estimate of the percentage of device life that has been used, based on the actual device usage and the manufacturer's prediction of device life. A value greater than 99 indicates that the estimated endurance has been consumed, but may not indicate a device failure. Omitted if value is unknown.
> percent-spares-consumed | [0..100] | integer optional | Percentage of device spare blocks that have been used. Each device has a number of spare blocks that will be used when a data block can no longer be used to store data. This value reports what percentage of the spares have already been consumed. Omitted if value is unknown.
> percent-spares-consumed-limit | [0..100] | integer optional | Spares consumed percentage limit reported by the device. Omitted if value is unknown.

Element definition: v-series-detail-info | [top]

> LUN status from RAID array LUNs

> Name | Range | Type | Description
> alternate-array-node-wwn |  | string | The RAID array LUN alternate path is the path that can be used to communicate with the LUN, but not currently used. This is the WWNN (World Wide Node Name) of the array FC port used as the secondary path.
> alternate-array-port-wwn |  | string | The RAID array LUN alternate path is the path that can be used to communicate with the LUN, but not currently used. This is the WWPN (World Wide Port Name) of the array FC port used as the secondary path.
> alternate-array-switch-port-wwn |  | string optional | The RAID array LUN alternate path is the path that can be used to communicate with the LUN, but not currently used. This is the WWN of the switch FC port connected to the array FC port used as primary path. This field is present in switch attached configrations only.
> alternate-controller-port-wwn |  | string | The RAID array LUN alternate path is the path that can be used to communicate with the LUN, but not currently used. This is the WWN of the FC port controller used as secondary path.
> alternate-lun-number |  | integer | LUN number on the alternate path Range: [0..65535]
> alternate-switch-name |  | string optional | Switch name of the alternate path. Present for switch attached configurations only.
> alternate-switch-port |  | integer optional | Switch port of the alternate path. Present for switch attached configurations only. Range: [0..1024].
> alternate-vseries-port-wwn |  | string | This is the same as alternate-controller-port-wwn, presented for backwards compatibility.
> primary-array-node-wwn |  | string | The RAID array LUN primary path is the path that is currently used to communicate with the LUN. This is the WWNN (World Wide Node Name) of the array FC port used as primary path.
> primary-array-port-wwn |  | string | The RAID array LUN primary path is the path that is currently used to communicate with the LUN. This is the WWPN (World Wide Port Name) of the array FC port used as primary path.
> primary-array-switch-port-wwn |  | string optional | The RAID array LUN primary path is the path that is currently used to communicate with the LUN. This is the WWN of the switch FC port connected to the array FC port used as primary path. This field is present in switch attached configrations only.
> primary-controller-port-wwn |  | string | The RAID array LUN primary path is the path that is currently used to communicate with the LUN. This is the WWN of the FC port controller used as primary path.
> primary-lun-number |  | integer | LUN number on the primary path Range: [0..65535]
> primary-switch-name |  | string optional | Switch name of the primary path. Present for switch attached configurations only.
> primary-switch-port |  | integer optional | Switch port of the primary path. Present for switch attached configurations only. Range: [0..1024].
> primary-vseries-port-wwn |  | string | This is the same as primary-controller-port-wwn, presented for backwards compatibility.
> product-id |  | string | Product id string of the raid array lun resides on.