Skip to main content
A newer release of this product is available.

job

Contributors
Suggest changes
PDFs

job-bad-erase

This ONTAPI call does not have an equivalent REST API call.

job-bad-get-iter

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

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 State
dead → failure
dormant → running
error → failure
failure → failure
initial → queued
paused → paused
pausing → running
queued → queued
quit → failure
quitting → running
reschedule → running
restart → running
running → running
success → success
waiting → running
unknown → running

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

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 State
dead → failure
dormant → running
error → failure
failure → failure
initial → queued
paused → paused
pausing → running
queued → queued
quit → failure
quitting → running
reschedule → running
restart → running
running → running
success → success
waiting → running
unknown → running

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

The maximum number of records to return before paging

job-delete

DELETE /api/cluster/jobs/{uuid}

ONTAPI attribute REST attribute Comment

job-id

No REST Equivalent

job-delete-iter

DELETE /api/cluster/jobs/{uuid}

ONTAPI attribute REST attribute Comment

continue-on-failure

No REST Equivalent

max-failure-count

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

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 State
dead → failure
dormant → running
error → failure
failure → failure
initial → queued
paused → paused
pausing → running
queued → queued
quit → failure
quitting → running
reschedule → running
restart → running
running → running
success → success
waiting → running
unknown → running

job-status-code

code

job-type

No REST Equivalent

job-username

No REST Equivalent

job-uuid

uuid

job-vserver

svm.name

return-failure-list

No REST Equivalent

return-success-list

No REST Equivalent

job-expunge

This ONTAPI call does not have an equivalent REST API call.

job-expunge-iter

This ONTAPI call does not have an equivalent REST API call.

job-get

GET /api/cluster/jobs/{uuid}

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 State
dead → failure
dormant → running
error → failure
failure → failure
initial → queued
paused → paused
pausing → running
queued → queued
quit → failure
quitting → running
reschedule → running
restart → running
running → running
success → success
waiting → running
unknown → running

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

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 State
dead → failure
dormant → running
error → failure
failure → failure
initial → queued
paused → paused
pausing → running
queued → queued
quit → failure
quitting → running
reschedule → running
restart → running
running → running
success → success
waiting → running
unknown → running

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

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

This ONTAPI call does not have an equivalent REST API call.

job-init-state-get-iter

This ONTAPI call does not have an equivalent REST API call.

job-kick

PATCH /api/cluster/jobs/{uuid}

ONTAPI attribute REST attribute Comment

job-uuid

uuid

job-pause

PATCH /api/cluster/jobs/{uuid}

ONTAPI attribute REST attribute Comment

job-id

No REST Equivalent

job-pause-iter

PATCH /api/cluster/jobs/{uuid}

ONTAPI attribute REST attribute Comment

continue-on-failure

No REST Equivalent

max-failure-count

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

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 State
dead → failure
dormant → running
error → failure
failure → failure
initial → queued
paused → paused
pausing → running
queued → queued
quit → failure
quitting → running
reschedule → running
restart → running
running → running
success → success
waiting → running
unknown → running

job-status-code

code

job-type

No REST Equivalent

job-username

No REST Equivalent

job-uuid

uuid

job-vserver

svm.name

return-failure-list

No REST Equivalent

return-success-list

No REST Equivalent

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

This ONTAPI call does not have an equivalent REST API call.

job-private-delete-iter

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

This ONTAPI call does not have an equivalent REST API call.

job-queue-get-iter

This ONTAPI call does not have an equivalent REST API call.

job-resume

PATCH /api/cluster/jobs/{uuid}

ONTAPI attribute REST attribute Comment

job-id

No REST Equivalent

job-resume-iter

PATCH /api/cluster/jobs/{uuid}

ONTAPI attribute REST attribute Comment

continue-on-failure

No REST Equivalent

max-failure-count

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

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 State
dead → failure
dormant → running
error → failure
failure → failure
initial → queued
paused → paused
pausing → running
queued → queued
quit → failure
quitting → running
reschedule → running
restart → running
running → running
success → success
waiting → running
unknown → running

job-status-code

code

job-type

No REST Equivalent

job-username

No REST Equivalent

job-uuid

uuid

job-vserver

svm.name

return-failure-list

No REST Equivalent

return-success-list

No REST Equivalent

job-schedule-consumer-get

This ONTAPI call does not have an equivalent REST API call.

job-schedule-consumer-get-iter

This ONTAPI call does not have an equivalent REST API call.

job-schedule-cron-create

POST /api/cluster/schedules

ONTAPI attribute REST attribute Comment

job-schedule-cluster

No REST Equivalent

job-schedule-cron-day

No REST Equivalent

job-schedule-cron-day-of-week

No REST Equivalent

job-schedule-cron-hour

No REST Equivalent

job-schedule-cron-minute

No REST Equivalent

job-schedule-cron-month

No REST Equivalent

job-schedule-name

No REST Equivalent

return-record

?return-records=true

job-schedule-cron-destroy

DELETE /api/cluster/schedules/{uuid}

ONTAPI attribute REST attribute Comment

job-schedule-cluster

No REST Equivalent

job-schedule-name

No REST Equivalent

job-schedule-cron-destroy-iter

DELETE /api/cluster/schedules

ONTAPI attribute REST attribute Comment

continue-on-failure

No REST Equivalent

max-failure-count

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

job-schedule-cluster

No REST Equivalent

job-schedule-cron-day

No REST Equivalent

job-schedule-cron-day-of-week

No REST Equivalent

job-schedule-cron-hour

No REST Equivalent

job-schedule-cron-minute

No REST Equivalent

job-schedule-cron-month

No REST Equivalent

job-schedule-description

No REST Equivalent

job-schedule-name

No REST Equivalent

return-failure-list

No REST Equivalent

return-success-list

No REST Equivalent

job-schedule-cron-get

GET /api/cluster/schedules/{uuid}

ONTAPI attribute REST attribute Comment

job-schedule-cluster

No REST Equivalent

job-schedule-cron-day

No REST Equivalent

job-schedule-cron-day-of-week

No REST Equivalent

job-schedule-cron-hour

No REST Equivalent

job-schedule-cron-minute

No REST Equivalent

job-schedule-cron-month

No REST Equivalent

job-schedule-description

No REST Equivalent

job-schedule-name

No REST Equivalent

job-schedule-cluster

No REST Equivalent

job-schedule-name

No REST Equivalent

job-schedule-cron-get-iter

GET /api/cluster/schedules

ONTAPI attribute REST attribute Comment

job-schedule-cluster

No REST Equivalent

job-schedule-cron-day

No REST Equivalent

job-schedule-cron-day-of-week

No REST Equivalent

job-schedule-cron-hour

No REST Equivalent

job-schedule-cron-minute

No REST Equivalent

job-schedule-cron-month

No REST Equivalent

job-schedule-description

No REST Equivalent

job-schedule-name

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

job-schedule-cron-modify

PATCH /api/cluster/schedules/{uuid}

ONTAPI attribute REST attribute Comment

job-schedule-cluster

No REST Equivalent

job-schedule-cron-day

No REST Equivalent

job-schedule-cron-day-of-week

No REST Equivalent

job-schedule-cron-hour

No REST Equivalent

job-schedule-cron-minute

No REST Equivalent

job-schedule-cron-month

No REST Equivalent

job-schedule-name

No REST Equivalent

job-schedule-get

GET /api/cluster/schedules/{uuid}

ONTAPI attribute REST attribute Comment

job-schedule-cluster

No REST Equivalent

job-schedule-description

No REST Equivalent

job-schedule-name

No REST Equivalent

job-schedule-type

No REST Equivalent

job-schedule-cluster

No REST Equivalent

job-schedule-name

No REST Equivalent

job-schedule-get-iter

GET /api/cluster/schedules

ONTAPI attribute REST attribute Comment

job-schedule-cluster

No REST Equivalent

job-schedule-description

No REST Equivalent

job-schedule-name

No REST Equivalent

job-schedule-type

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

job-schedule-interval-create

POST /api/cluster/schedules

ONTAPI attribute REST attribute Comment

job-schedule-cluster

No REST Equivalent

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

No REST Equivalent

return-record

?return-records=true

job-schedule-interval-destroy

DELETE /api/cluster/schedules/{uuid}

ONTAPI attribute REST attribute Comment

job-schedule-cluster

No REST Equivalent

job-schedule-name

No REST Equivalent

job-schedule-interval-destroy-iter

DELETE /api/cluster/schedules

ONTAPI attribute REST attribute Comment

continue-on-failure

No REST Equivalent

max-failure-count

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

job-schedule-cluster

No REST Equivalent

job-schedule-description

No REST Equivalent

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

No REST Equivalent

return-failure-list

No REST Equivalent

return-success-list

No REST Equivalent

job-schedule-interval-get

GET /api/cluster/schedules/{uuid}

ONTAPI attribute REST attribute Comment

job-schedule-cluster

No REST Equivalent

job-schedule-description

No REST Equivalent

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

No REST Equivalent

job-schedule-cluster

No REST Equivalent

job-schedule-name

No REST Equivalent

job-schedule-interval-get-iter

GET /api/cluster/schedules

ONTAPI attribute REST attribute Comment

job-schedule-cluster

No REST Equivalent

job-schedule-description

No REST Equivalent

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

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

job-schedule-interval-modify

PATCH /api/cluster/schedules/{uuid}

ONTAPI attribute REST attribute Comment

job-schedule-cluster

No REST Equivalent

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

No REST Equivalent

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}

ONTAPI attribute REST attribute Comment

job-id

No REST Equivalent

job-stop-iter

PATCH /api/cluster/jobs/{uuid}

ONTAPI attribute REST attribute Comment

continue-on-failure

No REST Equivalent

max-failure-count

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

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 State
dead → failure
dormant → running
error → failure
failure → failure
initial → queued
paused → paused
pausing → running
queued → queued
quit → failure
quitting → running
reschedule → running
restart → running
running → running
success → success
waiting → running
unknown → running

job-status-code

code

job-type

No REST Equivalent

job-username

No REST Equivalent

job-uuid

uuid

job-vserver

svm.name

return-failure-list

No REST Equivalent

return-success-list

No REST Equivalent

job-type-by-category-get

This ONTAPI call does not have an equivalent REST API call.

job-type-by-category-get-iter

This ONTAPI call does not have an equivalent REST API call.

job-type-get

This ONTAPI call does not have an equivalent REST API call.

job-type-get-iter

This ONTAPI call does not have an equivalent REST API call.

job-unclaim

This ONTAPI call does not have an equivalent REST API call.

job-unclaim-iter

This ONTAPI call does not have an equivalent REST API call.