Input Name	Range	Type	Description
tag		string	Tag from a previous dp-backup-content-list-iter-start.

Errno	Description
EINVALIDTAG

Get next few records in the iteration started by dp-backup-content-list-iter-start.

Input Name	Range	Type	Description
maximum		integer	The maximum number of entries to retrieve. Range: [1..2^31-1].
tag		string	Tag from a previous dp-backup-content-list-iter-start.
Output Name	Range	Type	Description
backup-contents		dp-backup-content-info[]	List of files and directories in backup.
records		integer	The number of records actually returned. Range: [0..2^31-1].

Errno	Description
EINVALIDTAG

Starts iteration to list contents of a backup. Files and directories directly under specified path are listed. In order to list all files recursively, multiple invocations of this API are necessary.

Input Name	Range	Type	Description
backup-id		integer	Id of backup whose file contents are to be listed. Use dp-backup-list-iter-start to retrieve valid backup ids. Range: [1..2^31-1]
primary-snapshot-name		string optional	Name of the Snapshot copy on the primary where the data originated. This field is ignored if the root-object-name-or-id is omitted. It is also ignored, if primary-snapshot-unique-id is specified.
primary-snapshot-unique-id		string optional	Unique id of the Snapshot copy on the primary where the data originated. Currently, this is the Snapshot copy's creation time. This field is ignored if the root-object-name-or-id is omitted.
root-object-name-or-id		string optional	Name or id of a data set member that is at the root of the file tree. This may be qtree, ossv directory or volume that is the source of the physical data protection relationship. Indirect members may also be specified. If the sub path input is given, then this input is required. If specified, backup contents of this object are listed. Otherwise, backup contents directly under the data set are listed.
sub-path		string optional	Local subpath within the data set with regard to root-object-name-or-id. If specified, backup contents directly under this sub path are listed. Otherwise, backup contents directly under the specified root-object are listed. Ignored if root-object-name-or-id input is not present If the root-object-name-or-id is a volume,qtree or ossv unix directory then this sub-path is a unix-like path, ex: 'dir1/dir2/'. If the root-object-name-or-id is ossv windows directory then this sub-path is a windows path, ex : 'dir1\\dir2\\'. Maximum length of sub-path is 32767 characters.
Output Name	Range	Type	Description
records		integer	Number which tells you how many items have been saved for future retrieval with dp-backup-content-list-iter-next. Range: [0..2^31-1]
tag		string	Tag to be used in subsequent calls to dp-backup-content-list-iter-next.

Errno	Description
EBACKUPLOCATIONDOESNOTEXIST
EBACKUPDOESNOTEXIST
EPATHDOESNOTEXIST

Given a backup-id or the backup-version and a list of member-ids or member-names, returns the snapshot name, volume that it exists on as well as the secondary qtree associated with the member id.

Input Name	Range	Type	Description
backup-id		integer optional	Identifier of the backup. Range: [1..2^31-1]
backup-version		dp-timestamp optional	Timestamp of the backup version.
dataset-name-or-id		obj-name-or-id optional	Name or ID of the dataset to which this backup version belongs to. This parameter is ignored in case of backup-id parameter in the input.
paths		dp-backup-path-info[]	Path information about backup
Output Name	Range	Type	Description
backup-locations		backup-location-info[]	Location information for the backup.

Ends iteration to list backups.

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

Errno	Description
EINVALIDTAG

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

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

Errno	Description
EINVALIDTAG

Starts iteration to list backups of a dataset or a path within dataset.

Input Name	Range	Type	Description
backup-id		integer optional validate	Id of backup whose information is to be listed. If this parameter is specified backup-version, volume-id, snapshot-unique-id, root-object-name-or-id and sub-path parameters are ignored. Range: [1..2^31-1]
backup-version		dp-timestamp optional validate	Timestamp when the backup was taken. Backups of the dataset that were taken at this time is listed. If this parameter is specified, volume-id, snapshot-unique-id, root-object-name-or-id and sub-path are ignored.
dataset-name-or-id		obj-name-or-id	Name or id of dataset. Backups for this dataset are listed.
include-metadata		boolean optional	If true, returns metadata for the backup. If false, metadata, which can be large in size, is not returned. Default is false.
root-object-name-or-id		obj-name-or-id optional	Name or id of a dataset member that is at the root of the file tree. This may be qtree, ossv directory or volume that is source of the physical data protection relationship. If sub path input is given then this input is required. If specified, backups containing this object are listed. Otherwise, all backups of this dataset are listed.
snapshot-unique-id		string optional	Unique id of a snapshot. If volume-id is present, then this input must be given. Ignored if volume-id is not present.
sub-path		string optional	Local subpath within the dataset with regard to root-object-name-or-id. If specified, backups containing this sub path are listed. Ignored if root-object-name-or-id input is not present If the root-object-name-or-id is a volume,qtree or ossv unix directory then this sub-path is a unix-like path, ex: 'dir1/dir2/'. If the root-object-name-or-id is ossv windows directory then this sub-path is a windows path, ex : 'dir1\dir2\'. Maximum length of sub-path is 32767 characters.
volume-id		obj-id optional	Id of volume that is member of a dataset node. If this input is present then snapshot-unique-id must be present. backup-version containing this (volume-id, snapshot-unique-id) is returned. If this parameter is specified, root-object-name-or-id, sub-path are ignored.
Output Name	Range	Type	Description
records		integer	Number which tells you how many items have been saved for future retrieval with dp-backup-list-iter-next. Range: [0..2^31-1]
tag		string	Tag to be used in subsequent calls to dp-backup-list-iter-next.

Errno	Description
EOBJECTNOTFOUND
EBACKUPDOESNOTEXIST
EPATHDOESNOTEXIST
EINVALIDINPUT
EDATABASEERROR
EACCESSDENIED

Start an unscheduled backup of a dataset. All members of the dataset will be backed up. A background job will be spawned to backup the dataset.

Input Name	Range	Type	Description
backup-description		string optional	Description for the backup. Can be arbitrary string meaningful to the user. If provided, the job spawned will have this description. The length of this string cannot be more than 255 characters.
backup-destination		string optional	Destination of the backup. This should be name of one of the nodes in the data protection policy attached to the dataset. If name of the primary node is specified, the management station takes local snapshot only. Otherwise, the management station transfers the backup over intervening policy nodes until it reaches the specified destination node. If this input is not provided, then the management station takes local snapshots on the primary node as well as backups on all connections in the policy.
dataset-name-or-id		obj-name-or-id	Name or id of the dataset to backup.
retention-type		dp-backup-retention-type	Retention type to which the backup version should be archived.
Output Name	Range	Type	Description
job-id		integer	Id of the job that handles the unscheduled backup of the dataset. dp-backup-progress-* apis can be used to track the progress of the backup job. Range: [1..2^31-1]

Errno	Description
EOBJECTNOTFOUND
EACCESSDENIED
EINVALIDINPUT
EINTERNALERROR

Creates a backup version. Backup version is collection of volume snapshots and denotes a single backed up image of a dataset. The management station keeps track of actual volumes that hold the data set backup using backup versions.

Input Name	Range	Type	Description
backup-description		string optional	Description for backup version. Can be arbitrary string meaningful to the user. If provided, the new version will have this description. The length of this string cannot be more than 255 characters.
backup-metadata		dfm-metadata-field[] optional	Opaque metadata for this backup. Metadata is usually set and interpreted by an application that is using the data set. DFM does not look into the contents of the metadata.
dataset-name-or-id		obj-name-or-id optional	Name or identifier of the data set for the backup version.
is-complete		boolean optional	Indicates whether or not this backup version is a consistent backup of the data set. The default value is true.
is-for-propagation		boolean optional	Indicates whether or not this backup version should be propagated according to the data protection policy. If false, the backup version will not be propagated to other nodes. Once a backup version is created, this property can not be modified. Default value is true.
retention-type		string	Retention type of this version. Possible values: 'hourly','daily', 'weekly', 'monthly' and 'unlimited'.
storageset-id		obj-id optional	Identifier of storage set on which this backup version exists. If the storage set is not specified, then the default is the primary storage set.
version-members		version-member-info[]	Describes snapshot members of this backup version.
version-timestamp		dp-timestamp	Timestamp of the backup version. This corresponds to the time at which backup for the data set started.
Output Name	Range	Type	Description
backup-id		integer	Integer identifier of the new backup version. Range: [1..2^31-1] This is different from backup-version.

Errno	Description
EOBJECTNOTFOUND
EINVALIDINPUT
EDATABASEERROR

Delete an existing backup version from the database and delete the snapshots from the filers for this backup version. The backup version must currently exist. Error conditions: EBACKUPDOESNOTEXIST - The backup version was not found. EINVALIDINPUT - Not enough inputs to determine version properly. This can happen if less than three of dataset, backup-version, and node-name are used in the case where backup-id is not supplied. EACCESSDENIED - Access was denied on the requested backup version. EINTERNALERROR - An error occurred while processing the request. Try again later. EOBJECTNOTFOUND - Dataset not found.

Input Name	Range	Type	Description
backup-id		integer optional	Identifier of the backup version to be deleted. Range: [1..2^31-1] This input is required unless all three inputs of dataset-name-or-id, backup-version, and node-name are supplied in which case backup-id should be omitted.
backup-version		dp-timestamp optional	Timestamp when the backup was taken. This input is required if backup-id is not present. This input should be omitted and is ignored if backup-id is present.
dataset-name-or-id		obj-name-or-id optional	Name or identifier of the data set for the backup version to be deleted. This input is required if backup-id is not present. This input should be omitted and is ignored if backup-id is present.
node-name		string optional	Name of policy node that uniquely defines the backup-id for backup version to be deleted. This input is required if backup-id is not present. This input should be omitted and is ignored if backup-id is present.

Errno	Description
EBACKUPDOESNOTEXIST
EINVALIDINPUT
EOBJECTNOTFOUND
EDATABASEERROR
EACCESSDENIED
EINTERNALERROR

Modifies a backup version.

Input Name	Range	Type	Description
backup-description		string optional	Description for backup version. Can be arbitrary string meaningful to the user. The length of this string cannot be more than 255 characters.
backup-id		integer optional	Identifier of backup version to be modified. Range: [1..2^31-1] Either the backup-id or both the dataset-name-or-id and backup-version must be specified.
backup-metadata		dfm-metadata-field[] optional	Opaque metadata for this backup. Metadata is usually set and interpreted by an application that is using the data set. DFM does not look into the contents of the metadata.
backup-status-name		string optional	Name of backup status to update. This field is meant for internal use. Possible values: 'delete_status', 'copy_status', and 'transfer_status'. This corresponds to backup-transfer-status in the output.
backup-status-process-id		integer optional	Identifier of the process that is modifying backup status. This is used to reset the status, if process terminates abnormally. This field is meant for internal use. Valid only when backup-status-name is specified.
backup-status-value		string optional	Value of status referred in backup-status-name. This field is meant for internal use. Valid only when backup-status-name is specified. If backup-status-name is 'delete_status', possible values: 'deleting' or an empty string ''. If backup-status-name is 'copy_status', possible values: 'copying' or an empty string ''. If backup-status-name is 'transfer_status', possible values: 'transferring', 'transferred', 'transfer_failed', or an empty string ''.
backup-version		dp-timestamp optional	Timestamp when the backup was taken. Backups of same dataset at different locations have same version if their contents are identical. The management station keeps track of which backups have identical contents and assigns same version to them. Either the backup-id or both the dataset-name-or-id and backup-version must be specified. Ignored if backup-id is specified.
dataset-name-or-id		obj-name-or-id optional	Name or identifier of the data set for the backup version. Either the backup-id or both the dataset-name-or-id and backup-version must be specified. Ignored if backup-id is specified.
is-complete		boolean optional	Indicates whether or not this backup version is a consistent backup of the data set. If not specified, the value of the attribute remains unchanged.
retention-type		string optional	Retention type of this version. Possible values: 'hourly','daily', 'weekly', 'monthly' and 'unlimited'.
version-members		version-member-info[] optional	Snapshots to add to the backup. If a snapshot is already a member of the backup, do nothing. Existing members of the backup are unaffected.

Errno	Description
EOBJECTNOTFOUND
EINVALIDINPUT
EDATABASEERROR
EBACKUPDOESNOTEXIST
EACCESSDENIED

Returns a set of jobs to be spawned to backup the dataset. This zapi is used to obtain data that is later used to start an on-demand backup of dataset.

Input Name	Range	Type	Description
backup-destination		string optional	Destination of the dataset backup. This should be name of one of the nodes in data protection policy attached to the dataset. If primary node is specified, only local snapshot is taken. Otherwise, backup is transferred over intervening policy nodes until it reaches the specified node. If this element is not present, then local snapshot on the primary node as well as backup and mirror transfers on all connections of the policy are done.
dataset-name-or-id		obj-name-or-id	Name or id of the dataset to be backed up.
retention-type		dp-backup-retention-type	Retention type to which the backup version should be archived.
Output Name	Range	Type	Description
dp-jobs-data		dp-job-data[]	List of jobs that need to be started to backup this dataset. Each element will have all the details required for that job.

Errno	Description
EOBJECTNOTFOUND
EACCESSDENIED
EINVALIDINPUT
EINTERNALERROR

location information for backup. Only the members which are found are returned.

Name	Range	Type	Description
backup-id		integer optional	Actual backup image used to restore Range: [1..2^31-1]
member-id		obj-id	ID of the qtree or OSSV directory. member-id is for the primary qtree or OSSV dir.
member-name		obj-name	Name of the qtree or OSSV directory. member-name is for the primary qtree or OSSV dir.
path		string optional	Name of the path. The maximum path length is 32767 characters. This path is relative to 'member-id' path in the filer or OSSV host. For filer and ossv unix hosts this is a unix-like path (ex: '/dir1/dir2'). For ossv windows host this is a windows path (ex: '\dir1\dir2').
path-found		boolean	TRUE if the path is found in a backup-version. The following elements will be set only is path-found is TRUE.
primary-snapshot-name		string optional	Name of the Snapshot copy on the primary where the data originated.
primary-snapshot-unique-id		string optional	Unique id of the Snapshot copy on the primary where the data originated. Currently, this is the Snapshot copy's creation time.
secondary-qtree-id		obj-id optional	ID of the secondary qtree which is protecting the member-id.
secondary-qtree-name		obj-name optional	Name of the secondary qtree which is protecting the member-id.
snapshot-name		string optional	Name of the snapshot in the backup which contains the backup of the member.
storage-system-id		obj-id optional	ID of the storage system on which the secondary Snapshot copy resides. Always present in the output if the path is found.
storage-system-name		obj-name optional	Name of the storage system on which the secondary Snapshot copy resides. Always present in the output if the path is found.
volume-id		obj-id optional	Identifier of the volume on which the snapshot resides.

Named field in the metadata.

Name	Range	Type	Description
field-name		string	Name of the metadata field. Field names are up to 255 characters in length and are case- insensitive.
field-value		string	Arbitrary, user-defined data expressed as a string. The string is opaque to the server and must not exceed 16384 (16k) characters in length.

Information about contents of a backup of dataset.

Name	Range	Type	Description
dp-file-info		dp-file-info optional	Information about file (or directory etc.) in a backup. This element will not be present in case of top-level contents.
primary-snapshot-name		string optional	Name of the Snapshot copy on the primary where the data originated. Present in the top level contents of backup only.
primary-snapshot-unique-id		string optional	Unique id of the Snapshot copy on the primary where the data originated. Currently, this is the Snapshot copy's creation time. This can be used to differentiate between versions of the same file in the same backup. Present in the top level contents of backup only.
root-object-id		obj-id optional	Id of a dataset member that is at the root of the file tree. This may be qtree, ossv directory or volume that is source of the physical data protection relationship. Present in the top level contents of backup only.
root-object-name		string optional	Object name for root-object-id. Present in the top level contents of backup only.
root-object-type		string optional	Object type for root-object-id. Possible values: 'qtree', 'directory', 'volume'. Present in the top level contents of backup only.

Backup is a single backed up image of a dataset. If backup is too large to fit on a single volume, the management station uses multiple volumes in the same storageset. In such cases, a single backup may span multiple volumes in a single storageset. The management station keeps track of actual volumes that hold the backup. Caller can identify backup by its numeric identifier.

Name	Range	Type	Description
backup-description		string optional	User specified description of backup for unscheduled backup started by dp-backup-start. The maximum length of this string is 255 characters.
backup-id		integer	Identifier of the backup. The management station assigns a unique id to each backup. Range: [1..2^31-1]
backup-metadata		dfm-metadata-field[] optional	Opaque metadata for the backup. Metadata is usually set and interpreted by an application that is using the data set. DFM does not look into the contents of the metadata.
backup-transfer-status		string optional	Indicates the transfer status of this backup. This field is meant for internal use. It is set by backup transfer job only for backups on the Primary node of an application data set. Possible values: 'transferring', 'transferred', 'transfer_failed', and ''.
backup-version		dp-timestamp	Timestamp when the backup was taken. Backups of same dataset at different locations have same version if their contents are identical. The management station keeps track of which backups have identical contents and assigns same version to them. The timestamp value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.
is-for-propagation		boolean optional	Indicates whether or not this backup version should be propagated according to the data protection policy. If false, the backup version will not be propagated to other nodes. Default value is true.
node-name		string optional	Name of policy node that corresponds to the storageset that holds backup. May not be present if policy has been modified in such a way that storageset has no corresponding node in policy. It may be possible to restore contents from such orphaned backup if the physical relationships continue to exist.
retention-type		dp-backup-retention-type	Type of retention for the backup.
version-members		version-member-info[]	describes snapshot members of this backup version.

Information about backup path

Name	Range	Type	Description
member-id		obj-id optional	The qtree or OSSV dir ID. Either member-id or member-name must be supplied. If member-id is supplied member-name should not be supplied.
member-name		obj-name optional	The qtree or OSSV dir name. Either member-id or member-name must be supplied. member-name is only used if member-id is not supplied
path		string optional	Name of the path. The maximum path length is 32767 characters. This path is relative to 'member-id' path in the storage system or OSSV host. For storage system and ossv unix hosts this is a unix-like path (ex: '/dir1/dir2'). For ossv windows host this is a windows path (ex: '\dir1\dir2').
primary-snapshot-name		string optional	Name of the Snapshot copy on the primary where the data originated. This is ignored if primary-snapshot-unique-id is specified.
primary-snapshot-unique-id		string optional	Unique id of the Snapshot copy on the primary where the data originated. Currently, this is the Snapshot copy's creation time. This should be specified when member exists in more than one Snapshot copies in the same backup.

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

[none]

Describes an unscheduled data protection job. Type of job is specified in dp-job-type element. Only one of all possible dp-*-job-data elements can be present.

Name	Range	Type	Description
dataset-id		obj-id	Id of the dataset being protected by the job.
dp-job-type		string	Type of the dp job. Possible values: 'snapvault', 'snapmirror' and 'local_snapshot'.
dp-local-snapshot-job-data		dp-local-snapshot-job-data optional	Data for local-snapshot job.
dp-snapmirror-transfer-job-data		dp-snapmirror-transfer-job-data optional	Data for snapmirror-transfer job.
dp-snapvault-transfer-job-data		dp-snapvault-transfer-job-data optional	Data for snapvault-transfer job.

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]

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. data set, 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 or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI type string. An obj-name-or-id must contain between 1 and 64 characters, and must conform to one of the following formats: It must have the format of an obj-name, or It must be the decimal numeric string form of a positive integer whose value is in the range [1..2^31 - 1]. Elements of type obj-name-or-id are used only as inputs to ZAPIs. The value must match either the name or internal ID of an existing DFM object. The ZAPI must specify the object's DFM object type (e.g. data set, 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]

Describes one snapshot member of a backup version.

Name	Range	Type	Description
snapshot-contents		snapshot-member-info[]	Contents of the snapshot.
snapshot-name		string	Name of the snapshot.
snapshot-unique-id		string	Unique id of the snapshot. currently this is snapshot creation time.
volume-id		obj-id optional	Always included in output, either volume-id or volume-name must be specified in input. ID of the volume corresponding to member snapshot.
volume-name		obj-name optional	Always included in output, either volume-id or volume-name must be specified in input. The name of the volume this Snapshot resides on.

Named field in the metadata.

Name	Range	Type	Description
field-name		string	Name of the metadata field. Field names are up to 255 characters in length and are case- insensitive.
field-value		string	Arbitrary, user-defined data expressed as a string. The string is opaque to the server and must not exceed 16384 (16k) characters in length.

Information about file, directory, qtree, drive etc. on a primary host or in a backup.

Name	Range	Type	Description
child-count		integer	Count of children. This is zero when value of file-type element is 'file'. Otherwise, it can be zero or non-zero. Range: [0..2^31-1]
file-name		string	Name of the file.
file-size		integer optional	Size of file in bytes. Range: [0..2^64-1]
file-type		string	Type of the file. Possible values: 'file', 'directory', 'qtree', 'volume', 'drive', 'fifo', 'cspec', 'bspec', 'symlink', 'socket', 'registry', and 'other'.
last-modified-timestamp		integer optional	Timestamp when the file was last modified. The timestamp value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.

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

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

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

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

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

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

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. data set, 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 builtin 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 data sets, DP schedules, and DP policies. This means that no two data sets may have the same name, but a data set 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]

Information of one qtree or ossv dir that is in snapshot.

Name	Range	Type	Description
primary-id		obj-id optional	Always returned on output, either primary-id or primary-name must be specified on input. Primary qtree or OSSV directory ID.
primary-name		obj-name optional	Always returned on output, either primary-id or primary-name must be specified on input. The name of a qtree or OSSV directory whose data is in the Snapshot.
primary-snapshot-name		string optional	Name of the Snapshot copy on the primary where the data originated.
primary-snapshot-unique-id		string optional	Unique id of the Snapshot copy on the primary where the data originated. Currently, this is the Snapshot copy's creation time.
secondary-qtree-id		obj-id optional	Corresponding secondary qtree id. This legacy parameter if supplied along with secondary-qtree-name-or-id will be ignored unless it references a different qtree in which case an error will be returned. Not included if the backup version consists of local snapshots.
secondary-qtree-name-or-id		string optional	Corresponding secondary qtree name or identifier. This is used to lookup the secondary-qtree-id if present. If this is present, secondary-qtree-id will be ignored. Not included if the backup version consists of local snapshots.

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

[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. data set, 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 builtin 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 data sets, DP schedules, and DP policies. This means that no two data sets may have the same name, but a data set 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]