job
Suggest changes
PDFs
job-bad-erase
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-bad-get-iter
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-by-node-get
This ONTAPI call does not have an equivalent REST API call.
job-by-node-get-iter
This ONTAPI call does not have an equivalent REST API call.
job-completed-get
GET /api/cluster/jobs/{uuid}?state=success|failure
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-restarted |
No REST Equivalent |
|
job-category |
No REST Equivalent |
|
job-completion |
message |
|
job-description |
description |
|
job-dropdead-time |
No REST Equivalent |
|
job-end-time |
end_time |
|
job-id |
No REST Equivalent |
|
job-name |
No REST Equivalent |
|
job-node |
No REST Equivalent |
|
job-priority |
No REST Equivalent |
|
job-progress |
message |
|
job-queue-time |
No REST Equivalent |
|
job-schedule |
No REST Equivalent |
|
job-start-time |
start_time |
|
job-state |
state |
ONTAPI State → REST API State |
job-status-code |
code |
|
job-type |
No REST Equivalent |
|
job-username |
No REST Equivalent |
|
job-uuid |
uuid |
|
job-vserver |
svm.name |
|
job-id |
No REST Equivalent |
job-completed-get-iter
GET /api/cluster/jobs?state=success|failure
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-restarted |
No REST Equivalent |
|
job-category |
No REST Equivalent |
|
job-completion |
message |
|
job-description |
description |
|
job-dropdead-time |
No REST Equivalent |
|
job-end-time |
end_time |
|
job-id |
No REST Equivalent |
|
job-name |
No REST Equivalent |
|
job-node |
No REST Equivalent |
|
job-priority |
No REST Equivalent |
|
job-progress |
message |
|
job-queue-time |
No REST Equivalent |
|
job-schedule |
No REST Equivalent |
|
job-start-time |
start_time |
|
job-state |
state |
ONTAPI State → REST API State |
job-status-code |
code |
|
job-type |
No REST Equivalent |
|
job-username |
No REST Equivalent |
|
job-uuid |
uuid |
|
job-vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
job-delete
DELETE /api/cluster/jobs/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-id |
No REST Equivalent |
The job-id property is represented as the "uuid" in the resource path. |
job-delete-iter
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-expunge
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-expunge-iter
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-get
GET /api/cluster/jobs/{uuid}
Note: The REST API resource /api/cluster/jobs applies a filter based on the schedule property (@now|-) to remove background system jobs.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-restarted |
No REST Equivalent |
|
job-category |
No REST Equivalent |
|
job-completion |
message |
|
job-description |
description |
|
job-dropdead-time |
No REST Equivalent |
|
job-end-time |
end_time |
|
job-id |
No REST Equivalent |
|
job-name |
No REST Equivalent |
|
job-node |
No REST Equivalent |
|
job-priority |
No REST Equivalent |
|
job-progress |
message |
|
job-queue-time |
No REST Equivalent |
|
job-schedule |
No REST Equivalent |
|
job-start-time |
start_time |
|
job-state |
state |
ONTAPI State → REST API State |
job-status-code |
code |
|
job-type |
No REST Equivalent |
|
job-username |
No REST Equivalent |
|
job-uuid |
uuid |
|
job-vserver |
svm.name |
|
job-id |
No REST Equivalent |
job-get-iter
GET /api/cluster/jobs
Note: The REST API resource /api/cluster/jobs applies a filter based on the schedule property (@now|-) to remove background system jobs.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-restarted |
No REST Equivalent |
|
job-category |
No REST Equivalent |
|
job-completion |
message |
|
job-description |
description |
|
job-dropdead-time |
No REST Equivalent |
|
job-end-time |
end_time |
|
job-id |
No REST Equivalent |
|
job-name |
No REST Equivalent |
|
job-node |
No REST Equivalent |
|
job-priority |
No REST Equivalent |
|
job-progress |
message |
|
job-queue-time |
No REST Equivalent |
|
job-schedule |
No REST Equivalent |
|
job-start-time |
start_time |
|
job-state |
state |
ONTAPI State → REST API State |
job-status-code |
code |
|
job-type |
No REST Equivalent |
|
job-username |
No REST Equivalent |
|
job-uuid |
uuid |
|
job-vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
job-history-get
This ONTAPI call does not have an equivalent REST API call.
job-history-get-iter
This ONTAPI call does not have an equivalent REST API call.
job-init-state-get
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-init-state-get-iter
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-kick
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-pause
PATCH /api/cluster/jobs/{uuid}?action=pause
Note: Not all jobs support the pause action. The pause action can only be applied to running jobs.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-id |
No REST Equivalent |
The job-id property is represented as the "uuid" in the resource path. |
job-pause-iter
This ONTAPI call does not have an equivalent REST API call.
job-private-completed-get
This ONTAPI call does not have an equivalent REST API call.
job-private-completed-get-iter
This ONTAPI call does not have an equivalent REST API call.
job-private-delete
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-private-delete-iter
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-private-get
This ONTAPI call does not have an equivalent REST API call.
job-private-get-iter
This ONTAPI call does not have an equivalent REST API call.
job-private-pause
This ONTAPI call does not have an equivalent REST API call.
job-private-pause-iter
This ONTAPI call does not have an equivalent REST API call.
job-private-resume
This ONTAPI call does not have an equivalent REST API call.
job-private-resume-iter
This ONTAPI call does not have an equivalent REST API call.
job-private-soft-pause
This ONTAPI call does not have an equivalent REST API call.
job-private-soft-pause-iter
This ONTAPI call does not have an equivalent REST API call.
job-private-stop
This ONTAPI call does not have an equivalent REST API call.
job-private-stop-iter
This ONTAPI call does not have an equivalent REST API call.
job-private-watch-progress
This ONTAPI call does not have an equivalent REST API call.
job-queue-config-get
This ONTAPI call does not have an equivalent REST API call.
job-queue-config-modify
This ONTAPI call does not have an equivalent REST API call.
job-queue-get
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-queue-get-iter
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-resume
PATCH /api/cluster/jobs/{uuid}?action=resume
Note: Not all jobs support the resume action. The pause action can only be applied to paused jobs.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-id |
No REST Equivalent |
The job-id property is represented as the "uuid" in the resource path. |
job-resume-iter
This ONTAPI call does not have an equivalent REST API call.
job-schedule-consumer-get
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-schedule-consumer-get-iter
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-schedule-cron-create
POST /api/cluster/schedules
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-schedule-cluster |
cluster.name |
|
job-schedule-cron-day |
cron.days |
|
job-schedule-cron-day-of-week |
cron.weekdays |
|
job-schedule-cron-hour |
cron.hours |
|
job-schedule-cron-minute |
cron.minutes |
|
job-schedule-cron-month |
cron.months |
|
job-schedule-name |
name |
|
return-record |
?return-records=true |
job-schedule-cron-destroy
DELETE /api/cluster/schedules/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-schedule-cluster |
No REST Equivalent |
|
job-schedule-name |
No REST Equivalent |
job-schedule-cron-destroy-iter
This ONTAPI call does not have an equivalent REST API call.
job-schedule-cron-get
GET /api/cluster/schedules/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-schedule-cluster |
cluster.name |
|
job-schedule-cron-day |
cron.days |
|
job-schedule-cron-day-of-week |
cron.weekdays |
|
job-schedule-cron-hour |
cron.hours |
|
job-schedule-cron-minute |
cron.minutes |
|
job-schedule-cron-month |
cron.months |
|
job-schedule-description |
No REST Equivalent |
|
job-schedule-name |
name |
job-schedule-cron-get-iter
GET /api/cluster/schedules
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-schedule-cluster |
cluster.name |
|
job-schedule-cron-day |
cron.days |
|
job-schedule-cron-day-of-week |
cron.weekdays |
|
job-schedule-cron-hour |
cron.hours |
|
job-schedule-cron-minute |
cron.minutes |
|
job-schedule-cron-month |
cron.months |
|
job-schedule-description |
No REST Equivalent |
|
job-schedule-name |
name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
job-schedule-cron-modify
PATCH /api/cluster/schedules/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-schedule-cluster |
cluster.name |
|
job-schedule-cron-day |
cron.days |
|
job-schedule-cron-day-of-week |
cron.weekdays |
|
job-schedule-cron-hour |
cron.hours |
|
job-schedule-cron-minute |
cron.minutes |
|
job-schedule-cron-month |
cron.months |
|
job-schedule-name |
name |
job-schedule-get
GET /api/cluster/schedules/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-schedule-description |
No REST Equivalent |
|
job-schedule-name |
name |
|
job-schedule-type |
No REST Equivalent |
|
job-schedule-cluster |
cluster.name |
job-schedule-get-iter
GET /api/cluster/schedules
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-schedule-cluster |
cluster.name |
|
job-schedule-description |
No REST Equivalent |
|
job-schedule-name |
name |
|
job-schedule-type |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
job-schedule-interval-create
POST /api/cluster/schedules
Note: Interval schedules no longer use separate properties for days, hours, minutes, seconds, but use a string interval property that follows the ISO-8601 format.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-schedule-cluster |
cluster.name |
|
job-schedule-interval-days |
No REST Equivalent |
|
job-schedule-interval-hours |
No REST Equivalent |
|
job-schedule-interval-minutes |
No REST Equivalent |
|
job-schedule-interval-seconds |
No REST Equivalent |
|
job-schedule-name |
name |
|
return-record |
?return-records=true |
job-schedule-interval-destroy
DELETE /api/cluster/schedules/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-schedule-cluster |
No REST Equivalent |
|
job-schedule-name |
No REST Equivalent |
job-schedule-interval-destroy-iter
This ONTAPI call does not have an equivalent REST API call.
job-schedule-interval-get
GET /api/cluster/schedules/{uuid}
Note: Interval schedules no longer use separate properties for days, hours, minutes, seconds, but use a string interval property that follows the ISO-8601 format.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-schedule-cluster |
cluster.name |
|
job-schedule-description |
No REST Equivalent |
|
job-schedule-interval-days |
interval |
|
job-schedule-interval-hours |
interval |
|
job-schedule-interval-minutes |
interval |
|
job-schedule-interval-seconds |
interval |
|
job-schedule-name |
name |
job-schedule-interval-get-iter
GET /api/cluster/schedules
Note: Interval schedules no longer use separate properties for days, hours, minutes, seconds, but use a string interval property that follows the ISO-8601 format.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-schedule-cluster |
cluster.name |
|
job-schedule-description |
No REST Equivalent |
|
job-schedule-interval-days |
interval |
|
job-schedule-interval-hours |
interval |
|
job-schedule-interval-minutes |
interval |
|
job-schedule-interval-seconds |
interval |
|
job-schedule-name |
name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
job-schedule-interval-modify
PATCH /api/cluster/schedules/{uuid}
Note: Interval schedules no longer use separate properties for days, hours, minutes, seconds, but use a string interval property that follows the ISO-8601 format.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-schedule-cluster |
cluster.name |
|
job-schedule-interval-days |
interval |
|
job-schedule-interval-hours |
interval |
|
job-schedule-interval-minutes |
interval |
|
job-schedule-interval-seconds |
interval |
|
job-schedule-name |
name |
job-soft-pause
This ONTAPI call does not have an equivalent REST API call.
job-soft-pause-iter
This ONTAPI call does not have an equivalent REST API call.
job-stop
PATCH /api/cluster/jobs/{uuid}?action=cancel
Note: Not all jobs support the cancel action.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
job-id |
No REST Equivalent |
The job-id property is represented as the "uuid" in the resource path. |
job-stop-iter
This ONTAPI call does not have an equivalent REST API call.
job-type-by-category-get
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-type-by-category-get-iter
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-type-get
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-type-get-iter
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-unclaim
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.
job-unclaim-iter
Note: This is an unsupported ONTAPI operation.
This ONTAPI call does not have an equivalent REST API call.