Input Name	Range	Type	Description
tag		string	An internal opaque handle used by the DFM station

Errno	Description
EINVALIDTAG

For more documentation please check aggregate-list-info-iter-start. The aggregate-list-info-iter-next API is used to iterate over the members of the aggregates stored in the temporary store created by the aggregate-list-info-iter-start API.

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 aggregate-list-info-iter-start. It's an opaque handle used by the DFM station to identify the temporary store created by aggregate-list-info-iter-start.
Output Name	Range	Type	Description
aggregates		aggregate-info[]	List of aggregates.
records		integer	The number of records actually returned. Range: [1..2^31-1]

Errno	Description
EINVALIDINPUTERROR
EINVALIDTAG

The aggregate-list-info-iter-* set of APIs are used to retrieve the list of aggregates in DFM. The aggregate-list-info-iter-start API is used to load the list of aggregates into a temporary store. The API returns a tag that identifies that temporary store so that subsequent APIs can be used to iterate over the aggregates in the temporary store. If aggregate-list-info-iter-start is invoked twice, then two distinct temporary stores are created. If neither aggregate-name-or-id or aggr-group-name-or-id are provided, all aggregates will be listed. If either, but not both are provided, the aggregate or all aggregates in the group will be listed respectively. If aggregate-name-or-id and aggr-group-name-or-id are provided, the aggregate will be listed only if it is under the specified group.

Input Name	Range	Type	Description
aggregate-type		string optional	Filter by type of aggregate. Possible values are: traditional aggregate striped If no aggregate-type input is supplied, all types of aggregates will be listed.
block-type		file-system-block-type optional	Filter by file system block type of the aggregate. If no block-type input is supplied, all types of aggregates will be listed.
include-dataset-space-info		boolean optional	If true, a list of datasets that consume space from this aggregate and the actual space consumed is returned in datasets-space-info. Default value: false.
include-is-available		boolean optional	If true, the is-available status is calculated for each aggregate which may make the call to this zapi take much longer. Default is false.
is-direct-member-only		boolean optional	If true, only return the aggregates that are direct members of the specified resource group. Default value is false. This field is meaningful only if a resource group name or id is given for the object-name-or-id field.
is-dp-ignored		boolean optional	If true, only list aggregates that have been set to be ignored for purposes of data protection. If false, only list aggregates that have not been set to be ignored for purposes of data protection. If not specified, list all aggregates without taking into account whether they have been ignored or not.
is-in-dataset		boolean optional	If true, only list aggregates which only contain data which is protected by a dataset. If false, only list aggregates containing data which is not protected by a dataset. If not specified, list all aggregates whether they are in a dataset or not.
is-unprotected		boolean optional	If true, only list aggregates that are not protected, which means the aggregate is: 1. not in any resource pool. 2. not a child of a host that is a member of any resource pool. and 3. not a member of a node in a dataset with protection policy assigned. If false or not set, list all aggregates.
object-management-filter		object-management-interface optional	Filter the object based on the Data ONTAP interface that provides complete management for the object i.e. ONTAP CLIs, SNMP, ONTAPI etc. If no filter is supplied, all objects will be considered.
object-name-or-id		string optional	Name or identifier of an object to list aggregates for. The allowed object types for this argument are: Resource Group Resource Pool Dataset Storage Set Host Aggregate Volume Qtree GenericAppObject If object-name-or-id identifies an aggregate, that single aggregate will be returned. If object-name-or-id resolves to more than one aggregate, all of them will be returned. If no object-name-or-id is provided, all aggregates will be listed.
rbac-operation		string optional	Name of an RBAC operation. If specified, only return aggregates for which authenticated admin has the required capability. A capability is an operation/resource pair. The resource is the volume where the aggregate lives. The possible values that can be specified for operation can be obtained by calling rbac-operation-info-list. If operation is not specified, then it defaults to DFM.Database.Read. For more information about operations, capabilities and user roles, see the RBAC APIs.
resourcepool-filter		string optional	Possible Value: 'in_rpool', 'not_in_rpool', 'all'. If set to 'in_rpool', only list aggregates that are in a resource pool. If set to 'not_in_rpool', only list aggregates that are not in a resource pool. If set to 'all', then list all aggregates. If a value is not specified, then 'all' will be the default. An aggregate is said to be in a resource pool if either the aggregate or the storage system containing the aggregate is a member of a resource pool.
volumes-to-migrate		object-name-or-id[] optional	This is a filter to return a list of candidate destination aggregates where the volumes in volumes-to-migrate can be migrated to. An ordered list of candidate aggregates are returned based on free space. Each object-name-or-id in volumes-to-migrate input should be the identifier or full name of a volume and they should all belong to the same source aggregate. Returning the list of candidate aggregates for migration can potentially take some time to compute.
Output Name	Range	Type	Description
records		integer	Number which tells you how many items have been saved for future retrieval with aggregate-list-info-iter-next. Range: [1..2^31-1]
tag		string	Tag to be used in subsequent calls to aggregate-list-info-iter-next. It is an opaque handle used by the DFM station to identify a temporary store.

Errno	Description
EINTERNALERROR
EAPIERROR
EACCESSDENIED
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EDATABASEERROR
EINVALIDINPUTERROR

Modify an aggregate's information. If modifying of one property fails, nothing will be changed. Error Conditions: EACCESSDENIED - When the user does not have DFM.Database.Write capability on the specified aggregate. EINVALIDINPUT - When invalid input specified. EOBJECTNOTFOUND - When the aggregate-name-or-id does not correspond to an aggregate. EDATABASEERROR - On database error.

Input Name	Range	Type	Description
aggregate-name-or-id		string	Name or identifier of the aggregate to modify.
is-dp-ignored		boolean optional	True if an administrator has chosen to ignore this object for purposes of data protection.

Errno	Description
EACCESSDENIED
EINVALIDINPUT
EDATABASEERROR
EOBJECTNOTFOUND

Add a space management operation as part of this space management session. The actual operation is not carried out unless aggregate-space-management-commit is called. If this operation cannot be carried out, then ESPACEMGMTCONFLICTOP will be returned The following rules apply when adding an operation to the session. A session cannot have 2 operations of same type for a give volume. For example two volume resize operations cannot be added for the same volume to a session. If this check fails the api will return ESPACEMGMTCONFLICTOP error. If a volume migration operation is added to a session then other session management operations cannot be added to the session. Similarly a volume migration cannot be added to a session if other type of operation is already added to session. If this check fails the api will return ESPACEMGMTCONFLICTOP error. If this operation leads to errors in dry-run-results that are returned, then this operation is not added to the session.

Input Name	Range	Type	Description
space-management-operation-info		space-management-operation-info	Details of a space management operation to be added to the session.
space-management-session-id		integer	Identifier of the space management session on an aggregate to which this space management operation has to be added. Range: [1..2^31-1]
Output Name	Range	Type	Description
aggregate-diff-space-infos		aggregate-space-info[]	Returns the difference in aggregate space consumption (i.e used space and committed space) due to this space management operation only on the session aggregate as well as other aggregates affected by this operation (for example volume migration affects both session aggregate and destination aggregate.) The values returned in aggregate-space-info can be positive or negetive depending on whether the operation consumes or frees up space on the aggregates. For example volume migration frees up space on the source aggregate and consumes space on the destination aggregate.
dry-run-results		dry-run-result[] optional	Results of a dry run. Each result describes one action the system would take and the predicted effects of that action.

Errno	Description
ESPACEMGMTSESSIONNOTFOUND
ESPACEMGMTCONFLICTOP
EDATABASEERROR
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EACCESSDENIED
EINVALIDOBJECTTYPE
EINVALIDINPUT

Open a space management session to run space management operations on an aggregate. This allows adding a set of space management operations in a session, getting the difference in space consumption due to these set of operations and then committing all the operations. A space management session must be started before invoking the following ZAPIs: aggregate-space-management-add-operation aggregate-space-management-remove-operation aggregate-space-management-commit aggregate-space-management-rollback Use aggregate-space-management-commit to commit the changes and to start jobs which will carry out the space management operations. Use aggregate-space-management-rollback to rollback the session. This will not submit any jobs for space management operations. After 24 hours, a session can be opened on the same aggregate by another client without the force option. This will cause any space management operations that were part of the session to be discarded.

Input Name	Range	Type	Description
aggregate-name-or-id		obj-name-or-id	Name or identifier of the aggregate on which to open the space management session.
force		boolean optional	By default, force is false. If true, and a space management session is already in progress on the specified aggregate the previous space management session is rolled back and a new edit session is begun.
Output Name	Range	Type	Description
space-management-session-id		integer	Identifier of the space management session. Range: [1..2^31-1]

Errno	Description
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EACCESSDENIED
EDATABASEERROR
ESPACEMGMTSESSIONINPROGRESS
EINVALIDINPUT

Commit the space management operations added as part of this space management session. The session that was opened on the aggregate will be released once all the space management jobs that were part of the session are queued to be executed eventually. This will not wait for the jobs to be executed. Use the dry-run option to test the commit. It returns a set of dry-run results for each space management operation that was added as part of this session. dry-run-results is a set of steps that the server will take to carry out the space management operation When dry-run is true, it also returns the projected used and committed space of the aggregate on which the space management session was opened and other dependent aggregates in case of migration operations. If dry-run is false, then before the call returns, the system submits jobs to the provisioning engine to execute.

Input Name	Range	Type	Description
dry-run		boolean optional	If true, return the dry-run-results list for each space management operation and aggregate-space-infos which gives the projected used and committed space of the aggregate(s) as a result of space management operations added to the session. The dry-run-results list contains actions that would be taken should the changes be committed without actually committing the changes. The session is not released after a dry run. By default, dry-run is false.
space-management-session-id		integer	Identifier of the space management session on an aggregate Range: [1..2^31-1]
Output Name	Range	Type	Description
aggregate-space-infos		aggregate-space-info[] optional	Returns overall effect of space management operations added to the session on the used and committed space of all affected aggregates (i.e aggregate on which the space management session is started and the aggregates affected by space management operations added to the session. For example migration effects two aggregates, session aggregate and destination aggregate). The space effect is calculated by obtaining the space freed or consumed by each operation and by adding or subtracting it from the current used and committed space of the aggregate. Returned only if dry-run is true.
space-management-results		space-management-result-info[]	Results of a commit operation for each space management operation that was added in this session.

Errno	Description
EACCESSDENIED
EDATABASEERROR
ESPACEMGMTSESSIONNOTFOUND

Remove a space management operation that was added as part of this space management session.

Input Name	Range	Type	Description
object-name-or-id		obj-name-or-id	Object whose space management operation has to be removed from this session.
space-management-op-type		space-management-op-type	Type of space management operation to be removed for the object from this session.
space-management-session-id		integer	Identifier of the space management session on an aggregate from which this space management operation has to be removed. Range: [1..2^31-1]
Output Name	Range	Type	Description
aggregate-diff-space-infos		aggregate-space-info[]	Returns difference in aggregate space consumption (i.e used space and committed space) caused by removing this space magagement operation from the session. The values returned here are same as the values returned by aggregate-space-management-add-operation zapi (called when adding this operation to the session) but with the signs reversed.

Errno	Description
ESPACEMGMTSESSIONNOTFOUND
ESPCMGMTNOSUCHOP
EDATABASEERROR
EACCESSDENIED
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EINVALIDINPUT

Release the session opened for space management on an aggregate. All the space management operations that were submitted as part of the space management session would be discarded.

Input Name	Range	Type	Description
space-management-session-id		integer	Identifier of the space management session on an aggregate to be rolled back. Range: [1..2^31-1]

Errno	Description
ESPACEMGMTSESSIONNOTFOUND
EACCESSDENIED

Information about a aggregate.

Name	Range	Type	Description
aggregate-full-threshold		integer	The value (as an integer percentage) of the fullness threshold used to generate an "aggregate full" event for this aggregate. If the value is empty, then the global setting for aggregate full threshold is considered and this can be obtained from dfm-get-option API with option-name as "aggregateFullThreshold". Range: [0..1000]
aggregate-id		integer	Identifier of the aggregate. Range: [1..2^31-1]
aggregate-name		string	Simple name of the aggregate. Always present in the output. The name is any simple name such as myaggr.
aggregate-nearly-full-threshold		integer	The value (as an integer percentage) of the fullness threshold used to generate an "aggregate nearly full" event for this aggregate. If the value is empty, then the global setting for aggregate nearly full threshold is considered and this can be obtained from dfm-get-option API with option-name as "aggregateNearlyFullThreshold". Range: [0..1000]
aggregate-nearly-overcommitted-threshold		integer	The value (as an integer percentage) is used to generate "aggregate nearly overcommitted" event for this aggregate. If the value is empty, then the global setting for aggregate nearly over committed threshold is considered and this can be obtained from dfm-get-option API with option-name as "aggregateNearlyOverCommittedThreshold". Range: [0..65535]
aggregate-overcommitted-threshold		integer	The value (as an integer percentage) is used to generate "aggregate overcommitted" event for this aggregate. If the value is empty, then the global setting for aggregate over committed threshold is considered and this can be obtained from dfm-get-option API with option-name as "aggregateOverCommittedThreshold". Range: [0..65535]
aggregate-perf-status		obj-status optional	Current status of the aggregate based on performance events
aggregate-size		aggregate-size	Sizes of various parameters of the aggregate.
aggregate-space-status		object-space-status	Space status of the aggregate. This indicates the fullness of the aggregate in terms of whether the percentage of used space with respect to total size of the aggregate has reached or crossed the fullness thresholds given in aggregate-nearly-full-threshold and aggregate-full-threshold.
aggregate-status		obj-status optional	Current status of the aggregate based on all events
aggregate-type		string	Type of aggregate. Possible values are: traditional aggregate striped
block-type		file-system-block-type	File system block type of the aggregate. The volumes on both the source and destination sides of a SnapMirror relationship must be of the same block type.
datasets		dataset-reference[]	List of dataset IDs and names containing this volume. If is-in-dataset is false, this list will be empty.
datasets-space-info		dataset-space-info[] optional	Space used by each dataset in the aggregate. Returned only when include-dataset-space-info is set to true in aggregate-list-info-iter-start.
filer-id		integer	Identifier of controller when aggregate-type is traditional or aggregate. Identifier of cluster when aggregate-type is striped. Always present in the output. Range: [1..2^31-1]
filer-name		string	Name of controller when aggregate-type is traditional or aggregate. Name of cluster when aggregate-type is striped. Always present in the output. The name is any simple name such as myhost.
is-available		boolean optional	True if this object and all of it's parents are up or online. Only output if the call to iter-start included the "include-is-available" flag.
is-dp-ignored		boolean	True if an admin wants to ignore this aggregate for purposes of data protection.
is-in-dataset		boolean	True indicates if this aggregate is a member of any dataset.
resourcepool-name		obj-name optional	Name of the resource pool of which the aggregate is a member. This element will not be present if the aggregate is not a member of a resource pool.
time-to-full		integer	Estimated amount of time left in seconds for the aggregate to become full. This is returned as empty when the estimated amount of time is more than a year. This can happen due to very low or negative rate of consumption of space in the aggregate. Range: [0..31536000]

Information about space charecteristics of an aggregate.

Name	Range	Type	Description
aggregate-id		obj-id	Aggregate identifier
aggregate-name		obj-name	Aggregate name
committed-space		integer	Information about committed space of an aggregate in bytes. Range: [0..2^63-1]
used-space		integer	Information about used space of an aggregate in bytes. Range: [0..2^63-1]

A description of one action and the predicted effects of taking that action.

Name	Range	Type	Description
dry-run-action		string	An action the system would take.
dry-run-effect		string	The predicted effect of the action.
dry-run-reason		string optional	Present only if severity is error or warning. Specifies possible reasons for the error, warning. If there are no reasons to specify, this element will not be present.
dry-run-reason-details		result-detail[] optional	These details apply to the associated dry-run-reason within the same dry-run-result. These offer additional information such as the reasons individual reasources may not have been selected for the dry-run-action in this same dry-run-result.
dry-run-severity		obj-status	severity of the dry-run result. Possible values are "information", "error" or "warning".
dry-run-suggestion		string	Present only if severity is error or warning. Specifies any suggestions to rectify the warnings, errors. If there are no suggestions to specify, this element will not be present.

Block Type of the file system. The volumes on both the source and destination sides of a SnapMirror relationship must be of the same block type. Volumes contained in a larger parent agregate may have a block-type of 64_bit. For upgraded systems it is possible that this value may be unknown until the system can determine the block-type. Possible values are: 32_bit 64_bit unknown

[none]

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]. In case of application resources from the Host Service, this field can contain unique identifier assigned to the object by the Host Service e.g. for a Virtual Machine, it can be a GUID of the VM. One exception is when such unique identifier is a decimal numeric string containing only digits from 0 through 9. In that case, you cannot use such identifier as obj-name-or-id input. 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]

Specify the management interface of ONTAP that provides complete management for the object i.e. ONTAP CLIs, SNMP, ONTAPI etc. Possible values are: "node" - For objects manageable by node management interface "cluster" - For objects manageable by cluster management interface

[none]

Name or ID of an object.

[none]

Type of space management operation Possible values: resize_volume delete_snapshot delete_backup migrate_volume dedupe_volume

[none]

Details of a space management operation. Only one of the request info in space-management-operation-info should be sent in input.

Name	Range	Type	Description
backup-deletion-request-info		backup-deletion-request-info optional	Details of backups to be deleted as part of this space management operation. The backups to be deleted should be on a volume in the aggregate on which the space management session was opened.
dedupe-request-info		dedupe-request-info optional	Details of deduplication scan to be run on a volume.
object-name-or-id		obj-name-or-id	Name or id of the volume on which a space management operation needs to be performed.
resize-volume-request-info		resize-volume-request-info optional	Details of a resize request to be carried out as part of this space management operation. The resize request should be on a volume in the aggregate on which the space management session was opened.
snapshot-deletion-request-info		snapshot-deletion-request-info optional	Details of a snapshot deletion request to be carried out as part of this space management operation. The snapshot deletion request should be on a volume in the aggregate on which the space management session was opened.
space-management-op-type		space-management-op-type	Type of space management operation.
volume-migration-request-info		volume-migration-request-info optional	Details of volume migration operation to be carried out. The volumes to be migrated should belong to the aggregate on which the space management session was opened.

Results of the space management session.

Name	Range	Type	Description
dry-run-results		dry-run-result[] optional	Results of a dry run. Each result describes one action the system would take and the predicted effects of that action. Only returned if dry-run is true.
job-id		integer optional	Identifier of job started for the provisioning request. Returned only when dry-run is false.
object-id		obj-id	Identifier of the object on which the space management operation is invoked.
object-name		obj-full-name	Name of the object on which space management operation is invoked.
space-management-op-type		space-management-op-type	Type of space management operation.

Sizes of various parameters of an aggregate.

Name	Range	Type	Description
size-available		integer	Available bytes in the aggregate. Range: [0..2^63-1].
size-total		integer	Aggregate total size in bytes. Range : [0..2^63-1].
size-used		integer	Aggregate bytes used. Range: [0..2^63-1].
space-total-committed		integer optional	Total space committed in bytes. Range: [0..2^63-1]

Details of backup to be deleted.

Name	Range	Type	Description
backup-ids		backup-id[]	List of backups to be deleted on a volume.

The name and id of a dataset.

Name	Range	Type	Description
dataset-id		obj-id	Identifier for the dataset. Range: [1..2^31-1]
dataset-name		obj-name	Name of the dataset.

Information about a datset consuming space from the aggregate.

Name	Range	Type	Description
dataset-id		obj-id	Database identifier of the dataset.
dataset-name		obj-name	Name of the dataset.
dp-node-id		integer	Identifier of the node in the dataset that is consuming space from the aggregate. If there is no protection policy associated with the dataset, node-id will be 1. Range: [1..2^32-1]
dp-node-name		string	Name of the node in the dataset that is consuming space from the aggregate. If there is no protection policy associated with the dataset, this would return the name of the dataset.
is-capable-of-migration		boolean	Indicates whether the dataset is capable of migration. This is returned true only if the dataset can be migrated in a transparent way using vFiler migration.
is-dp-node-effective-primary		boolean	Specifies whether the node in the dataset that is consuming space from the aggregate is the effective primary node or not.
used-space		integer	Space used by the dataset on the aggregate in bytes. Range: [0..2^64-1].

Deduplication request details

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.

A description of one action and the predicted effects of taking that action.

Name	Range	Type	Description
dry-run-action		string	An action the system would take.
dry-run-effect		string	The predicted effect of the action.
dry-run-reason		string optional	Present only if severity is error or warning. Specifies possible reasons for the error, warning. If there are no reasons to specify, this element will not be present.
dry-run-reason-details		result-detail[] optional	These details apply to the associated dry-run-reason within the same dry-run-result. These offer additional information such as the reasons individual reasources may not have been selected for the dry-run-action in this same dry-run-result.
dry-run-severity		obj-status	severity of the dry-run result. Possible values are "information", "error" or "warning".
dry-run-suggestion		string	Present only if severity is error or warning. Specifies any suggestions to rectify the warnings, errors. If there are no suggestions to specify, this element will not be present.

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]

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]

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]

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]. In case of application resources from the Host Service, this field can contain unique identifier assigned to the object by the Host Service e.g. for a Virtual Machine, it can be a GUID of the VM. One exception is when such unique identifier is a decimal numeric string containing only digits from 0 through 9. In that case, you cannot use such identifier as obj-name-or-id input. 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]

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]

Space status of the object. This indicates the fullness of the object in terms of whether the percentage of used space with respect to total size of the object has reached the fullness thresholds. Possible values: ok - when the percentage of used space of the object is within the nearly full and full threshold of the object. nearly_full - when the percentage of used space of the object is within the full threshold of the object but has reached or crossed the nearly full threshold. full - when the percentage of used space of the object has reached or crossed the full threshold of the object.

[none]

Details of the resize request. Atleast one of new-size, maximum-capacity or snap-reserve needs to be specified.

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 storage syste, to which the volume belongs is of ONTAP version 7.1 or above only and if autosize is enabled on the volume. Range: [1..2^44-1]
new-size		integer optional	Specify the new size of the volume. The value is specified in bytes. Range: [1..2^44-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. Range: [0..100]

Details on a specific action that adds information intended to explain more about a higher level result. For example, the detail may be used to explain a dry-run result by explaining why resources were not selected.

Name	Range	Type	Description
action		string	An action or check the system had taken.
effect		string	The result of the action or check.
reason		string optional	Specifies possible reasons for the this result. If there are no reasons to specify, this element will not be present.
severity		obj-status	severity of the result result. Possible values are "information", "error" "warning". It is normal for "information" to be used to explain why a resource was not selected.
suggestion		string	Specifies any suggestions to rectify the information, warnings, errors. If there are no suggestions to specify, this element will not be present.

Details of snapshot deletion request

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.

Type of space management operation Possible values: resize_volume delete_snapshot delete_backup migrate_volume dedupe_volume

[none]

Details of volume migration request

Name	Range	Type	Description
cleanup-stale-storage		cleanup-stale-storage optional	Indicates when should the volumes in the source aggregate should be destroyed after successful migration. Default value is "cleanup_after_migration".
destination-aggregate-name-or-id		obj-name-or-id optional	Name or identifier of the destination aggregate to which all the volumes has to be migrated to. If the destination aggregate is not provided, the system will select a suitable aggregate from the resource pools associated with the dataset node to which the volumes belong to.
retention-type		dp-backup-retention-type optional	Retention type to which the backup version created should be archived for the backups created as part of running an on-demand update after successful migration. This element is ignored if run-on-demand-update is false. Default value is "daily".
run-dedupe-scan		boolean optional	Indicates whether a full deduplication scan has to be run on the new volume after migration. This option is applicable only for volumes that are enabled for deduplication and is useful to regenerate the fingerprint database used in deduplication and will be ignored for other volumes. Default value is false.
run-on-demand-update		boolean optional	Indicates whether an on-demand update has to be triggered after successful migration on the dataset to which the volumes that were migrated belong to. Default value is false.

Identifier of the backup instance to be deleted. Range: [1..2^31-1]

[none]

Indicates when the volumes in the source aggregate should be destroyed after successful migration. Possible values are: cleanup_after_update cleanup_after_migration no_cleanup

[none]

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

[none]

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]. In case of application resources from the Host Service, this field can contain unique identifier assigned to the object by the Host Service e.g. for a Virtual Machine, it can be a GUID of the VM. One exception is when such unique identifier is a decimal numeric string containing only digits from 0 through 9. In that case, you cannot use such identifier as obj-name-or-id input. 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]

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 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.