CreateSnapMirrorRelationship

Contributors netapp-mwallis Download PDF of this page

The Element web UI uses the CreateSnapMirrorRelationship method to create a SnapMirror extended data protection relationship between a source and destination endpoint.

Parameters

This method has the following input parameters:

Name Description Type Default value Required

snapMirrorEndpointID

The endpoint ID of the remote ONTAP storage system communicating with the Element storage cluster.

integer

None

Yes

sourceVolume

The source volume in the relationship.

None

Yes

destinationVolume

The destination volume in the relationship.

None

Yes

relationshipType

The type of relationship. On storage systems running Element software, this value is always “extended_data_protection”.

string

None

No

policyName

Specifies the name of the ONTAP SnapMirror policy for the relationship. If not specified, the default policy name is MirrorLatest.

string

None

No

scheduleName

The name of the pre-existing cron schedule on the ONTAP system that is used to update the SnapMirror relationship. If no schedule is designated, snapMirror updates are not scheduled and must be updated manually.

string

None

No

maxTransferRate

Specifies the maximum data transfer rate between the volumes in kilobytes per second. The default value, 0, is unlimited and permits the SnapMirror relationship to fully utilize the available network bandwidth.

integer

None

No

Return values

This method has the following return values:

Name

Description

Type

snapMirrorRelationship

Information about the newly created SnapMirror relationship.

New since version

10.1