Input Name	Type
DpRelationshipListInfoIterEnd	DpRelationshipListInfoIterEnd
Output Name	Type
DpRelationshipListInfoIterEndResult	DpRelationshipListInfoIterEndResult

Error Name	Description
EINVALIDTAG

Get next few Records in the iteration started by DpRelationshipListInfoIterStart.

Input Name	Type
DpRelationshipListInfoIterNext	DpRelationshipListInfoIterNext
Output Name	Type
DpRelationshipListInfoIterNextResult	DpRelationshipListInfoIterNextResult

Error Name	Description
EINVALIDTAG

Starts iteration To list data protection relationships. These are SnapVault or SnapMirror relationships formed in order To implement data protection Policy for a Dataset. You can list relationships for a single Policy connection or for a particular Source or destination storage server.

Input Name	Type
DpRelationshipListInfoIterStart	DpRelationshipListInfoIterStart
Output Name	Type
DpRelationshipListInfoIterStartResult	DpRelationshipListInfoIterStartResult

Error Name	Description
EDATABASEERROR
EINVALIDINPUT
EOBJECTNOTFOUND

Modify settings of a SnapVault, Qtree SnapMirror or Volume SnapMirror relationship.

Input Name	Type
DpRelationshipModify	DpRelationshipModify
Output Name	Type
DpRelationshipModifyResult	DpRelationshipModifyResult

Error Name	Description
EACCESSDENIED
EAPIERROR
EDATABASEERROR
EINVALIDINPUT
EOBJECTNOTFOUND

Ends iteration To list data protection relationships.

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

[none]

Get next few Records in the iteration started by DpRelationshipListInfoIterStart.

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

Name	Type	Description
DpRelationships	ArrayOfDpRelationshipInfo	List of SnapVault and SnapMirror relationships.
Records	xsd:integer	The number of Records actually returned. Range: [0..2^31-1]

Starts iteration To list data protection relationships. These are SnapVault or SnapMirror relationships formed in order To implement data protection Policy for a Dataset. You can list relationships for a single Policy connection or for a particular Source or destination storage server.

Name	Type	Description
ConnectionId	xsd:integer optional	Identifier of Policy connection. If present, only list relationships protecting this connection of the data protection Policy. If specified, DatasetNameOrId must also be specified. Range: [1..2^31-1]
DatasetNameOrId	ObjNameOrId optional	Name or identifier of Dataset. Relationships protecting any connection of this Dataset are listed.
DestinationId	ObjId optional	Identifier of the destination Qtree, Volume, Aggregate or Storage System. If not present, relationships To all destinations are listed.
DestinationType	RelationshipEndpointType optional	If present, list only relationships where the destination is of the specified Type. If not present, list all relationships.
IncludeDeleted	xsd:boolean optional	If present and true, relationships which are marked as deleted in the database are also returned. Otherwise, deleted relationships are not returned.
IsDpIgnored	xsd:boolean optional	If present and true, only list relationships for which the Source object has been marked as ignored for data protection. If present and false, only list relationships for which the Source object has not been marked as ignored. If not present, list all relationships.
IsDpManaged	xsd:boolean optional	If present and true, only list relationships which are To be managed by Protection Manager. If present and false, only list relationships which are not To be managed by Protection Manager. If not present, list all relationships.
IsInDataset	xsd:boolean optional	If present and true, only list relationships which are in a Dataset. If present and false, only list relationships for which are not in a Dataset. If not present, list all relationships.
IsMigrationRelationship	xsd:boolean optional	If true, only relationships created for migration are returned. If DatasetNameOrId is specified with this flag, the migration relationships for the Members of that Dataset will be returned along with the relationship of the root volume/qtree of the vFiler Unit associated with the root node of the Dataset. It is invalid To specify IsInDataset or ConnectionId fields when is-migraton-relationship is true. If false or not present all relationships will be returned. Default Value is false.
OperationalStatuses	ArrayOfOperationalStatus optional	If specified, the relationships in any of these statuses are only returned.
RelationshipId	ObjId optional	Identifier of relationship To list. If unspecified, all relationships are listed.
RelationshipStates	ArrayOfRelationshipState optional	If specified, the relationships in any of these states are only returned.
RelationshipType	RelationshipType optional	If present, list only relationships of specified Type. If not present, list all relationships.
SourceId	ObjId optional	Identifier of the Source Qtree, OSSV Directory, Volume, Aggregate, Storage System, or OSSV Host. If not present, relationships From all sources are listed.
SourceOrDestinationId	ObjId optional	Identifier of either a Source or a destination object. If empty, all relationships are listed. The Source or destination object must be either a Host, Aggregate, Volume, Qtree, OSSV Directory or DFM Group.
SourceType	RelationshipEndpointType optional	If present, list only relationships where the Source is of the specified Type. If not present, list all relationships.

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

Modify settings of a SnapVault, Qtree SnapMirror or Volume SnapMirror relationship.

Name	Type	Description
IsDpImported	xsd:boolean optional	If present and true this relationship will be marked as imported but only if IsDpManaged is also present and true. It is an Error for IsDpImported To be true when IsDpManaged is not present or present and false. If IsDpImported is present and false, clear the IsDpImported flag reguardless of the IsDpManaged being present. If a relationship has the IsDpImported flag set then the relationship will not be cleaned up after a containing Dataset has been deleted unless the fully automatic cleanup mode is active.
IsDpManaged	xsd:boolean optional	If present and true, set the IsDpManaged flag for this relationship. If present and false, clear the IsDpManaged flag for this relationship. If not present, IsDpManaged flag is not changed. If a relationship has the IsDpManaged flag set, then Protection Manager is allowed To modify the relationship as necessary To make the relationship conform To a data protection Policy. This includes modifying any settings or schedules of the relationship, or deleting the relationship if no longer needed. Protection Manager also has the responsibility of updating the relationship as necessary, either using its own schedules or setting an ONTAP schedule for this relationship. If the IsDpManaged flag is clear, Protection Manager will not modify, update, or delete this relationship.
RelationshipId	ObjId	Identifier of the relationships To be modified.

[none]

Name	Type	Description
DpRelationshipInfo	DpRelationshipInfo[]

Name	Type	Description
OperationalStatus	OperationalStatus[]

Name	Type	Description
RelationshipState	RelationshipState[]

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

[none]

Type of an object at either the Source or destination of a data protection relationship. Values for Source Objects are "ossv_directory", "Volume" or "Qtree". Values for destination Objects are "Volume" or "Qtree".

[none]

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

[none]

Information about a single SnapVault or SnapMirror relationship. Currently, there are three kinds of relationships: SnapVault, Qtree SnapMirror (QSM) and Volume SnapMirror (VSM).

Name	Type	Description
DatasetId	ObjId optional	ID of the Dataset this relationship is protecting. Not present if this relationship is not protecting a component of a Dataset.
DatasetName	ObjName optional	Name of the Dataset this relationship is protecting. Not present if this relationship is not a protecting a component of a Dataset.
DeletedBy	xsd:string optional	The user who deleted the relationship.
DeletedTimestamp	DpTimestamp optional	The time and date when the relationship was deleted.
DestinationAggregateId	ObjId optional	DFM object ID of destination Aggregate. If the destination object is a Qtree, this is the ID of the Aggregate containing the Volume that contains the Qtree.
DestinationFullName	ObjFullName	Full Name of storage object where this relationship ends.
DestinationHostId	ObjId	DFM object ID of destination Host.
DestinationHostName	ObjFullName	Fully-qualified domain Name of destination Host.
DestinationId	ObjId	DFM Object ID of storage object where this relationship ends.
DestinationName	ObjName	Name of storage object where this relationship ends.
DestinationStoragesetId	ObjId optional	DFM object ID of the storage set for the destination for this relationship. This element is only valid for the Query if ConnectionId was supplied.
DestinationType	RelationshipEndpointType	Type of the destination storage object. SnapVault and Qtree SnapMirror relationships always terminate at a Qtree. Volume SnapMirror relationships always terminate at a Volume.
DestinationVolumeId	ObjId optional	DFM object ID of destination Volume. If the destination object is a Qtree, this is the ID of the Volume containing that Qtree.
DiscoveredTimestamp	DpTimestamp	The time and date when the relationship was discovered.
IsDpIgnored	xsd:boolean	True if the Source object for this relationship is being ignored by Protection Manager. See the discussion section for the meaning of "ignoring" Objects.
IsDpImported	xsd:boolean	True if this relationship was at some earlier time imported into a Protection Manager Dataset. A relationship may be marked as imported and dp managed and yet not be in a Dataset.
IsDpManaged	xsd:boolean	True if this relationship is set To be managed by Protection Manager. See the discussion section for the meaning of "being managed".
IsDpOrphan	xsd:boolean	True if this relationship is considered an orphan by Protection Manager. An orphan relationship is a relationship that is managed by Protection Manager and was once part of a Dataset but is no longer contained in a Dataset.
IsDpRedundant	xsd:boolean	True if this relationship is considered To be a redundant relationship by Protection Manager. A redundant relationship duplicates the need of a Dataset connection by having it's Source and destination between the same two nodes as another relationship in the same Dataset. It is possible To have more than one redundant relationship in the same Dataset.
IsInDataset	xsd:boolean	True if the Source object for this relationship matches a Dataset. A relationship is considered To Match a data set if: the Source object is a member of a storage set the destination object is a member of a storage set both storage sets are assigned To adjacent nodes of a single Dataset. If the relationship does not Match the above criteria, it is not considered part of a Dataset.
Lag	xsd:integer	Seconds since the completion of the last successful transfer To the destination. This Value is undefined and will be returned as 0 for Unintialized relationshaps. Range: [0..2^31-1]
LagStatus	ObjStatus	Lag Status of the relationship Lag versus the DP Policy Lag threshold settings. Possible Values are "unknown", "normal", "warning" and "Error".
OperationalStatus	OperationalStatus	Status of the relationship
RelationshipId	ObjId	Identifier of the relationship.
RelationshipState	RelationshipState	State of the relationship
RelationshipType	RelationshipType	Type of the relationship.
SourceAggregateId	ObjId optional	DFM object ID of Source Aggregate. Not present if the Source object is an OSSV Directory.
SourceFullName	ObjFullName	Full Name of storage object where this relationship originates.
SourceHostId	ObjId	DFM object ID of Source Host.
SourceHostName	ObjFullName	Fully-qualified domain Name of Source Host.
SourceId	ObjId	DFM object ID of storage object where this relationship originates.
SourceName	ObjName	Name of storage object where this relationship originates.
SourceStoragesetId	ObjId optional	DFM object ID of the storage set for the Source for this relationship. This element is only valid for the Query if ConnectionId was supplied.
SourceType	RelationshipEndpointType	Type of the Source storage object. SnapVault relationships originate at either a Qtree or OSSV Directory. Qtree SnapMirror relationships originate at a Qtree. Volume SnapMirror relationships originate at a Volume.
SourceVolumeId	ObjId optional	DFM object ID of Source Volume. Not present if the Source object is an OSSV Directory.

Status of the relationship. Possible Values are "idle", "transferring", "pending", "aborting", "migrating", "quiescing", "resyncing", "waiting", "syncing", "in_sync" or "paused". idle: No data is being transferred. transferring: Transfer has been initiated, but has not yet finished, or is just finishing. pending: The secondary storage system cannot be updated because of a Resource issue; the transfer is retried automatically. aborting: A transfer is being aborted and cleaned up. migrating: Valid only in case of 'qtree_snapmirror' or 'volume_snapmirror' relationships. quiescing: The specified Volume or Qtree is waiting for all existing transfers To complete. The destination is being brought into a stable state. resyncing: The specified Volume or Qtree is being matched with data in the common Snapshot copy. waiting: Valid only in case of 'qtree_snapmirror' or 'volume_snapmirror' relationships. SnapMirror is waiting for a new tape To be put in the tape device. syncing: Valid only in case of 'qtree_snapmirror' or 'volume_snapmirror' relationships. in_sync: Valid only in case of 'qtree_snapmirror' or 'volume_snapmirror' relationships. paused: Valid only in case of 'qtree_snapmirror' or 'volume_snapmirror' relationships.

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

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]

Full Name of a DFM object. This typedef is an alias for the builtin ZAPI Type string. An object full Name conforms To all the rules of an ObjName, except that the full Name may be up To 255 characters long. DFM creates full names by concatenating an object Name with any parent object names, so as To create a unique Name for an object. The format of full names is as follows: Host full names are the either the fully-qualified domain Name or the IP Address of the Host. Aggregate full names are the Host Name and the Aggregate Name, separated by a colon, e.g. Hostname:aggr0. Volume full names are the Host Name and the Volume Name, separated by ":/", e.g. Hostname:/volume. Note this does not include "/vol". Volume and Aggregate full names are distinguished by the presence of a forward slash after the colon. Qtree full names are the containing Volume full Name and the Qtree Name, separated by a slash, e.g. Hostname:/volume/qtree. The data not contained by any Qtree may be represented by "-", e.g. Hostname:/volume/-. Lun Path full names are either a Volume or Qtree full Name and the LUN Path, separated by a slash, e.g. Hostname:/volume/LUN or Hostname:/volume/qtree/LUN. Network full names are a network Address block in CIDR format, e.g. 1.2.3.0/8. OSSV Directory full names are the OSSV Host Name and the OSSV Path, separated by a colon, e.g. host-lnx:/usr/local or host-w2k:c:/temp Include any others here... Initiator Group full names are Host Name and the initiator Group Name, separated by a colon, e.g. Hostname:igroup. For any DFM object not listed above, the ObjName and ObjFullName are identical.

[none]

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]