APIs in Category: fcp-target | API version 3.8

fcp-target-list-info-iter-end fcp-target-list-info-iter-next fcp-target-list-info-iter-start | List FCP target information stored in DFM Server database.

NetApp Manage ONTAP

fcp-target-list-info-iter-end | [top]

> Ends iteration of targets.

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous fcp-target-list-info-iter-start.

> Errno | Description
> EINVALIDTAG |  |

fcp-target-list-info-iter-next | [top]

> Get next set of records in the iteration started by call to fcp-target-list-info-iter-start. This zapi will fetch the fcp target info records. The input param 'maximum' specifies the number of records it will show at a time.

> Input Name | Range | Type | Description
> maximum |  | integer | Maximum records to retrieve. Range: [1..2^31-1]
> tag |  | string | Tag from a previous fcp-target-list-info-iter-start.
> Output Name | Range | Type | Description
> records |  | integer | The number of records actually returned. Value of 0 records indicates that end of records. Range: [1..2^31-1]
> targets |  | target-info[] | List of targets.

> Errno | Description
> EINVALIDTAG |  |

fcp-target-list-info-iter-start | [top]

> Start iteration of targets.Depending on the input it will return a tag and the number of records to be retrieved.

> Input Name | Range | Type | Description
> object-name-or-id |  | obj-name-or-id optional | Name or Id of the following objects. FCPTarget Storage System If Storage System name or Id is specified only the FCP targets discovered on the Storage System are returned. The name of the FCP target should be specified in : format. Ex: storage01:0c_2 If no object-name-or-id is present in the input all the fcp targets will be fetched.
> Output Name | Range | Type | Description
> records |  | integer | Number of records fetched and stored for retrieval using fcp-target-list-info-iter-next. Range: [1..2^31-1]
> tag |  | string | Tag to be used for subsequent calls.

> Errno | Description
> EACCESSDENIED |  |
> EOBJECTNOTFOUND |  |
> EDATABASEERROR |  |
> EINVALIDINPUTERROR |  |
> EOBJECTAMBIGUOUS |  |

Element definition: obj-name-or-id | [top]

> Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI type string. An obj-name-or-id must contain between 1 and 64 characters, and must conform to one of the following formats: It must have the format of an obj-name, or It must be the decimal numeric string form of a positive integer whose value is in the range [1..2^31 - 1]. Elements of type obj-name-or-id are used only as inputs to ZAPIs. The value must match either the name or internal ID of an existing DFM object. The ZAPI must specify the object's DFM object type (e.g. dataset, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the format of an obj-name-or-id input element does not conform, or the value does not match the name or ID of an existing object, then generally the ZAPI documents that it fails with error code EOBJECTNOTFOUND. A ZAPI may return more specific error codes. In such cases, the ZAPI specification must document its behavior. If a ZAPI can accept a null value (e.g. reference to no object at all) for such an element, then the element is declared optional, and the absence of the input element represents a null value.

> [none]

Element definition: target-info | [top]

> Information of about one target.

> Name | Range | Type | Description
> host-id |  | obj-id | Identifier of the Storage System on which the target is present.
> host-name |  | string | DNS name of the Storage System on which the target is present.
> target-id |  | obj-id | Identifier of target in DFM Server database.
> target-name |  | obj-name | Name of the target (ex: 0c).
> target-port-name |  | string | WWPN of the target.
> target-status |  | string | Operation status of the target,Possible values: "startup","uninitialized","initializing_fw", "link_not_connected","waiting_for_link_up", "online","link_disconnected","resetting", "offline","offlined_by_user_system", "unknown".

Element definition: obj-id | [top]

> Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed to be 0, which is interpreted as a null value, e.g., a reference to no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed to assign an ID to an object. Therefore, an input element of type obj-id is always used to refer to an existing object by its ID. The ZAPI must specify the object's DFM object type (e.g. dataset, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the value of an obj-id input element does not match the ID of any existing DFM object of the specified type or types, then typically the ZAPI fails with error code EOBJECTNOTFOUND. A ZAPI may deviate from this general rule, for example, it may return a more specific error code. In either case, the ZAPI specification must document its behavior.

> [none]

Element definition: obj-name | [top]

> Name of a DFM object. This typedef is an alias for the built in ZAPI type string. An object name must conform to the following format: It must contain between 1 and 64 characters. It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9'). In some contexts, a name may be the empty string (""), which is interpreted as a null value, e.g., a reference to no object at all. The behavior of a ZAPI when it encounters an error involving an obj-name input element depends on how the ZAPI uses the input element. Here are the general rules: If the input name element is used to create a new object with the given name, or rename an existing object to that name, and the name does not conform to the above format, then the ZAPI fails with error code EINVALIDINPUTERROR. Note that because EINVALIDINPUTERROR is such a common error code, ZAPI specifications are not required to document cases when they may return it. If the input name element is used to refer to an existing object with that name, and there is no object with that name, then the ZAPI fails with error code EOBJECTNOTFOUND. Generally the ZAPI specification documents cases when it may return this error code. A ZAPI may deviate from these general rules, for example, it may return more specific error codes. In such cases, the ZAPI specification must document its behavior. If an input name element is used to refer to an existing object, then the ZAPI specification must specify which DFM object type (e.g. data set, host, DP policy, etc.) is allowed. Some ZAPIs allow the object to be one of several different types. See the description of obj-full-name for examples of valid input formats. Note that there is no requirement that all object names must be unique. However, the names for some specific types of objects are constrained such that no two objects of that type may have the same name. For example, this constraint applies to datasets, DP schedules, and DP policies. This means that no two datasets may have the same name, but a dataset may have the same name as a DP schedule or DP policy. In general, object names are compared in a case-insensitive manner. This means that, for example, "MyObject" and "MYOBJECT" are considered to be the same name for purposes of: creating new objects, renaming existing objects, or looking up an object by name. On the other hand, ZAPIs that return an obj-name generally do not change the capitalization at all. For example, if an object's name has been set to "MyObject", then list iteration ZAPIs that return the object's name return it as "MyObject" rather than "MYOBJECT" or "myobject". ZAPIs that operate on obj-name values and do not follow these general rules about case sensitivity must document the rules that they do follow. One important exception to these general rules is that volumes, qtrees, OSSV directories, SRM paths, interfaces, FCP targets and FC switch ports all have case-sensitive names. When looking up objects of these types by name, the case must match the object name.

> [none]