Input Name	Type
DpDashboardGetDrDatasetCounts	DpDashboardGetDrDatasetCounts
Output Name	Type
DpDashboardGetDrDatasetCountsResult	DpDashboardGetDrDatasetCountsResult

Error Name	Description
EDATABASEERROR
EGROUPDOESNOTEXIST
EINTERNALERROR

Get a list of the most lagged Datasets. This API returns a list of some or all Datasets, sorted by Lag time. Only the Datasets Name, ID, and worst relationship Lag time are returned. Error conditions: EGROUPDOESNOTEXIST - The Group Name or ID was not found. EINTERNALERROR - An Error occurred while processing the Request. Try again later. EDATABASEERROR - A database-related Error occurred while processing the Request. Try again later.

Input Name	Type
DpDashboardGetLaggedDatasets	DpDashboardGetLaggedDatasets
Output Name	Type
DpDashboardGetLaggedDatasetsResult	DpDashboardGetLaggedDatasetsResult

Error Name	Description
EDATABASEERROR
EGROUPDOESNOTEXIST
EINTERNALERROR

Get a list of the most lagged relationships. This API returns a list of some or all relationships, sorted by Lag time. Only the relationship Name, ID, and Lag time are returned. Error conditions: EGROUPDOESNOTEXIST - The Group Name or ID was not found. EINTERNALERROR - An Error occurred while processing the Request. Try again later. EDATABASEERROR - A database-related Error occurred while processing the Request. Try again later.

Input Name	Type
DpDashboardGetLaggedRelationships	DpDashboardGetLaggedRelationships
Output Name	Type
DpDashboardGetLaggedRelationshipsResult	DpDashboardGetLaggedRelationshipsResult

Error Name	Description
EDATABASEERROR
EGROUPDOESNOTEXIST
EINTERNALERROR

This zapi call has been deprecated in Juno (4.0) release, because the definitions for "protected" and "unprotected" Objects changed. Please use DpDashboardGetProtectedDataCounts2 instead. Get counts for certain types of Objects for displaying on the Protection Manager Dashboard. The types of Objects are: Datasets, Volumes, Qtrees, and OSSV Directories. For each object Type, the number of protected Objects, unprotected Objects, and ignored Objects is returned. And object is considered To be protected if it is a member of a Dataset, and a Dataset is considered To be protected if it has a protection Policy. Objects are unprotected if they are both not protected and not ignored. Error conditions: EGROUPDOESNOTEXIST - The Group Name or ID was not found. EINTERNALERROR - An Error occurred while processing the Request. Try again later. EDATABASEERROR - A database-related Error occurred while processing the Request. Try again later.

Input Name	Type
DpDashboardGetProtectedDataCounts	DpDashboardGetProtectedDataCounts
Output Name	Type
DpDashboardGetProtectedDataCountsResult	DpDashboardGetProtectedDataCountsResult

Error Name	Description
EDATABASEERROR
EGROUPDOESNOTEXIST
EINTERNALERROR

Get counts for certain types of Objects for displaying on the Protection Manager Dashboard. The types of Objects are: Datasets, Volumes, Qtrees, and OSSV Directories. For each object Type, the number of protected, unprotected and ignored Objects are returned. An object is considered To be protected if it is: 1. A Dataset with a protection Policy assigned, and has conformed at least once. 2. Any Volume or Qtree in a Protection Manager managed relationship. 3. Any Host or Aggregate in a Dataset with protection Policy assigned. 4. Any Host in any Resource pool (does not have To be associated with any Dataset). 5. Any Aggregate that is either in any Resource pool themselves, or is a child of a Host that is a member of any Resource pool. Error conditions: EGROUPDOESNOTEXIST - The Group Name or ID was not found. EINTERNALERROR - An Error occurred while processing the Request. Try again later. EDATABASEERROR - A database-related Error occurred while processing the Request. Try again later.

Input Name	Type
DpDashboardGetProtectedDataCounts2	DpDashboardGetProtectedDataCounts2
Output Name	Type
DpDashboardGetProtectedDataCounts2Result	DpDashboardGetProtectedDataCounts2Result

Error Name	Description
EDATABASEERROR
EGROUPDOESNOTEXIST
EINTERNALERROR

Return number of disaster recovery enabled Datasets in all DrState and DrStatus combinations. The number of Datasets in each distinct dr-state/dr-status combination is returned. Error conditions: EGROUPDOESNOTEXIST - The Group Name or ID was not found. EINTERNALERROR - An Error occurred while processing the Request. Try again later. EDATABASEERROR - A database-related Error occurred while processing the Request. Try again later.

Name	Type	Description
GroupNameOrId	GroupNameOrId optional	If present, limit counts To Datasets which are Members of this Group.

Name	Type	Description
DrStateStatusCounts	ArrayOfDrStateStatusCount	Counts of all Datasets with a distinct dr-state/dr-status combination.

Get a list of the most lagged Datasets. This API returns a list of some or all Datasets, sorted by Lag time. Only the Datasets Name, ID, and worst relationship Lag time are returned. Error conditions: EGROUPDOESNOTEXIST - The Group Name or ID was not found. EINTERNALERROR - An Error occurred while processing the Request. Try again later. EDATABASEERROR - A database-related Error occurred while processing the Request. Try again later.

Name	Type	Description
GroupNameOrId	GroupNameOrId optional	Name or identifier of a Group. Only relationships inside the specified Group will be returned. If no Value is specified, then relationships are returned regardless of Group.
MaxDatasets	xsd:integer optional	The Maximum number of Datasets To return. If not specified, all Datasets are returned. Range: [1..2^31-1]

Name	Type	Description
DpDatasets	ArrayOfDpDatasetLagInfo	List of Datasets.

Get a list of the most lagged relationships. This API returns a list of some or all relationships, sorted by Lag time. Only the relationship Name, ID, and Lag time are returned. Error conditions: EGROUPDOESNOTEXIST - The Group Name or ID was not found. EINTERNALERROR - An Error occurred while processing the Request. Try again later. EDATABASEERROR - A database-related Error occurred while processing the Request. Try again later.

Name	Type	Description
GroupNameOrId	GroupNameOrId optional	Name or identifier of a Group. Only relationships inside the specified Group will be returned. If no Value is specified, then relationships are returned regardless of Group.
IsExternalRelationship	xsd:boolean optional	If true, only list external relationships. Otherwise, list all relationships.
MaxRelationships	xsd:integer optional	The Maximum number of relationships To return. If not specified, all relationships are returned. Range: [1..2^31-1]

Name	Type	Description
DpRelationships	ArrayOfDpRelationshipLagInfo	List of SnapVault and SnapMirror relationships.

This zapi call has been deprecated in Juno (4.0) release, because the definitions for "protected" and "unprotected" Objects changed. Please use DpDashboardGetProtectedDataCounts2 instead. Get counts for certain types of Objects for displaying on the Protection Manager Dashboard. The types of Objects are: Datasets, Volumes, Qtrees, and OSSV Directories. For each object Type, the number of protected Objects, unprotected Objects, and ignored Objects is returned. And object is considered To be protected if it is a member of a Dataset, and a Dataset is considered To be protected if it has a protection Policy. Objects are unprotected if they are both not protected and not ignored. Error conditions: EGROUPDOESNOTEXIST - The Group Name or ID was not found. EINTERNALERROR - An Error occurred while processing the Request. Try again later. EDATABASEERROR - A database-related Error occurred while processing the Request. Try again later.

Name	Type	Description
GroupNameOrId	GroupNameOrId optional	Name or identifier of a Group. Only Objects inside the specified Group will be counted. If no Value is specified, then all Objects are counted, regardless of Group.

Get counts for certain types of Objects for displaying on the Protection Manager Dashboard. The types of Objects are: Datasets, Volumes, Qtrees, and OSSV Directories. For each object Type, the number of protected, unprotected and ignored Objects are returned. An object is considered To be protected if it is: 1. A Dataset with a protection Policy assigned, and has conformed at least once. 2. Any Volume or Qtree in a Protection Manager managed relationship. 3. Any Host or Aggregate in a Dataset with protection Policy assigned. 4. Any Host in any Resource pool (does not have To be associated with any Dataset). 5. Any Aggregate that is either in any Resource pool themselves, or is a child of a Host that is a member of any Resource pool. Error conditions: EGROUPDOESNOTEXIST - The Group Name or ID was not found. EINTERNALERROR - An Error occurred while processing the Request. Try again later. EDATABASEERROR - A database-related Error occurred while processing the Request. Try again later.

Name	Type	Description
GroupNameOrId	GroupNameOrId optional	Name or identifier of a Group. Only Objects inside the specified Group will be counted. If no Value is specified, then all Objects are counted, regardless of Group.

Name	Type	Description
IgnoredDatasetCount	xsd:integer	Number of ignored Datasets. Range: [0..2^31-1]
IgnoredOssvDirectoryCount	xsd:integer	Number of ignored OSSV Directories. Range: [0..2^31-1]
IgnoredQtreeCount	xsd:integer	Number of ignored Qtrees. Range: [0..2^31-1]
IgnoredVolumeCount	xsd:integer	Number of ignored Volumes. Range: [0..2^31-1]
ProtectedDatasetCount	xsd:integer	Number of protected Datasets. Range: [0..2^31-1]
ProtectedOssvDirectoryCount	xsd:integer	Number of protected OSSV Directories. Range: [0..2^31-1]
ProtectedQtreeCount	xsd:integer	Number of protected Qtrees. Range: [0..2^31-1]
ProtectedVolumeCount	xsd:integer	Number of protected Volumes. Range: [0..2^31-1]
UnprotectedDatasetCount	xsd:integer	Number of unprotected Datasets. Range: [0..2^31-1]
UnprotectedQtreeCount	xsd:integer	Number of unprotected Qtrees. Range: [0..2^31-1]
UnprotectedVolumeCount	xsd:integer	Number of unprotected Volumes. Range: [0..2^31-1]

Name	Type	Description
IgnoredDatasetCount	xsd:integer	Number of ignored Datasets. Range: [0..2^31-1]
IgnoredOssvDirectoryCount	xsd:integer	Number of ignored OSSV Directories. Range: [0..2^31-1]
IgnoredQtreeCount	xsd:integer	Number of ignored Qtrees. Range: [0..2^31-1]
IgnoredVolumeCount	xsd:integer	Number of ignored Volumes. Range: [0..2^31-1]
ProtectedDatasetCount	xsd:integer	Number of protected Datasets. Range: [0..2^31-1]
ProtectedOssvDirectoryCount	xsd:integer	Number of protected OSSV Directories. Range: [0..2^31-1]
ProtectedQtreeCount	xsd:integer	Number of protected Qtrees. Range: [0..2^31-1]
ProtectedVolumeCount	xsd:integer	Number of protected Volumes. Range: [0..2^31-1]
UnprotectedDatasetCount	xsd:integer	Number of unprotected Datasets. Range: [0..2^31-1]
UnprotectedOssvDirectoryCount	xsd:integer	Number of unprotected OSSV Directories. Range: [0..2^31-1]
UnprotectedQtreeCount	xsd:integer	Number of unprotected Qtrees. Range: [0..2^31-1]
UnprotectedVolumeCount	xsd:integer	Number of unprotected Volumes. Range: [0..2^31-1]

Name	Type	Description
DpDatasetLagInfo	DpDatasetLagInfo[]

Name	Type	Description
DpRelationshipLagInfo	DpRelationshipLagInfo[]

Name	Type	Description
DrStateStatusCount	DrStateStatusCount[]

Name or ID of a Group. If a Group Name is specified, it must be fully qualified.

[none]

Information about a single Dataset.

Name	Type	Description
DatasetId	ObjId	ID of the Dataset.
DatasetName	ObjName	Name of the Dataset.
LagStatus	ObjStatus	Lag Status of the relationship Lag versus the DP Policy Lag threshold settings. Possible Values are "unknown", "normal", "warning" and "Error".
WorstLag	xsd:integer	Worst Lag time of all the relationships in the Datasets. The Lag time is the number of seconds since the completion of the last successful transfer To the destination for each relationship. Range: [0..2^63-1]

Information about a single SnapVault or SnapMirror relationship.

Name	Type	Description
Lag	xsd:integer	Seconds since the completion of the last successful transfer To the destination. If no transfer has ever succeeded, this Value is 0. Range: [0..2^63-1]
RelationshipId	ObjId	Identifier of the relationship.
RelationshipSource	ObjName	Full Path of the Source object of the relationship.
RelationshipState	RelationshipState	State of the relationship
RelationshipType	RelationshipType	Type of the relationship.

Number of DR-enabled Datasets with a single distinct dr-state/dr-status combination.

Name	Type	Description
Count	xsd:integer	Number of DR-enabled Datasets with a state of DrState and Status of DrStatus. Only return state and Status combinations which have at least one Dataset in them. Range: [1..2^31-1]
DrState	DrState	DR state of all Datasets
DrStatus	DrStatus	DR Status of all Datasets

Disaster recovery states of a Dataset. Possible Values are: "ready": The Dataset is prepared To fail over. "failing_over": The Dataset is in the process of failing over. Eventually, the state of the Dataset will change To either "failed_over" or "failover_error". "failed_over": The Dataset has failed over. The primary data is now considered unavailable and the mirror relationships From the primary To the DR node have been broken. "failover_error": The Dataset attempted To fail over but encountered an Error. User intervention is required To change the state To either "failed_over" or "ready".

[none]

The DR Status has one of the following Values: normal : A DR Operation would likely succeed, and the amount of lost data would be within the Duration specified by the Lag warning threshold. warning : A DR Operation would likely succeed, but the amount of lost data would exceed that specified by the Policy's Lag warning threshold. Error : A DR Operation would likely fail, or would succeed but the amount of lost data would be unacceptable. The DR Status is computed based on all of the following: The Resource Status of the Dataset's DR secondaries. The specific Condition that impacts the Resource Status is the availability of the secondary filers and Volumes. The Status will be Error if either is unavailable. Whether there is sufficient space on the DR secondaries To meet the space guarantees of the primaries. The existence and state of the relationships associated with the Dataset's disaster recovery capable connection. Whether the relationships associated with the Dataset's DR-capable connection are within their Thresholds for Lag warnings and Errors. If the Dataset list iteration's output element IsDrCapable is true, then this element appears in the output. Otherwise, if IsDrCapable is false, this element does not appear in the output.

[none]

Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI Type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed To be 0, which is interpreted as a null Value, e.g., a reference To no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed To assign an ID To an object. Therefore, an input element of Type ObjId is always used To refer To an existing object by its ID. The ZAPI must specify the object's DFM object Type (e.g. Dataset, Host, DP Policy, etc.). Some ZAPIs allow the object To be one of several different types. If the Value of an ObjId input element does not Match the ID of any existing DFM object of the specified Type or types, then typically the ZAPI fails with Error code EOBJECTNOTFOUND. A ZAPI may deviate From this general rule, for example, it may return a more specific Error code. In either case, the ZAPI specification must document its behavior.

[none]

Name of a DFM object. This typedef is an alias for the built in ZAPI Type string. An object Name must conform To the following format: It must contain between 1 and 64 characters. It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9'). In some contexts, a Name may be the empty string (""), which is interpreted as a null Value, e.g., a reference To no object at all. The behavior of a ZAPI when it encounters an Error involving an ObjName input element depends on how the ZAPI uses the input element. Here are the general rules: If the input Name element is used To create a new object with the given Name, or rename an existing object To that Name, and the Name does not conform To the above format, then the ZAPI fails with Error code EINVALIDINPUTERROR. Note that because EINVALIDINPUTERROR is such a common Error code, ZAPI specifications are not required To document cases when they may return it. If the input Name element is used To refer To an existing object with that Name, and there is no object with that Name, then the ZAPI fails with Error code EOBJECTNOTFOUND. Generally the ZAPI specification documents cases when it may return this Error code. A ZAPI may deviate From these general rules, for example, it may return more specific Error codes. In such cases, the ZAPI specification must document its behavior. If an input Name element is used To refer To an existing object, then the ZAPI specification must specify which DFM object Type (e.g. data set, Host, DP Policy, etc.) is allowed. Some ZAPIs allow the object To be one of several different types. See the Description of ObjFullName for examples of valid input formats. Note that there is no requirement that all object names must be unique. However, the names for some specific types of Objects are constrained such that no two Objects of that Type may have the same Name. For example, this constraint applies To Datasets, DP schedules, and DP policies. This means that no two Datasets may have the same Name, but a Dataset may have the same Name as a DP schedule or DP Policy. In general, object names are compared in a case-insensitive manner. This means that, for example, "MyObject" and "MYOBJECT" are considered To be the same Name for purposes of: creating new Objects, renaming existing Objects, or looking up an object by Name. On the other hand, ZAPIs that return an ObjName generally do not change the capitalization at all. For example, if an object's Name has been set To "MyObject", then list iteration ZAPIs that return the object's Name return it as "MyObject" rather than "MYOBJECT" or "myobject". ZAPIs that operate on ObjName Values and do not follow these general rules about case sensitivity must document the rules that they do follow. One important exception To these general rules is that Volumes, Qtrees, OSSV Directories, SRM Paths, Interfaces, FCP Targets and FC switch ports all have case-sensitive names. When looking up Objects of these types by Name, the case must Match the object Name.

[none]

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]

State of the relationship. Possible Values are "uninitialized", "snapvaulted", "snapmirrored", "broken_off", "quiesced", "Source", "unknown" or "restoring" uninitialized: The destination storage Volume or Qtree is not yet initialized or is being initialized. snapvaulted: Valid only in case of 'snapvault' relationships. The relationship is created and the Qtree is a SnapVault secondary destination. snapmirrored: Valid only in case of 'qtree_snapmirror' or 'volume_snapmirror' relationships. The destination Volume or Qtree is in a SnapMirror relationship. broken_off: Valid only in case of 'qtree_snapmirror' or 'volume_snapmirror' relationships. The destination was in a SnapMirror relationship, but a snapmirror break command made the Volume or Qtree writable. This state is reported as long as the base Snapshot copy is still present in the Volume. If the Snapshot copy is deleted, the state is listed as "uninitialized" if the destination is in the /etc/snapmirror.conf filen then the Snapshot copy is no longer listed. A successful snapmirror resync command restores the snapmirrored Status. quiesced: Valid only in case of 'qtree_snapmirror' or 'volume_snapmirror' relationships. SnapMirror is in a consistent internal state and no SnapMirror activity is occurring. In this state, you can create Snapshot copies with confidence that all destinations are consistent. The snapmirror quiesce command brings the destination into this state. The snapmirror resume command restarts all SnapMirror activities. Source: This state is reported when the snapvault Status or snapmirror Status command is run on the primary storage system. When the destination is on another system, its Status is unknown, so the Source Status is reported. In case of 'snapvault' relationships, it also appears if snapvault Status is run on secondary storage systems after the snapvault restore command was run on an associated primary storage system. unknown: The destination Volume or the Volume that contains the destination Qtree is in an unknown state. It might be offline or restricted restoring: Valid only in case of 'snapvault' relationships.

[none]

Type of a data protection relationship. Legal Values are "snapvault", "qtree_snapmirror" and "volume_snapmirror".

[none]