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

storage-array-get-config-summary storage-array-list-info storage-array-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[] | 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. (29 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. (29 chars max)
> 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-ports-list-info | [top]

> generate a list of 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. (29 chars)
> Output Name | Range | Type | Description
> array-ports |  | storage-array-port[] | 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. (29 chars max)
> new-name |  | string | The new name to assign to this array profile. (29 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. 29 character string, no spaces.
> 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.
> 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. (29 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)