Input Name	Type
DpJobAbort	DpJobAbort
Output Name	Type
DpJobAbortResult	DpJobAbortResult

Error Name	Description
EACCESSDENIED
EDATABASEERROR
EJOBALREADYABORTED
EJOBALREADYCOMPLETED
EJOBCANNOTBEABORTED
EJOBDOESNOTEXIST

Ends iteration To list Jobs.

Input Name	Type
DpJobListIterEnd	DpJobListIterEnd
Output Name	Type
DpJobListIterEndResult	DpJobListIterEndResult

Error Name	Description
EINVALIDTAG

Get next few Records in the iteration started by DpJobListIterStart.

Input Name	Type
DpJobListIterNext	DpJobListIterNext
Output Name	Type
DpJobListIterNextResult	DpJobListIterNextResult

Error Name	Description
EACCESSDENIED
EINVALIDTAG

Starts iteration To list Jobs. The Jobs that Match all the specified filters will be returned.

Input Name	Type
DpJobListIterStart	DpJobListIterStart
Output Name	Type
DpJobListIterStartResult	DpJobListIterStartResult

Error Name	Description
EACCESSDENIED
EAPIERROR
EAPILICENSE
EDATABASEERROR
EINVALIDINPUT
EINVALIDJOBSTATE
EINVALIDJOBTYPE

Ends iteration To list progress of job.

Input Name	Type
DpJobProgressEventListIterEnd	DpJobProgressEventListIterEnd
Output Name	Type
DpJobProgressEventListIterEndResult	DpJobProgressEventListIterEndResult

Error Name	Description
EINVALIDTAG

Get next few Records in the iteration started by DpJobProgressEventListIterStart.

Input Name	Type
DpJobProgressEventListIterNext	DpJobProgressEventListIterNext
Output Name	Type
DpJobProgressEventListIterNextResult	DpJobProgressEventListIterNextResult

Error Name	Description
EACCESSDENIED
EINVALIDTAG

Starts iteration To list job progress Events. The event could be one of the following Type. 'job-start' 'JobProgress' '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' 'MigrateStart' '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' 'VfilerCreate' 'VfilerSetup' 'aggregate-space'

Input Name	Type
DpJobProgressEventListIterStart	DpJobProgressEventListIterStart
Output Name	Type
DpJobProgressEventListIterStartResult	DpJobProgressEventListIterStartResult

Error Name	Description
EACCESSDENIED
EAPIERROR
EDATABASEERROR
EINVALIDJOBSTATE
EINVALIDJOBTYPE
EJOBDOESNOTEXIST

Purge all completed Jobs From the database. Purged Jobs are removed From the database, all information is lost.

Input Name	Type
DpJobPurge	DpJobPurge
Output Name	Type
DpJobPurgeResult	DpJobPurgeResult

Error Name	Description
EACCESSDENIED
EDATABASEERROR
EINVALIDINPUT
EJOBDOESNOTEXIST

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.

Input Name	Type
DpJobScheduleGetLastChanged	DpJobScheduleGetLastChanged
Output Name	Type
DpJobScheduleGetLastChangedResult	DpJobScheduleGetLastChangedResult

Error Name	Description
EINVALIDTAG

Ends iteration To list scheduled Jobs.

Input Name	Type
DpJobScheduleListIterEnd	DpJobScheduleListIterEnd
Output Name	Type
DpJobScheduleListIterEndResult	DpJobScheduleListIterEndResult

Error Name	Description
EINVALIDTAG

Get next few Records in the iteration started by DpJobScheduleListIterStart.

Input Name	Type
DpJobScheduleListIterNext	DpJobScheduleListIterNext
Output Name	Type
DpJobScheduleListIterNextResult	DpJobScheduleListIterNextResult

Error Name	Description
EINVALIDTAG

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	Type
DpJobScheduleListIterStart	DpJobScheduleListIterStart
Output Name	Type
DpJobScheduleListIterStartResult	DpJobScheduleListIterStartResult

Error Name	Description
EACCESSDENIED
EAPIERROR
EINVALIDINPUTERROR
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND

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.

Name	Type	Description
JobId	xsd:integer	Identifier of job To abort. Range: [1..2^31-1].

[none]

Ends iteration To list Jobs.

Name	Type	Description
Tag	xsd:string	Tag From a previous DpJobListIterStart.

[none]

Get next few Records in the iteration started by DpJobListIterStart.

Name	Type	Description
Maximum	xsd:integer	The Maximum number of entries To retrieve. Range: [1..2^31-1].
Tag	xsd:string	Tag From a previous DpJobListIterStart.

Name	Type	Description
Jobs	ArrayOfDpJobInfo	List of Jobs.
Records	xsd:integer	The number of Records actually returned. Range: [1..2^31-1].

Starts iteration To list Jobs. The Jobs that Match all the specified filters will be returned.

Name	Type	Description
JobContextObjNameOrId	xsd: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 ObjNameOrId or JobId is specified.
JobId	xsd:integer optional	Identifier of a job To list. If unspecified, all Jobs are listed. Range: [1..2^31-1].
JobState	DpJobState optional	State of the Jobs To list. If specified, only the Jobs which are in this state are listed.
JobType	DpJobType optional	If specified, only Jobs of specified Type are listed. This field is deprecated in favor of JobTypes. Only one of JobType or JobTypes can be specified.
JobTypes	ArrayOfJobType optional	List of job types. Only Jobs of these types are listed. Only one of JobType or JobTypes can be specified.
MaxJobs	xsd: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]
ObjectNameOrId	ObjNameOrId 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.
StartedTimestampFrom	DpTimestamp optional	If specified, Jobs started at or after the specified time are listed.
StartedTimestampTo	DpTimestamp optional	If specified, Jobs started at or before the specified time are listed.

Name	Type	Description
Records	xsd:integer	Number which tells you how many items have been saved for future retrieval with DpJobListIterNext. Range: [1..2^31-1].
Tag	xsd:string	Tag To be used in subsequent calls To DpJobListIterNext.

Ends iteration To list progress of job.

Name	Type	Description
Tag	xsd:string	Tag From a previous DpJobProgressEventListIterStart.

[none]

Get next few Records in the iteration started by DpJobProgressEventListIterStart.

Name	Type	Description
Maximum	xsd:integer	The Maximum number of entries To retrieve. Range: [1..2^31-1].
Tag	xsd:string	Tag From a previous DpJobProgressEventListIterStart.

Name	Type	Description
ProgressEvents	ArrayOfDpJobProgressEventInfo	List of job progress Events.
Records	xsd:integer	The number of Records actually returned. Range: [1..2^31-1].

Starts iteration To list job progress Events. The event could be one of the following Type. 'job-start' 'JobProgress' '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' 'MigrateStart' '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' 'VfilerCreate' 'VfilerSetup' 'aggregate-space'

Name	Type	Description
ConnectionId	xsd: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].
DatasetNameOrId	xsd:string optional	Identifier of the Dataset To list progress Events for. If not specified progress Events for all Jobs are returned. Only DatasetNameOrId or JobId may be supplied, but not both. This field is deprecated in favor of ObjectNameOrId.
EndTime	DpTimestamp optional	End Timestamp. Events after this time will not be returned. If not present, all Events up To the present are returned.
History	xsd: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 JobProgress 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.
JobId	xsd:integer optional	Identifier of the job To list progress Events for. Only DatasetNameOrId or JobId may be supplied, but not both. If neither is supplied, all progress Events are returned. Range: [1..2^31-1].
JobType	DpJobType 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 JobTypes.
JobTypes	ArrayOfJobType 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 JobType or JobTypes can be specified.
ObjectNameOrId	ObjNameOrId optional	Identifier of the object To list progress Events for. If not specified, progress Events for all Jobs are returned. Only ObjectNameOrId or JobId may be supplied, but not both. Only one of DatasetNameOrId or ObjectNameOrId can be specified.
StartTime	DpTimestamp optional	Start Timestamp. Events before this time will not be returned. If not present, all Events since the earliest event are returned.

Name	Type	Description
Records	xsd:integer	Number which tells you how many items have been saved for future retrieval with DpJobProgressEventListIterNext. Range: [1..2^31-1].
Tag	xsd:string	Tag To be used in subsequent calls To DpJobProgressEventListIterNext.

Purge all completed Jobs From the database. Purged Jobs are removed From the database, all information is lost.

Name	Type	Description
CompletedTimestamp	DpTimestamp optional	If specified, all Jobs successfully completed before this time are purged. This field must be specified when JobId is not specified.
JobId	xsd:integer optional	Identifier of job To purge. If specifed, only this job is purged. Range: [1..2^31-1].
PurgeJobsCompletedWithError	xsd:boolean optional	If specified, Jobs completed with Error are also purged. Otherwise, only successfully completed Jobs are purged.

[none]

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.

[none]

Name	Type	Description
LastChangedTimestamp	xsd:integer	Timestamp when job schedule last changed. Timestamp Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.

Ends iteration To list scheduled Jobs.

Name	Type	Description
Tag	xsd:string	Tag From a previous DpJobScheduleListIterStart.

[none]

Get next few Records in the iteration started by DpJobScheduleListIterStart.

Name	Type	Description
Maximum	xsd:integer	The Maximum number of entries To retrieve. Range: [0..2^31-1]
Tag	xsd:string	Tag From a previous DpJobScheduleListIterStart.

Name	Type	Description
Records	xsd:integer	The number of Records actually returned. Range: [0..2^31-1]
ScheduledJobs	ArrayOfDpScheduledJob	List of Jobs that need To be started by the scheduler. This list is sorted by increasing StartTime.

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.

Name	Type	Description
DatasetNameOrId	xsd:integer optional	If specified, list of Jobs is filtered by this Dataset. Range: [1..2^31-1]
FromTime	xsd: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.
ToTime	xsd:integer	Jobs To be started until this time (inclusive) will be listed. Must be equal To or greater than FromTime. Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.

Name	Type	Description
Records	xsd:integer	Number which tells you how many items have been saved for future retrieval with DpJobScheduleListIterNext. Range: [1..2^31-1]
Tag	xsd:string	Tag To be used in subsequent calls To DpJobScheduleListIterNext.

Name	Type	Description
DpJobInfo	DpJobInfo[]

Name	Type	Description
DpJobProgressEventInfo	DpJobProgressEventInfo[]

Name	Type	Description
DpScheduledJob	DpScheduledJob[]

Name	Type	Description
JobType	JobType[]

The state of the data protection/provisioning job. The possible Values are "queued", "running", "completed", "aborting", "aborted". This state is derived From CompletedTimestamp, AbortRequestedTimestamp and StartedTimestamp.

[none]

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]

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]

Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI Type string. An ObjNameOrId must contain between 1 and 64 characters, and must conform To one of the following formats: It must have the format of an ObjName, 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 ObjNameOrId 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 ObjNameOrId 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]

A job is used To run one or more Data Protection or provisioning operations.

Name	Type	Description
AbortRequestedTimestamp	DpTimestamp optional	Timestamp when Request was received To abort job. If unspecified, no such Request was received.
BytesTransferred	xsd:integer	Bytes transferred in this Operation. Zero when transfer starts. Range: [0..2^63-1]. It will be always zero for a provisioning job.
CompletedTimestamp	DpTimestamp optional	Timestamp when the job was completed. If unspecified, the job has not yet reached completion.
DatasetId	xsd: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 ObjectName and ObjectType. Range: [1..2^31-1].
DatasetName	xsd: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 ObjectName and ObjectType.
DestinationNodeId	xsd: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]
DestinationNodeName	xsd: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).
JobContextObjId	ObjId	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 JobContextObjType for valid types of job context Objects.
JobContextObjName	ObjFullName	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 JobContextObjType for valid types of job context Objects.
JobContextObjType	xsd:string	Type of the job context object. Possible Values are :- Aggregate Dataset Vfiler
JobDescription	xsd:string	Description of what job is trying To accomplish.
JobId	xsd:integer	Identifier of the job. Range: [1..2^31-1].
JobOverallStatus	DpJobOverallStatus	Overall Status of the job based on JobProgress and JobState.
JobProgress	DpJobProgress	The current progress of the data protection or provisioning job.
JobState	DpJobState	State of the job.
JobType	DpJobType	Type of data protection or provisioning job.
ObjectId	ObjId	Identifier of the object on which this job was carried out.
ObjectName	ObjFullName	Full Name of the object on which this job was carried out.
ObjectType	xsd:string	Type of the object on which this job was carried out. Possible Values: Dataset Vfiler Volume
PolicyId	xsd: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].
PolicyName	xsd: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.
ProvisionRequestInfo	ProvisionRequestInfo optional	Information of the provisioning Request. Present only if the JobType is one of 'provision_member', 'resize_member', 'delete_snapshots', 'destroy_member', 'dedupe_member' or 'undedupe_member'.
SourceNodeId	xsd:integer	Source Policy node Id associated with this job. Range: [1..2^31-1]
SourceNodeName	xsd:string	Source Policy node Name associated with this job.
StartedTimestamp	DpTimestamp optional	Timestamp when job was started. If unspecified, the job has not yet started running and is queued.
SubmittedBy	xsd: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.

One historical progress event for a data protection or provisioning job.

Name	Type	Description
DpProgressBackupInfo	DpProgressBackupInfo optional	Information about the creation or deletion of a backup Version.
DpProgressFailoverInfo	DpProgressFailoverInfo optional	Information about a failover job.
DpProgressJobAbortInfo	DpProgressJobAbortInfo optional	Information about the abort of a job.
DpProgressRelationshipInfo	DpProgressRelationshipInfo optional	Information about creation or destruction of a SnapVault or SnapMirror relationship.
DpProgressRestoreInfo	DpProgressRestoreInfo optional	Information about restore of a Path.
DpProgressSnapmirrorInfo	DpProgressSnapmirrorInfo 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.
DpProgressSnapshotInfo	DpProgressSnapshotInfo optional	Information about a newly created Snapshot.
DpProgressSnapvaultInfo	DpProgressSnapvaultInfo 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.
ErrorMessage	xsd:string optional	If present, a human readable Error message. If absent, there has been no Error.
EventId	xsd:integer	Unique ID of this progress event. Range: [1..2^31-1].
EventMessage	xsd:string	Human-readable message describing event.
EventStatus	ObjStatus	The Status of the progress event. Possible Values: 'normal', 'warning' and 'Error'
EventTimestamp	DpTimestamp	Time of event
EventType	xsd:string	Type of event. Values are: 'job-start' 'JobProgress' 'job-abort' (DpProgressJobAbortInfo) 'job-end' 'job-retry' 'rel-create-start' (DpProgressRelationshipInfo) 'rel-create-progress' (DpProgressRelationshipInfo) 'rel-create-end' (DpProgressRelationshipInfo) 'rel-destroy-start' (DpProgressRelationshipInfo) 'rel-destroy-progress' (DpProgressRelationshipInfo) 'rel-destroy-end' (DpProgressRelationshipInfo) 'snapshot-create' (DpProgressSnapshotInfo) 'snapshot-delete' (DpProgressSnapshotInfo) 'backup-create' (DpProgressBackupInfo) 'backup-delete' (DpProgressBackupInfo) 'snapvault-start' (DpProgressSnapvaultInfo) 'snapvault-progress' (DpProgressSnapvaultInfo) 'snapvault-end' (DpProgressSnapvaultInfo) 'snapmirror-start' (DpProgressSnapmirrorInfo) 'snapmirror-progress' (DpProgressSnapmirrorInfo) 'snapmirror-end' (DpProgressSnapmirrorInfo) 'restore-start' (DpProgressRestoreInfo) 'restore-progress' (DpProgressRestoreInfo) 'restore-end' (DpProgressRestoreInfo) 'MigrateStart' (DpProgressRestoreInfo) 'migrate-progress' (DpProgressRestoreInfo) 'migrate-end' (DpProgressRestoreInfo) 'mirror-break-script-start' (DpProgressFailoverInfo) 'mirror-break-script-end' (DpProgressFailoverInfo) 'mirror-break-quiesce-start' (DpProgressFailoverInfo) 'mirror-break-quiesce-end' (DpProgressFailoverInfo) 'mirror-break-start' (DpProgressFailoverInfo) 'mirror-break-end' (DpProgressFailoverInfo) 'volume-create' (ProgressVolumeInfo) 'volume-option-set' (ProgressVolumeOptionInfo) 'snapshot-reserve-resize' (ProgressVolumeInfo) 'volume-autosize' (ProgressVolumeInfo) 'snapshot-autodelete' (ProgressVolumeInfo) 'lun-create' (ProgressLunInfo) 'lun-destroy' (ProgressLunInfo) 'lun-map' (ProgressLunMapInfo) 'lun-unmap' (ProgressLunMapInfo) 'igroup-create' (ProgressIgroupInfo) 'igroup-destroy' (ProgressIgroupInfo) 'igroup-add' (ProgressIgroupConfigInfo) 'igroup-remove' (ProgressIgroupConfigInfo) 'qtree-create' (ProgressQtreeInfo) 'quota-set' (ProgressQuotaInfo) 'nfsexport-create' (ProgressNfsexportInfo) 'cifs-share-create' (ProgressCifsShareInfo) 'cifs-share-modify' (ProgressCifsShareInfo) 'cifs-share-delete' (ProgressCifsShareInfo) 'volume-offline' (ProgressVolumeInfo) 'volume-destroy' (ProgressVolumeInfo) 'qtree-destroy' (ProgressQtreeInfo) 'vfiler-storage-add' (ProgressVfilerStorageInfo) 'script-run' (ProgressScriptRunInfo) 'VfilerCreate' (ProgressVfilerInfo) 'VfilerSetup' (ProgressVfilerInfo) 'volume-dedupe' (ProgressVolumeDedupeInfo) 'volume-dedupe-enable' (ProgressVolumeDedupeInfo) 'volume-dedupe-disable' (ProgressVolumeDedupeInfo) 'volume-dedupe-schedule-set' (ProgressVolumeDedupeInfo) 'aggregate-space' (ProgressAggregateInfo) 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.
JobId	xsd:integer	The ID of the job that generated this event. Range: [1..2^31-1].
JobType	DpJobType	Type of data protection or provisioning job.
ProgressAggregateInfo	ProgressAggregateInfo optional	Information about Aggregate.
ProgressCifsShareInfo	ProgressCifsShareInfo optional	CIFS share information.
ProgressIgroupConfigInfo	ProgressIgroupConfigInfo optional	Information about the Initiators added or removed From an initiator Group.
ProgressIgroupInfo	ProgressIgroupInfo optional	Information about the initiator Group on which the mapping Operation is executed.
ProgressLunInfo	ProgressLunInfo optional	Information about the Lun being provisioned.
ProgressLunMapInfo	ProgressLunMapInfo optional	Information about the Lun on which the mapping Operation is executed.
ProgressNfsexportInfo	ProgressNfsexportInfo optional	NFS export information.
ProgressQtreeInfo	ProgressQtreeInfo optional	Information about the Qtree provisioned.
ProgressQuotaInfo	ProgressQuotaInfo optional	Information about the quota being modified/set.
ProgressScriptRunInfo	ProgressScriptRunInfo optional	Information about the script which is run.
ProgressVfilerInfo	ProgressVfilerInfo optional	Information about the Vfiler which is being created.
ProgressVfilerStorageInfo	ProgressVfilerStorageInfo optional	Information about the Vfiler on which storage is added or removed.
ProgressVolumeDedupeInfo	ProgressVolumeDedupeInfo optional	Information about dedupe Operation on the Volume.
ProgressVolumeInfo	ProgressVolumeInfo optional	Information about the Volume on which the provisioning Operation is executed.
ProgressVolumeOptionInfo	ProgressVolumeOptionInfo optional	Information about the Name and Value of various Volume Options.

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	Type	Description
DatasetId	xsd:integer	Id of the Dataset being protected by the job. Range: [1..2^31-1]
DpLocalSnapshotJobData	DpLocalSnapshotJobData optional	Data for local-snapshot job.
DpSnapmirrorTransferJobData	DpSnapmirrorTransferJobData optional	Data for snapmirror-transfer job.
DpSnapvaultTransferJobData	DpSnapvaultTransferJobData optional	Data for snapvault-transfer job.
StartTime	xsd: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.

Job Type.

[none]

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 DpJobState and DpJobProgress. The current mappings are as follow: DpJobState DpJobProgress DpJobOverallStatus ===================================================== 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]

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]

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	Type	Description
IsConfirmationData	xsd:boolean optional	If the element: "IsConfirmationData" 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.
NodeId	xsd:integer	Id of the node that needs local Snapshot. Range: [1..2^31-1]
RetentionType	DpBackupRetentionType	Retention To be used for the local Snapshot.

Information about the creation or deletion of a backup Version.

Name	Type	Description
BackupId	xsd:integer	ID of the new backup Instance. Each copy of a backup Version gets a unique backup ID. Range: [1..2^31-1]
BackupVersion	DpTimestamp	Time at which backup image was created. All Backups with the same BackupVersion are copies of the same point-in-time image of the original data.
Retention	DpBackupRetentionType	Retention Type of backup.

Information about a failover job.

Name	Type	Description
DestinationPath	xsd: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'.
EnvironmentVariableList	ArrayOfEnvironmentVariableInfo 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'.
RelationshipId	ObjId 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'.
ScriptExitStatus	xsd:int optional	Exit code of the script. This element is present only for event Type 'mirror-break-script-end'. Range: [-2^31..2^31-1]
ScriptPath	xsd:string optional	Path of the failover script. This element is present only for event Type 'mirror-break-script-start' and 'mirror-break-script-end'.
ScriptRunAs	xsd: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'.
ScriptSummary	xsd:string optional	Detailed output From the failover script. This element is present only for event Type 'mirror-break-script-end'.

Information about the abort of a job.

Name	Type	Description
AbortedBy	xsd:string	User who aborted the job.

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

Name	Type	Description
BytesTransferred	xsd:integer	Bytes transferred as a Result of creating a relationship. Zero when for relationship Destroy messages. Range: [0..2^63-1].
DestinationVolumeOrQtreeId	xsd:integer	Numeric ID of destination Volume or Qtree. Range: [1..2^31-1]
DestinationVolumeOrQtreeName	xsd:string	Name of the destination Volume or Qtree. The format is ://.
RelationshipType	xsd:string	Type of relationship being created or destroyed. Legal Values are "snapvault" or "snapmirror".
SourceVolumeOrQtreeId	xsd:integer	Numeric ID of the Source Volume or Qtree. Range: [1..2^31-1]
SourceVolumeOrQtreeName	xsd:string	Numeric ID of the Source Volume or Qtree. The format is ://.

Information about restore of a Path.

Name	Type	Description
BackupId	xsd:integer	ID of the backup Instance used for restore. Range: [1..2^31-1]
BackupVersion	DpTimestamp	The backup Version used for restore.
BytesTransferred	xsd:integer optional	Bytes transferred in this Operation. Zero when transfer starts. Range: [0..2^63-1].
DestinationPath	xsd:string optional	The full Path To restore the Dataset member To. The format is :/
MemberId	xsd:integer	The ID of the Dataset member To be restored. Range: [1..2^31-1]
MemberName	xsd:string	The full Name of the Dataset member To be restored.
Path	xsd:string	Path To be restored.

Information about the start and end of a SnapMirror transfer.

Name	Type	Description
BytesTransferred	xsd:integer	Bytes transferred in this Operation. Zero when transfer starts. Range: [0..2^63-1].
DestinationVolumeOrQtreeId	xsd:integer	Numeric ID of destination Volume or Qtree of the mirror. Range: [1..2^31-1]
DestinationVolumeOrQtreeName	xsd:string	Full Name of destination Volume or Qtree of the mirror. The format is :/.
SourceVolumeOrQtreeId	xsd:integer	Numeric ID of Volume or Qtree being mirrored. Range: [1..2^31-1]
SourceVolumeOrQtreeName	xsd:string	Name of Volume or Qtree being mirrored. The format is :/.

Information about the creation or deletion of a Snapshot.

Name	Type	Description
SnapshotName	xsd:string	Name of Snapshot
VolumeId	xsd:integer	Numeric ID of Volume getting Snapshot. Range: [1..2^31-1]
VolumeName	xsd:string	Full Name of the Volume object getting the Snapshot. The format is :/

Information about the start and end of a SnapVault transfer.

Name	Type	Description
BytesTransferred	xsd:integer	Bytes transferred in this Operation. Zero when transfer starts. Range: [0..2^63-1].
DestinationQtreeId	xsd:integer	Numeric ID of Qtree receiving back up. Range: [1..2^31-1]
DestinationQtreeName	xsd:string	Name of Qtree receiving backed up. The format is ://.
SourceQtreeId	xsd:integer	Numeric ID of Qtree being backed up. Range: [1..2^31-1]
SourceQtreeName	xsd:string	Name of Qtree being backed up. The format is ://

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	Type	Description
ConnectionId	xsd:integer	Id of the Policy connection that needs SnapMirror transfer. Range: [1..2^31-1]
RetentionType	DpBackupRetentionType	Retention To be used for the pre/post backup script in the snapmirror-transfer job only.

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	Type	Description
ConnectionId	xsd:integer	Id of the Policy connection that needs SnapVault transfer. Range: [1..2^31-1]
RetentionType	DpBackupRetentionType	Retention To be used for the backup created by snapvault-transfer job.

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 ObjName, 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 ObjName and ObjFullName are identical.

[none]

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 ObjId 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 ObjId 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]

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]

Information about the Aggregate

Name	Type	Description
AggregateId	ObjId	Database identifier of the Aggregate
AggregateName	ObjFullName	Full Name of the Aggregate

Information about the CIFS share created as part of provisioning Operation.

Name	Type	Description
CifsAclList	ArrayOfCifsAcl optional	CIFS access control list set on the CIFS share.
CifsShareName	xsd:string	Name of the CIFS share.
VolOrQtreeId	ObjId	Database identifier of the Volume or Qtree for which the CIFS share is created.
VolOrQtreeName	ObjFullName	Full Name of the Volume or Qtree for which the CIFS share is created.

Information about Initiators being added or removed to/from an initiator Group of a job.

Name	Type	Description
IgroupId	ObjId	Database identifier of the initiator Group To which Initiators are added or destroyed in a provisioning job.
IgroupName	ObjFullName	Full Name of the initiator Group To which Initiators are added or destroyed in a provisioning job.
Initiators	xsd:string	Comma separated list of Initiators that are added or removed in this provisioning job.

Information about the initiator Group of a job.

Name	Type	Description
IgroupId	ObjId	Database identifier of the initiator Group which is created or destroyed in the provisioning job.
IgroupName	ObjFullName	Full Name of the initiator Group which is created or destroyed in the provisioning job.

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

Name	Type	Description
LunName	ObjFullName	Full Name of the LUN that is provisioned or destroyed
LunPathId	ObjId	Database identifier of the LUN.

Information about the mapping of a LUN.

Name	Type	Description
IgroupId	ObjId	Database identifier of the initiator Group To which the LUN is mapped.
IgroupName	ObjFullName	Full Name of the initiator Group To which the LUN is mapped.
LunName	ObjFullName	Full Name of the LUN that is mapped.
LunPathId	ObjId	Database identifier of the LUN that is mapped.

Information about the NFS export created as part of provisioning Operation.

Name	Type	Description
Path	xsd:string	Name of the NFS export by which it can be accessed.
QtreeId	ObjId	Database identifier of the Qtree for which the NFS export is created.
QtreeName	ObjFullName	Full Name of the Qtree for which the NFS export is created.

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

Name	Type	Description
QtreeId	ObjId	Database identifier of the Qtree provisioned or destroyed.
QtreeName	ObjFullName	Full Name of the Qtree provisioned or destroyed.
VolumeId	ObjId	Database identifier of the Volume To which the Qtree belongs To.
VolumeName	ObjFullName	Full Name of the Volume To which the Qtree belongs To.

Information about the quota of a Qtree.

Name	Type	Description
DefaultGroupQuota	xsd:integer optional	Default Group quota Value set in bytes. Range: [1..2^63-1].
DefaultUserQuota	xsd:integer optional	Default user quota Value set in bytes. Range: [1..2^63-1].
QtreeId	ObjId	Database identifier of the Qtree on which the quotas are set.
QtreeName	ObjFullName	Full Name of the Qtree on which the quotas are set.
TreeQuota	xsd:integer optional	Tree quota Value set in bytes. Range: [1..2^63-1].

Information about the post provisioning script which is run.

Name	Type	Description
ScriptName	xsd:string	Name of the script with its absolute Path.

Information about creating a Vfiler

Name	Type	Description
FilerId	ObjId	Database identifier of the storage system.
FilerName	ObjFullName	Full Name of the storage system on which the Vfiler is being created.
Ipaddress	xsd:string	IP Address of the Vfiler
Ipspace	xsd:string	IPspace of the Vfiler
VfilerId	ObjId optional	Database identifier of the vFiler Unit
VfilerName	ObjFullName	Full Name of the vFiler Unit which is created

Information about adding storage To a vFiler.

Name	Type	Description
VfilerId	ObjId	Database identifier of the vFiler To which storage is added.
VfilerName	ObjFullName	Full Name of the vFiler To which storage is added.
VolumeId	ObjId	Database identifier of the Volume which is added To the vFiler.
VolumeName	ObjFullName	Full Name of the Volume which is added To the vFiler.

Information about the deduplication Operation on the Volume.

Name	Type	Description
DedupeProgress	xsd: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".
DedupeSchedule	xsd:string optional	Specifies the deduplication schedule set on the Volume.
DedupeStatus	xsd:string optional	Deduplication Operation Status of the Volume. Possible Values: "idle", "active", "pending", or "undoing".
VolumeId	ObjId	Database identifier of the Volume on which the deduplication is run.
VolumeName	ObjFullName	Full Name of the Volume on which the deduplication Operation is run.

Information about the Volume of on which a provisioning Operation is executed.

Name	Type	Description
VolumeId	ObjId	Database identifier of the Volume on which the provisioning Operation is executed.
VolumeName	ObjFullName	Full Name of the Volume on which the provisioning Operation is executed.

Information about the Volume Options set.

Name	Type	Description
VolumeId	ObjId	Database identifier of the Volume on which the provisioning Operation is executed.
VolumeName	ObjFullName	Full Name of the Volume on which the provisioning Operation is executed.
VolumeOptions	ArrayOfVolumeOption	A list of of Volume Options and its Values.

Information of a single provisioning Request

Name	Type	Description
DedupeMemberRequestInfo	DedupeMemberRequestInfo optional	Information specific To the 'dedupe_member' Request. Returned only when JobType is 'dedupe_member'.
DeleteSnapshotsRequestInfo	DeleteSnapshotsRequestInfo optional	Information specific To the Snapshot deletion Request. Returned only when the JobType is 'delete_snapshots'.
DestroyMemberRequestInfo	DestroyMemberRequestInfo optional	Information specific To the 'destroy_member' Request. Returned only when JobType is 'destroy_member'.
ProvisionMemberRequestInfo	ProvisionMemberRequestInfo optional	Information specific To the 'provision_member' Request. Returned only when JobType is 'provision_member'.
ResizeMemberRequestInfo	ResizeMemberRequestInfo optional	Information specific To the resize related provisioning Request. Returned only when JobType is 'resize_member'.
UndedupeMemberRequestInfo	UndedupeMemberRequestInfo optional	Information specific To the 'undedupe_member' Request. Returned only when JobType is 'undedupe_member'.

Name	Type	Description
CifsAcl	CifsAcl[]

Name	Type	Description
EnvironmentVariableInfo	EnvironmentVariableInfo[]

Name	Type	Description
VolumeOption	VolumeOption[]

Details of the dedupe member Request.

Name	Type	Description
FullVolumeDedupe	xsd:boolean optional	If true, full Volume dedupe scan is performed. Otherwise only new data since last deduplication Operation is scanned. Default Value is false.
VolumeId	ObjId optional	Identifier of a Volume member of a Dataset.
VolumeName	ObjName optional	Name of a Volume member of the Dataset. Either VolumeId or VolumeName has To be specified. If VolumeId is specified then VolumeName is ignored.

Details on which Snapshot copies are To be deleted.

Name	Type	Description
Snapshots	ArrayOfSnapshot	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.
VolumeId	ObjId 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.
VolumeName	ObjName 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 VolumeId or VolumeName has To be specified. If VolumeId is specified then VolumeName is ignored.

Details specific To the 'destroy_member' Request.

Name	Type	Description
MemberId	ObjId	This is the Id of the Dataset member on which the Action was performed.
MemberName	ObjFullName	This is the full Name of the Dataset member on which the Action is performed.
MemberType	xsd:string	Type of the Dataset member on which the Action was or is To be performed. Possible Values are 'Volume', 'Qtree' and 'Lun'.

Retention Type To which the backup should be archived. Possible Values are: 'hourly', 'daily', 'weekly', 'monthly' and 'unlimited'.

[none]

Details specific To the 'provision_member' Request.

Name	Type	Description
Comments	ArrayOfProvisionMemberComment optional	Comment Values To assign To the newly provisioned storage object.
CreateNewVfiler	xsd: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 ResourcepoolMemberListInfoIterStart zapi and RunProvisioningChecks is specified as 'true'. This input is ignored in DatasetProvisionMember and StorageServiceDatasetProvision zapi. The default Value is 'false'.
DatasetExportInfo	DatasetExportInfo 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	xsd:string optional	Description of the provisioning Request. The Length of this string cannot be more than 255 characters.
InitialSnapshotSpace	xsd: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]
MaximumDataSize	xsd:integer 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]
MaximumSnapshotSpace	xsd: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	xsd: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.
OnlineMigration	xsd: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 ResourcepoolMemberListInfoIterStart API and RunProvisioningChecks is specified as true and either CreateNewVfiler is true or VfilerNameOrId is specified. This input is ignored in StorageServiceDatasetProvision and DatasetProvisionMember APIs.
ProvisioningPolicyId	ObjId optional	Name or identifier of the provisioning Policy used with this Request. Ignored for DatasetProvisionMember and StorageServiceDatasetProvision and is used only when listing provisioning requests and Jobs.
ProvisioningPolicyName	ObjFullName optional	Name of the provisioning Policy used with this Request. Present only if the Request Type is 'provision_member'. Ignored for DatasetProvisionMember and StorageServiceDatasetProvision and is used only when listing provisioning requests and Jobs.
ResourceNameOrId	ObjNameOrId 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	xsd:integer	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]
VfilerNameOrId	ObjNameOrId 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 StorageServiceDatasetProvision.

Details of the resize Request.

Name	Type	Description
MaximumCapacity	xsd: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 MemberId or MemberName refers To a flexible Volume. Range: [1..2^63-1]
MemberId	ObjId 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.
MemberName	ObjName 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 MemberId or MemberName has To be specified. If MemberId is specified then MemberName is ignored.
NewSize	xsd: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]
SnapReserve	xsd: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 MemberId or MemberName refers To a flexible Volume. Range: [0..100]

Details of the undedupe member Request.

Name	Type	Description
VolumeId	ObjId optional	Identifier of a Volume member of a Dataset.
VolumeName	ObjName optional	Name of a Volume member of the Dataset. Either VolumeId or VolumeName has To be specified. If VolumeId is specified then VolumeName is ignored.

Name	Type	Description
ProvisionMemberComment	ProvisionMemberComment[]

Name	Type	Description
Snapshot	Snapshot[]

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

Name	Type	Description
AccessRights	xsd:string	Access right of the user accessing the CIFS share. Possible Values are 'no_access', 'read', 'change' and 'full_control'
UserName	xsd: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.

Specifies the NAS or SAN export settings for a Dataset node.

Name	Type	Description
DatasetCifsExportSetting	DatasetCifsExportSetting optional	The CIFS export settings for storage exported over CIFS. This field may be present only if the DatasetExportProtocol is 'cifs' or 'mixed'.
DatasetExportProtocol	DatasetExportProtocol 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 DatasetNfsExportSetting and DatasetCifsSharePermissions, should be specified in a modify Operation, and will be returned in the iterator output.
DatasetLunMappingInfo	DatasetLunMappingInfo 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 DatasetExportProtocol is 'fcp' or 'iscsi'.
DatasetNfsExportSetting	DatasetNfsExportSetting optional	The NFS export settings for storage exported over NFS. This field may be present only if the DatasetExportProtocol is 'nfs' or 'mixed'.

Information about an environment variable.

Name	Type	Description
Name	xsd:string	Environment variable Name.
Value	xsd:string	Value of an environment variable.

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 ObjName 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 ObjFullName 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 ObjName 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 ObjName 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]

Information about Option and its Value.

Name	Type	Description
OptionName	xsd:string	Name of a Volume Option as defined in ONTAP.
OptionValue	xsd:string	Value of the Volume Option as allowed in ONTAP.

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	Type	Description
CifsDomain	xsd: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.
DatasetCifsSharePermissions	ArrayOfDatasetCifsSharePermission optional	Specifies the permissions granted To users on storage provisioned in this Dataset node. This field may be present only if the DatasetExportProtocol is 'cifs' or 'mixed'.

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]

Specifies the Hosts and/or Initiators To which LUNs in this Dataset node will be mapped, and the igroup OS Type.

Name	Type	Description
IgroupOsType	xsd: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.
LunMappingInitiators	ArrayOfLunMappingInitiator	Specifies the Initiators To map LUNs in the Dataset node To, and, optionally, the Host To which they belong.

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	Type	Description
AnonymousAccessUser	xsd:integer 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.
DisableSetuid	xsd:boolean optional	If true, causes the server file system To ignore attempts To enable the setuid or setgid mode bits. Default Value is true.
IsReadonlyForAllHosts	xsd: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, IsReadwriteForAllHosts must be false.
IsReadwriteForAllHosts	xsd: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, IsReadonlyForAllHosts must be false.
NfsExportRoHosts	ArrayOfNfsExportHost optional	A list of Hosts with read-only permissions on exports in this Dataset node. If a non empty list of NfsExportRoHosts is present along with IsReadonlyForAllHosts as true, then ZAPI will throw an Error.
NfsExportRootHosts	ArrayOfNfsExportHost optional	A list of Hosts with the root user having read-only or read-write permissions on exports in this Dataset node.
NfsExportRwHosts	ArrayOfNfsExportHost optional	A list of Hosts with read-write permissions on exports in this Dataset node. If a non empty list of NfsExportRwHosts is present along with IsReadwriteForAllHosts as true, then ZAPI will throw an Error.
NfsProtocolVersion	xsd: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.
NfsSecurityFlavors	ArrayOfNfsSecurityFlavor 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.

One comment field To fill in as part of the Request

Name	Type	Description
CommentFieldNameOrId	CommentFieldNameOrId	Name or identifier of the comment field.
CommentValue	CommentValue	Value of the comment field. An empty string can be used To unset the Value of the comment field for this object.

Information of one Snapshot copy. Either UniqueId or Name of the Snapshot copy should be specified.

Name	Type	Description
SnapshotName	xsd:string optional	Name of the Snapshot copy. If UniqueId is specified, then this element is ignored.
UniqueId	xsd:string optional	Unique identifier of the Snapshot copy. Currently, this is the Snapshot copy's creation time.

Name	Type	Description
DatasetCifsSharePermission	DatasetCifsSharePermission[]

Name	Type	Description
LunMappingInitiator	LunMappingInitiator[]

Name	Type	Description
NfsExportHost	NfsExportHost[]

Name	Type	Description
NfsSecurityFlavor	NfsSecurityFlavor[]

Name or identifier of the comment field. It must conform To one of the following formats: It must be of the format of CommentFieldName It must be of the format of CommentFieldId

[none]

Value of the specified comment field To be set on the object. This can be of Maximum 1024 characters.

[none]

A single Permission granted To a user on CIFS shares within a Dataset node.

Name	Type	Description
CifsUsername	xsd: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	CifsPermission	Specifies the permissions granted To a user.

Specifies an initiator To map LUNs in the Dataset node To, and, optionally, the Host To which it belongs.

Name	Type	Description
Hostname	xsd:string optional	Specifies the Name of the Host which owns the initiator.
InitiatorId	InitiatorId	Specifies an initiator Id on a Host To which a LUN should be mapped.

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	Type	Description
Hostname	xsd: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.
IsAnException	xsd: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.

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]

Permission granted To a CIFS user on a share. Possible Values are 'no_access', 'read', 'change' and 'full_control'

[none]

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]