APIs in Category: Report | API version 5.0

ReportCategoryList ReportDesignerList ReportDesignerScheduleAdd ReportDesignerScheduleDelete ReportDesignerScheduleModify ReportDesignerShare ReportGraphListInfoIterEnd ReportGraphListInfoIterNext ReportGraphListInfoIterStart ReportListInfoIterEnd ReportListInfoIterNext ReportListInfoIterStart ReportOutputDelete ReportOutputListInfoIterEnd ReportOutputListInfoIterNext ReportOutputListInfoIterStart ReportOutputRead ReportScheduleAdd ReportScheduleDelete ReportScheduleDisable ReportScheduleEnable ReportScheduleListInfoIterEnd ReportScheduleListInfoIterNext ReportScheduleListInfoIterStart ReportScheduleModify ReportScheduleRun | These APIs allow the user To manage report schedules, report outputs, listing Reports and their corresponding Graphs.

NetApp Manage ONTAP API version 5.0

ReportCategoryList (supported) | [top]

> Api To list report-categories and its details.

> Input Name | Type
> ReportCategoryList | ReportCategoryList
> Output Name | Type
> ReportCategoryListResult | ReportCategoryListResult

> Error Name | Description
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EREPORTCATEGORYNOTFOUND |  |

ReportDesignerList (supported) | [top]

> API To list Reports created using report designer.

> Input Name | Type
> ReportDesignerList | ReportDesignerList
> Output Name | Type
> ReportDesignerListResult | ReportDesignerListResult

> Error Name | Description
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EREPORTCATEGORYNOTFOUND |  |

ReportDesignerScheduleAdd (supported) | [top]

> API To schedule a report. Only Reports listed by ReportDesignerList API can be scheduled using this API. It creates a new schedule based on ScheduleContentInfo and a new report schedule object with the schedule and corresponding report being scheduled

> Input Name | Type
> ReportDesignerScheduleAdd | ReportDesignerScheduleAdd
> Output Name | Type
> ReportDesignerScheduleAddResult | ReportDesignerScheduleAddResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EREPORTNOTFOUND |  |

ReportDesignerScheduleDelete (supported) | [top]

> API To delete a report schedule object and its associated schedule. Only report schedules for Reports returned by ReportDesignerList API can be deleted using this API.

> Input Name | Type
> ReportDesignerScheduleDelete | ReportDesignerScheduleDelete
> Output Name | Type
> ReportDesignerScheduleDeleteResult | ReportDesignerScheduleDeleteResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |

ReportDesignerScheduleModify (supported) | [top]

> API To modify a report schedule and/or its schedule details. Only report schedules for Reports returned by ReportDesignerList API can be modified using this API

> Input Name | Type
> ReportDesignerScheduleModify | ReportDesignerScheduleModify
> Output Name | Type
> ReportDesignerScheduleModifyResult | ReportDesignerScheduleModifyResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EREPORTNOTFOUND |  |

ReportDesignerShare (supported) | [top]

> Shares report output of specified report in the specified format To the mentioned EmailAddressList.

> Input Name | Type
> ReportDesignerShare | ReportDesignerShare
> Output Name | Type
> ReportDesignerShareResult | ReportDesignerShareResult

> Error Name | Description
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EREPORTNOTFOUND |  |

ReportGraphListInfoIterEnd (supported) | [top]

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

> Input Name | Type
> ReportGraphListInfoIterEnd | ReportGraphListInfoIterEnd
> Output Name | Type
> ReportGraphListInfoIterEndResult | ReportGraphListInfoIterEndResult

> Error Name | Description
> EINVALIDTAG |  |

ReportGraphListInfoIterNext (supported) | [top]

> Returns items From a previous call To ReportGraphListInfoIterStart

> Input Name | Type
> ReportGraphListInfoIterNext | ReportGraphListInfoIterNext
> Output Name | Type
> ReportGraphListInfoIterNextResult | ReportGraphListInfoIterNextResult

> Error Name | Description
> EACCESSDENIED |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EINVALIDTAG |  |

ReportGraphListInfoIterStart (supported) | [top]

> Initiates a Query for a list of Graphs for a particular report.

> Input Name | Type
> ReportGraphListInfoIterStart | ReportGraphListInfoIterStart
> Output Name | Type
> ReportGraphListInfoIterStartResult | ReportGraphListInfoIterStartResult

> Error Name | Description
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EREPORTAMBIGUOUS |  |
> EREPORTNOTFOUND |  |

ReportListInfoIterEnd (supported) | [top]

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

> Input Name | Type
> ReportListInfoIterEnd | ReportListInfoIterEnd
> Output Name | Type
> ReportListInfoIterEndResult | ReportListInfoIterEndResult

> Error Name | Description
> EINVALIDTAG |  |

ReportListInfoIterNext (supported) | [top]

> Returns items From a previous call To ReportListInfoIterStart

> Input Name | Type
> ReportListInfoIterNext | ReportListInfoIterNext
> Output Name | Type
> ReportListInfoIterNextResult | ReportListInfoIterNextResult

> Error Name | Description
> EACCESSDENIED |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EINVALIDTAG |  |

ReportListInfoIterStart (supported) | [top]

> Initiates a Query for a list of Reports that can be scheduled.

> Input Name | Type
> ReportListInfoIterStart | ReportListInfoIterStart
> Output Name | Type
> ReportListInfoIterStartResult | ReportListInfoIterStartResult

> Error Name | Description
> EAPIERROR |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> EREPORTAMBIGUOUS |  |
> EREPORTNOTFOUND |  |

ReportOutputDelete (supported) | [top]

> Deletes a report output.

> Input Name | Type
> ReportOutputDelete | ReportOutputDelete
> Output Name | Type
> ReportOutputDeleteResult | ReportOutputDeleteResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EREPORTNOTLICENSED |  |
> EREPORTNOTSCHEDULABLE |  |
> EREPORTOUTPUTDELETEERROR |  |
> EREPORTOUTPUTNOTFOUND |  |

ReportOutputListInfoIterEnd (supported) | [top]

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

> Input Name | Type
> ReportOutputListInfoIterEnd | ReportOutputListInfoIterEnd
> Output Name | Type
> ReportOutputListInfoIterEndResult | ReportOutputListInfoIterEndResult

> Error Name | Description
> EACCESSDENIED |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EINVALIDTAG |  |

ReportOutputListInfoIterNext (supported) | [top]

> Returns items From a previous call To ReportOutputListInfoIterStart.

> Input Name | Type
> ReportOutputListInfoIterNext | ReportOutputListInfoIterNext
> Output Name | Type
> ReportOutputListInfoIterNextResult | ReportOutputListInfoIterNextResult

> Error Name | Description
> EACCESSDENIED |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EINVALIDTAG |  |

ReportOutputListInfoIterStart (supported) | [top]

> Initiates a Query for a list of report outputs.

> Input Name | Type
> ReportOutputListInfoIterStart | ReportOutputListInfoIterStart
> Output Name | Type
> ReportOutputListInfoIterStartResult | ReportOutputListInfoIterStartResult

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

ReportOutputRead (supported) | [top]

> Reads report output data From a file. API will fail if Length exceeds 1 MB.

> Input Name | Type
> ReportOutputRead | ReportOutputRead
> Output Name | Type
> ReportOutputReadResult | ReportOutputReadResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EREPORTNOTSCHEDULABLE |  |
> EREPORTOUTPUTFILENOTFOUND |  |
> EREPORTOUTPUTFILEREADERROR |  |
> EREPORTOUTPUTNOTFOUND |  |

ReportScheduleAdd (supported) | [top]

> Add a new report schedule.

> Input Name | Type
> ReportScheduleAdd | ReportScheduleAdd
> Output Name | Type
> ReportScheduleAddResult | ReportScheduleAddResult

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

ReportScheduleDelete (supported) | [top]

> Deletes a report schedule.

> Input Name | Type
> ReportScheduleDelete | ReportScheduleDelete
> Output Name | Type
> ReportScheduleDeleteResult | ReportScheduleDeleteResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EREPORTNOTSCHEDULABLE |  |
> EREPORTSCHEDULEDELETEERROR |  |

ReportScheduleDisable (supported) | [top]

> Disable a report schedule.

> Input Name | Type
> ReportScheduleDisable | ReportScheduleDisable
> Output Name | Type
> ReportScheduleDisableResult | ReportScheduleDisableResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EREPORTNOTSCHEDULABLE |  |

ReportScheduleEnable (supported) | [top]

> Enable a report schedule.

> Input Name | Type
> ReportScheduleEnable | ReportScheduleEnable
> Output Name | Type
> ReportScheduleEnableResult | ReportScheduleEnableResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EREPORTNOTLICENSED |  |
> EREPORTNOTSCHEDULABLE |  |

ReportScheduleListInfoIterEnd (supported) | [top]

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

> Input Name | Type
> ReportScheduleListInfoIterEnd | ReportScheduleListInfoIterEnd
> Output Name | Type
> ReportScheduleListInfoIterEndResult | ReportScheduleListInfoIterEndResult

> Error Name | Description
> EACCESSDENIED |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EINVALIDTAG |  |

ReportScheduleListInfoIterNext (supported) | [top]

> Returns items From a previous call To ReportScheduleListInfoIterStart.

> Input Name | Type
> ReportScheduleListInfoIterNext | ReportScheduleListInfoIterNext
> Output Name | Type
> ReportScheduleListInfoIterNextResult | ReportScheduleListInfoIterNextResult

> Error Name | Description
> EACCESSDENIED |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EINVALIDTAG |  |

ReportScheduleListInfoIterStart (supported) | [top]

> Initiates a Query for a list of report schedules.

> Input Name | Type
> ReportScheduleListInfoIterStart | ReportScheduleListInfoIterStart
> Output Name | Type
> ReportScheduleListInfoIterStartResult | ReportScheduleListInfoIterStartResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EREPORTAMBIGUOUS |  |
> EREPORTNOTSCHEDULABLE |  |

ReportScheduleModify (supported) | [top]

> Modify a report schedule.

> Input Name | Type
> ReportScheduleModify | ReportScheduleModify
> Output Name | Type
> ReportScheduleModifyResult | ReportScheduleModifyResult

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

ReportScheduleRun (supported) | [top]

> Runs a report schedule at that instant of time.

> Input Name | Type
> ReportScheduleRun | ReportScheduleRun
> Output Name | Type
> ReportScheduleRunResult | ReportScheduleRunResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EREPORTNOTLICENSED |  |
> EREPORTNOTSCHEDULABLE |  |

Element definition: ReportCategoryList | [top]

> Api To list report-categories and its details.

> Name | Type | Description
> CategoryNameOrId | xsd: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.
> CategoryProvenance | xsd:string optional | Possible Values:"custom" returns only custom Categories. "canned" returns only canned Categories. If not specified both custom and canned Categories are returned.

Element definition: ReportCategoryListResult | [top]

> Name | Type | Description
> CategoryList | ArrayOfCategoryListInfo optional | Contains list of Categories.

Element definition: ReportDesignerList | [top]

> API To list Reports created using report designer.

> Name | Type | Description
> CategoryNameOrId | xsd: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.
> ReportProvenance | ReportProvenance optional | It describes the category the report belongs.

Element definition: ReportDesignerListResult | [top]

> Name | Type | Description
> ReportList | ArrayOfReportListInfo optional | Contains list of Reports.

Element definition: ReportDesignerScheduleAdd | [top]

> API To schedule a report. Only Reports listed by ReportDesignerList API can be scheduled using this API. It creates a new schedule based on ScheduleContentInfo and a new report schedule object with the schedule and corresponding report being scheduled

> Name | Type | Description
> ReportScheduleInfo | ReportScheduleInfo | Details of a report schedule
> ScheduleContentInfo | ScheduleContentInfo | Details of a schedule

Element definition: ReportDesignerScheduleAddResult | [top]

> Name | Type | Description
> ReportScheduleId | ObjId | Specifies the Id of the report schedule created.

Element definition: ReportDesignerScheduleDelete | [top]

> API To delete a report schedule object and its associated schedule. Only report schedules for Reports returned by ReportDesignerList API can be deleted using this API.

> Name | Type | Description
> ReportScheduleNameOrId | ObjNameOrId | Name or Id of the report schedule.

Element definition: ReportDesignerScheduleDeleteResult | [top]

> [none]

Element definition: ReportDesignerScheduleModify | [top]

> API To modify a report schedule and/or its schedule details. Only report schedules for Reports returned by ReportDesignerList API can be modified using this API

> Name | Type | Description
> ReportScheduleInfo | ReportScheduleInfo optional | Details of modifiable contents of a report schedule. If this is not specified, ScheduleContentInfo should be specified.
> ReportScheduleNameOrId | ObjNameOrId | Specifies the Name or Id of the report schedule To be modified.
> ScheduleContentInfo | ScheduleContentInfo optional | Details of a schedule. If this is not specified, ReportScheduleInfo should be specified.

Element definition: ReportDesignerScheduleModifyResult | [top]

> [none]

Element definition: ReportDesignerShare | [top]

> Shares report output of specified report in the specified format To the mentioned EmailAddressList.

> Name | Type | Description
> EmailAddressList | EmailAddressList | Email addresses of recipients for a mail To be sent with an attachment when the report is generated.
> OutputFormat | ReportOutputFormat optional | Specifies the format of the report To be sent. Default Value is html.
> ReportNameOrId | xsd:string | The CLI Name or unique Id of the report To be shared.
> SubjectField | xsd:string optional | The string which should be sent as subject field in the email. Default: Generated Report: (provided-by-user) on (provided by user).
> TargetObjectNameOrId | ObjNameOrId optional | Specifies the Target object on which the report has To be shared. If not specified, the report is generated at the global level.

Element definition: ReportDesignerShareResult | [top]

> [none]

Element definition: ReportGraphListInfoIterEnd | [top]

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

> Name | Type | Description
> Tag | xsd:string | An opaque handle used by the DFM station To identify a temporary store.

Element definition: ReportGraphListInfoIterEndResult | [top]

> [none]

Element definition: ReportGraphListInfoIterNext | [top]

> Returns items From a previous call To ReportGraphListInfoIterStart

> Name | Type | Description
> Maximum | xsd:integer | The Maximum number of entries To retrieve. Range: [1..(2^31)-1]
> Tag | xsd:string | An opaque handle used by the DFM station To identify a temporary store.

Element definition: ReportGraphListInfoIterNextResult | [top]

> Name | Type | Description
> GraphList | ArrayOfGraphInfo | A list of Graphs.
> Records | xsd:integer | The number of Records actually returned. Range: [0..2^31-1].

Element definition: ReportGraphListInfoIterStart | [top]

> Initiates a Query for a list of Graphs for a particular report.

> Name | Type | Description
> ReportApplication | ReportApplication optional | Specifies the application To which the report belongs.
> ReportNameOrId | xsd: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]
> TargetObjectNameOrId | ObjNameOrId | Name or Id of the object for which Graphs have To be listed. Range for Id: [1..(2^31)-1]

Element definition: ReportGraphListInfoIterStartResult | [top]

> Name | Type | Description
> Records | xsd:integer | Number indicating how many items are available for future retrieval with ReportGraphListInfoIterNext. Range: [1..(2^31)-1]
> Tag | xsd:string | An opaque handle used by the DFM station To identify a temporary store. Used in subsequent calls To ReportGraphListInfoIterNext or ReportGraphListInfoIterEnd.

Element definition: ReportListInfoIterEnd | [top]

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

> Name | Type | Description
> Tag | xsd:string | An opaque handle used by the DFM station To identify a temporary store.

Element definition: ReportListInfoIterEndResult | [top]

> [none]

Element definition: ReportListInfoIterNext | [top]

> Returns items From a previous call To ReportListInfoIterStart

> Name | Type | Description
> Maximum | xsd:integer | The Maximum number of entries To retrieve. Range: [1..(2^31)-1]
> Tag | xsd:string | An opaque handle used by the DFM station To identify a temporary store.

Element definition: ReportListInfoIterNextResult | [top]

> Name | Type | Description
> Records | xsd:integer | The number of Records actually returned. Range: [0..2^31-1].
> ReportList | ArrayOfReportInfo | A list of Reports that can be scheduled.

Element definition: ReportListInfoIterStart | [top]

> Initiates a Query for a list of Reports that can be scheduled.

> Name | Type | Description
> ReportApplication | ReportApplication optional | Specifies the application for which Reports have To be listed. If not specified then all the Reports are listed.
> ReportNameOrId | xsd:string optional | Specifies the Name of report To be listed. For custom report Id can be specified. Range for Id: [1..(2^31)-1]
> ReportType | xsd:string optional | Specifies the Type for which Reports have To be listed. Possible Values: 'custom', 'built_in'.

Element definition: ReportListInfoIterStartResult | [top]

> Name | Type | Description
> Records | xsd:integer | Number indicating how many items are available for future retrieval with ReportListInfoIterNext. Range: [1..(2^31)-1]
> Tag | xsd:string | An opaque handle used by the DFM station To identify a temporary store. Used in subsequent calls To ReportListInfoIterNext or ReportListInfoIterEnd.

Element definition: ReportOutputDelete | [top]

> Deletes a report output.

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

Element definition: ReportOutputDeleteResult | [top]

> [none]

Element definition: ReportOutputListInfoIterEnd | [top]

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

> Name | Type | Description
> Tag | xsd:string | An opaque handle used by the DFM station To identify a temporary store.

Element definition: ReportOutputListInfoIterEndResult | [top]

> [none]

Element definition: ReportOutputListInfoIterNext | [top]

> Returns items From a previous call To ReportOutputListInfoIterStart.

> Name | Type | Description
> Maximum | xsd:integer | The Maximum number of entries To retrieve. Range: [1..(2^31)-1]
> Tag | xsd:string | An opaque handle used by the DFM station To identify a temporary store.

Element definition: ReportOutputListInfoIterNextResult | [top]

> Name | Type | Description
> ReportOutputList | ArrayOfReportOutputInfo | A list of outputs.

Element definition: ReportOutputListInfoIterStart | [top]

> Initiates a Query for a list of report outputs.

> Name | Type | Description
> IsSuccessful | xsd: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.
> ReportApplication | ReportApplication optional | Specifies the application for which Reports have To be listed. Default is 'control_center'.
> ReportNameOrId | xsd:string optional | Name of the report. For custom Reports it can either be Name or Id. Range for Id: [1..(2^31)-1]
> ReportOutputId | xsd:integer optional | Specifies the Id of the report output. If this is specified then filtering based on ObjectNameOrId and ReportScheduleNameOrId is ignored. Range: [1..(2^31)-1]
> ReportScheduleNameOrId | ObjNameOrId 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]
> TargetObjectNameOrId | ObjNameOrId 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]

Element definition: ReportOutputListInfoIterStartResult | [top]

> Name | Type | Description
> Records | xsd:integer | Number indicating how many items are available for future retrieval with ReportOutputListInfoIterNext. Range: [1..(2^31)-1]
> Tag | xsd:string | An opaque handle used by the DFM station To identify a temporary store. Used in subsequent calls To ReportOutputListInfoIterNext or ReportOutputListInfoIterEnd.

Element definition: ReportOutputRead | [top]

> Reads report output data From a file. API will fail if Length exceeds 1 MB.

> Name | Type | Description
> Length | xsd:integer | Number of bytes To read From the file. Range: [0..2^20]
> Offset | xsd:integer | Offset into file To start reading From. Range: [0..(2^31)-1]
> ReportOutputId | xsd:integer | Specifies the Id of the report output. Range: [1..(2^31)-1]

Element definition: ReportOutputReadResult | [top]

> Name | Type | Description
> FileData | xsd:string | Data read From the file. The data is is xml encoded.
> Length | xsd: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]
> OutputFormat | ReportOutputFormat | The output format of the file read.

Element definition: ReportScheduleAdd | [top]

> Add a new report schedule.

> Name | Type | Description
> ReportScheduleInfo | ReportScheduleInfo | Details of a report schedule

Element definition: ReportScheduleAddResult | [top]

> Name | Type | Description
> ReportScheduleId | ObjId | Specifies the Id of the report schedule created. Range: [1..(2^31)-1]

Element definition: ReportScheduleDelete | [top]

> Deletes a report schedule.

> Name | Type | Description
> ReportScheduleNameOrId | ObjNameOrId | Name or Id of the report schedule. Range for Id: [1..(2^31)-1]

Element definition: ReportScheduleDeleteResult | [top]

> [none]

Element definition: ReportScheduleDisable | [top]

> Disable a report schedule.

> Name | Type | Description
> ReportScheduleNameOrId | ObjNameOrId | Name or Id of the report schedule. Range for Id: [1..(2^31)-1]

Element definition: ReportScheduleDisableResult | [top]

> [none]

Element definition: ReportScheduleEnable | [top]

> Enable a report schedule.

> Name | Type | Description
> ReportScheduleNameOrId | ObjNameOrId | Name or Id of the report schedule. Range for Id: [1..(2^31)-1]

Element definition: ReportScheduleEnableResult | [top]

> [none]

Element definition: ReportScheduleListInfoIterEnd | [top]

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

> Name | Type | Description
> Tag | xsd:string | An opaque handle used by the DFM station To identify a temporary store.

Element definition: ReportScheduleListInfoIterEndResult | [top]

> [none]

Element definition: ReportScheduleListInfoIterNext | [top]

> Returns items From a previous call To ReportScheduleListInfoIterStart.

> Name | Type | Description
> Maximum | xsd:integer | The Maximum number of entries To retrieve. Range: [1..(2^31)-1]
> Tag | xsd:string | An opaque handle used by the DFM station To identify a temporary store.

Element definition: ReportScheduleListInfoIterNextResult | [top]

> Name | Type | Description
> ReportScheduleList | ArrayOfReportScheduleContentInfo | A list of report schedules.

Element definition: ReportScheduleListInfoIterStart | [top]

> Initiates a Query for a list of report schedules.

> Name | Type | Description
> IsEnabled | xsd: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.
> ReportApplication | ReportApplication optional | Specifies To list only those report schedules which involve Reports that belong To this application. Default is 'control_center'.
> ReportNameOrId | xsd:string optional | Name of the report. For custom Reports it can either be Name or Id. Range for Id: [1..(2^31)-1]
> ReportScheduleNameOrId | ObjNameOrId optional | Specifies the Name or Id of the report schedule To be listed. If this is specified then filtering the report schedules based on ReportNameOrId, ReportApplication, TargetObjectNameOrId 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]
> TargetObjectNameOrId | ObjNameOrId 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]

Element definition: ReportScheduleListInfoIterStartResult | [top]

> Name | Type | Description
> Records | xsd:integer | Number indicating how many items are available for future retrieval with ReportScheduleListInfoIterNext. Range: [1..(2^31)-1]
> Tag | xsd:string | An opaque handle used by the DFM station To identify a temporary store. Used in subsequent calls To ReportScheduleListInfoIterNext or ReportScheduleListInfoIterEnd.

Element definition: ReportScheduleModify | [top]

> Modify a report schedule.

> Name | Type | Description
> ReportScheduleInfo | ReportScheduleInfo | Details of modifiable contents of a report schedule.
> ReportScheduleNameOrId | ObjNameOrId | Specifies the Name or Id of the report schedule To be modified. Range for Id: [1..(2^31)-1]

Element definition: ReportScheduleModifyResult | [top]

> [none]

Element definition: ReportScheduleRun | [top]

> Runs a report schedule at that instant of time.

> Name | Type | Description
> ReportScheduleNameOrId | ObjNameOrId | Name or Id of the report schedule. Range for Id: [1..(2^31)-1]

Element definition: ReportScheduleRunResult | [top]

> Name | Type | Description
> ReportOutputId | xsd:integer | Specifies the Id of the report output generated. Range: [1..(2^31)-1]

Element definition: ArrayOfCategoryListInfo | [top]

> Name | Type | Description
> CategoryListInfo | CategoryListInfo[] |

Element definition: ArrayOfGraphInfo | [top]

> Name | Type | Description
> GraphInfo | GraphInfo[] |

Element definition: ArrayOfReportInfo | [top]

> Name | Type | Description
> ReportInfo | ReportInfo[] |

Element definition: ArrayOfReportListInfo | [top]

> Name | Type | Description
> ReportListInfo | ReportListInfo[] |

Element definition: ArrayOfReportOutputInfo | [top]

> Name | Type | Description
> ReportOutputInfo | ReportOutputInfo[] |

Element definition: ArrayOfReportScheduleContentInfo | [top]

> Name | Type | Description
> ReportScheduleContentInfo | ReportScheduleContentInfo[] |

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

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: ReportApplication | [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: ReportOutputFormat | [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: ReportProvenance | [top]

> Possible Values:"custom" returns only custom and modified_canned Reports. "canned" returns only canned Reports. If not specified all Reports are returned.

> [none]

Element definition: ReportScheduleInfo | [top]

> Detailed contents of a report schedule.

> Name | Type | Description
> ArchivalFormat | ReportOutputFormat optional | Format of the report To be saved. Default Value is html.
> EmailAddressList | EmailAddressList optional | Email addresses of recipients for a mail To be sent with an attachment when the report is generated.
> GraphName | xsd: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.
> IncludeDeletedObjects | xsd:boolean optional | Include deleted Objects in the report generated. Default Value is FALSE.
> ReportApplication | ReportApplication optional | Specifies the application To which a report belongs. Default is 'control_center'.
> ReportNameOrId | xsd:string optional | Name of the report. For custom Reports it can either be Name or Id. Required for ReportScheduleAdd API. Range for Id: [1..(2^31)-1]
> ReportScheduleName | ObjName optional | Specifies the Name of the report schedule To be created. This element is mandatory for 'ReportScheduleAdd'.
> SaveAllFields | xsd:boolean optional | Saves all fields, Ignored if ArchivalFormat is not perl or xml. Default Value is FALSE.
> ScheduleNameOrId | ObjNameOrId optional | Name or Id of a schedule. Required for ReportScheduleAdd API. Range for Id: [1..(2^31)-1]
> TargetObjectNameOrId | ObjNameOrId 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]

Element definition: ScheduleContentInfo | [top]

> Detailed schedule contents. A schedule can be a daily, weekly, or monthly schedule. A daily schedule may include both multiple recurring hourly schedules (HourlyList element) and/or individual non-recurring daily schedules (DailyList element). A weekly schedule may include multiple references To daily schedules To be run on specific Days of the week (WeeklySubscheduleList element) and/or individual non-recurring weekly schedules (WeeklyList element). A monthly schedule may include multiple non-recurring monthly schedules (MonthlyList 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 MonthlySubscheduleInfo element in the MonthlySubscheduleList.

> Name | Type | Description
> DailyList | ArrayOfDailyInfo optional | List of daily schedules. May only be used in a daily schedule.
> HourlyList | ArrayOfHourlyInfo optional | List of hourly schedules. May only be used in a daily schedule.
> IsModifiable | xsd: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. IsModifiable always appears in the output. It is not possible To use it as input.
> MonthlyList | ArrayOfMonthlyInfo optional | List of monthly schedules. May only be used in a monthly schedule.
> MonthlySubscheduleList | ArrayOfMonthlySubscheduleInfo optional | List of monthly sub-schedules used by the schedule. May only be used in a monthly schedule.
> ScheduleCategory | xsd:string optional | Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'. The default Value is 'dp_schedule'.
> ScheduleDescription | xsd: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 "".
> ScheduleId | ObjId optional | ID of the schedule. Ignored for DfmScheduleCreate. Required for all other calls. Range: [1..(2^31)-1]
> ScheduleName | ObjName | Name of the schedule. May not be numeric.
> ScheduleType | xsd: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
> WeeklyList | ArrayOfWeeklyInfo optional | List of weekly schedules. May only be used in a weekly schedule.
> WeeklySubscheduleList | ArrayOfWeeklySubscheduleInfo optional | List of weekly sub-schedules used by the schedule. May only be used in a weekly schedule.

Element definition: ArrayOfDailyInfo | [top]

> Name | Type | Description
> DailyInfo | DailyInfo[] |

Element definition: ArrayOfHourlyInfo | [top]

> Name | Type | Description
> HourlyInfo | HourlyInfo[] |

Element definition: ArrayOfMonthlyInfo | [top]

> Name | Type | Description
> MonthlyInfo | MonthlyInfo[] |

Element definition: ArrayOfMonthlySubscheduleInfo | [top]

> Name | Type | Description
> MonthlySubscheduleInfo | MonthlySubscheduleInfo[] |

Element definition: ArrayOfWeeklyInfo | [top]

> Name | Type | Description
> WeeklyInfo | WeeklyInfo[] |

Element definition: ArrayOfWeeklySubscheduleInfo | [top]

> Name | Type | Description
> WeeklySubscheduleInfo | WeeklySubscheduleInfo[] |

Element definition: CategoryListInfo | [top]

> Contains the details of the Categories

> Name | Type | Description
> CategoryId | xsd:integer | Unique identifier of category. Range: [1..2^31-1]
> CategoryList | ArrayOfCategoryListInfo optional | contains the list of sub-categories under a category.
> CategoryName | xsd:string | The Name of the category. Max Length: 64 chars
> IsCategoryCustom | xsd:boolean | Indicates that this category is a custom category. true if the category is a custom category. false otherwise.

Element definition: GraphInfo | [top]

> Describes the meta data of a graph

> Name | Type | Description
> DeprecatedBy | xsd:string optional | Name of the graph that replaces this graph. Will be absent for non-deprecated Graphs. Only returned via the GraphListInfoIterNext api.
> Description | xsd:string optional | Description of the graph. Maximum Length of 1024 characters. Only returned via the ReportGraphListInfoIterNext api.
> GraphLines | ArrayOfGraphLineInfo optional | Specifies the list of Lines in the graph. Only returned via the GraphListInfoIterNext api.
> GraphName | xsd:string | Unique Name of the graph. Maximum Length of 64 characters.
> GraphPrettyName | xsd:string | Long Name of the graph. Maximum Length of 64 characters.
> IsDefault | xsd:boolean optional | Specifies whether the graph is the default graph for the report. Only returned via the ReportGraphListInfoIterNext api.
> IsDeprecated | xsd:boolean optional | true if the graph is deprecated. Only returned via the GraphListInfoIterNext api.

Element definition: ObjName | [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 ObjName 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 ObjFullName 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 ObjName 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 ObjName 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: ReportInfo | [top]

> Describes the Name of the report.

> Name | Type | Description
> DeprecatedBy | xsd:string optional | Name of the report that replaces this report. Will be absent for non-deprecated Reports.
> Description | xsd:string optional | Description of the report. Max Length: 1024 chars
> DisplayTab | xsd: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'
> IsDeprecated | xsd:boolean optional | true if the report is deprecated.
> OutputFormatList | ArrayOfReportOutputFormat | The list of output formats supported by report.
> RbacOperation | xsd:string | The Name of the RBAC Operation required To View the report. Use RbacOperationInfoList To get the list of currently valid operations. Max Length: 255 chars
> ReportApplication | ReportApplication | Application To which the report belongs.
> ReportId | xsd:integer optional | Id of the report in case of Custom Reports. Range: [1..(2^31)-1]
> ReportName | xsd:string | Unique Name of the report. Max Length: 64 chars
> ReportPrettyName | xsd:string | Long Name of the report. Max Length: 64 chars
> ReportType | xsd:string | Type of the report. Possible Values: 'built_in' 'custom'

Element definition: ReportListInfo | [top]

> Contains the details of the Reports.

> Name | Type | Description
> CategoryId | xsd:integer optional | Unique identifier of category. The CategoryId is not returned for Reports which do not belong To any category. Range: [1..2^31-1]
> IsIntervalAllowed | xsd:boolean | Specifies if the report can be generated for a specific time Interval.
> ReportDescription | xsd:string optional | Description of the report. Max Length: 1024 chars
> ReportDesignFileName | xsd: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
> ReportId | xsd:integer | This contains the unique Id of the report. Range: [1..2^31-1]
> ReportName | xsd:string | This contains the unique cli Name of the report. Max Length: 64 chars
> ReportPrettyName | xsd:string | This contains the pretty Name of the report displayed in UI. Max Length: 64 chars
> ReportProvenance | ReportProvenance | It describes the category the report belongs.

Element definition: ReportOutputInfo | [top]

> Describes the contents of an output.

> Name | Type | Description
> FailureReason | xsd:string optional | Specifies the Reason as To why the output failed. Present only in case of failure. Maximum Length of 255 characters.
> GraphName | xsd:string optional | Name of the graph.
> ReportApplication | ReportApplication | Specifies the application To which a report belongs. Default is 'control_center'.
> ReportId | xsd:integer optional | specifies the Id of the report in case of custom Reports. Range: [1..(2^31)-1]
> ReportName | xsd:string | Name of the report.
> ReportOutputId | xsd:integer | Specifies the output Id. Range: [1..(2^31)-1]
> ReportScheduleId | ObjId | Specifies the Id of the report schedule. Range: [1..(2^31)-1]
> ReportScheduleName | ObjName | Specifies the Name of the report schedule.
> RunBy | xsd:string | Specifies the Name of the user who generated the report output. Maximum Length of 255 characters.
> RunStatus | xsd:string | Specifies the Status of the report output. Possible Values: 'pending' 'running' 'succeeded' 'failed' 'aborted'
> RunTime | xsd: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.
> TargetObjectId | xsd:integer | Specifies the object on which the output was generated. Range: [1..(2^31)-1]
> TargetObjectName | xsd:string | Specifies the Name of the object on which the output was generated.

Element definition: ReportScheduleContentInfo | [top]

> Describes the contents of a report schedule.

> Name | Type | Description
> ArchivalFormat | ReportOutputFormat | Specifies the format in which the report is saved.
> EmailAddressList | EmailAddressList optional | Email addresses of recipients for a mail To be sent with an attachment when the report is generated.
> GraphName | xsd:string optional | Name of the graph. Maximum Length of 64 characters.
> IncludeDeletedObjects | xsd:boolean | Include deleted Objects in the report generated.
> IsEnabled | xsd:boolean optional | Specifies whether the state of the report schedule is enabled.
> IsSuccessful | xsd:boolean optional | Specifies whether the last run Result was successful. This element is not present if the report schedule has not run even once.
> LastRunTime | xsd: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.
> ReportApplication | ReportApplication | Specifies the application To which a report belongs. Default is 'control_center'.
> ReportId | xsd:integer optional | Specifies the Id of the custom report. Range: [1..(2^31)-1]
> ReportName | xsd:string | Specifies the Name of the report.
> ReportScheduleId | ObjId | Specifies the schedule Id. Range: [1..(2^31)-1]
> ReportScheduleName | ObjName | Specifies the Name of the report schedule.
> SaveAllFields | xsd:boolean | Saves all fields, Only in perl and xml format.
> ScheduleId | xsd:integer | Specifies the Id of the schedule. Range: [1..(2^31)-1]
> ScheduleName | xsd:string | Specifies the Name of the schedule.
> TargetObjectId | xsd:integer | Specifies the Id of the object on which the report schedule is scheduled To run. Range: [1..(2^31)-1]
> TargetObjectName | xsd:string | Specifies the Name of the object on which the report schedule is scheduled To run.

Element definition: ArrayOfGraphLineInfo | [top]

> Name | Type | Description
> GraphLineInfo | GraphLineInfo[] |

Element definition: ArrayOfReportOutputFormat | [top]

> Name | Type | Description
> ReportOutputFormat | ReportOutputFormat[] |

Element definition: DailyInfo | [top]

> The Attributes of a daily schedule. May only be used in a daily schedule.

> Name | Type | Description
> ItemId | xsd:integer optional | ID of the daily item within the schedule. Ignored for dfm-schedule-create/modify and Required for all other calls. Will be presented in output. Range: [1..(2^31)-1]
> StartHour | xsd:integer | Start Hour of the daily schedule. Range: [0..23]
> StartMinute | xsd:integer | Start Minute of the daily schedule. Range: [0..59]

Element definition: HourlyInfo | [top]

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

> Name | Type | Description
> EndHour | xsd:integer | End Hour of the hourly schedule. Range: [0..23]
> EndMinute | xsd:integer | End Minute of the hourly schedule. Range: [0..59]
> Frequency | xsd:integer | Number of minutes between each schedule. Range: [5..1440]
> ItemId | xsd:integer optional | ID of the hourly item within the schedule. Ignored for dfm-schedule-create/modify and Required for all other calls. Will be presented in output. Range: [1..(2^31)-1]
> StartHour | xsd:integer | Start Hour of the hourly schedule. Range: [0..23]
> StartMinute | xsd:integer | Start Minute of the hourly schedule. Range: [0..59]

Element definition: MonthlyInfo | [top]

> The Attributes of a monthly schedule. May only be used in a monthly schedule.

> Name | Type | Description
> DayOfMonth | xsd:integer optional | If DayOfMonth 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 DayOfMonth is set, then both WeekOfMonth and DayOfWeek must not be set. Range: [1..31]
> DayOfWeek | xsd:integer optional | Day of week for the schedule. If DayOfWeek is set, then WeekOfMonth must also be set and DayOfMonth must not be set. Range: [0..6] (0 = "Sun")
> ItemId | xsd:integer optional | ID of the monthly item within the schedule. Ignored for dfm-schedule-create/modify and Required for all other calls. Will be presented in output. Range: [1..(2^31)-1]
> StartHour | xsd:integer | Start Hour of the monthly schedule. Range: [0..23]
> StartMinute | xsd:integer | Start Minute of the monthly schedule. Range: [0..59]
> WeekOfMonth | xsd:integer optional | A Value of 5 indicates the last week of the Month. If WeekOfMonth is set, then DayOfWeek must also be set and DayOfMonth must not be set. Range: [1..5]

Element definition: MonthlySubscheduleInfo | [top]

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

> Name | Type | Description
> SubscheduleId | ObjId | ID of the subschedule To be used. Range: [1..(2^31)-1]
> SubscheduleName | ObjName 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]

Element definition: WeeklyInfo | [top]

> The Attributes of a weekly schedule. May only be used in a weekly schedule.

> Name | Type | Description
> DayOfWeek | xsd:integer | Day of week for the schedule. Range: [0..6] (0 = "Sun")
> ItemId | xsd:integer optional | ID of the weekly item within the schedule Ignored for dfm-schedule-create/modify and Required for all other calls. Will be presented in output. Range: [1..(2^31)-1]
> StartHour | xsd:integer | Start Hour of the weekly schedule. Range: [0..23]
> StartMinute | xsd:integer | Start Minute of the weekly schedule. Range: [0..59]

Element definition: WeeklySubscheduleInfo | [top]

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

> Name | Type | Description
> EndDayOfWeek | xsd:integer | End Day To be applied To the schedule being used. Range: [0..6] (0 = "Sun")
> ItemId | xsd:integer optional | ID of the use Type within the schedule. Ignored for dfm-schedule-create/modify and Required for all other calls. Will be presented in output. Range: [1..(2^31)-1]
> StartDayOfWeek | xsd:integer | Start Day To be applied To the schedule being used. Range: [0..6] (0 = "Sun")
> SubscheduleId | ObjId | ID of the subschedule To be used. Range: [1..(2^31)-1]
> SubscheduleName | ObjName 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]

Element definition: GraphLineInfo | [top]

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

> Name | Type | Description
> SampleFormat | xsd: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]
> SampleName | xsd:string | Name of the sample. Maximum Length: 64 characters.
> SamplePrettyName | xsd:string | The Name of the sample which can be used for displaying. Maximum Length: 64 characters.
> SampleSuffix | xsd:string | The Unit of the sample. If the Unit is not known then 'none' is returned. Possible Values: 'bytes' 'percentage' 'minutes' 'none'