APIs in Category: comment | API version 4.0

comment-field-create comment-field-destroy comment-field-list-info-iter-end comment-field-list-info-iter-next comment-field-list-info-iter-start comment-field-modify comment-field-values-list-info-iter-end comment-field-values-list-info-iter-next comment-field-values-list-info-iter-start comment-set-object-value | Management of creation, modification and deletion of comment fields, setting and unsetting of comment field values to various managed objects. Comment fields are added at the global level using comment-field-create API. Once the comment fields are created, values can be set for these new comment fields on various managed objects using comment-set-object-value API.

NetApp Manage ONTAP

comment-field-create | [top]

> Create a comment field. Error conditions: ECOMMENTFIELDALREADYEXISTS - A comment field by the same name already exists. EDATABASEERROR - A database error occurred while processing the request. EINVALIDINPUT - Invalid input was provided.

> Input Name | Range | Type | Description
> comment-field-info |  | comment-field-info | Information about the comment field.
> Output Name | Range | Type | Description
> comment-field-id |  | comment-field-id | Identifier of the newly created comment field.

> Errno | Description
> ECOMMENTFIELDALREADYEXISTS |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |

comment-field-destroy | [top]

> Destroy a comment field. Error conditions: ECOMMENTFIELDDOESNOTEXIST - A comment field by the specified id does not exist. ESYSTEMCOMMENTFIELD - An attempt was made to destroy a system comment field. EDATABASEERROR - A database error occured while processing the request.

> Input Name | Range | Type | Description
> comment-field-name-or-id |  | comment-field-name-or-id | Comment field to be destroyed.

> Errno | Description
> ECOMMENTFIELDDOESNOTEXIST |  |
> ESYSTEMCOMMENTFIELD |  |
> EDATABASEERROR |  |

comment-field-list-info-iter-end | [top]

> Terminate a list iteration that had been started by a call to comment-field-list-info-iter-start. This informs the server that it may now release any resources associated with the temporary store for the list iteration. Error conditions: EINVALIDTAG - The specified tag does not exist.

> Input Name | Range | Type | Description
> tag |  | string | The opaque handle returned by the prior call to comment-field-list-info-iter-start that started this list iteration.

> Errno | Description
> EINVALIDTAG |  |

comment-field-list-info-iter-next | [top]

> Get the next set of comment fields in the iteration started by comment-field-list-info-iter-start. Error conditions: EINVALIDTAG - The specified tag does not exist. EDATABASEERROR - A database error occurred while processing the request.

> Input Name | Range | Type | Description
> maximum |  | integer validate | The maximum number of comment fields to return. Range: [1..2^31-1].
> tag |  | string | The opaque handle returned by the prior call to comment-field-list-info-iter-start that started this list iteration.
> Output Name | Range | Type | Description
> comment-fields |  | comment-field-info[] | List of comment fields.
> records |  | integer | The number of records actually returned.

> Errno | Description
> EINVALIDTAG |  |
> EDATABASEERROR |  |

comment-field-list-info-iter-start | [top]

> Starts iteration to list all comment fields. Error conditions: ECOMMENTFIELDDOESNOTEXIST - A comment field by the specified id or name does not exist. EDATABASEERROR - A database error occured while processing the request.

> Input Name | Range | Type | Description
> comment-field-name-or-id |  | comment-field-name-or-id optional | If specified, only the specified comment field is returned. Otherwise information about all comment fields are returned.
> comment-field-object-types |  | comment-field-object-type[] optional | If specified, only the specified comment field with specified object type is returned. If not specified, then all comment fields will be returned.
> show-system-comments |  | boolean optional | Indicates whether system comment fields are returned. Default is true.
> Output Name | Range | Type | Description
> records |  | integer | Number of items present in the list iteration. Range: [0..2^31-1].
> tag |  | string | An opaque handle used to identify the list iteration. The list content resides in a temporary store in the server.

> Errno | Description
> ECOMMENTFIELDDOESNOTEXIST |  |
> EDATABASEERROR |  |

comment-field-modify | [top]

> Modify a comment field. Currently only the name of the comment field can be modified. Error conditions: ECOMMENTFIELDDOESNOTEXIST - A comment field by the specified id does not exist. ECOMMENTFIELDALREADYEXISTS - A comment field by the same name already exists. ESYSTEMCOMMENTFIELD - An attempt was made to modify a system comment field. EDATABASEERROR - A database error occured while processing the request. EINVALIDINPUT - Invalid input was provided.

> Input Name | Range | Type | Description
> comment-field-name-or-id |  | comment-field-name-or-id | Name or identifier of the comment field which has to be modified.
> comment-field-object-types |  | comment-field-object-type[] optional | Object type(s) of the comment field to be modified. If an object type of the comment field does not exist, then the new object type will be associated with the comment field. Any existing object type of the comment field that is not specified in this input will be disassociated. If the input is empty, then all object types of the comment field will be disassociated.
> new-comment-field-name |  | comment-field-name optional | New name of the comment field. May be omitted if only changing the comment field object types.

> Errno | Description
> ECOMMENTFIELDALREADYEXISTS |  |
> ECOMMENTFIELDDOESNOTEXIST |  |
> ESYSTEMCOMMENTFIELD |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |

comment-field-values-list-info-iter-end | [top]

> Terminate a list iteration that had been started by a call to comment-field-values-list-info-iter-start. This informs the server that it may now release any resources associated with the temporary store for the list iteration. Error conditions: EINVALIDTAG - The specified tag does not exist.

> Input Name | Range | Type | Description
> tag |  | string | The opaque handle returned by the prior call to comment-field-values-list-iter-start that started this list iteration.

> Errno | Description
> EINVALIDTAG |  |

comment-field-values-list-info-iter-next | [top]

> Get the next set of comment field values in the iteration started by comment-field-values-list-iter-start Error conditions: EINVALIDTAG - The specified tag does not exist. EDATABASEERROR - A database error occurred while processing the request.

> Input Name | Range | Type | Description
> maximum |  | integer validate | The maximum number of comment field values to return. Range: [1..2^31-1].
> tag |  | string | The opaque handle returned by the prior call to comment-field-values-list-iter-start that started this list iteration.
> Output Name | Range | Type | Description
> comment-field-values |  | comment-field-value[] | Comment field values.
> records |  | integer | The number of records actually returned.

> Errno | Description
> EINVALIDTAG |  |
> EDATABASEERROR |  |

comment-field-values-list-info-iter-start | [top]

> Start iteration on listing comment field values for objects. Error conditions: ECOMMENTFIELDDOESNOTEXIST - A comment field by the specified id or name does not exist. EDATABASEERROR - A database error occured while processing the request. EACCESSDENIED - The user does not have DFM.Database.Read capability on the specified object. If the object is a dataset, then the user does not have DFM.Dataset.Read on the dataset. EOBJECTNOTFOUND - The specified object was not found. EOBJECTAMBIGUOUS - The specified object name could refer to more than a single object. Use object identifiers to disambiguate.

> Input Name | Range | Type | Description
> comment-field-name-or-id |  | comment-field-name-or-id optional | If specified, the values set for various objects for the specified comment field is returned. Otherwise, list the comment field values for all comment fields.
> comment-field-object-types |  | comment-field-object-type[] optional | Object type(s) of the comment field to be returned.
> object-name-or-id |  | obj-name-or-id optional | Name or identifier of the managed object. If specified all comment field values set for that object is returned. Otherwise list the comment field values for all objects.
> Output Name | Range | Type | Description
> records |  | integer | Number of items present in the list iteration. Range: [0..2^31-1].
> tag |  | string | An opaque handle used to identify the list iteration. The list content resides in a temporary store in the server.

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

comment-set-object-value | [top]

> Set the value of a comment field for a specified managed object. Error conditions: ECOMMENTFIELDDOESNOTEXIST - A comment field by the specified id or name does not exist. EDATABASEERROR - A database error occured while processing the request. EACCESSDENIED - The user does not have DFM.Database.Write capability on the specified object. EINVALIDINPUT - The specified comment value is invalid. EOBJECTNOTFOUND - The specified object was not found or the managed object was not a supported type for setting comments. EOBJECTAMBIGUOUS - The specified object name could refer to more than a single object. Use object identifiers to disambiguate.

> Input Name | Range | Type | Description
> comment-field-name-or-id |  | comment-field-name-or-id | Name or identifier of the comment field.
> comment-value |  | comment-value | Value of the comment field. An empty string can be used to unset the value of the comment field for this object.
> object-name-or-id |  | obj-name-or-id | Name or identifier of the managed object for which the value of the comment has to be set. The supported object types for which a comment value can be set are: dataset host volume qtree lun_path quota_user resource_group aggregate srm_path resource_pool dp_policy dp_schedule dp_throttle prov_policy ossv_directory

> Errno | Description
> ECOMMENTFIELDDOESNOTEXIST |  |
> EDATABASEERROR |  |
> EACCESSDENIED |  |
> EINVALIDINPUT |  |
> EOBJECTNOTFOUND |  |
> EOBJECTAMBIGUOUS |  |

Element definition: comment-field-id | [top]

> Identifier of the comment field. Range: [1..2^31-1]

> [none]

Element definition: comment-field-info | [top]

> Information about the comment field.

> Name | Range | Type | Description
> comment-field-id |  | comment-field-id optional | Identifier of the comment field. This field is ignored on create.
> comment-field-name |  | comment-field-name | Name of the comment field. Required for create.
> comment-field-object-types |  | comment-field-object-type[] optional | Object type(s) of the comment field. If not specified, then no object type will be associated with the comment field.
> is-system-comment |  | boolean optional | Indicates whether this is a system comment field. This field is returned in list output and ignored on create. By default, this is false. System comment fields cannot be modified or destroyed.

Element definition: comment-field-name | [top]

> Name of the comment field. Name can contain a maximum of 255 characters.

> [none]

Element definition: comment-field-name-or-id | [top]

> Name or identifier of the comment field. It must conform to one of the following formats: It must be of the format of comment-field-name It must be of the format of comment-field-id

> [none]

Element definition: comment-field-object-type | [top]

> Object type of the comment field. Name can contain a maximum of 64 characters. Possible input values are 'Dataset', 'DP Policy', 'Prov Policy'.

> [none]

Element definition: comment-field-value | [top]

> A single comment field value.

> Name | Range | Type | Description
> comment-field-id |  | comment-field-id | Identifier of the comment field.
> comment-field-name |  | comment-field-name | Name of the comment field.
> comment-value |  | comment-value | Value of the comment field
> object-full-name |  | obj-full-name | Name of the managed object
> object-id |  | obj-id | Identifier of the managed object.
> object-type |  | string | Type of the managed object. Possible values: "Host" "Volume" "Resource Group" "Qtree" "Interface" "Administrator" "Network" "Mgmt Station" "Configuration" "QuotaUser" "Initiator Group" "Lun Path" "FCP Target" "Directory" "HBA" "FCP Initiator" "SAN Host Cluster" "SRM Path" "Mirror" "Aggregate" "Script" "Script Schedule" "Script Job" "Role" "Data Set" "Storage Set" "Resource Pool" "DP Policy" "DP Schedule" "DP Throttle" "OSSV Directory" "Prov Policy" "Schedule" "Report Schedule" "VFiler Template" "Disk"

Element definition: comment-value | [top]

> Value of the specified comment field to be set on the object. This can be of maximum 1024 characters.

> [none]

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: comment-field-id | [top]

> Identifier of the comment field. Range: [1..2^31-1]

> [none]

Element definition: comment-field-name | [top]

> Name of the comment field. Name can contain a maximum of 255 characters.

> [none]

Element definition: obj-full-name | [top]

> Full name of a DFM object. This typedef is an alias for the builtin ZAPI type string. An object full name conforms to all the rules of an obj-name, except that the full name may be up to 255 characters long. DFM creates full names by concatenating an object name with any parent object names, so as to create a unique name for an object. The format of full names is as follows: Host full names are the either the fully-qualified domain name or the IP address of the host. Aggregate full names are the host name and the aggregate name, separated by a colon, e.g. hostname:aggr0. Volume full names are the host name and the volume name, separated by ":/", e.g. hostname:/volume. Note this does not include "/vol". Volume and aggregate full names are distinguished by the presence of a forward slash after the colon. Qtree full names are the containing volume full name and the qtree name, separated by a slash, e.g. hostname:/volume/qtree. The data not contained by any qtree may be represented by "-", e.g. hostname:/volume/-. Lun Path full names are either a volume or qtree full name and the LUN path, separated by a slash, e.g. hostname:/volume/LUN or hostname:/volume/qtree/LUN. Network full names are a network address block in CIDR format, e.g. 1.2.3.0/8. OSSV Directory full names are the OSSV host name and the OSSV path, separated by a colon, e.g. host-lnx:/usr/local or host-w2k:c:/temp Include any others here... Initiator Group full names are host name and the initiator group name, separated by a colon, e.g. hostname:igroup. For any DFM object not listed above, the obj-name and obj-full-name are identical.

> [none]

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]