Create a schedule
Use this endpoint to set up a new schedule for jobs and automate task execution based on specified timing criteria. You can define the schedule using either cron or interval fields, depending on your needs.
HTTP method and endpoint
POST /cluster/schedules
Introduced in
ONTAP 9.6
Usage notes
Creates a schedule.
Required Fields
-
name - Name of the job schedule. You must provide a minutes field for a cron schedule and an interval field for an interval schedule. Do not provide both a cron field and an interval field.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
return_records |
boolean |
query |
False |
The default is false. If set to true, the records are returned.
|
Request Body
| Name | Type | Description |
|---|---|---|
cluster |
The cluster that owns the schedule. Defaults to the local cluster. |
|
cron |
Details for schedules of type cron. |
|
interval |
string |
An ISO-8601 duration formatted string. |
name |
string |
Schedule name. Required in the URL or POST body. |
scope |
string |
If the schedule is owned by a data SVM, then the scope is set to svm. Otherwise it will be set to cluster. |
svm |
||
type |
string |
Schedule type |
uuid |
string |
Job schedule UUID |
Example request
{
"cluster": {
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"cron": {
"days": [
"integer"
],
"hours": [
"integer"
],
"minutes": [
"integer"
],
"months": [
"integer"
],
"weekdays": [
"integer"
]
},
"interval": "P1DT2H3M4S",
"name": "string",
"scope": "string",
"svm": {
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"type": "string",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
Response
Status: 201, Created
Error
Status: Default
ONTAP Error Response Codes
| Error Code | Description |
|---|---|
458788 |
The schedule specified is not a valid schedule. |
459760 |
The schedule specified is not a valid schedule. |
459763 |
Schedule cannot be created locally using the remote cluster name as the owner. |
459764 |
Cannot create a schedule with the same name as an existing schedule from the MetroCluster partner cluster but of a different schedule type. |
460783 |
As this is a MetroCluster configuration and the local cluster is waiting for switchback, changes to non-system schedules are not allowed. |
460784 |
An error occurred creating the remote cluster version of this schedule. |
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
cluster
The cluster that owns the schedule. Defaults to the local cluster.
| Name | Type | Description |
|---|---|---|
name |
string |
Cluster name |
uuid |
string |
Cluster UUID |
cron
Details for schedules of type cron.
| Name | Type | Description |
|---|---|---|
days |
array[integer] |
The days of the month the schedule runs. Leave empty for all. |
hours |
array[integer] |
The hours of the day the schedule runs. Leave empty for all. |
minutes |
array[integer] |
The minutes the schedule runs. Required on POST for a cron schedule. |
months |
array[integer] |
The months of the year the schedule runs. Leave empty for all. |
weekdays |
array[integer] |
The weekdays the schedule runs. Leave empty for all. |
svm
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
schedule
Complete schedule information
| Name | Type | Description |
|---|---|---|
cluster |
The cluster that owns the schedule. Defaults to the local cluster. |
|
cron |
Details for schedules of type cron. |
|
interval |
string |
An ISO-8601 duration formatted string. |
name |
string |
Schedule name. Required in the URL or POST body. |
scope |
string |
If the schedule is owned by a data SVM, then the scope is set to svm. Otherwise it will be set to cluster. |
svm |
||
type |
string |
Schedule type |
uuid |
string |
Job schedule UUID |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |