APIs in Category: report | API version 3.8

report-graph-list-info-iter-end report-graph-list-info-iter-next report-graph-list-info-iter-start report-list-info-iter-end report-list-info-iter-next report-list-info-iter-start report-output-delete report-output-list-info-iter-end report-output-list-info-iter-next report-output-list-info-iter-start report-output-read report-schedule-add report-schedule-delete report-schedule-disable report-schedule-enable report-schedule-list-info-iter-end report-schedule-list-info-iter-next report-schedule-list-info-iter-start report-schedule-modify report-schedule-run | These APIs allow the user to manage report schedules, report outputs, listing reports and their corresponding graphs.

NetApp Manage ONTAP

report-graph-list-info-iter-end | [top]

> Terminate a view list iteration and clean up any saved info.

> Input Name | Range | Type | Description
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store.

> Errno | Description
> EINVALIDTAG |  |

report-graph-list-info-iter-next | [top]

> Returns items from a previous call to report-graph-list-info-iter-start

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve. Range: [1..(2^31)-1]
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store.
> Output Name | Range | Type | Description
> graph-list |  | graph-info[] | A list of graphs.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EINVALIDTAG |  |

report-graph-list-info-iter-start | [top]

> Initiates a query for a list of graphs for a particular report.

> Input Name | Range | Type | Description
> report-application |  | report-application optional | Specifies the application to which the report belongs.
> report-name-or-id |  | string | Name of the report for which graphs have to be listed. For custom reports it can either be name or id. Range for id: [1..(2^31)-1]
> target-object-name-or-id |  | obj-name-or-id | Name or id of the object for which graphs have to be listed. Range for id: [1..(2^31)-1]
> Output Name | Range | Type | Description
> records |  | integer | Number indicating how many items are available for future retrieval with report-graph-list-info-iter-next. Range: [1..(2^31)-1]
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store. Used in subsequent calls to report-graph-list-info-iter-next or report-graph-list-info-iter-end.

> Errno | Description
> EINVALIDINPUT |  |
> EDATABASEERROR |  |
> EREPORTNOTFOUND |  |
> EREPORTAMBIGUOUS |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |

report-list-info-iter-end | [top]

> Terminate a view list iteration and clean up any saved info.

> Input Name | Range | Type | Description
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store.

> Errno | Description
> EINVALIDTAG |  |

report-list-info-iter-next | [top]

> Returns items from a previous call to report-list-info-iter-start

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve. Range: [1..(2^31)-1]
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store.
> Output Name | Range | Type | Description
> report-list |  | report-info[] | A list of reports that can be scheduled.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EINVALIDTAG |  |

report-list-info-iter-start | [top]

> Initiates a query for a list of reports that can be scheduled.

> Input Name | Range | Type | Description
> report-application |  | report-application optional | Specifies the application for which reports have to be listed. If not specified then all the reports are listed.
> report-name-or-id |  | string optional | Specifies the name of report to be listed. For custom report id can be specified. Range for id: [1..(2^31)-1]
> report-type |  | string optional | Specifies the type for which reports have to be listed. Possible values: 'custom', 'built_in'.
> Output Name | Range | Type | Description
> records |  | integer | Number indicating how many items are available for future retrieval with report-list-info-iter-next. Range: [1..(2^31)-1]
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store. Used in subsequent calls to report-list-info-iter-next or report-list-info-iter-end.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EDATABASEERROR |  |
> EREPORTNOTFOUND |  |
> EREPORTAMBIGUOUS |  |

report-output-delete | [top]

> Deletes a report output.

> Input Name | Range | Type | Description
> report-output-id |  | integer | Specifies the id of the report output. Range: [1..(2^31)-1]

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EREPORTNOTLICENSED |  |
> EREPORTNOTSCHEDULABLE |  |
> EREPORTOUTPUTNOTFOUND |  |
> EREPORTOUTPUTDELETEERROR |  |

report-output-list-info-iter-end | [top]

> Input Name | Range | Type | Description
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EINVALIDTAG |  |

report-output-list-info-iter-next | [top]

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve. Range: [1..(2^31)-1]
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store.
> Output Name | Range | Type | Description
> report-output-list |  | report-output-info[] | A list of outputs.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EINVALIDTAG |  |

report-output-list-info-iter-start | [top]

> Input Name | Range | Type | Description
> is-successful |  | boolean optional | Specifies whether the status of the report output was successful. If the input element is not present then all (success and fail) the report outputs are listed.
> report-application |  | report-application optional | Specifies the application for which reports have to be listed. Default is 'control_center'.
> report-name-or-id |  | string optional | Name of the report. For custom reports it can either be name or id. Range for id: [1..(2^31)-1]
> report-output-id |  | integer optional | Specifies the id of the report output. If this is specified then filtering based on object-name-or-id and report-schedule-name-or-id is ignored. Range: [1..(2^31)-1]
> report-schedule-name-or-id |  | obj-name-or-id optional | Specifies the name or id of the report schedule for which the output has to be listed. Range for id: [1..(2^31)-1]
> target-object-name-or-id |  | obj-name-or-id optional | Specifies one of the following: - the name or id of the group. - the name or id of the object. Range for id: [1..(2^31)-1]
> Output Name | Range | Type | Description
> records |  | integer | Number indicating how many items are available for future retrieval with report-output-list-info-iter-next. Range: [1..(2^31)-1]
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store. Used in subsequent calls to report-output-list-info-iter-next or report-output-list-info-iter-end.

> Errno | Description
> EINTERNALERROR |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EREPORTAMBIGUOUS |  |
> EREPORTOUTPUTNOTFOUND |  |
> EREPORTNOTSCHEDULABLE |  |
> EINVALIDINPUT |  |

report-output-read | [top]

> Reads report output data from a file. API will fail if length exceeds 1 MB.

> Input Name | Range | Type | Description
> length |  | integer | Number of bytes to read from the file. Range: [0..2^20]
> offset |  | integer | Offset into file to start reading from. Range: [0..(2^31)-1]
> report-output-id |  | integer | Specifies the id of the report output. Range: [1..(2^31)-1]
> Output Name | Range | Type | Description
> file-data |  | string | Data read from the file. The data is is xml encoded.
> length |  | integer | Number of bytes actually read from the file. If this value is 0, then you have attempted to read at or past the end of the file. Range: [0..2^20]
> output-format |  | report-output-format | The output format of the file read.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINVALIDOUTPUTID |  |
> EREPORTNOTSCHEDULABLE |  |
> EREPORTOUTPUTNOTFOUND |  |
> EREPORTOUTPUTFILEREADERROR |  |
> EREPORTOUTPUTFILENOTFOUND |  |

report-schedule-add | [top]

> Add a new report schedule.

> Input Name | Range | Type | Description
> report-schedule-info |  | report-schedule-info | Details of a report schedule
> Output Name | Range | Type | Description
> report-schedule-id |  | obj-id | Specifies the id of the report schedule created. Range: [1..(2^31)-1]

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EREPORTAMBIGUOUS |  |
> EREPORTSCHEDULEDUPLICATE |  |
> EREPORTNOTLICENSED |  |
> EREPORTNOTSCHEDULABLE |  |

report-schedule-delete | [top]

> Deletes a report schedule.

> Input Name | Range | Type | Description
> report-schedule-name-or-id |  | obj-name-or-id | Name or id of the report schedule. Range for id: [1..(2^31)-1]

> Errno | Description
> EINTERNALERROR |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EINVALIDINPUT |  |
> EREPORTNOTSCHEDULABLE |  |
> EREPORTSCHEDULEDELETEERROR |  |

report-schedule-disable | [top]

> Disable a report schedule.

> Input Name | Range | Type | Description
> report-schedule-name-or-id |  | obj-name-or-id | Name or id of the report schedule. Range for id: [1..(2^31)-1]

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EINVALIDINPUT |  |
> EREPORTNOTSCHEDULABLE |  |

report-schedule-enable | [top]

> Enable a report schedule.

> Input Name | Range | Type | Description
> report-schedule-name-or-id |  | obj-name-or-id | Name or id of the report schedule. Range for id: [1..(2^31)-1]

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EINVALIDINPUT |  |
> EREPORTNOTLICENSED |  |
> EREPORTNOTSCHEDULABLE |  |

report-schedule-list-info-iter-end | [top]

> Input Name | Range | Type | Description
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store.

> Errno | Description
> EINTERNALERROR |  |
> EACCESSDENIED |  |
> EINVALIDTAG |  |
> EINVALIDINPUT |  |

report-schedule-list-info-iter-next | [top]

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve. Range: [1..(2^31)-1]
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store.
> Output Name | Range | Type | Description
> report-schedule-list |  | report-schedule-content-info[] | A list of report schedules.

> Errno | Description
> EINTERNALERROR |  |
> EACCESSDENIED |  |
> EINVALIDTAG |  |
> EINVALIDINPUT |  |

report-schedule-list-info-iter-start | [top]

> Input Name | Range | Type | Description
> is-enabled |  | boolean optional | Specifies whether the state of the report schedule is enabled. If the input element is not present then all (enabled and disabled) the report schedules are listed.
> report-application |  | report-application optional | Specifies to list only those report schedules which involve reports that belong to this application. Default is 'control_center'.
> report-name-or-id |  | string optional | Name of the report. For custom reports it can either be name or id. Range for id: [1..(2^31)-1]
> report-schedule-name-or-id |  | obj-name-or-id optional | Specifies the name or id of the report schedule to be listed. If this is specified then filtering the report schedules based on report-name-or-id, report-application, target-object-name-or-id if any is ignored. If not specified then only the report schedules satisfying all the conditions will be listed. Range for id: [1..(2^31)-1]
> target-object-name-or-id |  | obj-name-or-id optional | Specifies one of the following: - the name or id of the group. - the name or id of the object. If specified, only the report schedules which have the target object as that of the input are listed. Range for id: [1..(2^31)-1]
> Output Name | Range | Type | Description
> records |  | integer | Number indicating how many items are available for future retrieval with report-schedule-list-info-iter-next. Range: [1..(2^31)-1]
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store. Used in subsequent calls to report-schedule-list-info-iter-next or report-schedule-list-info-iter-end.

> Errno | Description
> EINTERNALERROR |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EINVALIDINPUT |  |
> EREPORTAMBIGUOUS |  |
> EREPORTNOTSCHEDULABLE |  |

report-schedule-modify | [top]

> Modify a report schedule.

> Input Name | Range | Type | Description
> report-schedule-info |  | report-schedule-info | Details of modifiable contents of a report schedule.
> report-schedule-name-or-id |  | obj-name-or-id | Specifies the name or id of the report schedule to be modified. Range for id: [1..(2^31)-1]

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTNOTFOUND |  |
> EOBJECTAMBIGUOUS |  |
> EREPORTAMBIGUOUS |  |
> EREPORTNOTLICENSED |  |
> EREPORTNOTSCHEDULABLE |  |
> EREPORTSCHEDULEDUPLICATE |  |

report-schedule-run | [top]

> Runs a report schedule at that instant of time.

> Input Name | Range | Type | Description
> report-schedule-name-or-id |  | obj-name-or-id | Name or id of the report schedule. Range for id: [1..(2^31)-1]
> Output Name | Range | Type | Description
> report-output-id |  | integer | Specifies the id of the report output generated. Range: [1..(2^31)-1]

> Errno | Description
> EOBJECTNOTFOUND |  |
> EOBJECTAMBIGUOUS |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EREPORTNOTLICENSED |  |
> EREPORTNOTSCHEDULABLE |  |

Element definition: graph-info | [top]

> Describes the meta data of a graph.

> Name | Range | Type | Description
> graph-lines |  | graph-line-info[] | Specifies the list of lines in the graph.
> graph-name |  | string | Specifies the name of the graph. Maximum length: 64 characters.
> graph-pretty-name |  | string | Specifies the pretty name of the graph. Maximum length: 64 characters.

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-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: report-application | [top]

> Specifies the application to which a report belongs. This typedef is an alias for the built-in ZAPI type string. Possible values: 'control_center' 'backup' 'disaster_recovery'

> [none]

Element definition: report-info | [top]

> Describes the name of the report.

> Name | Range | Type | Description
> description |  | string optional | Description of the report. Max Length: 1024 chars
> display-tab |  | string | The tab where a report is displayed in DFM UI. Possible values: 'aggregates' 'appliances' 'data_sets' 'events' 'filesrm' 'filesystems' 'luns' 'resource_pools' 'sans' 'scripts' 'vfilers' 'others'
> output-format-list |  | report-output-format[] | The list of output formats supported by report.
> rbac-operation |  | string | The name of the RBAC operation required to view the report. Use rbac-operation-info-list to get the list of currently valid operations. Max Length: 255 chars
> report-application |  | report-application | Application to which the report belongs.
> report-id |  | integer optional | id of the report in case of Custom reports. Range: [1..(2^31)-1]
> report-name |  | string | Unique name of the report. Max Length: 64 chars
> report-pretty-name |  | string | Long name of the report. Max Length: 64 chars
> report-type |  | string | Type of the report. Possible values: 'built_in' 'custom'

Element definition: report-output-format | [top]

> The type of output format. This typedef the built-in ZAPI type string. Possible values: 'csv' 'html' 'paragraph' 'perl' 'text' 'xls' 'xml'

> [none]

Element definition: report-output-info | [top]

> Describes the contents of an output.

> Name | Range | Type | Description
> failure-reason |  | string optional | Specifies the reason as to why the output failed. Present only in case of failure. Maximum length of 255 characters.
> graph-name |  | string optional | Name of the graph.
> report-application |  | report-application | Specifies the application to which a report belongs. Default is 'control_center'.
> report-id |  | integer optional | specifies the id of the report in case of custom reports. Range: [1..(2^31)-1]
> report-name |  | string | Name of the report.
> report-output-id |  | integer | Specifies the output id. Range: [1..(2^31)-1]
> report-schedule-id |  | obj-id | Specifies the id of the report schedule. Range: [1..(2^31)-1]
> report-schedule-name |  | obj-name | Specifies the name of the report schedule.
> run-by |  | string | Specifies the name of the user who generated the report output. Maximum length of 255 characters.
> run-status |  | string | Specifies the status of the report output. Possible values: 'pending' 'running' 'succeeded' 'failed' 'aborted'
> run-time |  | integer optional | Specifies the timestamp when the output was saved. Not present if the report output is in pending, running or aborted state. The timestamp value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.
> target-object-id |  | integer | Specifies the object on which the output was generated. Range: [1..(2^31)-1]
> target-object-name |  | string | Specifies the name of the object on which the output was generated.

Element definition: report-schedule-content-info | [top]

> Describes the contents of a report schedule.

> Name | Range | Type | Description
> archival-format |  | report-output-format | Specifies the format in which the report is saved.
> email-address-list |  | email-address-list optional | Email addresses of recipients for a mail to be sent with an attachment when the report is generated.
> graph-name |  | string optional | Name of the graph. Maximum length of 64 characters.
> include-deleted-objects |  | boolean | Include deleted objects in the report generated.
> is-enabled |  | boolean optional | Specifies whether the state of the report schedule is enabled.
> is-successful |  | boolean optional | Specifies whether the last run result was successful. This element is not present if the report schedule has not run even once.
> last-run-time |  | integer optional | Specifies the timestamp when the report was last run. This element is not present if the report schedule has not run even once. The timestamp value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.
> report-application |  | report-application | Specifies the application to which a report belongs. Default is 'control_center'.
> report-id |  | integer optional | Specifies the id of the custom report. Range: [1..(2^31)-1]
> report-name |  | string | Specifies the name of the report.
> report-schedule-id |  | obj-id | Specifies the schedule id. Range: [1..(2^31)-1]
> report-schedule-name |  | obj-name | Specifies the name of the report schedule.
> save-all-fields |  | boolean | Saves all fields, Only in perl and xml format.
> schedule-id |  | integer | Specifies the id of the schedule. Range: [1..(2^31)-1]
> schedule-name |  | string | Specifies the name of the schedule.
> target-object-id |  | integer | Specifies the id of the object on which the report schedule is scheduled to run. Range: [1..(2^31)-1]
> target-object-name |  | string | Specifies the name of the object on which the report schedule is scheduled to run.

Element definition: report-schedule-info | [top]

> Detailed contents of a report schedule.

> Name | Range | Type | Description
> archival-format |  | report-output-format optional | Format of the report to be saved. Default value is html.
> email-address-list |  | email-address-list optional | Email addresses of recipients for a mail to be sent with an attachment when the report is generated.
> graph-name |  | string optional | Name of the graph. The graph name is validated as follows: - It should belong to the report name specified. - It should be applicable to the target object. - The license should support the graph. Maximum length of 64 characters.
> include-deleted-objects |  | boolean optional | Include deleted objects in the report generated. Default value is FALSE.
> report-application |  | report-application optional | Specifies the application to which a report belongs. Default is 'control_center'.
> report-name-or-id |  | string optional | Name of the report. For custom reports it can either be name or id. Required for report-schedule-add API. Range for id: [1..(2^31)-1]
> report-schedule-name |  | obj-name | Specifies the name of the report schedule to be created.
> save-all-fields |  | boolean optional | Saves all fields, Ignored if archival-format is not perl or xml. Default value is FALSE.
> schedule-name-or-id |  | obj-name-or-id optional | Name or id of a schedule. Required for report-schedule-add API. Range for id: [1..(2^31)-1]
> target-object-name-or-id |  | obj-name-or-id optional | Specifies the target object on which the report has to be scheduled. The object type depends on the name of the report specified. For ex: appliance-details report can run on a target object which is of type host. Range for id: [1..(2^31)-1]

Element definition: email-address-list | [top]

> A list of email addresses. If more than one email address is specified, the addresses must be seperated by a ','. Spaces (and other white space) are not allowed, either between addresses or in them. Unprintable characters are also invalid. The list may contain up to 255 characters.

> [none]

Element definition: graph-line-info | [top]

> Describes the meta data of a line in a graph.

> Name | Range | Type | Description
> sample-format |  | string | The format in which the sample value is returned. Possible values: 'integer' 'float' Range of the sample value if integer: [0..(2^63) - 1] Range of the sample value if float: [0..(2^63) - 1]
> sample-name |  | string | Name of the sample. Maximum length: 64 characters.
> sample-pretty-name |  | string | The name of the sample which can be used for displaying. Maximum length: 64 characters.
> sample-suffix |  | string | The unit of the sample. If the unit is not known then 'none' is returned. Possible values: 'bytes' 'percentage' 'minutes' '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]

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]

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: report-application | [top]

> Specifies the application to which a report belongs. This typedef is an alias for the built-in ZAPI type string. Possible values: 'control_center' 'backup' 'disaster_recovery'

> [none]

Element definition: report-output-format | [top]

> The type of output format. This typedef the built-in ZAPI type string. Possible values: 'csv' 'html' 'paragraph' 'perl' 'text' 'xls' 'xml'

> [none]