Input Name	Range	Type	Description
tag		string	The tag returned in a previous call to dp-ossv-application-list-info-iter-start.

Errno	Description
EINTERNALERROR
EINVALIDTAG

Returns items from a previous call to dp-ossv-application-list-info-iter-start.

Input Name	Range	Type	Description
maximum		integer	The maximum number of entries to retrieve. Range: [1..2^31-1]
tag		string	The tag returned in a previous dp-ossv-directory-application-list-info-iter-start call
Output Name	Range	Type	Description
ossv-application-list		ossv-application-info[]	List of applications supported by OSSV host.
records		integer	The number of records actually returned.

Errno	Description
EINTERNALERROR
EINVALIDTAG

Browse the application components supported by an OSSV host.

Input Name	Range	Type	Description
ossv-application-path		string optional	The path of the application to browse. If specified it must be an the application path returned by dp-ossv-application-list-info-iter-start. If not specified, it is same as an empty string and all the Virtual Machines reported by the OSSV host will be returned. Length: [1..255]
ossv-host-name-or-id		ossv-host-name-or-id	Name or ID of an OSSV host.
Output Name	Range	Type	Description
records		integer	Number indicating how many items are available for future retrieval with dp-ossv-application-list-info-iter-next. Range: [1..2^31-1]
tag		string	Tag to be used in subsequent calls to dp-ossv-application-list-info-iter-next or dp-ossv-application-list-info-iter-end

Errno	Description
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EINTERNALERROR
EDIRDOESNOTEXIST

Terminate an iteration started by dp-ossv-application-restore-destination-list-info-iter-start and clean up any saved info. Error conditions: EINTERNALERROR - An error occurred while processing the request. Try again later. EINVALIDTAG - The iterator tag specified is not valid. Restart the iteration operation to obtain a new valid tag.

Input Name	Range	Type	Description
tag		string	The tag returned in a previous call to dp-ossv-application-restore-destination-list-info-iter-start.

Errno	Description
EINTERNALERROR
EINVALIDTAG

Returns items from a previous call to dp-ossv-application-restore-destination-list-info-iter-start

Input Name	Range	Type	Description
maximum		integer	The maximum number of entries to retrieve. Range: [1..2^31-1]
tag		string	The tag returned in a previous dp-ossv-application-restore-destination-list-info-iter-start call.
Output Name	Range	Type	Description
ossv-application-restore-destination-list		ossv-application-restore-destination-info[]	List of all the OSSV hosts through which the application can be restored to its original location.
records		integer	The number of records actually returned.

Errno	Description
EINTERNALERROR
EINVALIDTAG

List all the OSSV hosts through which a restore to the original location is possible for a given application.

Input Name	Range	Type	Description
application-name-or-id		obj-name-or-id	Name or ID of the application.
Output Name	Range	Type	Description
records		integer	Number indicating how many items are available for future retrieval with dp-ossv-application-restore-destination-list-info-iter-next. Range: [1..2^31-1]
tag		string	Tag to be used in subsequent calls to dp-ossv-application-restore-destination-list-info-iter-next or dp-ossv-application-restore-destination-list-info-iter-end

Errno	Description
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EINTERNALERROR

Add a new OSSV directory to the list of discovered directories. If the directory already exists, return its object ID. Error conditions: EOBJECTAMBIGUOUS - The specified host name could refer to 2 or more hosts. Try again with a host ID or a fully qualified host name or IP address. There can be two applications with the same name. Try specifying the application path. EOBJECTNOTFOUND - The host name, IP address, or host ID was not found. EACCESSDENIED - Access was denied on the requested host(s). EINTERNALERROR - An error occurred while processing the request. Try again later. EDIRDOESNOTEXIST - The specified directory was not found.

Input Name	Range	Type	Description
directory-path		string	Directory path to add. This path must be an absolute path on the given host. In case of adding an application component this should be the ossv-application-path returned by dp-ossv-application-list-info-iter-next.
ossv-host-name-or-id		ossv-host-name-or-id	Name or ID of an OSSV host.
Output Name	Range	Type	Description
directory-id		integer	ID of the newly added directory. Range: [1..2^31-1]

Errno	Description
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EINTERNALERROR
EOBJECTEXISTS
EDIRDOESNOTEXIST

Terminate an iteration started by dp-ossv-directory-browse-iter-start and clean up any saved info. Error conditions: EINTERNALERROR - An error occurred while processing the request. Try again later. EINVALIDTAG - The iterator tag specified is not valid. Restart the iteration operation to obtain a new valid tag.

Input Name	Range	Type	Description
tag		string	The tag returned in a previous call to dp-ossv-directory-browse-iter-start.

Errno	Description
EINTERNALERROR
EINVALIDTAG

Returns items from a previous call to dp-ossv-directory-browse-iter-start. Error conditions: EINTERNALERROR - An error occurred while processing the request. Try again later. EINVALIDTAG - The iterator tag specified is not valid. Restart the iteration operation to obtain a new valid tag.

Input Name	Range	Type	Description
maximum		integer	The maximum number of entries to retrieve. Range: [1..2^31-1]
tag		string	The tag returned in a previous dp-ossv-directory-browse-iter-start call.
Output Name	Range	Type	Description
subdirectories		dp-ossv-directory-name[]	List of subdirectories.

Errno	Description
EINTERNALERROR
EINVALIDTAG

Get the list of subdirectories beneath a given directory on an OSSV host. Error conditions: EOBJECTAMBIGUOUS - The specified host name could refer to 2 or more hosts. Try again with a host ID or a fully qualified host name or IP address. EOBJECTNOTFOUND - The host name, IP address, or host ID was not found. EACCESSDENIED - Access was denied on the requested host(s). EINTERNALERROR - An error occurred while processing the request. Try again later. EDIRDOESNOTEXIST - The specified directory was not found.

Input Name	Range	Type	Description
directory-path		string optional	Directory name to browse. Must be an absolute path, or an empty string. If directory-path is omitted, it is the same as an empty string. If this value is omitted, or an empty string, then a list of all the roots of filesystems that are suitable for backup will be returned. On some systems, special backup sources will be returned as well. These special backup sources will not have a trailing slash when returned. For example, on Windows, "SystemState" is a valid backup source returned by this API, but it cannot be browsed by this API.
ossv-host-name-or-id		ossv-host-name-or-id	Name or ID of an OSSV host.
Output Name	Range	Type	Description
records		integer	Number indicating how many items are available for future retrieval with dp-ossv-directory-browse-iter-next. Range: [1..2^31-1]
tag		string	Tag to be used in subsequent calls to dp-ossv-directory-browse-iter-next or dp-ossv-directory-browse-iter-end.

Errno	Description
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EINTERNALERROR
EDIRDOESNOTEXIST

Terminate an iteration started by dp-ossv-directory-discovered-iter-start and clean up any saved info. Error conditions: EINTERNALERROR - An error occurred while processing the request. Try again later. EINVALIDTAG - The iterator tag specified is not valid. Restart the iteration operation to obtain a new valid tag.

Input Name	Range	Type	Description
tag		string	The tag returned in a previous call to dp-ossv-directory-discovered-iter-start.

Errno	Description
EINTERNALERROR
EINVALIDTAG

Returns items from a previous call to dp-ossv-directory-discovered-iter-start. Error conditions: EINTERNALERROR - An error occurred while processing the request. Try again later. EINVALIDTAG - The iterator tag specified is not valid. Restart the iteration operation to obtain a new valid tag.

Input Name	Range	Type	Description
maximum		integer	The maximum number of entries to retrieve. Range: [1..2^31-1]
tag		string	The tag returned in a previous dp-ossv-directory-discovered-iter-start call.
Output Name	Range	Type	Description
directories		dp-ossv-directory-info[]	List of directories.

Errno	Description
EINTERNALERROR
EINVALIDTAG

List the OSSV directories which have been discovered by the monitor. This list includes OSSV roots, and siblings of directories in backup relationships. The list can be filtered to exclude directories which are marked as "ignored" and to exclude directories which are protected. Error conditions: EOBJECTAMBIGUOUS - The specified host name could refer to 2 or more hosts. Try again with a host ID or a fully qualified host name or IP address. There can be two applications with the same name. Try specifying the ID of the application. EOBJECTNOTFOUND - The lookup object was not found. EINTERNALERROR - An error occurred while processing the request. Try again later. EACCESSDENIED - Access was denied on the requested directory object(s).

Input Name	Range	Type	Description
include-is-available		boolean optional	If true, the is-available status is calculated for each directory which may make the call to this zapi take much longer. Default is false.
is-dp-ignored		boolean optional	If the value is true, only list directories which are marked as ignored Freya/DFM for the purpose of data protection. If the value is false, only list directories which are not marked as ignored. If the value is not specified, then list all directories.
is-in-backup-relationship		boolean optional	If this value is true, only list directories which are in a backup relationship. If this value is false, only list directories which are not in a backup relationship. If this value is unspecified, then list all directories.
is-in-dataset		boolean optional	If the value is true, only list directories which are members of a dataset. If the value is false, only list directories which are not members of datasets. If the value is not specified, list all directories.
object-name-or-id		string optional	Name or identifier of an object to list OSSV directories for. The allowed object types for this argument are: Resource Group Dataset OSSV Host OSSV Directory If object-name-or-id identifies an OSSV directory, that single OSSV directory will be returned. If object-name-or-id resolves to more than one OSSV directory, all of them will be returned. If no object-name-or-id is provided, all OSSV directories will be listed. The same applies to OSSV applications as well.
Output Name	Range	Type	Description
records		integer	Number indicating how many items are available for future retrieval with dp-ossv-directory-discovered-iter-next. Range: [1..2^31-1]
tag		string	Tag to be used in subsequent calls to dp-ossv-directory-discovered-iter-next or dp-ossv-directory-discovered-iter-end.

Errno	Description
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EACCESSDENIED
EINTERNALERROR

Modify a directory'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 directory. EINTERNALERROR - An error occurred while processing the request. Try again later. EOBJECTNOTFOUND - When the dp-ossv-directory-name-or-id does not correspond to an ossv directory. EDATABASEERROR - On database error.

Input Name	Range	Type	Description
dp-ossv-directory-name-or-id		string	Name or identifier of the directory to modify. If a name is specified, it must be of the form "host-name:directory-path".
is-dp-ignored		boolean optional	True if an administrator has chosen to ignore this object for purposes of data protection.

Errno	Description
EACCESSDENIED
EINTERNALERROR
EDATABASEERROR
EOBJECTNOTFOUND

Terminate an iteration started by dp-ossv-directory-roots-iter-start and clean up any saved info. Error conditions: EINTERNALERROR - An error occurred while processing the request. Try again later. EINVALIDTAG - The iterator tag specified is not valid. Restart the iteration operation to obtain a new valid tag.

Input Name	Range	Type	Description
tag		string	The tag returned in a previous call to dp-ossv-directory-roots-iter-start.

Errno	Description
EINTERNALERROR
EINVALIDTAG

Returns items from a previous call to dp-ossv-directory-roots-iter-start. Error conditions: EINTERNALERROR - An error occurred while processing the request. Try again later. EINVALIDTAG - The iterator tag specified is not valid. Restart the iteration operation to obtain a new valid tag.

Input Name	Range	Type	Description
maximum		integer	The maximum number of entries to retrieve. Range: [1..2^31-1]
tag		string	The tag returned in a previous dp-ossv-directory-roots-iter-start call.
Output Name	Range	Type	Description
roots		dp-ossv-directory-root-info[]	List of roots.

Errno	Description
EINTERNALERROR
EINVALIDTAG

Get the list of filesystem roots from one or more OSSV hosts. Error conditions: EOBJECTAMBIGUOUS - The specified host name could refer to 2 or more hosts. Try again with a host ID or a fully qualified host name or IP address. EOBJECTNOTFOUND - The host name, IP address, or host ID was not found. EACCESSDENIED - Access was denied on the requested host(s). EINTERNALERROR - An error occurred while processing the request. Try again later.

Input Name	Range	Type	Description
fs-info		boolean optional	If fs-info is specified and true, then a list of all filesystems is returned instead of a list of root of filesystems suitable for backup. For example, CD-ROM drives and NFS mounts will be returned if fs-info is true. Additional information will be included in the output, specifically the filesystem device, type and state, as reported by NDMP. While this flag causes this API to return more data, the recommended way to find filesystems suitable for backup is to set this flag to false.
ossv-host-name-or-id		ossv-host-name-or-id optional	Name or ID of an OSSV host. If no OSSV host is specified, roots are returned for all OSSV hosts.
Output Name	Range	Type	Description
records		integer	Number indicating how many items are available for future retrieval with dp-ossv-directory-roots-iter-next. Range: [1..2^31-1]
tag		string	Tag to be used in subsequent calls to dp-ossv-directory-roots-iter-next or dp-ossv-directory-roots-iter-end.

Errno	Description
EOBJECTNOTFOUND
EOBJECTAMBIGUOUS
EHOSTDOESNOTEXIST
EINTERNALERROR

Information about one directory.

Name	Range	Type	Description
dataset-id		integer optional	If is-in-dataset is true, then this is the ID number of the dataset to which the directory belongs. This field is deprecated in favor of datasets, which lists all datasets the directory belongs to. It is still populated with one of the dataset ids.
datasets		dataset-reference[]	A list of the names and identifiers of the datasets this directory belongs to. If is-in-dataset is false, this list will be empty.
dir-id		integer	ID of the directory. Range: [1..2^31-1]
host-id		integer	ID of the host that contains this directory. Range: [1..2^31-1]
host-name		string	Name of the host that contains this directory.
is-available		boolean optional	True if this directory and it's parent host are up and online. Since OSSV hosts can only be contacted with valid credentials, if the login credentials are unset or invalid, the is-available status will be false. Only output if the call to iter-start included the "include-is-available" flag.
is-browsable		boolean	Set to true if the directory path can be used as an input to dp-ossv-directory-browse-iter-start. If set to false, this path is guaranteed not to have browsable child paths.
is-dp-ignored		boolean	Indicates that the directory is marked as ignored by Freya/DFM for the purposes of data protection.
is-in-backup-relationship		boolean	Indicates that the directory is in a backup relationship.
is-in-dataset		boolean	Indicates if the directory is a member of any dataset.
path		string	Path of the directory.

Name of one subdirectory. The name is relative to the parent directory ("directory-path" in the dp-ossv-directory-browse-iter-start API). If the parent directory was empty, then this will be an absolute path. The name will always end with a slash character appropriate to the host operating system of the OSSV agent, unless the path is a special directory which has no children.

[none]

Information about one filesystem root.

Name	Range	Type	Description
filesystem-device		string optional	Filesystem device from NDMP. Included only if fs-info is true.
filesystem-state		string optional	Filesystem state from NDMP. Included only if fs-info is true.
filesystem-type		string optional	Filesystem type from NDMP. Included only if fs-info is true.
host-id		integer	ID of the host that contains this root. Range: [1..2^31-1]
host-name		string	Name of the host that contains this root.
root-path		string	Path of the filesystem root. For example: "C:\" or "/".

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

[none]

Application related information.

Name	Range	Type	Description
can-backup		boolean	If true this component can be added to a dataset.
is-leaf		boolean	If true this path cannot be browsed further. If false the path can be specifed as input to the dp-ossv-application-list-info-iter-start zapi.
name		string	The display name for the application component.
path		string	The application path to be used for further browsing components under this path.
unique-id		string optional	Universal unique identifier for the application component.

OSSV host related information.

Name	Range	Type	Description
host-full-name		obj-full-name	The fully qualified domain name of the host.
host-id		obj-id	The ID of the OSSV host.
host-name		obj-name	The name of the OSSV host.

Name or ID of a host. IP addresses are also accepted.

[none]

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.

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]