APIs in Category: Comment
 API version 5.0

 
CommentFieldCreate
CommentFieldDestroy
CommentFieldListInfoIterEnd
CommentFieldListInfoIterNext
CommentFieldListInfoIterStart
CommentFieldModify
CommentFieldValuesListInfoIterEnd
CommentFieldValuesListInfoIterNext
CommentFieldValuesListInfoIterStart
CommentSetObjectValue
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 CommentFieldCreate API. Once the comment fields are created, Values can be set for these new comment fields on various managed Objects using CommentSetObjectValue API.

NetApp Manage ONTAP API version 5.0
 
CommentFieldCreate (supported) [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 Type
CommentFieldCreate CommentFieldCreate
 
Output Name Type
CommentFieldCreateResult CommentFieldCreateResult
 Error Name  Description
 ECOMMENTFIELDALREADYEXISTS
 EDATABASEERROR
 EINVALIDINPUT

 
CommentFieldDestroy (supported) [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 Type
CommentFieldDestroy CommentFieldDestroy
 
Output Name Type
CommentFieldDestroyResult CommentFieldDestroyResult
 Error Name  Description
 ECOMMENTFIELDDOESNOTEXIST
 EDATABASEERROR
 ESYSTEMCOMMENTFIELD

 
CommentFieldListInfoIterEnd (supported) [top]
Terminate a list iteration that had been started by a call To CommentFieldListInfoIterStart. 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 Type
CommentFieldListInfoIterEnd CommentFieldListInfoIterEnd
 
Output Name Type
CommentFieldListInfoIterEndResult CommentFieldListInfoIterEndResult
 Error Name  Description
 EINVALIDTAG

 
CommentFieldListInfoIterNext (supported) [top]
Get the next set of comment fields in the iteration started by CommentFieldListInfoIterStart.
Error conditions:
  • EINVALIDTAG - The specified Tag does not exist.
  • EDATABASEERROR - A database Error occurred while processing the Request.
Input Name Type
CommentFieldListInfoIterNext CommentFieldListInfoIterNext
 
Output Name Type
CommentFieldListInfoIterNextResult CommentFieldListInfoIterNextResult
 Error Name  Description
 EDATABASEERROR
 EINVALIDTAG

 
CommentFieldListInfoIterStart (supported) [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 Type
CommentFieldListInfoIterStart CommentFieldListInfoIterStart
 
Output Name Type
CommentFieldListInfoIterStartResult CommentFieldListInfoIterStartResult
 Error Name  Description
 ECOMMENTFIELDDOESNOTEXIST
 EDATABASEERROR

 
CommentFieldModify (supported) [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 Type
CommentFieldModify CommentFieldModify
 
Output Name Type
CommentFieldModifyResult CommentFieldModifyResult
 Error Name  Description
 ECOMMENTFIELDALREADYEXISTS
 ECOMMENTFIELDDOESNOTEXIST
 EDATABASEERROR
 EINVALIDINPUT
 ESYSTEMCOMMENTFIELD

 
CommentFieldValuesListInfoIterEnd (supported) [top]
Terminate a list iteration that had been started by a call To CommentFieldValuesListInfoIterStart. 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 Type
CommentFieldValuesListInfoIterEnd CommentFieldValuesListInfoIterEnd
 
Output Name Type
CommentFieldValuesListInfoIterEndResult CommentFieldValuesListInfoIterEndResult
 Error Name  Description
 EINVALIDTAG

 
CommentFieldValuesListInfoIterNext (supported) [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 Type
CommentFieldValuesListInfoIterNext CommentFieldValuesListInfoIterNext
 
Output Name Type
CommentFieldValuesListInfoIterNextResult CommentFieldValuesListInfoIterNextResult
 Error Name  Description
 EDATABASEERROR
 EINVALIDTAG

 
CommentFieldValuesListInfoIterStart (supported) [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 Type
CommentFieldValuesListInfoIterStart CommentFieldValuesListInfoIterStart
 
Output Name Type
CommentFieldValuesListInfoIterStartResult CommentFieldValuesListInfoIterStartResult
 Error Name  Description
 EACCESSDENIED
 ECOMMENTFIELDDOESNOTEXIST
 EDATABASEERROR
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
CommentSetObjectValue (supported) [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 Type
CommentSetObjectValue CommentSetObjectValue
 
Output Name Type
CommentSetObjectValueResult CommentSetObjectValueResult
 Error Name  Description
 EACCESSDENIED
 ECOMMENTFIELDDOESNOTEXIST
 EDATABASEERROR
 EINVALIDINPUT
 EOBJECTAMBIGUOUS
 EOBJECTNOTFOUND

 
Element definition: CommentFieldCreate [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.
Name Type Description
CommentFieldInfo CommentFieldInfo
Information about the comment field.

 
Element definition: CommentFieldCreateResult [top]
Name Type Description
CommentFieldId CommentFieldId
Identifier of the newly created comment field.

 
Element definition: CommentFieldDestroy [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.
Name Type Description
CommentFieldNameOrId CommentFieldNameOrId
Comment field To be destroyed.

 
Element definition: CommentFieldDestroyResult [top]
[none]

 
Element definition: CommentFieldListInfoIterEnd [top]
Terminate a list iteration that had been started by a call To CommentFieldListInfoIterStart. 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.
Name Type Description
Tag xsd:string
The opaque handle returned by the prior call To CommentFieldListInfoIterStart that started this list iteration.

 
Element definition: CommentFieldListInfoIterEndResult [top]
[none]

 
Element definition: CommentFieldListInfoIterNext [top]
Get the next set of comment fields in the iteration started by CommentFieldListInfoIterStart.
Error conditions:
  • EINVALIDTAG - The specified Tag does not exist.
  • EDATABASEERROR - A database Error occurred while processing the Request.
Name Type Description
Maximum xsd:integer
The Maximum number of comment fields To return. Range: [1..2^31-1].
Tag xsd:string
The opaque handle returned by the prior call To CommentFieldListInfoIterStart that started this list iteration.

 
Element definition: CommentFieldListInfoIterNextResult [top]
Name Type Description
CommentFields ArrayOfCommentFieldInfo
List of comment fields.
Records xsd:integer
The number of Records actually returned.

 
Element definition: CommentFieldListInfoIterStart [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.
Name Type Description
CommentFieldNameOrId CommentFieldNameOrId
optional
If specified, only the specified comment field is returned. Otherwise information about all comment fields are returned.
CommentFieldObjectTypes ArrayOfCommentFieldObjectType
optional
If specified, only the specified comment field with specified object Type is returned. If not specified, then all comment fields will be returned.
ShowSystemComments xsd:boolean
optional
Indicates whether system comment fields are returned. Default is true.

 
Element definition: CommentFieldListInfoIterStartResult [top]
Name Type Description
Records xsd:integer
Number of items present in the list iteration. Range: [0..2^31-1].
Tag xsd:string
An opaque handle used To identify the list iteration. The list content resides in a temporary store in the server.

 
Element definition: CommentFieldModify [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.
Name Type Description
CommentFieldNameOrId CommentFieldNameOrId
Name or identifier of the comment field which has To be modified.
CommentFieldObjectTypes ArrayOfCommentFieldObjectType
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.
NewCommentFieldName CommentFieldName
optional
New Name of the comment field. May be omitted if only changing the comment field object types.

 
Element definition: CommentFieldModifyResult [top]
[none]

 
Element definition: CommentFieldValuesListInfoIterEnd [top]
Terminate a list iteration that had been started by a call To CommentFieldValuesListInfoIterStart. 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.
Name Type Description
Tag xsd:string
The opaque handle returned by the prior call To comment-field-values-list-iter-start that started this list iteration.

 
Element definition: CommentFieldValuesListInfoIterEndResult [top]
[none]

 
Element definition: CommentFieldValuesListInfoIterNext [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.
Name Type Description
Maximum xsd:integer
The Maximum number of comment field Values To return. Range: [1..2^31-1].
Tag xsd:string
The opaque handle returned by the prior call To comment-field-values-list-iter-start that started this list iteration.

 
Element definition: CommentFieldValuesListInfoIterNextResult [top]
Name Type Description
CommentFieldValues ArrayOfCommentFieldValue
Comment field Values.
Records xsd:integer
The number of Records actually returned.

 
Element definition: CommentFieldValuesListInfoIterStart [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.
Name Type Description
CommentFieldNameOrId CommentFieldNameOrId
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.
CommentFieldObjectTypes ArrayOfCommentFieldObjectType
optional
Object Type(s) of the comment field To be returned.
ObjectNameOrId ObjNameOrId
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.

 
Element definition: CommentFieldValuesListInfoIterStartResult [top]
Name Type Description
Records xsd:integer
Number of items present in the list iteration. Range: [0..2^31-1].
Tag xsd:string
An opaque handle used To identify the list iteration. The list content resides in a temporary store in the server.

 
Element definition: CommentSetObjectValue [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.
Name Type Description
CommentFieldNameOrId CommentFieldNameOrId
Name or identifier of the comment field.
CommentValue CommentValue
Value of the comment field. An empty string can be used To unset the Value of the comment field for this object.
ObjectNameOrId ObjNameOrId
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

 
Element definition: CommentSetObjectValueResult [top]
[none]

 
Element definition: ArrayOfCommentFieldInfo [top]
Name Type Description
CommentFieldInfo CommentFieldInfo[]

 
Element definition: ArrayOfCommentFieldObjectType [top]
Name Type Description
CommentFieldObjectType CommentFieldObjectType[]

 
Element definition: ArrayOfCommentFieldValue [top]
Name Type Description
CommentFieldValue CommentFieldValue[]

 
Element definition: CommentFieldId [top]
Identifier of the comment field. Range: [1..2^31-1]
[none]

 
Element definition: CommentFieldInfo [top]
Information about the comment field.
Name Type Description
CommentFieldId CommentFieldId
optional
Identifier of the comment field. This field is ignored on create.
CommentFieldName CommentFieldName
Name of the comment field. Required for create.
CommentFieldObjectTypes ArrayOfCommentFieldObjectType
optional
Object Type(s) of the comment field. If not specified, then no object Type will be associated with the comment field.
IsSystemComment xsd: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: CommentFieldName [top]
Name of the comment field. Name can contain a Maximum of 255 characters.
[none]

 
Element definition: CommentFieldNameOrId [top]
Name or identifier of the comment field. It must conform To one of the following formats:
  • It must be of the format of CommentFieldName
  • It must be of the format of CommentFieldId
[none]

 
Element definition: CommentValue [top]
Value of the specified comment field To be set on the object. This can be of Maximum 1024 characters.
[none]

 
Element definition: ObjNameOrId [top]
Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI Type string. An ObjNameOrId must contain between 1 and 64 characters, and must conform To one of the following formats:
  • It must have the format of an ObjName, or
  • It must be the decimal numeric string form of a positive integer whose Value is in the range [1..2^31 - 1].
  • In case of application resources From the Host Service, this field can contain unique identifier assigned To the object by the Host Service e.g. for a Virtual Machine, it can be a GUID of the VM. One exception is when such unique identifier is a decimal numeric string containing only digits From 0 through 9. In that case, you cannot use such identifier as ObjNameOrId input.
Elements of Type ObjNameOrId 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 ObjNameOrId 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: CommentFieldObjectType [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: CommentFieldValue [top]
A single comment field Value.
Name Type Description
CommentFieldId CommentFieldId
Identifier of the comment field.
CommentFieldName CommentFieldName
Name of the comment field.
CommentValue CommentValue
Value of the comment field
ObjectFullName ObjFullName
Name of the managed object
ObjectId ObjId
Identifier of the managed object.
ObjectType xsd: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: ObjFullName [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 ObjName, 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 ObjName and ObjFullName are identical.
[none]

 
Element definition: ObjId [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 ObjId 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 ObjId 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]