APIs in Category: dfm-schedule | API version 3.7.1

dfm-schedule-content-get dfm-schedule-create dfm-schedule-daily-add dfm-schedule-daily-delete dfm-schedule-daily-modify dfm-schedule-dependency dfm-schedule-destroy dfm-schedule-hourly-add dfm-schedule-hourly-delete dfm-schedule-hourly-modify dfm-schedule-list dfm-schedule-list-info-iter-end dfm-schedule-list-info-iter-next dfm-schedule-list-info-iter-start dfm-schedule-modify dfm-schedule-monthly-add dfm-schedule-monthly-delete dfm-schedule-monthly-modify dfm-schedule-monthly-subschedule-set dfm-schedule-monthly-subschedule-unset dfm-schedule-rename dfm-schedule-weekly-add dfm-schedule-weekly-delete dfm-schedule-weekly-modify dfm-schedule-weekly-subschedule-add dfm-schedule-weekly-subschedule-delete dfm-schedule-weekly-subschedule-modify | This set of API's is being used to manage schedules. The schedule will be used by the following: - data protection policy to provide Snapshot, SnapVault and/or SnapMirror protection. A schedule can be of type daily, weekly or monthly. - report schedules to save reports on a scheduled basis. All date/time ranges in the APIs are inclusive.

NetApp Manage ONTAP

dfm-schedule-content-get | [top]

> Get the content of a given schedule.

> Input Name | Range | Type | Description
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> schedule-name-or-id |  | obj-name-or-id | Name or ID of the schedule
> Output Name | Range | Type | Description
> schedule-content-info |  | schedule-content-info | Details of a schedule

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-create | [top]

> Create a new schedule with the given name. The schedule type may be daily, weekly, or monthly.

> Input Name | Range | Type | Description
> schedule-content-info |  | schedule-content-info | Details of a schedule
> Output Name | Range | Type | Description
> schedule-id |  | obj-id | A unique ID of the schedule

> Errno | Description
> EDATABASEERROR |  |
> ESCHEDULEINVALIDINPUT |  |
> ESCHEDULEDUPLICATE |  |

dfm-schedule-daily-add | [top]

> Create a single schedule within a daily schedule.

> Input Name | Range | Type | Description
> daily-content |  | daily-info | Content of the daily schedule.
> daily-schedule-name-or-id |  | obj-name-or-id | Name or ID of a daily schedule
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> Output Name | Range | Type | Description
> item-id |  | integer | An ID of the daily item within the schedule

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> ESCHEDULENOTMODIFIABLE |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-daily-delete | [top]

> Delete a single schedule within a daily schedule.

> Input Name | Range | Type | Description
> daily-schedule-name-or-id |  | obj-name-or-id | Name or ID of a daily schedule
> item-id |  | integer | An ID of the daily item within the schedule. Range: [1..(2^31)-1]
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-daily-modify | [top]

> Modify a single schedule within a daily schedule. Sample schedules cannot be modified.

> Input Name | Range | Type | Description
> daily-content |  | daily-info | Content of the daily schedule.
> daily-schedule-name-or-id |  | obj-name-or-id | Name or ID of a daily schedule
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> ESCHEDULENOTMODIFIABLE |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-dependency | [top]

> Return a list of other DP policies, report schedule and schedules using the specified schedule.

> Input Name | Range | Type | Description
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> schedule-name-or-id |  | obj-name-or-id | Name or identifier of a schedule.
> Output Name | Range | Type | Description
> schedule-assignees |  | schedule-assignee[] | List of other DP policies, report schedules and schedules using the specified schedule. The list returned will depend on the schedule category. For schedule catedory 'dfm_schedule' only report schedules and the DFM schedules using this schedule will be returned. For schedule category 'dp_schedule' only DP policies and the DP schedules using this schedule will be returned. The list excludes DP policies, report schedules or schedules that the caller has no permissions to read.
> schedule-in-use |  | boolean | For schedule category 'dfm_schedule' this is true if its used by report schedules or DFM schedules. For schedule category 'dp_schedule' this is true if its used by DP policies or DP schedules.

> Errno | Description
> ESCHEDULENOTFOUND |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-destroy | [top]

> Delete a schedule with the given name or ID. A schedule that is used by another schedule(s) may not be deleted and an error will be returned. Sample schedules cannot be destroyed.

> Input Name | Range | Type | Description
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> schedule-name-or-id |  | obj-name-or-id | Name or ID of the schedule

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> EACCESSDENIED |  |
> ESCHEDULENOTMODIFIABLE |  |
> EDATABASEERROR |  |
> ESCHEDULEINUSE |  |

dfm-schedule-hourly-add | [top]

> Create an hourly schedule within a daily schedule. An hourly schedule specifies the frequency of schedules to be run within the start time and end time.

> Input Name | Range | Type | Description
> daily-schedule-name-or-id |  | obj-name-or-id | Name or ID of a daily schedule
> hourly-content |  | hourly-info | Content of the hourly schedule.
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> Output Name | Range | Type | Description
> item-id |  | integer | An ID of the hourly item within the schedule

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> ESCHEDULENOTMODIFIABLE |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-hourly-delete | [top]

> Delete an hourly schedule within a daily schedule.

> Input Name | Range | Type | Description
> daily-schedule-name-or-id |  | obj-name-or-id | Name or ID of a daily schedule
> item-id |  | integer | An ID of the hourly item within the schedule. Range: [1..(2^31)-1]
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-hourly-modify | [top]

> Modify an hourly schedule within a daily schedule. Sample schedules cannot be modified.

> Input Name | Range | Type | Description
> daily-schedule-name-or-id |  | obj-name-or-id | Name or ID of a daily schedule
> hourly-content |  | hourly-info | Content of the hourly schedule.
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> ESCHEDULENOTMODIFIABLE |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-list | [top]

> List all existing schedule IDs and types.

> Input Name | Range | Type | Description
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> Output Name | Range | Type | Description
> schedule-list |  | schedule-id-info[] | List of schedule IDs

> Errno | Description
> EDATABASEERROR |  |

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

> Tell the DFM station that the temporary store associated with the specified tag is no longer necessary

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

> Errno | Description
> EINVALIDTAG |  |
> ESCHEDULEINVALIDINPUT |  |

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

> Iterate over the list of schedules stored in the temporary store. The DFM internally maintains a cursor pointing to the last record returned. Subsequent calls to this API will return the records after the cursor up to the specified "maximum" or number of actual records left.

> Input Name | Range | Type | Description
> maximum |  | integer | Maximum number of schedules to retrieve
> 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.
> schedule-content-list |  | schedule-content-info[] | List of detailed schedule contents

> Errno | Description
> EINVALIDTAG |  |
> ESCHEDULEINVALIDINPUT |  |

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

> The dfm-schedule-list-info-iter-* set of APIs are used to retrieve a list of schedule contents

> Input Name | Range | Type | Description
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> schedule-name-or-id |  | obj-name-or-id optional | Name or ID of the schedule. If specified, only this schedule is listed.
> Output Name | Range | Type | Description
> records |  | integer | Number of items saved for future retrieval
> tag |  | string | An opaque handle used by the DFM station to identify a temporary store.

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-modify | [top]

> Modify a schedule's details in the database. When the zapi is called, all details within the schedule will be removed and replace by the new details specified in schedule-content. Sample schedules cannot be modified. schedule-id and schedule-type cannot be modified.

> Input Name | Range | Type | Description
> schedule-content-info |  | schedule-content-info | Details of a schedule

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> ESCHEDULENOTFOUND |  |
> EACCESSDENIED |  |
> ESCHEDULEDUPLICATE |  |
> ESCHEDULENOTMODIFIABLE |  |
> EDATABASEERROR |  |

dfm-schedule-monthly-add | [top]

> Specify a single schedule within a monthly schedule. Either day-of-month, or both week-of-month and day-of-week must be specified.

> Input Name | Range | Type | Description
> monthly-content |  | monthly-info | Content of the monthly schedule.
> monthly-schedule-name-or-id |  | obj-name-or-id | Name or ID of a weekly schedule
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> Output Name | Range | Type | Description
> item-id |  | integer | An ID of the monthly item within the schedule

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> ESCHEDULENOTMODIFIABLE |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-monthly-delete | [top]

> Delete a single schedule within a monthly schedule

> Input Name | Range | Type | Description
> item-id |  | integer | An ID of the monthly item within the schedule. Range: [1..(2^31)-1]
> monthly-schedule-name-or-id |  | obj-name-or-id | Name or ID of a weekly schedule
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-monthly-modify | [top]

> Modify a single schedule within a monthly schedule. Sample schedules cannot be modified.

> Input Name | Range | Type | Description
> monthly-content |  | monthly-info | Content of the monthly schedule.
> monthly-schedule-name-or-id |  | obj-name-or-id | Name or ID of a monthly schedule
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> ESCHEDULENOTMODIFIABLE |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-monthly-subschedule-set | [top]

> Specify a sub-schedule to be used by a monthly schedule. On top of the individual monthly events, a monthly schedule may only have 1 daily subschedule OR 1 weekly schedule. If this monthly schedule already has a daily or weekly schedule, this command replaces the old one.

> Input Name | Range | Type | Description
> monthly-schedule-name-or-id |  | obj-name-or-id | Name or ID of the monthly schedule
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> subschedule-name-or-id |  | obj-name-or-id | Name or ID of the schedule to be used by the monthly schedule

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-monthly-subschedule-unset | [top]

> Unset a sub-schedule used by a monthly schedule.

> Input Name | Range | Type | Description
> monthly-schedule-name-or-id |  | obj-name-or-id | Name or ID of the monthly schedule
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-rename | [top]

> Rename a schedule. Sample schedules cannot be renamed.

> Input Name | Range | Type | Description
> new-schedule-name |  | string | A new unique name of the schedule
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> schedule-name-or-id |  | obj-name-or-id | Name or ID of the schedule

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> EACCESSDENIED |  |
> ESCHEDULEDUPLICATE |  |
> ESCHEDULENOTMODIFIABLE |  |
> EDATABASEERROR |  |

dfm-schedule-weekly-add | [top]

> Specify a single schedule within a weekly schedule.

> Input Name | Range | Type | Description
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> weekly-content |  | weekly-info | Content of the weekly schedule.
> weekly-schedule-name-or-id |  | obj-name-or-id | Name or ID of a weekly schedule
> Output Name | Range | Type | Description
> item-id |  | integer | An ID of the weekly item within the schedule

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> ESCHEDULENOTMODIFIABLE |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-weekly-delete | [top]

> Delete a single schedule within a weekly schedule.

> Input Name | Range | Type | Description
> item-id |  | integer | An ID of the weekly item within the schedule. Range: [1..(2^31)-1]
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> weekly-schedule-name-or-id |  | obj-name-or-id | Name or ID of a weekly schedule

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-weekly-modify | [top]

> Modify a single schedule within a weekly schedule. Sample schedules canot be modified.

> Input Name | Range | Type | Description
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> weekly-content |  | weekly-info | Content of the weekly schedule.
> weekly-schedule-name-or-id |  | obj-name-or-id | Name or ID of a weekly schedule

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> ESCHEDULENOTMODIFIABLE |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-weekly-subschedule-add | [top]

> Specify which daily schedule will be used on a certain range of days within a weekly schedule

> Input Name | Range | Type | Description
> daily-schedule-name-or-id |  | obj-name-or-id | Name or ID of a daily schedule
> end-day-of-week |  | integer | Day of week for the schedule. Range: [0..6] (0 = "Sun")
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> start-day-of-week |  | integer | Day of week for the schedule. Range: [0..6] (0 = "Sun")
> weekly-schedule-name-or-id |  | obj-name-or-id | Name or ID of a weekly schedule
> Output Name | Range | Type | Description
> item-id |  | integer | An ID of the weekly use item within the schedule. Range: [1..(2^31)-1]

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> ESCHEDULENOTMODIFIABLE |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-weekly-subschedule-delete | [top]

> Specify which daily schedule to be deleted within a weekly schedule

> Input Name | Range | Type | Description
> item-id |  | integer | An ID of the weekly use item within the schedule. Range: [1..(2^31)-1]
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> weekly-schedule-name-or-id |  | obj-name-or-id | Name or ID of a weekly schedule

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dfm-schedule-weekly-subschedule-modify | [top]

> Specify which daily schedule will be used on a certain range of days within a weekly schedule. Permenent of sample schedules cannot be modified.

> Input Name | Range | Type | Description
> daily-schedule-name-or-id |  | obj-name-or-id | Name or ID of a weekly schedule
> end-day-of-week |  | integer | Day of week for the schedule. Range: [0..6] (0 = "Sun")
> item-id |  | integer | An ID of the weekly use item within the schedule. Range: [1..(2^31)-1]
> schedule-category |  | string | Specifies the category of the schedule. Possible values are: 'dfm_schedule', 'dp_schedule'.
> start-day-of-week |  | integer | Day of week for the schedule. Range: [0..6] (0 = "Sun")
> weekly-schedule-name-or-id |  | obj-name-or-id | Name or ID of a weekly schedule

> Errno | Description
> ESCHEDULEINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> ESCHEDULENOTFOUND |  |
> ESCHEDULENOTMODIFIABLE |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

Element definition: daily-info | [top]

> 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]

Element definition: hourly-info | [top]

> 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]

Element definition: monthly-info | [top]

> 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]

Element definition: obj-id | [top]

> Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed to be 0, which is interpreted as a null value, e.g., a reference to no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed to assign an ID to an object. Therefore, an input element of type obj-id is always used to refer to an existing object by its ID. The ZAPI must specify the object's DFM object type (e.g. data set, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the value of an obj-id input element does not match the ID of any existing DFM object of the specified type or types, then typically the ZAPI fails with error code EOBJECTNOTFOUND. A ZAPI may deviate from this general rule, for example, it may return a more specific error code. In either case, the ZAPI specification must document its behavior.

> [none]

Element definition: obj-name-or-id | [top]

> Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI type string. An obj-name-or-id must contain between 1 and 64 characters, and must conform to one of the following formats: It must have the format of an obj-name, or It must be the decimal numeric string form of a positive integer whose value is in the range [1..2^31 - 1]. Elements of type obj-name-or-id are used only as inputs to ZAPIs. The value must match either the name or internal ID of an existing DFM object. The ZAPI must specify the object's DFM object type (e.g. data set, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the format of an obj-name-or-id input element does not conform, or the value does not match the name or ID of an existing object, then generally the ZAPI documents that it fails with error code EOBJECTNOTFOUND. A ZAPI may return more specific error codes. In such cases, the ZAPI specification must document its behavior. If a ZAPI can accept a null value (e.g. reference to no object at all) for such an element, then the element is declared optional, and the absence of the input element represents a null value.

> [none]

Element definition: schedule-assignee | [top]

> Description of a DFM object using the schedule.

> Name | Range | Type | Description
> assignee-full-name |  | obj-full-name | Full name of a DFM object.
> assignee-id |  | obj-id | Identification number of a DFM object.
> assignee-type |  | string | Type of DFM object. Possible values are: 'dp_policy', 'dp_schedule', 'dfm_schedule' and 'report_schedule'.

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

> 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 | Specifies the category of the schedule. Possible values are: 'dfm_schedule', '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.

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

> The attributes of a id list

> Name | Range | Type | Description
> id |  | obj-id | ID of the schedule. Range: [1..(2^31)-1]
> name |  | obj-name | Name of the schedule. May not be numeric.
> type |  | string | Type of schedule. Possible values are: daily, weekly, monthly

Element definition: weekly-info | [top]

> 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]

Element definition: daily-info | [top]

> 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]

Element definition: hourly-info | [top]

> 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]

Element definition: monthly-info | [top]

> 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]

Element definition: monthly-subschedule-info | [top]

> 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]

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

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

> [none]

Element definition: obj-id | [top]

> Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed to be 0, which is interpreted as a null value, e.g., a reference to no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed to assign an ID to an object. Therefore, an input element of type obj-id is always used to refer to an existing object by its ID. The ZAPI must specify the object's DFM object type (e.g. data set, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the value of an obj-id input element does not match the ID of any existing DFM object of the specified type or types, then typically the ZAPI fails with error code EOBJECTNOTFOUND. A ZAPI may deviate from this general rule, for example, it may return a more specific error code. In either case, the ZAPI specification must document its behavior.

> [none]

Element definition: obj-name | [top]

> Name of a DFM object. This typedef is an alias for the builtin 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 data sets, DP schedules, and DP policies. This means that no two data sets may have the same name, but a data set may have the same name as a DP schedule or DP policy. In general, object names are compared in a case-insensitive manner. This means that, for example, "MyObject" and "MYOBJECT" are considered to be the same name for purposes of: creating new objects, renaming existing objects, or looking up an object by name. On the other hand, ZAPIs that return an obj-name generally do not change the capitalization at all. For example, if an object's name has been set to "MyObject", then list iteration ZAPIs that return the object's name return it as "MyObject" rather than "MYOBJECT" or "myobject". ZAPIs that operate on obj-name values and do not follow these general rules about case sensitivity must document the rules that they do follow. One important exception to these general rules is that volumes, qtrees, OSSV directories, SRM paths, interfaces, FCP targets and FC switch ports all have case-sensitive names. When looking up objects of these types by name, the case must match the object name.

> [none]

Element definition: weekly-subschedule-info | [top]

> 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]

Element definition: obj-id | [top]

> Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed to be 0, which is interpreted as a null value, e.g., a reference to no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed to assign an ID to an object. Therefore, an input element of type obj-id is always used to refer to an existing object by its ID. The ZAPI must specify the object's DFM object type (e.g. data set, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the value of an obj-id input element does not match the ID of any existing DFM object of the specified type or types, then typically the ZAPI fails with error code EOBJECTNOTFOUND. A ZAPI may deviate from this general rule, for example, it may return a more specific error code. In either case, the ZAPI specification must document its behavior.

> [none]

Element definition: obj-name | [top]

> Name of a DFM object. This typedef is an alias for the builtin 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 data sets, DP schedules, and DP policies. This means that no two data sets may have the same name, but a data set 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]