Input Name	Range	Type	Description
category-name-or-id		string optional	The name or id of the category. If specified, only the specified category along with its sub categories are listed. If not specified, all categories and their sub categories will be listed.
category-provenance		string optional	Possible values:"custom" returns only custom categories. "canned" returns only canned categories. If not specified both custom and canned categories are returned.
Output Name	Range	Type	Description
category-list		category-list-info[] optional	Contains list of categories.

Errno	Description
EINTERNALERROR
EINVALIDINPUT
EREPORTCATEGORYNOTFOUND
EDATABASEERROR

API to list reports created using report designer.

Input Name	Range	Type	Description
category-name-or-id		string optional	Contains the category name or the id. If specified, only reports which are in the specified category are returned. If not specified, all the reports will be listed.
report-provenance		report-provenance optional	It describes the category the report belongs.
Output Name	Range	Type	Description
report-list		report-list-info[] optional	Contains list of reports.

Errno	Description
EINTERNALERROR
EINVALIDINPUT
EREPORTCATEGORYNOTFOUND
EDATABASEERROR

API to schedule a report. Only reports listed by report-designer-list API can be scheduled using this API. It creates a new schedule based on schedule-content-info and a new report schedule object with the schedule and corresponding report being scheduled

Input Name	Range	Type	Description
report-schedule-info		report-schedule-info	Details of a report schedule
schedule-content-info		schedule-content-info	Details of a schedule
Output Name	Range	Type	Description
report-schedule-id		obj-id	Specifies the id of the report schedule created.

Errno	Description
EINTERNALERROR
EINVALIDINPUT
EACCESSDENIED
EDATABASEERROR
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EREPORTNOTFOUND

API to delete a report schedule object and its associated schedule. Only report schedules for reports returned by report-designer-list API can be deleted using this API.

Input Name	Range	Type	Description
report-schedule-name-or-id		obj-name-or-id	Name or id of the report schedule.

Errno	Description
EINTERNALERROR
EACCESSDENIED
EDATABASEERROR
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EINVALIDINPUT

API to modify a report schedule and/or its schedule details. Only report schedules for reports returned by report-designer-list API can be modified using this API

Input Name	Range	Type	Description
report-schedule-info		report-schedule-info optional	Details of modifiable contents of a report schedule. If this is not specified, schedule-content-info should be specified.
report-schedule-name-or-id		obj-name-or-id	Specifies the name or id of the report schedule to be modified.
schedule-content-info		schedule-content-info optional	Details of a schedule. If this is not specified, report-schedule-info should be specified.

Errno	Description
EINTERNALERROR
EINVALIDINPUT
EACCESSDENIED
EDATABASEERROR
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EREPORTNOTFOUND

Shares report output of specified report in the specified format to the mentioned email-address-list.

Input Name	Range	Type	Description
email-address-list		email-address-list	Email addresses of recipients for a mail to be sent with an attachment when the report is generated.
output-format		report-output-format optional	Specifies the format of the report to be sent. Default value is html.
report-name-or-id		string	The CLI name or unique id of the report to be shared.
subject-field		string optional	The string which should be sent as subject field in the email. Default: Generated Report: (provided-by-user) on (provided by user).
target-object-name-or-id		obj-name-or-id optional	Specifies the target object on which the report has to be shared. If not specified, the report is generated at the global level.

Errno	Description
EINTERNALERROR
EINVALIDINPUTERROR
EDATABASEERROR
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EREPORTNOTFOUND

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

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.
records		integer	The number of records actually returned. Range: [0..2^31-1].

Errno	Description
EINTERNALERROR
EINVALIDINPUT
EACCESSDENIED
EINVALIDTAG

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

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

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
records		integer	The number of records actually returned. Range: [0..2^31-1].
report-list		report-info[]	A list of reports that can be scheduled.

Errno	Description
EINTERNALERROR
EINVALIDINPUT
EACCESSDENIED
EINVALIDTAG

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

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

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
EINTERNALERROR
EINVALIDINPUT
EACCESSDENIED
EINVALIDTAG

Returns items from a previous call to report-output-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-output-list		report-output-info[]	A list of outputs.

Errno	Description
EINTERNALERROR
EINVALIDINPUT
EACCESSDENIED
EINVALIDTAG

Initiates a query for a list of report outputs.

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

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
EREPORTNOTSCHEDULABLE
EREPORTOUTPUTNOTFOUND
EREPORTOUTPUTFILEREADERROR
EREPORTOUTPUTFILENOTFOUND

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

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

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

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

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
EINTERNALERROR
EACCESSDENIED
EINVALIDTAG
EINVALIDINPUT

Returns items from a previous call to report-schedule-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-schedule-list		report-schedule-content-info[]	A list of report schedules.

Errno	Description
EINTERNALERROR
EACCESSDENIED
EINVALIDTAG
EINVALIDINPUT

Initiates a query for a list of report schedules.

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

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

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

Contains the details of the categories

Name	Range	Type	Description
category-id		integer	Unique identifier of category. Range: [1..2^31-1]
category-list		category-list-info[] optional	contains the list of sub-categories under a category.
category-name		string	The name of the category. Max Length: 64 chars
is-category-custom		boolean	Indicates that this category is a custom category. true if the category is a custom category. false otherwise.

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]

Describes the meta data of a graph

Name	Range	Type	Description
deprecated-by		string optional	Name of the graph that replaces this graph. Will be absent for non-deprecated graphs. Only returned via the graph-list-info-iter-next api.
description		string optional	Description of the graph. Maximum length of 1024 characters. Only returned via the report-graph-list-info-iter-next api.
graph-lines		graph-line-info[] optional	Specifies the list of lines in the graph. Only returned via the graph-list-info-iter-next api.
graph-name		string	Unique name of the graph. Maximum length of 64 characters.
graph-pretty-name		string	Long name of the graph. Maximum length of 64 characters.
is-default		boolean optional	Specifies whether the graph is the default graph for the report. Only returned via the report-graph-list-info-iter-next api.
is-deprecated		boolean optional	true if the graph is deprecated. Only returned via the graph-list-info-iter-next api.

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]

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]. 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 obj-name-or-id input. 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]

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]

Describes the name of the report.

Name	Range	Type	Description
deprecated-by		string optional	Name of the report that replaces this report. Will be absent for non-deprecated reports.
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'
is-deprecated		boolean optional	true if the report is deprecated.
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'

Contains the details of the reports.

Name	Range	Type	Description
category-id		integer optional	Unique identifier of category. The category-id is not returned for reports which do not belong to any category. Range: [1..2^31-1]
is-interval-allowed		boolean	Specifies if the report can be generated for a specific time interval.
report-description		string optional	Description of the report. Max Length: 1024 chars
report-design-file-name		string	This contains the name of the rptdesign(design file) of the report. rptdesign is a file format in BIRT. The report design is saved in the rptdesign file. Max Length: 128 chars
report-id		integer	This contains the unique id of the report. Range: [1..2^31-1]
report-name		string	This contains the unique cli name of the report. Max Length: 64 chars
report-pretty-name		string	This contains the pretty name of the report displayed in UI. Max Length: 64 chars
report-provenance		report-provenance	It describes the category the report belongs.

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

[none]

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.

Possible values:"custom" returns only custom and modified_canned reports. "canned" returns only canned reports. If not specified all reports are returned.

[none]

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.

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 optional	Specifies the name of the report schedule to be created. This element is mandatory for 'report-schedule-add'.
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: controller-details report can run on a target object which is of type host. Range for id: [1..(2^31)-1]

Detailed schedule contents. A schedule can be a daily, weekly, or monthly schedule. A daily schedule may include both multiple recurring hourly schedules (hourly-list element) and/or individual non-recurring daily schedules (daily-list element). A weekly schedule may include multiple references to daily schedules to be run on specific days of the week (weekly-subschedule-list element) and/or individual non-recurring weekly schedules (weekly-list element). A monthly schedule may include multiple non-recurring monthly schedules (monthly-list element). In addition, a monthly schedule may include a single reference to either a daily schedule or a montly schedule, not both. User may only specify one monthly-subschedule-info element in the monthly-subschedule-list.

Name	Range	Type	Description
daily-list		daily-info[] optional	List of daily schedules. May only be used in a daily schedule.
hourly-list		hourly-info[] optional	List of hourly schedules. May only be used in a daily schedule.
is-modifiable		boolean optional	If false, this schedule is one of the sample schedules that is created at installation time, therefore it may not be modified, renamed or destroyed. If true, it is not one of the sample schedules, therefore it may be modified, renamed or destroyed. is-modifiable always appears in the output. It is not possible to use it as input.
monthly-list		monthly-info[] optional	List of monthly schedules. May only be used in a monthly schedule.
monthly-subschedule-list		monthly-subschedule-info[] optional	List of monthly sub-schedules used by the schedule. May only be used in a monthly schedule.
schedule-category		string optional	Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'. The default value is 'dp_schedule'.
schedule-description		string optional	Description of the schedule. It may contain from 0 to 255 characters. The description always appears in the output. If the description is omitted, then the default value is the empty string "".
schedule-id		obj-id optional	ID of the schedule. Ignored for dfm-schedule-create. Required for all other calls. Range: [1..(2^31)-1]
schedule-name		obj-name	Name of the schedule. May not be numeric.
schedule-type		string	Type of schedule. Possible values are: 'daily', 'weekly', 'monthly'. Note that the type cannot be changed once the schedule is created. User has to delete the schedule before creating a new schedule using the same name with different type
weekly-list		weekly-info[] optional	List of weekly schedules. May only be used in a weekly schedule.
weekly-subschedule-list		weekly-subschedule-info[] optional	List of weekly sub-schedules used by the schedule. May only be used in a weekly schedule.

The attributes of a daily schedule. May only be used in a daily schedule.

Name	Range	Type	Description
item-id		integer optional	ID of the daily item within the schedule. Ignored for dfm-schedule-create/modify and *-add. Required for all other calls. Will be presented in output. Range: [1..(2^31)-1]
start-hour		integer	Start hour of the daily schedule. Range: [0..23]
start-minute		integer	Start minute of the daily schedule. Range: [0..59]

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]

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'

The attributes of an hourly schedule. May only be used in a daily schedule.

Name	Range	Type	Description
end-hour		integer	End hour of the hourly schedule. Range: [0..23]
end-minute		integer	End minute of the hourly schedule. Range: [0..59]
frequency		integer	Number of minutes between each schedule. Range: [5..1440]
item-id		integer optional	ID of the hourly item within the schedule. Ignored for dfm-schedule-create/modify and *-add. Required for all other calls. Will be presented in output. Range: [1..(2^31)-1]
start-hour		integer	Start hour of the hourly schedule. Range: [0..23]
start-minute		integer	Start minute of the hourly schedule. Range: [0..59]

The attributes of a monthly schedule. May only be used in a monthly schedule.

Name	Range	Type	Description
day-of-month		integer optional	If day-of-month is 29, 30, or 31, it will be interpretted as the last day of the month for months with fewer than that many days. if day-of-month is set, then both week-of-month and day-of-week must not be set. Range: [1..31]
day-of-week		integer optional	Day of week for the schedule. If day-of-week is set, then week-of-month must also be set and day-of-month must not be set. Range: [0..6] (0 = "Sun")
item-id		integer optional	ID of the monthly item within the schedule. Ignored for dfm-schedule-create/modify and *-add. Required for all other calls. Will be presented in output. Range: [1..(2^31)-1]
start-hour		integer	Start hour of the monthly schedule. Range: [0..23]
start-minute		integer	Start minute of the monthly schedule. Range: [0..59]
week-of-month		integer optional	A value of 5 indicates the last week of the month. If week-of-month is set, then day-of-week must also be set and day-of-month must not be set. Range: [1..5]

The attributes of a monthly subschedule. May only be used in a monthly schedule.

Name	Range	Type	Description
subschedule-id		obj-id	ID of the subschedule to be used. Range: [1..(2^31)-1]
subschedule-name		obj-name optional	Name of the subschedule to be used Ignored for dfm-schedule-create/modify. Required for all other calls. Will be presented in output. Range: [1..(2^31)-1]

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]

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]

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]. 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 obj-name-or-id input. 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]

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]

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

[none]

The attributes of a weekly schedule. May only be used in a weekly schedule.

Name	Range	Type	Description
day-of-week		integer	Day of week for the schedule. Range: [0..6] (0 = "Sun")
item-id		integer optional	ID of the weekly item within the schedule Ignored for dfm-schedule-create/modify and *-add. Required for all other calls. Will be presented in output. Range: [1..(2^31)-1]
start-hour		integer	Start hour of the weekly schedule. Range: [0..23]
start-minute		integer	Start minute of the weekly schedule. Range: [0..59]

The attributes of a weekly subschedule. May only be used in a weekly schedule.

Name	Range	Type	Description
end-day-of-week		integer	End day to be applied to the schedule being used. Range: [0..6] (0 = "Sun")
item-id		integer optional	ID of the use type within the schedule. Ignored for dfm-schedule-create/modify and *-add. Required for all other calls. Will be presented in output. Range: [1..(2^31)-1]
start-day-of-week		integer	Start day to be applied to the schedule being used. Range: [0..6] (0 = "Sun")
subschedule-id		obj-id	ID of the subschedule to be used. Range: [1..(2^31)-1]
subschedule-name		obj-name optional	Name of the subschedule to be used Ignored for dfm-schedule-create/modify. Required for all other calls. Will be presented in output. Range: [1..(2^31)-1]

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]

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]