APIs in Category: dp-job | API version 3.6R2

dp-job-abort dp-job-list-iter-end dp-job-list-iter-next dp-job-list-iter-start dp-job-progress-event-list-iter-end dp-job-progress-event-list-iter-next dp-job-progress-event-list-iter-start dp-job-purge dp-job-schedule-get-last-changed dp-job-schedule-list-iter-end dp-job-schedule-list-iter-next dp-job-schedule-list-iter-start | The dp-job-list-iter* API's list the history of data protection jobs performed on datasets. The dp-job-list-iter-* ZAPI's give a brief summary of the job. A data protection job for a dataset is the combination of tasks on each of the members of the dataset. The dp-job-progress-event-list-iter ZAPI's give the detailed progress of each such subtask for the job.

NetApp Manage ONTAP

dp-job-abort | [top]

> Abort a job. A request is sent to abort the job. The job will go into an aborting state and will get aborted after sometime.

> Input Name | Range | Type | Description
> job-id |  | integer | Identifier of job to abort. Range: [1..2^31-1].

> Errno | Description
> EACCESSDENIED |  |
> EJOBDOESNOTEXIST |  |
> EJOBALREADYCOMPLETED |  |
> EJOBALREADYABORTED |  |
> EJOBCANNOTBEABORTED |  |
> EDATABASEERROR |  |

dp-job-list-iter-end | [top]

> Ends iteration to list jobs.

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous dp-job-list-iter-start.

> Errno | Description
> EINVALIDTAG |  |

dp-job-list-iter-next | [top]

> Get next few records in the iteration started by dp-job-list-iter-start.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve. Range: [1..2^31-1].
> tag |  | string | Tag from a previous dp-job-list-iter-start.
> Output Name | Range | Type | Description
> jobs |  | dp-job-info[] | List of jobs.
> records |  | integer | The number of records actually returned. Range: [1..2^31-1].

> Errno | Description
> EINVALIDTAG |  |
> EACCESSDENIED |  |

dp-job-list-iter-start | [top]

> Starts iteration to list jobs. The jobs that match all the specified filters will be returned.

> Input Name | Range | Type | Description
> job-id |  | integer optional | Identifier of a job to list. If unspecified, all jobs are listed. Range: [1..2^31-1].
> job-state |  | dp-job-state optional | State of the jobs to list. If specified, only the jobs which are in this state are listed.
> job-type |  | dp-job-type optional | If specified, only jobs of specified type are listed.
> max-jobs |  | integer optional | If specified, this is the maximum number of jobs that the client wishes to receive at once. If set to zero, return all jobs. The default value of this parameter is 50,000. Range: [0..2^31-1]
> object-name-or-id |  | string optional | Name or ID of the dataset or a group. Range: [1..2^31-1] if Id is specified.
> started-timestamp-from |  | dp-timestamp optional | If specified, jobs started at or after the specified time are listed.
> started-timestamp-to |  | dp-timestamp optional | If specified, jobs started at or before the specified time are listed.
> Output Name | Range | Type | Description
> records |  | integer | Number which tells you how many items have been saved for future retrieval with dp-job-list-iter-next. Range: [1..2^31-1].
> tag |  | string | Tag to be used in subsequent calls to dp-job-list-iter-next.

> Errno | Description
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EAPIERROR |  |

dp-job-progress-event-list-iter-end | [top]

> Ends iteration to list progress of job.

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous dp-job-progress-event-list-iter-start.

> Errno | Description
> EINVALIDTAG |  |

dp-job-progress-event-list-iter-next | [top]

> Get next few records in the iteration started by dp-job-progress-event-list-iter-start.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve. Range: [1..2^31-1].
> tag |  | string | Tag from a previous dp-job-progress-event-list-iter-start.
> Output Name | Range | Type | Description
> progress-events |  | dp-job-progress-event-info[] | List of job progress events.
> records |  | integer | The number of records actually returned. Range: [1..2^31-1].

> Errno | Description
> EINVALIDTAG |  |
> EACCESSDENIED |  |

dp-job-progress-event-list-iter-start | [top]

> Starts iteration to list job progress events. The event could be one of the following type. 'job-start' 'job-progress' 'job-abort' 'job-end' 'rel-create-start' 'rel-create-progress' 'rel-create-end' 'rel-destroy-start' 'rel-destroy-progress' 'rel-destroy-end' 'snapshot-create' 'snapshot-delete' 'backup-create' 'backup-delete' 'snapvault-start' 'snapvault-progress' 'snapvault-end' 'snapmirror-start' 'snapmirror-progress' 'snapmirror-end' 'restore-start' 'restore-progress' 'restore-end' 'migrate-start' 'migrate-progress' 'migrate-end'

> Input Name | Range | Type | Description
> dataset-name-or-id |  | string optional | Identifier of the dataset to list progress events for. If not specified progress events for all jobs are returned. Only dataset-name-or-id or job-id may be supplied, but not both.
> end-time |  | dp-timestamp optional | End timestamp. Events after this time will not be returned. If not present, all events up to the present are returned.
> history |  | boolean optional | If FALSE return only the most recent progress events for job. The most recent progress events define the current progress of the job. For example a backup job generates a job-progress event which says "Retrieving preferred interfaces" and then when the interfaces are retrieved it generates an event "Retrieved preferred interfaces", the earlier then moves to history. The latter one becomes the current event. If TRUE all the events are returned. Default value is FALSE.
> job-id |  | integer optional | Identifier of the job to list progress events for. Only dataset-name-or-id or job-id may be supplied, but not both. If neither is supplied, all progress events are returned. Range: [1..2^31-1].
> start-time |  | dp-timestamp optional | Start timestamp. Events before this time will not be returned. If not present, all events since the earliest event are returned.
> Output Name | Range | Type | Description
> records |  | integer | Number which tells you how many items have been saved for future retrieval with dp-job-progress-event-list-iter-next. Range: [1..2^31-1].
> tag |  | string | Tag to be used in subsequent calls to dp-job-progress-event-list-iter-next.

> Errno | Description
> EJOBDOESNOTEXIST |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EAPIERROR |  |

dp-job-purge | [top]

> Purge all completed jobs from the database. Purged jobs are removed from the database, all information is lost.

> Input Name | Range | Type | Description
> completed-timestamp |  | dp-timestamp optional | If specified, all jobs successfully completed before this time are purged. This field must be specified when job-id is not specified.
> job-id |  | integer optional | Identifier of job to purge. If specifed, only this job is purged. Range: [1..2^31-1].
> purge-jobs-completed-with-error |  | boolean optional | If specified, jobs completed with error are also purged. Otherwise, only successfully completed jobs are purged.

> Errno | Description
> EJOBDOESNOTEXIST |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

dp-job-schedule-get-last-changed | [top]

> Gets time when job schedule last changed. This is used by the scheduler service to reload list of jobs that need to run in future. Jobs that are already running are not affected.

> Output Name | Range | Type | Description
> last-changed-timestamp |  | integer | Timestamp when job schedule last changed. Timestamp value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.

> Errno | Description
> EINVALIDTAG |  |

dp-job-schedule-list-iter-end | [top]

> Ends iteration to list scheduled jobs.

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous dp-job-schedule-list-iter-start.

> Errno | Description
> EINVALIDTAG |  |

dp-job-schedule-list-iter-next | [top]

> Get next few records in the iteration started by dp-job-schedule-list-iter-start.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve. Range: [0..2^31-1]
> tag |  | string | Tag from a previous dp-job-schedule-list-iter-start.
> Output Name | Range | Type | Description
> records |  | integer | The number of records actually returned. Range: [0..2^31-1]
> scheduled-jobs |  | dp-scheduled-job[] | List of jobs that need to be started by the scheduler. This list is sorted by increasing start-time.

> Errno | Description
> EINVALIDTAG |  |

dp-job-schedule-list-iter-start | [top]

> Starts iteration to list jobs that need to be started by scheduler in specified time range. Scheduler service periodically requests a list of scheduled data protection jobs that will need to start within next few hours. Each item in this list is a description of what needs to be done and time when it needs to be done. For example, a scheduled job might be: take a local snapshot on node 1 of dataset ds1 at 05/10/2006 9:00 AM UTC using "hourly" retention. Scheduler service is responsible for storing job into the database and starting the job at its start time.

> Input Name | Range | Type | Description
> dataset-name-or-id |  | string optional | If specified, list of jobs is filtered by this dataset. Range: [1..2^31-1]
> from-time |  | integer | Jobs to be started from this time will be listed. Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.
> to-time |  | integer | Jobs to be started until this time (inclusive) will be listed. Must be equal to or greater than from-time. Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.
> Output Name | Range | Type | Description
> records |  | integer | Number which tells you how many items have been saved for future retrieval with dp-job-schedule-list-iter-next. Range: [1..2^31-1]
> tag |  | string | Tag to be used in subsequent calls to dp-job-schedule-list-iter-next.

> Errno | Description
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EINVALIDINPUTERROR |  |
> EAPIERROR |  |
> EACCESSDENIED |  |

Element definition: dp-job-info | [top]

> A job is used to run one or more Data Protection operations.

> Name | Range | Type | Description
> abort-requested-timestamp |  | dp-timestamp optional | Timestamp when request was received to abort job. If unspecified, no such request was received.
> bytes-transferred |  | integer | Bytes transferred in this operation. Zero when transfer starts. Range: [0..2^63-1].
> completed-timestamp |  | dp-timestamp optional | Timestamp when the job was completed. If unspecified, the job has not yet reached completion.
> dataset-id |  | integer | Database ID of the dataset protected by this job. Range: [1..2^31-1].
> dataset-name |  | string | Name of the dataset being protected by this job.
> destination-node-id |  | integer optional | Destination policy node id associated with this job. Not present if this job is only associated with a single node (e.g. a snapshot job). Range: [1..2^31-1]
> destination-node-name |  | string optional | Destination policy node name associated with this job. Not present if this job is only associated with a single node (e.g. a snapshot job).
> job-description |  | string | Description of what job is trying to accomplish.
> job-id |  | integer | Identifier of the job. Range: [1..2^31-1].
> job-progress |  | dp-job-progress | The current progress of the data protection job.
> job-state |  | dp-job-state optional | State of the job.
> job-type |  | dp-job-type | Type of data protection job.
> policy-id |  | integer optional | Database ID of the data protection policy responsible for spawning this job. If unspecified, the job was not invoked in response to a policy. Range: [1..2^31-1].
> policy-name |  | string optional | Name of the data protection policy responsible for spawning this job. If unspecified, the job was not invoked in response to a policy.
> source-node-id |  | integer | Source policy node id associated with this job. Range: [1..2^31-1]
> source-node-name |  | string | Source policy node name associated with this job.
> started-timestamp |  | dp-timestamp optional | Timestamp when job was started. If unspecified, the job has not yet started running.
> submitted-by |  | string optional | User who submitted the job. If unspecified, the job was submitted by one of the internal DFM services such as the scheduler. The length of this string cannot be more than 255 characters.

Element definition: dp-job-progress-event-info | [top]

> One historical data protection event.

> Name | Range | Type | Description
> dp-progress-backup-info |  | dp-progress-backup-info optional | Information about the creation or deletion of a backup version.
> dp-progress-job-abort-info |  | dp-progress-job-abort-info optional | Information about the abort of a job.
> dp-progress-relationship-info |  | dp-progress-relationship-info optional | Information about creation or destruction of a SnapVault or SnapMirror relationship.
> dp-progress-restore-info |  | dp-progress-restore-info optional | Information about restore of a path.
> dp-progress-snapmirror-info |  | dp-progress-snapmirror-info optional | Information about a SnapMirror transfer. SnapMirror transfers will generally log a start message, zero or more progress messages, and finally either an end or error message.
> dp-progress-snapshot-info |  | dp-progress-snapshot-info optional | Information about a newly created snapshot.
> dp-progress-snapvault-info |  | dp-progress-snapvault-info optional | Information about a SnapVault transfer. SnapVault transfers will generally log a start message, zero or more progress messages, and finally either an end or error message.
> error-message |  | string optional | If present, a human readable error message. If absent, there has been no error.
> event-id |  | integer validate | Unique ID of this progress event. Range: [1..2^31-1].
> event-message |  | string | Human-readable message describing event.
> event-status |  | obj-status | The status of the progress event. Possible values: 'normal', 'warning' and 'error'
> event-timestamp |  | dp-timestamp | Time of event
> event-type |  | string | Type of event. Values are: 'job-start' 'job-progress' 'job-abort' (dp-progress-job-abort-info) 'job-end' 'rel-create-start' (dp-progress-relationship-info) 'rel-create-progress' (dp-progress-relationship-info) 'rel-create-end' (dp-progress-relationship-info) 'rel-destroy-start' (dp-progress-relationship-info) 'rel-destroy-progress' (dp-progress-relationship-info) 'rel-destroy-end' (dp-progress-relationship-info) 'snapshot-create' (dp-progress-snapshot-info) 'snapshot-delete' (dp-progress-snapshot-info) 'backup-create' (dp-progress-backup-info) 'backup-delete' (dp-progress-backup-info) 'snapvault-start' (dp-progress-snapvault-info) 'snapvault-progress' (dp-progress-snapvault-info) 'snapvault-end' (dp-progress-snapvault-info) 'snapmirror-start' (dp-progress-snapmirror-info) 'snapmirror-progress' (dp-progress-snapmirror-info) 'snapmirror-end' (dp-progress-snapmirror-info) 'restore-start' (dp-progress-restore-info) 'restore-progress' (dp-progress-restore-info) 'restore-end' (dp-progress-restore-info) 'migrate-start' (dp-progress-restore-info) 'migrate-progress' (dp-progress-restore-info) 'migrate-end' (dp-progress-restore-info) Each event type has a corresponding element with event-specific fields broken out. The name of the event-specific element is listed after the event type. Only the name of the event is returned. The value in the parenthesis is the type of element returned for that type of event.
> job-id |  | integer validate | The ID of the job that generated this event. Range: [1..2^31-1].

Element definition: dp-job-state | [top]

> The state of the data protection job. The possible values are "running", "completed", "aborting", "aborted". This state is derived from completed-timestamp, abort-requested-timestamp and started-timestamp.

> [none]

Element definition: dp-job-type | [top]

> The type of data protection job. Valid values are "local_backup", "remote_backup", "mirror", "restore", "create_relationship", "destroy_relationship" and "on_demand_backup".

> [none]

Element definition: dp-scheduled-job | [top]

> Describes a scheduled data protection job. Each job has a scheduled start time and protects a single dataset. Scheduler service is responsible for starting job at its scheduled time. Type of job is inferred from which dp-*-job-data element is present. Only one of all possible dp-*-job-data elements can be present. Scheduled job does not have a job id. When scheduler service is about to start the job, it creates a job record in the persistent database and at that time job gets its id.

> Name | Range | Type | Description
> dataset-id |  | integer | Id of the dataset being protected by the job. Range: [1..2^31-1]
> dp-local-snapshot-job-data |  | dp-local-snapshot-job-data optional | Data for local-snapshot job.
> dp-snapmirror-transfer-job-data |  | dp-snapmirror-transfer-job-data optional | Data for snapmirror-transfer job.
> dp-snapvault-transfer-job-data |  | dp-snapvault-transfer-job-data optional | Data for snapvault-transfer job.
> start-time |  | integer | Time when job needs to start. Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. Scheduler service is responsible for starting the job at this time.

Element definition: dp-timestamp | [top]

> Seconds since 1/1/1970 in UTC. Range: [0..2^31-1]. This runs out in 2036, so update the API some time before then.

> [none]

Element definition: dp-job-progress | [top]

> The progress of data protection job. Valid values are "in_progress", "partial_success", "success" and "failure". "in_progress" - No transfers have completed till now. "success" - Atleast one transfer succeeded, none failed till now "failure" - Atleast one transfer failed, none succeeded till now. "partial_success" - Atleast one transfer failed and atleast one transfer succeeded till now. The progress of the data protection job follows the following state diagram, depending on the success and failure of the transfers handled by the data protection job.
>      +------"in_progress"---+
>      |			|
>      |			|
>      failure?		success?
>      |		       	|
>      v			v
>      "failure"		"success"
>      |			|
>      |			|
>      success?		failure?
>      |			|
>      +-->"partial_success"<-+

> [none]

Element definition: dp-local-snapshot-job-data | [top]

> Data for local-snapshot job. If this element is present, job is responsible for taking a local snapshot of data on the storageset associated with the specified node.

> Name | Range | Type | Description
> node-id |  | integer | Id of the node that needs local snapshot. Range: [1..2^31-1]
> retention-type |  | dp-backup-retention-type | Retention to be used for the local snapshot.

Element definition: dp-progress-backup-info | [top]

> Information about the creation or deletion of a backup version.

> Name | Range | Type | Description
> backup-id |  | integer validate | Version ID of new backup version. Each copy of a backup version gets a unique backup ID. Range: [1..2^31-1]
> backup-version |  | dp-timestamp | Time at which backup image was created. All backups with the same backup-version are copies of the same point-in-time image of the original data.
> retention |  | dp-backup-retention-type | Retention type of backup.

Element definition: dp-progress-job-abort-info | [top]

> Information about the abort of a job.

> Name | Range | Type | Description
> aborted-by |  | string | User who aborted the job.

Element definition: dp-progress-relationship-info | [top]

> Information about the creation or destruction of a SnapVault or SnapMirror relationship.

> Name | Range | Type | Description
> bytes-transferred |  | integer validate | Bytes transferred as a result of creating a relationship. Zero when for relationship destroy messages. Range: [0..2^63-1].
> destination-volume-or-qtree-id |  | integer validate | Numeric ID of destination volume or qtree. Range: [1..2^31-1]
> destination-volume-or-qtree-name |  | string | Name of the destination volume or qtree. The format is ://.
> relationship-type |  | string | Type of relationship being created or destroyed. Legal values are "snapvault" or "snapmirror".
> source-volume-or-qtree-id |  | integer validate | Numeric ID of the source volume or qtree. Range: [1..2^31-1]
> source-volume-or-qtree-name |  | string | Numeric ID of the source volume or qtree. The format is ://.

Element definition: dp-progress-restore-info | [top]

> Information about restore of a path.

> Name | Range | Type | Description
> backup-id |  | integer validate | Version ID of backup version used for restore. Range: [1..2^31-1]
> backup-version |  | dp-timestamp | The backup version used for restore.
> bytes-transferred |  | integer optional | Bytes transferred in this operation. Zero when transfer starts. Range: [0..2^63-1].
> destination-path |  | string optional | The full path to restore the dataset member to. The format is :/
> member-id |  | integer | The ID of the dataset member to be restored. Range: [1..2^31-1]
> member-name |  | string | The full name of the dataset member to be restored.
> path |  | string | Path to be restored.

Element definition: dp-progress-snapmirror-info | [top]

> Information about the start and end of a SnapMirror transfer.

> Name | Range | Type | Description
> bytes-transferred |  | integer validate | Bytes transferred in this operation. Zero when transfer starts. Range: [0..2^63-1].
> destination-volume-or-qtree-id |  | integer validate | Numeric ID of destination volume or qtree of the mirror. Range: [1..2^31-1]
> destination-volume-or-qtree-name |  | string | Full name of destination volume or qtree of the mirror. The format is :/.
> source-volume-or-qtree-id |  | integer validate | Numeric ID of volume or qtree being mirrored. Range: [1..2^31-1]
> source-volume-or-qtree-name |  | string | Name of volume or qtree being mirrored. The format is :/.

Element definition: dp-progress-snapshot-info | [top]

> Information about the creation or deletion of a snapshot.

> Name | Range | Type | Description
> snapshot-name |  | string | Name of snapshot
> volume-id |  | integer validate | Numeric ID of volume getting snapshot. Range: [1..2^31-1]
> volume-name |  | string | Full name of the volume object getting the snapshot. The format is :/

Element definition: dp-progress-snapvault-info | [top]

> Information about the start and end of a SnapVault transfer.

> Name | Range | Type | Description
> bytes-transferred |  | integer validate | Bytes transferred in this operation. Zero when transfer starts. Range: [0..2^63-1].
> destination-qtree-id |  | integer validate | Numeric ID of qtree receiving back up. Range: [1..2^31-1]
> destination-qtree-name |  | string | Name of qtree receiving backed up. The format is ://.
> source-qtree-id |  | integer validate | Numeric ID of qtree being backed up. Range: [1..2^31-1]
> source-qtree-name |  | string | Name of qtree being backed up. The format is ://

Element definition: dp-snapmirror-transfer-job-data | [top]

> Data for snapmirror-transfer job. If this element is present, job is responsible for transferring data between two storagesets associated with the specified connection using SnapMirror protocol.

> Name | Range | Type | Description
> connection-id |  | integer | Id of the policy connection that needs SnapMirror transfer. Range: [1..2^31-1]
> retention-type |  | dp-backup-retention-type | Retention to be used for the pre/post backup script in the snapmirror-transfer job only.

Element definition: dp-snapvault-transfer-job-data | [top]

> Data for snapvault-transfer job. If this element is present, job is responsible for transferring data between two storagesets associated with the specified connection using SnapVault protocol.

> Name | Range | Type | Description
> connection-id |  | integer | Id of the policy connection that needs SnapVault transfer. Range: [1..2^31-1]
> retention-type |  | dp-backup-retention-type | Retention to be used for the backup created by snapvault-transfer job.

Element definition: dp-timestamp | [top]

> Seconds since 1/1/1970 in UTC. Range: [0..2^31-1]. This runs out in 2036, so update the API some time before then.

> [none]

Element definition: obj-status | [top]

> A status value which can be associated with a DFM object. This typedef is an alias for the builtin ZAPI type string. The severity associated with an event has this type. Possible values are: 'unknown', 'normal', 'information', 'unmanaged' 'warning', 'error', 'critical', 'emergency'. unknown: An object has an unknown status when it transitions from one state to another. Ideally, an object will have this status briefly. For example, when an object has been added, but not yet discovered. normal: An object has normal status when it is working within the thresholds specified in DFM. information: The information events are normal occurrences on an object for which you can define alarms. unmanaged: An object is considered to be unmanaged when the login and password are not set for the appliance or agent. warning: An object has the warning status when an event related to the object occurred that an administrator should know about. The event will not cause service disruption. error: An object has error status when it does not cause any service disruption, but it may affect performance. critical: An object has critical status when it is still performing, but service disruption may occur if corrective action is not taken immediately. emergency: An object is in emergency status when it stops performing unexpectedly and could lose data. In some contexts, it is important that severities are ordered (as above). For example, an alarm might be triggered if an event with a given severity "or worse" occurs. In this example, worse means "after" in the list above.

> [none]

Element definition: dp-backup-retention-type | [top]

> Retention type to which the backup should be archived. Possible values are: 'hourly', 'daily', 'weekly', 'monthly' and 'unlimited'.

> [none]