APIs in Category: job |
API version 6.1 |
job-abort |
Job operations include submission, cancellation, deletion, and listing of management jobs, meaning jobs which perform some task on or gather some data from a managed system. |
job-abort | [top] |
Abort a running management job.
Input Name Range Type Description job-id job-id
Identifier for a management job.
Errno Description EJOBDOESNOTEXIST EJOBALREADYCOMPLETED
job-delete | [top] |
Delete the results of a completed job.
Input Name Range Type Description job-id job-id
Identifier for a management job.
Errno Description EJOBDOESNOTEXIST
job-iter | [top] |
Retrieve information about management jobs.
- More than one job may be returned.
- If job-id or task-id is specified, it should be the only query criterion. If other inputs are specified as multiple criteria, they are ANDed. In other words, the intersection of the jobs specified by the matching criteria is returned.
Input Name Range Type Description job-id job-id
optional
Specify the job identity matching criteria. If other inputs are specified with job-id, EINVALIDINPUT error is returned. max-records integer
optional
The maximum number of records per return batch the caller wants to receive. The server may return smaller batch sizes based on performance constraints. If this field is not provided, then the server will return default number of records based on server performance. state job-state
optional
Specify the job state matching criteria. status job-status
optional
Specify the job status matching criteria. tag string
optional
Specify the tag from the last call. It is not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Any resource-filters specified in the first call must be included in subsequent calls. task-id job-task-id
optional
Specify the task identity matching criteria. If other inputs are specified with task-id, EINVALIDINPUT error is returned. type job-type
optional
Specify the job type matching criteria. Output Name Range Type Description next-tag string
optional
Tag for the next call. Not present when there are no more objects to return. num-records integer
The number of records returned in this call. records job-info[]
optional
The list of records.
Errno Description EINVALIDINPUT
job-task-iter | [top] |
Starts iteration to list tasks and their status.
- More than one tasks may be returned.
- The criteria are ANDed. That is: we return the intersection of the tasks specified by the matching criteria if input is specified other than task-id. No other input is allowed with Task-id input, in case other input is specified with task-id then EINVALIDINPUT error is returned. If specified job-id is not found then EJOBDOESNOTEXIST error is returned.
Input Name Range Type Description job-id job-id
optional
Job identity matching criteria. max-records integer
optional
The maximum number of records per return batch the caller wants to receive. The server may return smaller batch sizes based on performance constraints. If this field is not provided, then the server will return default number of records based on server performance. state task-state
optional
Task state matching criteria. status task-status
optional
Task status matching criteria. tag string
optional
Specify the tag from the last call. It is not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Any resource-filters specified in the first call must be included in subsequent calls. task-id job-task-id
optional
Task identity matching criteria. task-type string
optional
Task type matching criteria. Output Name Range Type Description next-tag string
optional
Tag for the next call. Not present when there are no more objects to return. num-records integer
The number of records returned in this call. records job-task-info[]
optional
The list of records.
Errno Description EINVALIDINPUT EOBJECTNOTFOUND EJOBDOESNOTEXIST
job-wait-for-state | [top] |
Blocks until a specified timeout period elapses or until a job state is reached by at least one job.
Input Name Range Type Description job-list job-id[]
List of job-ids to wait for to reach the specified state. If a listed job-id is not found, then EJOBDOESNOTEXIST is returned along with the first invalid/missing job-id. The API blocks until at least one of jobs reaches the specified state. state job-state
optional
Specify the job state to wait for. If state specified is other than 'completed' then E_FILTER_ARGUMENT_NOT_IMPLEMENTED error will be returned. Default is 'completed'. The 'completed' state implies all terminal job states viz. 'completed' and 'aborted'. wait-for-state-timeout [0..2^31-1] integer
Number of seconds to wait for job(s) to reach the specified state. The API blocks until at least one of the jobs reaches the specified state. Jobs already in the specified state will cause this API to return immediately with the corresponding list of job-ids. If timeout occurs before any job reaches the specified state, the API returns an empty job-id list. If wait-for-state-timeout is specified as '0' then API returns immediately without blocking.
Output Name Range Type Description job-list job-id[]
List of job-ids corresponding to the job(s) matching the specified state.
Errno Description EINVALIDINPUT EJOBDOESNOTEXIST E_OPERATION_TIMED_OUT E_FILTER_ARGUMENT_NOT_IMPLEMENTED
Element definition: job-id | [top] |
Opaque identifier for a job.
[none]
Element definition: job-info | [top] |
Information about a job. A job may be triggered by an explicit user action or through scheduled operations. Each info includes current state of execution and status of the operation.
Name Range Type Description end-time timestamp
optional
Time at which the job completed. estimated-percent-complete integer
optional
Estimated percent of the work completed for a job. Hold the aggregate estimated percent of work completed based on the completion of all job tasks. This information is an estimate and may not always be available. estimated-time-to-complete integer
optional
Estimated time (measured in seconds) for job completion. This will hold the aggregate estimated time to completion based on time to completion of all job tasks and in accordance to their execution dependency order. This information is an estimate and may not always be available. job-description string
Description of the job. job-detail job-detail
optional
Additional information relevant to job base on its type. job-id job-id
Identifier of this job. job-name string
Name of the job. job-state-events state-event-info[]
Job life cycle execution state audit log start-time timestamp
optional
Time at which the job started. state job-state
State of the job indicating if the job is currently running etc. status job-status
Status of the job indicating the overall success or failure. Overall status is computed based on status of the actions performed as part of the job. type job-type
Type of the job.
Element definition: job-state | [top] |
The state of the job. The possible values are:
- queued
- running
- completed
- aborting
- aborted
[none]
Element definition: job-status | [top] |
The status of the job. Rolled up status of the whole job based on all tasks. The possible values are:
- normal
- warning
- partial_failures
- error
[none]
Element definition: job-task-id | [top] |
Opaque identifier for a job task.
[none]
Element definition: job-task-info | [top] |
Information about the action for executing one task.
Name Range Type Description dependency-list job-task-id[]
List of job-task-id(s) on which this task depends. end-time timestamp
optional
Time at which the task completed. estimated-percent-complete integer
optional
Estimated percent of the work completed for a task. Some task allow tracking of progress, such as in the case of data transfer. For this type of tasks, this element will hold the estimated percent completed. estimated-time-to-complete integer
optional
Estimated time for task completion (measured in seconds). failure-reason string
optional
Reason causing task failure. job-id job-id
Identifier of the parent job. messages task-message-info[]
optional
Messages generated by the task during execution. object-interactions task-interaction-object[]
optional
Objects the task interacted with during execution. start-time timestamp
optional
Time at which the task started. state task-state
State of the task indicating the task current execution state. status task-status
Status of the task indicating the task current execution status. task-description string
Description of the task e.g. "Add Vault node to the storage service Gold Mirror". task-detail task-detail
optional
Additional information relevant to task based on its type. task-id job-task-id
Identifier of the task. task-state-events state-event-info[]
Task life cycle execution state audit log. type task-type
Type of the task. Each task type will have additional type specific data.
Element definition: job-type | [top] |
Job types. The possible values are:
- protect_storage_service_subscribe
- protect_storage_service_unsubscribe
- protect_storage_service_update
- protect_storage_service_conform
- protect_storage_service_import
- protect_storage_service_cleanup
- protect_storage_service_modify
- protect_storage_service_destroy
- protect_restore
- monitor
- active_management
- compensation
[none]
Element definition: task-state | [top] |
The state of the task. The possible values are:
- waiting
- queued
- running
- completed
[none]
Element definition: task-status | [top] |
The status of the task. Valid values are:
- normal
- error
- skipped
[none]
Element definition: job-detail | [top] |
Detail information specific to the task base on task type.
Name Range Type Description storage-service-job-info storage-service-job-info
optional
Information specific to storage service job. Returned only when the job-type is
- protect_storage_service_subscribe
- protect_storage_service_unsubscribe
- protect_storage_service_update
- protect_storage_service_conform
- protect_storage_service_import
- protect_storage_service_cleanup
- protect_storage_service_modify
- protect_storage_service_destroy
Element definition: job-id | [top] |
Opaque identifier for a job.
[none]
Element definition: job-task-id | [top] |
Opaque identifier for a job task.
[none]
Element definition: state-event-info | [top] |
Information specific to execution state audit events.
Name Range Type Description event string
Possible values can be: submitted started canceled aborted completed timestamp timestamp
Time at which the state changed.
Element definition: task-detail | [top] |
Detailed information specific to the task based on task type.
Name Range Type Description relationship-info relationship-task-info
optional
Information specific to setting up relationships. Returned only when the task-type is:
- protect_relationship_create
- protect_relationship_initialize
- protect_relationship_update
- protect_relationship_transfer_progress
- protect_relationship_destroy
- protect_relationship_abort
- protect_relationship_quiesce
Element definition: task-interaction-object | [top] |
An object that a task interacted with.
Name Range Type Description task-interaction-object-name string
Name of the object that the task reported interaction with. Example: "storage01.example.com". task-interaction-object-resource-key resource-key
Resource key of the object that the task reported interaction with. task-interaction-object-type resource-type
Type of object that the task reported interaction with.
Element definition: task-message-info | [top] |
Task message information.
Name Range Type Description message string
Generated message. timestamp timestamp
optional
Timestamp when the message was generated. type task-message-type
Type of message.
Element definition: task-type | [top] |
Task types. Valid values are:
- protect_secondary_provision
- protect_secondary_destroy
- protect_secondary_offline
- protect_relationship_create
- protect_relationship_initialize
- protect_relationship_modify
- protect_relationship_update
- protect_relationship_transfer_progress
- protect_relationship_destroy
- protect_relationship_abort
- protect_relationship_quiesce
- protect_restore
- protect_restore_ndmp_utility
- protect_storage_service_utility
- protect_vserver_peering
- monitor_discover
- active_quota_management
- empty
- administrative
- compensation
[none]
Element definition: timestamp | [top] |
Seconds since 1/1/1970 in UTC.
[none]
Element definition: relationship-task-info | [top] |
Details specific to the SnapMirror relationship operations.
Name Range Type Description connection-resource-key resource-key
optional
Resource key of the destination node in topology graph of this storage service. destination-member-name obj-name
optional
Name of the destination object for this relationship. destination-member-resource-key resource-key
optional
Resource key of the destination object for this relationship. destination-node-name obj-name
optional
Name of the destination node in topology graph of this storage service. destination-node-resource-key resource-key
optional
Resource key of the destination node in topology graph of this storage service. last-progress-info transfer-progress-task-info
optional
Most recent progress information for a data transfer. Returned only when the task-type is
- protect_relationship_transfer_progress
relationship-resource-key resource-key
optional
Resource key of the relationship between source-member and destination-member. Returned only when the task-type is:
- protect_relationship_initialize
- protect_relationship_update
- protect_relationship_transfer_progress
- protect_relationship_destroy
- protect_relationship_abort
- protect_relationship_quiesce
source-member-name obj-name
optional
Name of the source object for this relationship. source-member-resource-key resource-key
optional
Resource key of the source object for this relationship. source-node-name obj-name
optional
Name of the source node in topology graph of this storage service. source-node-resource-key resource-key
optional
Resource key of the source node in topology graph of this storage service.
Element definition: resource-key | [top] |
A self-describing string identifier for a managed resource.
[none]
Element definition: resource-type | [top] |
A canonical type name for a managed resource. Includes both Data ONTAP and OnCommand resource types. Valid Data ONTAP resource types: Valid OnCommand resource types:
- aggregate
- cluster
- cluster_node
- disk
- export_policy
- export_rule
- fcp_lif
- fcp_port
- flash_device
- igroup
- iscsi_portal_group
- lun
- lun_mapping
- network_lif
- network_port
- ontap_job_schedule
- plex
- portset
- qtree
- raid_group
- routing_group
- service_processor
- sis_policy
- snap_mirror
- snapshot
- snapshot_policy
- snapshot_policy_schedule
- storage_class
- storage_shelf
- volume
- volume_move
- vserver
- management_station
- resource_pool
- service_workflow
- storage_service
- storage_service_connection
- storage_service_node
[none]
Element definition: storage-service-job-info | [top] |
Detail information specific to the task base on task type.
Name Range Type Description storage-service-id obj-id
ID of storage service used in operation. storage-service-name obj-name
Name of storage service used in operation. subscription-context string
optional
Subscription context used in the request which generated the job. Only present for a jobs generated with a request containing specific subscription context.
Element definition: task-message-type | [top] |
Task message types. The possible values are:
- info
- warning
- error
[none]
Element definition: obj-id | [top] |
Identification number (ID) for an 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 an 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 object type (e.g. cluster, volume, aggregate, 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 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 an object. This typedef is an alias for the built in ZAPI type string. An object name must conform to the following format: 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:
- 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.
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 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 EINVALIDINPUT. Note that because EINVALIDINPUT 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.
If an input name element is used to refer to an existing object, then the ZAPI specification must specify which object type (e.g. cluster, vserver, volume 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.
[none]
Element definition: transfer-progress-task-info | [top] |
Data transfer progress update details.
Name Range Type Description ontap-transfer-job-id integer
optional
The Data ONTAP job identifier of the current relationship transfer. progress-last-updated timestamp
A timestamp indicating when the progress of the transfer was last updated. relationship-progress integer
optional
The total number of bytes that have been processed so far for the current transfer activity of the relationship. snapshot-checkpoint integer
optional
The number of bytes transferred as recorded for the checkpoint of the current or most recent transfer snapshot. snapshot-progress integer
optional
The number of bytes transferred for the transfer-snapshot. transfer-snapshot string
optional
The name of the current snapshot copy being transferred.
Element definition: timestamp | [top] |
Seconds since 1/1/1970 in UTC.
[none]