APIs in Category: dp-job | API version 4.0

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 and provisioning 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 whereas a provisioning job is for a provisioning operation on a member 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-context-obj-name-or-id |  | string optional | Name or identifier of the job context object. The object can be of type host, aggregate or dataset only. If specified, only those jobs that ran in the context of the specified object is returned. If not specified, all jobs will be listed. This field is ignored if either obj-name-or-id or job-id is specified.
> 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. This field is deprecated in favor of job-types. Only one of job-type or job-types can be specified.
> job-types |  | job-type[] optional | List of job types. Only jobs of these types are listed. Only one of job-type or job-types can be specified.
> 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 |  | obj-name-or-id optional | Name or ID of the dataset, a resource group or a vFiler unit. In case of datasets or vFiler units, jobs carried out on them are listed. In case of resource groups, jobs carried out on datasets or vFiler units which are members of the resource group are listed.
> 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 |  |
> EINVALIDJOBTYPE |  |
> EINVALIDJOBSTATE |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EAPILICENSE |  |
> 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' 'job-retry' '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' 'mirror-break-script-start' 'mirror-break-script-end' 'mirror-break-quiesce-start' 'mirror-break-quiesce-end' 'mirror-break-start' 'mirror-break-end' 'volume-create' 'volume-resize' 'volume-option-set' 'snapshot-reserve-resize' 'volume-autosize' 'snapshot-autodelete' 'lun-create' 'lun-destroy' 'lun-map' 'lun-unmap' 'igroup-create' 'igroup-destroy' 'igroup-add' 'igroup-remove' 'qtree-create' 'quota-set' 'nfsexport-create' 'cifs-share-create' 'cifs-share-modify' 'cifs-share-delete' 'volume-destroy' 'qtree-destroy' 'vfiler-storage-add' 'script-run' 'volume-dedupe' 'volume-dedupe-enable' 'volume-dedupe-schedule-set' 'vfiler-create' 'vfiler-setup' 'aggregate-space'

> Input Name | Range | Type | Description
> connection-id |  | integer optional | Identifier of the connection in the policy being used by the job. If not specified, then progress events for all jobs are returned. Range: [1..2^31-1].
> 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. This field is deprecated in favor of object-name-or-id.
> 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].
> job-type |  | dp-job-type optional | Type of the job associated with the event. If not specified progress events for all job types are returned. This field is deprecated in favor of job-types.
> job-types |  | job-type[] optional | List of job types associated with the progress events. Only progress events of jobs of these job types are listed. If not specified, progress events for all job types are returned. Only one of job-type or job-types can be specified.
> object-name-or-id |  | obj-name-or-id optional | Identifier of the object to list progress events for. If not specified, progress events for all jobs are returned. Only object-name-or-id or job-id may be supplied, but not both. Only one of dataset-name-or-id or object-name-or-id can be specified.
> 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 |  |
> EINVALIDJOBTYPE |  |
> EINVALIDJOBSTATE |  |
> 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 or provisioning 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]. It will be always zero for a provisioning job.
> completed-timestamp |  | dp-timestamp optional | Timestamp when the job was completed. If unspecified, the job has not yet reached completion.
> dataset-id |  | integer optional | Database ID of the dataset on which this job was carried out. This field is optional and will be returned only when the job is carried out on a dataset. This field is deprecated in favor of object-name and object-type. Range: [1..2^31-1].
> dataset-name |  | string optional | Name of the dataset on which this job was carried out. This field is optional and will be returned only when the job is carried out on a dataset. This field is deprecated in favor of object-name and object-type.
> 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 or a provisioning 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 or provisioning job).
> job-context-obj-id |  | obj-id | Identifier of the job context object. If there was no job context when the job is submitted, then the identifier of the job object on which the job ran will be returned as the job context object identifier. Refer to job-context-obj-type for valid types of job context objects.
> job-context-obj-name |  | obj-full-name | Full name of the job context object. If there was no job context when the job is submitted, then the full name of the job object on which the job ran will be returned as the job context object full name. Refer to job-context-obj-type for valid types of job context objects.
> job-context-obj-type |  | string | Type of the job context object. Possible values are :- aggregate dataset vfiler
> job-description |  | string | Description of what job is trying to accomplish.
> job-id |  | integer | Identifier of the job. Range: [1..2^31-1].
> job-overall-status |  | dp-job-overall-status | Overall status of the job based on job-progress and job-state.
> job-progress |  | dp-job-progress | The current progress of the data protection or provisioning job.
> job-state |  | dp-job-state | State of the job.
> job-type |  | dp-job-type | Type of data protection or provisioning job.
> object-id |  | obj-id | Identifier of the object on which this job was carried out.
> object-name |  | obj-full-name | Full name of the object on which this job was carried out.
> object-type |  | string | Type of the object on which this job was carried out. Possible values: dataset vfiler volume
> 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.
> provision-request-info |  | provision-request-info optional | Information of the provisioning request. Present only if the job-type is one of 'provision_member', 'resize_member', 'delete_snapshots', 'destroy_member', 'dedupe_member' or 'undedupe_member'.
> 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 and is queued.
> 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 progress event for a data protection or provisioning job.

> 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-failover-info |  | dp-progress-failover-info optional | Information about a failover job.
> 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' 'job-retry' '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) 'mirror-break-script-start' (dp-progress-failover-info) 'mirror-break-script-end' (dp-progress-failover-info) 'mirror-break-quiesce-start' (dp-progress-failover-info) 'mirror-break-quiesce-end' (dp-progress-failover-info) 'mirror-break-start' (dp-progress-failover-info) 'mirror-break-end' (dp-progress-failover-info) 'volume-create' (progress-volume-info) 'volume-option-set' (progress-volume-option-info) 'snapshot-reserve-resize' (progress-volume-info) 'volume-autosize' (progress-volume-info) 'snapshot-autodelete' (progress-volume-info) 'lun-create' (progress-lun-info) 'lun-destroy' (progress-lun-info) 'lun-map' (progress-lun-map-info) 'lun-unmap' (progress-lun-map-info) 'igroup-create' (progress-igroup-info) 'igroup-destroy' (progress-igroup-info) 'igroup-add' (progress-igroup-config-info) 'igroup-remove' (progress-igroup-config-info) 'qtree-create' (progress-qtree-info) 'quota-set' (progress-quota-info) 'nfsexport-create' (progress-nfsexport-info) 'cifs-share-create' (progress-cifs-share-info) 'cifs-share-modify' (progress-cifs-share-info) 'cifs-share-delete' (progress-cifs-share-info) 'volume-offline' (progress-volume-info) 'volume-destroy' (progress-volume-info) 'qtree-destroy' (progress-qtree-info) 'vfiler-storage-add' (progress-vfiler-storage-info) 'script-run' (progress-script-run-info) 'vfiler-create' (progress-vfiler-info) 'vfiler-setup' (progress-vfiler-info) 'volume-dedupe' (progress-volume-dedupe-info) 'volume-dedupe-enable' (progress-volume-dedupe-info) 'volume-dedupe-disable' (progress-volume-dedupe-info) 'volume-dedupe-schedule-set' (progress-volume-dedupe-info) 'aggregate-space' (progress-aggregate-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].
> job-type |  | dp-job-type | Type of data protection or provisioning job.
> progress-aggregate-info |  | progress-aggregate-info optional | Information about aggregate.
> progress-cifs-share-info |  | progress-cifs-share-info optional | CIFS share information.
> progress-igroup-config-info |  | progress-igroup-config-info optional | Information about the initiators added or removed from an initiator group.
> progress-igroup-info |  | progress-igroup-info optional | Information about the initiator group on which the mapping operation is executed.
> progress-lun-info |  | progress-lun-info optional | Information about the lun being provisioned.
> progress-lun-map-info |  | progress-lun-map-info optional | Information about the lun on which the mapping operation is executed.
> progress-nfsexport-info |  | progress-nfsexport-info optional | NFS export information.
> progress-qtree-info |  | progress-qtree-info optional | Information about the qtree provisioned.
> progress-quota-info |  | progress-quota-info optional | Information about the quota being modified/set.
> progress-script-run-info |  | progress-script-run-info optional | Information about the script which is run.
> progress-vfiler-info |  | progress-vfiler-info optional | Information about the vfiler which is being created.
> progress-vfiler-storage-info |  | progress-vfiler-storage-info optional | Information about the vfiler on which storage is added or removed.
> progress-volume-dedupe-info |  | progress-volume-dedupe-info optional | Information about dedupe operation on the volume.
> progress-volume-info |  | progress-volume-info optional | Information about the volume on which the provisioning operation is executed.
> progress-volume-option-info |  | progress-volume-option-info optional | Information about the name and value of various volume options.

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

> The state of the data protection/provisioning job. The possible values are "queued", "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, provisioning, migration or space management job. Valid values for data protection jobs are "local_backup", "local_backup_confirmation", "remote_backup", "mirror", "restore", "create_relationship", "destroy_relationship", "on_demand_backup" and "failover". Valid values for provisioning job types are "provision_member", "resize_member", "destroy_member", "delete_snapshots", "dedupe_member", "undedupe_member", "dedupe_volume" and "pm_re_export". Valid space management jobs are: "dedupe_volume", "migrate_volume", "resize_volume", "delete_snapshot" and "delete_backup". Valid migration job types are: "migrate_start", "migrate_complete", "migrate_cancel", "migrate_cleanup", "migrate_update".

> [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: job-type | [top]

> Job type.

> [none]

Element definition: obj-name-or-id | [top]

> Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI type string. An obj-name-or-id must contain between 1 and 64 characters, and must conform to one of the following formats: It must have the format of an obj-name, or It must be the decimal numeric string form of a positive integer whose value is in the range [1..2^31 - 1]. Elements of type obj-name-or-id are used only as inputs to ZAPIs. The value must match either the name or internal ID of an existing DFM object. The ZAPI must specify the object's DFM object type (e.g. dataset, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the format of an obj-name-or-id input element does not conform, or the value does not match the name or ID of an existing object, then generally the ZAPI documents that it fails with error code EOBJECTNOTFOUND. A ZAPI may return more specific error codes. In such cases, the ZAPI specification must document its behavior. If a ZAPI can accept a null value (e.g. reference to no object at all) for such an element, then the element is declared optional, and the absence of the input element represents a null value.

> [none]

Element definition: dp-job-overall-status | [top]

> The overall status of the data protection/provisioning job. The possible values are "queued", "canceling", "canceled", "running", "running_with_failures", "partially_failed", "succeeded", and "failed". This field is derived from dp-job-state and dp-job-progress. The current mappings are as follow:
>      dp-job-state    dp-job-progress dp-job-overall-status
>      =====================================================
>      queued          *               queued
>      running         in_progress     running
>      running         success         running
>      running         partial_success running_with_failures
>      running         failure         running_with_failures
>      aborting        *               canceling
>      aborted         *               canceled
>      completed       partial_success partially_failed
>      completed       failure         failed
>      completed       success         succeeded
>      completed       in_progress     canceled

> [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
> is-confirmation-data |  | boolean optional | If the element: "is-confirmation-data" is set to 'true', this job only confirms backups have been created on the primary node. An external agent, such as a SnapManager/SnapDrive, is responsible for creating these backups. This element can only be true for application data sets. If set to true, the job type will be "local_backup_confirmation" and the job will update the protection status without creating a local backup.
> 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 | ID of the new backup instance. 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-failover-info | [top]

> Information about a failover job.

> Name | Range | Type | Description
> destination-path |  | string optional | Destination path for the SnapMirror break operation. This element is not present for event type 'mirror-break-script-start' and 'mirror-break-script-end'.
> environment-variable-list |  | environment-variable-info[] optional | List of environment variables related to the dataset to be passed to the failover script. This element is present only for event type 'mirror-break-script-start'.
> relationship-id |  | obj-id optional | The relationship ID for performing mirror break. This element is not present for event type 'mirror-break-script-start' and 'mirror-break-script-end'.
> script-exit-status |  | integer optional | Exit code of the script. This element is present only for event type 'mirror-break-script-end'. Range: [-2^31..2^31-1]
> script-path |  | string optional | Path of the failover script. This element is present only for event type 'mirror-break-script-start' and 'mirror-break-script-end'.
> script-run-as |  | string optional | Username used to run the failover script. This element is present only for event type 'mirror-break-script-start' and 'mirror-break-script-end'.
> script-summary |  | string optional | Detailed output from the failover script. This element is present only for event type 'mirror-break-script-end'.

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 | ID of the backup instance 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-full-name | [top]

> Full name of a DFM object. This typedef is an alias for the builtin ZAPI type string. An object full name conforms to all the rules of an obj-name, except that the full name may be up to 255 characters long. DFM creates full names by concatenating an object name with any parent object names, so as to create a unique name for an object. The format of full names is as follows: Host full names are the either the fully-qualified domain name or the IP address of the host. Aggregate full names are the host name and the aggregate name, separated by a colon, e.g. hostname:aggr0. Volume full names are the host name and the volume name, separated by ":/", e.g. hostname:/volume. Note this does not include "/vol". Volume and aggregate full names are distinguished by the presence of a forward slash after the colon. Qtree full names are the containing volume full name and the qtree name, separated by a slash, e.g. hostname:/volume/qtree. The data not contained by any qtree may be represented by "-", e.g. hostname:/volume/-. Lun Path full names are either a volume or qtree full name and the LUN path, separated by a slash, e.g. hostname:/volume/LUN or hostname:/volume/qtree/LUN. Network full names are a network address block in CIDR format, e.g. 1.2.3.0/8. OSSV Directory full names are the OSSV host name and the OSSV path, separated by a colon, e.g. host-lnx:/usr/local or host-w2k:c:/temp Include any others here... Initiator Group full names are host name and the initiator group name, separated by a colon, e.g. hostname:igroup. For any DFM object not listed above, the obj-name and obj-full-name are identical.

> [none]

Element definition: obj-id | [top]

> Identification number (ID) for a DFM 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 a DFM 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 DFM object type (e.g. dataset, host, DP policy, 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 DFM 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-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 storage system 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: progress-aggregate-info | [top]

> Information about the aggregate

> Name | Range | Type | Description
> aggregate-id |  | obj-id | Database identifier of the aggregate
> aggregate-name |  | obj-full-name | Full name of the aggregate

Element definition: progress-cifs-share-info | [top]

> Information about the CIFS share created as part of provisioning operation.

> Name | Range | Type | Description
> cifs-acl-list |  | cifs-acl[] optional | CIFS access control list set on the CIFS share.
> cifs-share-name |  | string | Name of the CIFS share.
> vol-or-qtree-id |  | obj-id | Database identifier of the volume or qtree for which the CIFS share is created.
> vol-or-qtree-name |  | obj-full-name | Full name of the volume or qtree for which the CIFS share is created.

Element definition: progress-igroup-config-info | [top]

> Information about initiators being added or removed to/from an initiator group of a job.

> Name | Range | Type | Description
> igroup-id |  | obj-id | Database identifier of the initiator group to which initiators are added or destroyed in a provisioning job.
> igroup-name |  | obj-full-name | Full name of the initiator group to which initiators are added or destroyed in a provisioning job.
> initiators |  | string | Comma separated list of initiators that are added or removed in this provisioning job.

Element definition: progress-igroup-info | [top]

> Information about the initiator group of a job.

> Name | Range | Type | Description
> igroup-id |  | obj-id | Database identifier of the initiator group which is created or destroyed in the provisioning job.
> igroup-name |  | obj-full-name | Full name of the initiator group which is created or destroyed in the provisioning job.

Element definition: progress-lun-info | [top]

> Information about the lun being provisioned or destroyed in a provisioning job.

> Name | Range | Type | Description
> lun-name |  | obj-full-name | Full name of the LUN that is provisioned or destroyed
> lun-path-id |  | obj-id | Database identifier of the LUN.

Element definition: progress-lun-map-info | [top]

> Information about the mapping of a LUN.

> Name | Range | Type | Description
> igroup-id |  | obj-id | Database identifier of the initiator group to which the LUN is mapped.
> igroup-name |  | obj-full-name | Full name of the initiator group to which the LUN is mapped.
> lun-name |  | obj-full-name | Full name of the LUN that is mapped.
> lun-path-id |  | obj-id | Database identifier of the LUN that is mapped.

Element definition: progress-nfsexport-info | [top]

> Information about the NFS export created as part of provisioning operation.

> Name | Range | Type | Description
> path |  | string | Name of the NFS export by which it can be accessed.
> qtree-id |  | obj-id | Database identifier of the qtree for which the NFS export is created.
> qtree-name |  | obj-full-name | Full name of the qtree for which the NFS export is created.

Element definition: progress-qtree-info | [top]

> Information about a qtree which is created or destroyed in the provisioning job.

> Name | Range | Type | Description
> qtree-id |  | obj-id | Database identifier of the qtree provisioned or destroyed.
> qtree-name |  | obj-full-name | Full name of the qtree provisioned or destroyed.
> volume-id |  | obj-id | Database identifier of the volume to which the qtree belongs to.
> volume-name |  | obj-full-name | Full name of the volume to which the qtree belongs to.

Element definition: progress-quota-info | [top]

> Information about the quota of a qtree.

> Name | Range | Type | Description
> default-group-quota |  | integer optional | Default group quota value set in bytes. Range: [1..2^63-1].
> default-user-quota |  | integer optional | Default user quota value set in bytes. Range: [1..2^63-1].
> qtree-id |  | obj-id | Database identifier of the qtree on which the quotas are set.
> qtree-name |  | obj-full-name | Full name of the qtree on which the quotas are set.
> tree-quota |  | integer optional | Tree quota value set in bytes. Range: [1..2^63-1].

Element definition: progress-script-run-info | [top]

> Information about the post provisioning script which is run.

> Name | Range | Type | Description
> script-name |  | string | Name of the script with its absolute path.

Element definition: progress-vfiler-info | [top]

> Information about creating a vfiler

> Name | Range | Type | Description
> filer-id |  | obj-id | Database identifier of the storage system.
> filer-name |  | obj-full-name | Full name of the storage system on which the vfiler is being created.
> ipaddress |  | string | IP address of the vfiler
> ipspace |  | string | IPspace of the vfiler
> vfiler-id |  | obj-id optional | Database identifier of the vFiler unit
> vfiler-name |  | obj-full-name | Full name of the vFiler unit which is created

Element definition: progress-vfiler-storage-info | [top]

> Information about adding storage to a vFiler.

> Name | Range | Type | Description
> vfiler-id |  | obj-id | Database identifier of the vFiler to which storage is added.
> vfiler-name |  | obj-full-name | Full name of the vFiler to which storage is added.
> volume-id |  | obj-id | Database identifier of the volume which is added to the vFiler.
> volume-name |  | obj-full-name | Full name of the volume which is added to the vFiler.

Element definition: progress-volume-dedupe-info | [top]

> Information about the deduplication operation on the volume.

> Name | Range | Type | Description
> dedupe-progress |  | string optional | The progress of the current deduplication operation on the volume with information as to which stage of deduplication is currently in progress and how much data is processed for that stage. For eg: "25 MB Scanned, 20MB Searched, 40MB (20%) Done , 30MB Verified".
> dedupe-schedule |  | string optional | Specifies the deduplication schedule set on the volume.
> dedupe-status |  | string optional | Deduplication operation status of the volume. Possible values: "idle", "active", "pending", or "undoing".
> volume-id |  | obj-id | Database identifier of the volume on which the deduplication is run.
> volume-name |  | obj-full-name | Full name of the volume on which the deduplication operation is run.

Element definition: progress-volume-info | [top]

> Information about the volume of on which a provisioning operation is executed.

> Name | Range | Type | Description
> volume-id |  | obj-id | Database identifier of the volume on which the provisioning operation is executed.
> volume-name |  | obj-full-name | Full name of the volume on which the provisioning operation is executed.

Element definition: progress-volume-option-info | [top]

> Information about the volume options set.

> Name | Range | Type | Description
> volume-id |  | obj-id | Database identifier of the volume on which the provisioning operation is executed.
> volume-name |  | obj-full-name | Full name of the volume on which the provisioning operation is executed.
> volume-options |  | volume-option[] | A list of of volume options and its values.

Element definition: provision-request-info | [top]

> Information of a single provisioning request

> Name | Range | Type | Description
> dedupe-member-request-info |  | dedupe-member-request-info optional | Information specific to the 'dedupe_member' request. Returned only when job-type is 'dedupe_member'.
> delete-snapshots-request-info |  | delete-snapshots-request-info optional | Information specific to the snapshot deletion request. Returned only when the job-type is 'delete_snapshots'.
> destroy-member-request-info |  | destroy-member-request-info optional | Information specific to the 'destroy_member' request. Returned only when job-type is 'destroy_member'.
> provision-member-request-info |  | provision-member-request-info optional | Information specific to the 'provision_member' request. Returned only when job-type is 'provision_member'.
> resize-member-request-info |  | resize-member-request-info optional | Information specific to the resize related provisioning request. Returned only when job-type is 'resize_member'.
> undedupe-member-request-info |  | undedupe-member-request-info optional | Information specific to the 'undedupe_member' request. Returned only when job-type is 'undedupe_member'.

Element definition: cifs-acl | [top]

> Information about the user and the permission with which the user can access the CIFS share.

> Name | Range | Type | Description
> access-rights |  | string | Access right of the user accessing the CIFS share. Possible values are 'no_access', 'read', 'change' and 'full_control'
> user-name |  | string | Name of the user accessing the CIFS share. The username may be the name of an actual domain user or one of the built-in names like 'administrator' or 'everyone'. This can be a maximum of 128 characters.

Element definition: dedupe-member-request-info | [top]

> Details of the dedupe member request.

> Name | Range | Type | Description
> full-volume-dedupe |  | boolean optional | If true, full volume dedupe scan is performed. Otherwise only new data since last deduplication operation is scanned. Default value is false.
> volume-id |  | obj-id optional | Identifier of a volume member of a dataset.
> volume-name |  | obj-name optional | Name of a volume member of the dataset. Either volume-id or volume-name has to be specified. If volume-id is specified then volume-name is ignored.

Element definition: delete-snapshots-request-info | [top]

> Details on which Snapshot copies are to be deleted.

> Name | Range | Type | Description
> snapshots |  | snapshot[] | List of Snapshot copies to be deleted from the volume. A minimum of 1 and a maximum of 255 Snapshot copies can be listed for deletion.
> volume-id |  | obj-id optional | Identifier of the volume whose Snapshot copies are to be deleted. This volume should be a member of the effective primary node of the dataset either through direct or indirect membership.
> volume-name |  | obj-name optional | Name of the volume whose Snapshot copies are to be deleted. This volume should be a member of the effective primary node of the dataset either through direct or indirect membership. Either volume-id or volume-name has to be specified. If volume-id is specified then volume-name is ignored.

Element definition: destroy-member-request-info | [top]

> Details specific to the 'destroy_member' request.

> Name | Range | Type | Description
> member-id |  | obj-id | This is the id of the dataset member on which the action was performed.
> member-name |  | obj-full-name | This is the full name of the dataset member on which the action is performed.
> member-type |  | string | Type of the dataset member on which the action was or is to be performed. Possible values are 'volume', 'qtree' and 'lun'.

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]

Element definition: environment-variable-info | [top]

> Information about an environment variable.

> Name | Range | Type | Description
> name |  | string | Environment variable name.
> value |  | string | Value of an environment variable.

Element definition: obj-full-name | [top]

> Full name of a DFM object. This typedef is an alias for the builtin ZAPI type string. An object full name conforms to all the rules of an obj-name, except that the full name may be up to 255 characters long. DFM creates full names by concatenating an object name with any parent object names, so as to create a unique name for an object. The format of full names is as follows: Host full names are the either the fully-qualified domain name or the IP address of the host. Aggregate full names are the host name and the aggregate name, separated by a colon, e.g. hostname:aggr0. Volume full names are the host name and the volume name, separated by ":/", e.g. hostname:/volume. Note this does not include "/vol". Volume and aggregate full names are distinguished by the presence of a forward slash after the colon. Qtree full names are the containing volume full name and the qtree name, separated by a slash, e.g. hostname:/volume/qtree. The data not contained by any qtree may be represented by "-", e.g. hostname:/volume/-. Lun Path full names are either a volume or qtree full name and the LUN path, separated by a slash, e.g. hostname:/volume/LUN or hostname:/volume/qtree/LUN. Network full names are a network address block in CIDR format, e.g. 1.2.3.0/8. OSSV Directory full names are the OSSV host name and the OSSV path, separated by a colon, e.g. host-lnx:/usr/local or host-w2k:c:/temp Include any others here... Initiator Group full names are host name and the initiator group name, separated by a colon, e.g. hostname:igroup. For any DFM object not listed above, the obj-name and obj-full-name are identical.

> [none]

Element definition: obj-id | [top]

> Identification number (ID) for a DFM 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 a DFM 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 DFM object type (e.g. dataset, host, DP policy, 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 DFM 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: provision-member-request-info | [top]

> Details specific to the 'provision_member' request.

> Name | Range | Type | Description
> comments |  | provision-member-comment[] optional | Comment values to assign to the newly provisioned storage object.
> create-new-vfiler |  | boolean optional | True, if new vFiler Unit needs to be created during provisioning. The provisioned storage container is then moved to the vFiler Unit. This input is applicable only in the context of resourcepool-member-list-info-iter-start zapi and run-provisioning-checks is specified as 'true'. This input is ignored in dataset-provision-member and storage-service-dataset-provision zapi. The default value is 'false'.
> dataset-export-info |  | dataset-export-info optional | Specifies the NAS or SAN export settings for the the provisioning member. Member level export settings cannot be specified, if export settings have been configured at node level.
> description |  | string optional | Description of the provisioning request. The length of this string cannot be more than 255 characters.
> initial-snapshot-space |  | integer optional | Applicable when provisioning members in SAN data sets (i.e. datasets associated with provisioning policy of type 'san'). Specify the initial disk space in bytes that needs to be allocated upfront for Snapshot copies of the member. Range: [1..2^63-1]
> maximum-data-size |  | integer validate optional | Maximum storage space for the dataset member. Applicable when provisioning members in NFS data sets (i.e. datasets associated with provisioning policy of type 'nas' and export over 'NFS' protocol). Storage clients can write data up to this limit if the containing aggregate has space. The value is specified in bytes. Range: [1..2^63-1]
> maximum-snapshot-space |  | integer optional | Applicable when provisioning members in SAN data sets (i.e. datasets associated with provisioning policy of type 'san'). Specify the maximum disk space in bytes for the Snapshot copies of the member. Once the space consumed by Snapshot copies reaches this value, further Snapshot copies will fail. Range: [1..2^63-1]
> name |  | string | Name of the storage container. If this is a NAS dataset, i.e the provisioning policy associated with the primary node of the dataset is of type 'nas', then this name corresponds to the qtree created. If this is a SAN dataset, i.e the provisioning policy associated with the primary node of the dataset is of type 'san', then this name corresponds to the LUN or volume that will be provisioned as part of this request. The length of this string cannot be more than 255 characters.
> online-migration |  | boolean optional | Indicates whether pre checks related to online migration has to be performed on the storage system during provisioning. This input is applicable only in the context of resourcepool-member-list-info-iter-start API and run-provisioning-checks is specified as true and either create-new-vfiler is true or vfiler-name-or-id is specified. This input is ignored in storage-service-dataset-provision and dataset-provision-member APIs.
> provisioning-policy-id |  | obj-id optional | Name or identifier of the provisioning policy used with this request. Ignored for dataset-provision-member and storage-service-dataset-provision and is used only when listing provisioning requests and jobs.
> provisioning-policy-name |  | obj-full-name optional | Name of the provisioning policy used with this request. Present only if the request type is 'provision_member'. Ignored for dataset-provision-member and storage-service-dataset-provision and is used only when listing provisioning requests and jobs.
> resource-name-or-id |  | obj-name-or-id optional | Name or identifier of the resource object from which storage space will be provisioned. valid types of objects are:- Filer Aggregate The filer or aggregate specified should belong to the resource pool(s) associated with primary node of the dataset.
> size |  | integer validate | Amount of storage space for data. Whether this space has to allocated on demand or reserved upfront from an aggregate in resource pool is decided based on the provisioning policy settings. The value is specified in bytes. Range: [1..2^63-1]
> vfiler-name-or-id |  | obj-name-or-id optional | Name or id of the vFiler Unit, if specified the newly provisioned dataset member will be moved to the specified vFiler Unit and accessed via the vFiler Unit's IP addresses. Ignored for storage-service-dataset-provision.

Element definition: resize-member-request-info | [top]

> Details of the resize request.

> Name | Range | Type | Description
> maximum-capacity |  | integer optional | Specify the new maximum capacity value for a flexbile volume. The value is specified in bytes. Valid only if the filer to which the volume belongs is of ONTAP version 7.1 or above only. This input is valid only if member-id or member-name refers to a flexible volume. Range: [1..2^63-1]
> member-id |  | obj-id optional | Identifier of the dataset member on which the resize operation has to be carried out. This member can be either a flexible volume or a qtree which is a member of the effective primary node of the dataset either through direct or indirect membership.
> member-name |  | obj-name optional | Name of the dataset member on which the resize operation has to be carried out. This member can be either a flexible volume or a qtree which is a member of the effective primary node of the dataset either through direct or indirect membership. Either member-id or member-name has to be specified. If member-id is specified then member-name is ignored.
> new-size |  | integer optional | Specify the new size of the dataset member. The value is specified in bytes. If the member is a volume, this corresponds to the size of the volume. If the member is a qtree, this corresponds to hard disk quota limit for the qtree. Range: [1..2^63-1]
> snap-reserve |  | integer optional | Specifies the percetage of space set aside for snapshots in a volume. The value is specified in percentage of the total size of the volume. This input is valid only if member-id or member-name refers to a flexible volume. Range: [0..100]

Element definition: undedupe-member-request-info | [top]

> Details of the undedupe member request.

> Name | Range | Type | Description
> volume-id |  | obj-id optional | Identifier of a volume member of a dataset.
> volume-name |  | obj-name optional | Name of a volume member of the dataset. Either volume-id or volume-name has to be specified. If volume-id is specified then volume-name is ignored.

Element definition: volume-option | [top]

> Information about option and its value.

> Name | Range | Type | Description
> option-name |  | string | Name of a volume option as defined in ONTAP.
> option-value |  | string | Value of the volume option as allowed in ONTAP.

Element definition: dataset-export-info | [top]

> Specifies the NAS or SAN export settings for a dataset node.

> Name | Range | Type | Description
> dataset-cifs-export-setting |  | dataset-cifs-export-setting optional | The CIFS export settings for storage exported over CIFS. This field may be present only if the dataset-export-protocol is 'cifs' or 'mixed'.
> dataset-export-protocol |  | dataset-export-protocol optional | Specifies the protocol over which members of the dataset node will be exported. This value is always returned. If omitted during a modify operation, the existing value is not changed. If specified as 'none' in a modify operation, the existing settings will be cleared. Default value is 'none'. Depending on the export protocol, dataset-lun-mapping, or a combination of dataset-nfs-export-setting and dataset-cifs-share-permissions, should be specified in a modify operation, and will be returned in the iterator output.
> dataset-lun-mapping-info |  | dataset-lun-mapping-info optional | Specifies the hosts and/or initiators to which LUNs in this dataset node will be mapped, and the igroup OS type. This field may be present only if the dataset-export-protocol is 'fcp' or 'iscsi'.
> dataset-nfs-export-setting |  | dataset-nfs-export-setting optional | The NFS export settings for storage exported over NFS. This field may be present only if the dataset-export-protocol is 'nfs' or 'mixed'.

Element definition: obj-full-name | [top]

> Full name of a DFM object. This typedef is an alias for the builtin ZAPI type string. An object full name conforms to all the rules of an obj-name, except that the full name may be up to 255 characters long. DFM creates full names by concatenating an object name with any parent object names, so as to create a unique name for an object. The format of full names is as follows: Host full names are the either the fully-qualified domain name or the IP address of the host. Aggregate full names are the host name and the aggregate name, separated by a colon, e.g. hostname:aggr0. Volume full names are the host name and the volume name, separated by ":/", e.g. hostname:/volume. Note this does not include "/vol". Volume and aggregate full names are distinguished by the presence of a forward slash after the colon. Qtree full names are the containing volume full name and the qtree name, separated by a slash, e.g. hostname:/volume/qtree. The data not contained by any qtree may be represented by "-", e.g. hostname:/volume/-. Lun Path full names are either a volume or qtree full name and the LUN path, separated by a slash, e.g. hostname:/volume/LUN or hostname:/volume/qtree/LUN. Network full names are a network address block in CIDR format, e.g. 1.2.3.0/8. OSSV Directory full names are the OSSV host name and the OSSV path, separated by a colon, e.g. host-lnx:/usr/local or host-w2k:c:/temp Include any others here... Initiator Group full names are host name and the initiator group name, separated by a colon, e.g. hostname:igroup. For any DFM object not listed above, the obj-name and obj-full-name are identical.

> [none]

Element definition: obj-id | [top]

> Identification number (ID) for a DFM 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 a DFM 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 DFM object type (e.g. dataset, host, DP policy, 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 DFM 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 a DFM object. This typedef is an alias for the built in ZAPI type string. An object name must conform to the following format: 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. 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: 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 EINVALIDINPUTERROR. Note that because EINVALIDINPUTERROR 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. 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 an input name element is used to refer to an existing object, then the ZAPI specification must specify which DFM object type (e.g. data set, host, DP policy, 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. For example, this constraint applies to datasets, DP schedules, and DP policies. This means that no two datasets may have the same name, but a dataset may have the same name as a DP schedule or DP policy. In general, object names are compared in a case-insensitive manner. This means that, for example, "MyObject" and "MYOBJECT" are considered to be the same name for purposes of: creating new objects, renaming existing objects, or looking up an object by name. On the other hand, ZAPIs that return an obj-name generally do not change the capitalization at all. For example, if an object's name has been set to "MyObject", then list iteration ZAPIs that return the object's name return it as "MyObject" rather than "MYOBJECT" or "myobject". ZAPIs that operate on obj-name values and do not follow these general rules about case sensitivity must document the rules that they do follow. One important exception to these general rules is that volumes, qtrees, OSSV directories, SRM paths, interfaces, FCP targets and FC switch ports all have case-sensitive names. When looking up objects of these types by name, the case must match the object name.

> [none]

Element definition: obj-name-or-id | [top]

> Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI type string. An obj-name-or-id must contain between 1 and 64 characters, and must conform to one of the following formats: It must have the format of an obj-name, or It must be the decimal numeric string form of a positive integer whose value is in the range [1..2^31 - 1]. Elements of type obj-name-or-id are used only as inputs to ZAPIs. The value must match either the name or internal ID of an existing DFM object. The ZAPI must specify the object's DFM object type (e.g. dataset, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the format of an obj-name-or-id input element does not conform, or the value does not match the name or ID of an existing object, then generally the ZAPI documents that it fails with error code EOBJECTNOTFOUND. A ZAPI may return more specific error codes. In such cases, the ZAPI specification must document its behavior. If a ZAPI can accept a null value (e.g. reference to no object at all) for such an element, then the element is declared optional, and the absence of the input element represents a null value.

> [none]

Element definition: provision-member-comment | [top]

> One comment field to fill in as part of the request

> Name | Range | Type | Description
> comment-field-name-or-id |  | comment-field-name-or-id | Name or identifier of the comment field.
> comment-value |  | comment-value | Value of the comment field. An empty string can be used to unset the value of the comment field for this object.

Element definition: snapshot | [top]

> Information of one Snapshot copy. Either unique-id or name of the Snapshot copy should be specified.

> Name | Range | Type | Description
> snapshot-name |  | string optional | Name of the Snapshot copy. If unique-id is specified, then this element is ignored.
> unique-id |  | string optional | Unique identifier of the Snapshot copy. Currently, this is the Snapshot copy's creation time.

Element definition: comment-field-name-or-id | [top]

> Name or identifier of the comment field. It must conform to one of the following formats: It must be of the format of comment-field-name It must be of the format of comment-field-id

> [none]

Element definition: comment-value | [top]

> Value of the specified comment field to be set on the object. This can be of maximum 1024 characters.

> [none]

Element definition: dataset-cifs-export-setting | [top]

> If storage inside this dataset node is exported over CIFS, this specifies some of the common properties that will be applied to all such provisioned storage.

> Name | Range | Type | Description
> cifs-domain |  | string optional | Name of the CIFS domain. If present, then only filers or vFilers belonging to this CIFS domain is considered for provisioning. If not present, then any filer is picked. Up to 255 characters.
> dataset-cifs-share-permissions |  | dataset-cifs-share-permission[] optional | Specifies the permissions granted to users on storage provisioned in this dataset node. This field may be present only if the dataset-export-protocol is 'cifs' or 'mixed'.

Element definition: dataset-export-protocol | [top]

> Specifies the export protocols that members in this dataset node will be exported over. Possible values are 'nfs', 'cifs', 'mixed', 'fcp', 'iscsi' and 'none'. Specifying 'mixed' implies that the storage in the dataset should be exported over both NFS and CIFS.

> [none]

Element definition: dataset-lun-mapping-info | [top]

> Specifies the hosts and/or initiators to which LUNs in this dataset node will be mapped, and the igroup OS type.

> Name | Range | Type | Description
> igroup-os-type |  | string | Specifies the OS type for initiators to map LUNs in the dataset node to. Possible values are: 'windows', 'windows_gpt', 'windows_2008', 'hpux', 'aix, 'linux, 'solaris', 'vmware' and 'netware'. Here "windows_gpt" refers to Windows using GPT (GUID Partition Type) partitioning style and "windows_2008" refers to Windows Longhorn systems.
> lun-mapping-initiators |  | lun-mapping-initiator[] | Specifies the initiators to map LUNs in the dataset node to, and, optionally, the host to which they belong.

Element definition: dataset-nfs-export-setting | [top]

> If storage inside this dataset node is exported over NFS, this specifies some of the common properties that will be applied to all such provisioned storage.

> Name | Range | Type | Description
> anonymous-access-user |  | string optional | If the client accessing the export is not present in the root access list for the export, the effective user for root is the value specified for this field. Default value is 65534 which maps to user nobody. It could be an integer Range: [0..65534] or a user name not more than 255 characters.
> disable-setuid |  | boolean optional | If true, causes the server file system to ignore attempts to enable the setuid or setgid mode bits. Default value is true.
> is-readonly-for-all-hosts |  | boolean optional | Specifies that all hosts receive read-only permissions on nfs exports in this dataset node. Equivalent to specifying "ro" on the filer. Default value is false. If true, is-readwrite-for-all-hosts must be false.
> is-readwrite-for-all-hosts |  | boolean optional | Specifies that all hosts receive read-write permissions on nfs exports in this dataset node. Equivalent to specifying "rw" on the filer. Default value is false. If true, is-readonly-for-all-hosts must be false.
> nfs-export-ro-hosts |  | nfs-export-host[] optional | A list of hosts with read-only permissions on exports in this dataset node. If a non empty list of nfs-export-ro-hosts is present along with is-readonly-for-all-hosts as true, then ZAPI will throw an error.
> nfs-export-root-hosts |  | nfs-export-host[] optional | A list of hosts with the root user having read-only or read-write permissions on exports in this dataset node.
> nfs-export-rw-hosts |  | nfs-export-host[] optional | A list of hosts with read-write permissions on exports in this dataset node. If a non empty list of nfs-export-rw-hosts is present along with is-readwrite-for-all-hosts as true, then ZAPI will throw an error.
> nfs-protocol-version |  | string optional | NFS protocol version, valid values are "v2", "v3" and "v4". Default value is "v3". If set, the storage systems that have the given version enabled will be selected to provision storage for the dataset.
> nfs-security-flavors |  | nfs-security-flavor[] optional | List of strings specifying the security flavors supported on exports in this dataset node. If this field is not specified, the default value of 'sys' is assumed.

Element definition: dataset-cifs-share-permission | [top]

> A single permission granted to a user on CIFS shares within a dataset node.

> Name | Range | Type | Description
> cifs-username |  | string | Name of a user in the specified domain. The username may be the name of an actual domain user or one of the built-in names - 'administrator' or 'everyone'.
> permission |  | cifs-permission | Specifies the permissions granted to a user.

Element definition: lun-mapping-initiator | [top]

> Specifies an initiator to map LUNs in the dataset node to, and, optionally, the host to which it belongs.

> Name | Range | Type | Description
> hostname |  | string optional | Specifies the name of the host which owns the initiator.
> initiator-id |  | initiator-id | Specifies an initiator id on a host to which a LUN should be mapped.

Element definition: nfs-export-host | [top]

> Specifies a single host or all-hosts. A host can be a host name (DNS name), an IP address, a subnet or a domain name. If an 'all-hosts' entry is present, all other host name entries must be negated.

> Name | Range | Type | Description
> hostname |  | string optional | Specifies a single host name entry. A host name may be a DNS name, an IP address, a subnet (specified as <subnet address>/<prefix length> i.e. CIDR notation or '[network] <subnet-address> [netmask] <netmask>'), a domain, or a workgroup.
> is-an-exception |  | boolean optional | Specifies that the rule does not apply to this host. Should be used when it is required to grant permissions to hosts in a subnet or a domain or all hosts excluding some. Default value is false.

Element definition: nfs-security-flavor | [top]

> A security flavor to be applied on nfs exports. Possible values are 'none', 'sys' (Unix Style), 'krb5' (Kerberos v5) , krb5i' (Kerberos v5 integrity) and 'krb5p' (Kerberos v5 privacy). Default value is 'sys'.

> [none]

Element definition: cifs-permission | [top]

> Permission granted to a CIFS user on a share. Possible values are 'no_access', 'read', 'change' and 'full_control'

> [none]

Element definition: initiator-id | [top]

> For FCP initiators, this is a string composed of 16 hexadecimal digits. For iSCSI initiators, this is an initiator name in the dotted-domain notation.

> [none]