snapmirror initialize

Start a baseline transfer

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

The snapmirror initialize command initializes the destination Vserver, volume or a non-Data ONTAP endpoint of a SnapMirror relationship. The command behaves differently between data protection (DP), extended data protection (XDP) and load-sharing (LS) relationships.

For data protection (DP) and extended data protection (XDP) relationships, the snapmirror initialize command initializes the destination volume.

For load-sharing (LS) relationships, the snapmirror initialize command initializes a new load-sharing mirror in an existing set of load-sharing mirrors. If the command finishes before the start of a scheduled or manual transfer of the set of load-sharing mirrors, the load-sharing mirror is up to date with the set of load-sharing mirrors; otherwise, the load-sharing mirror will be brought up to date at the next scheduled or manual transfer of the set of load-sharing mirrors.

The initial transfer to an empty destination volume is called a baseline transfer. During a baseline transfer for a data protection (DP) or extended data protection (XDP) relationship, the snapmirror initialize command takes a Snapshot copy on the source volume to capture the current image of the source volume. For data protection relationships, the snapmirror initialize command transfers all of the Snapshot copies up to and including the Snapshot copy created by it from the source volume to the destination volume. For extended data protection (XDP) relationships, the snapmirror initialize command behavior depends on the snapmirror policy associated with the relationship. If the policy type is async-mirror then depending on the rules in the policy it can transfer either all the Snapshot copies up to and including the Snapshot copy created by it or only the Snapshot copy created by it from the source volume to the destination volume. For extended data protection (XDP) relationships with policy type vault or mirror-vault the snapmirror initialize transfers only the Snapshot copy created by it.

After the snapmirror initialize command successfully completes, the last Snapshot copy transferred is made the exported Snapshot copy on the destination volume.

You can use the snapmirror initialize command to initialize a specific load-sharing mirror that is new to the set of load-sharing mirrors. An initialize of the new load-sharing mirror should bring it up to date with the other up-to-date destination volumes in the set of load-sharing mirrors.

Note: Using the snapmirror initialize command to initialize a set of load-sharing mirrors will not work. Use the snapmirror initialize-ls-set command to initialize a set of load-sharing mirrors.

If a SnapMirror relationship does not already exist, that is, the relationship was not created using the snapmirror create command, the snapmirror initialize command will implicitly create the SnapMirror relationship, with the same behaviors as described for the snapmirror create command before initializing the relationship. This implicit create feature is not supported for Vservers.

This command is supported for SnapMirror relationships with the field "Relationship Capability" showing as either "8.2 and above" or "Pre 8.2" in the output of the snapmirror show command.

For relationships with "Relationship Capability" of "8.2 and above", you can track the progress of the operation using the snapmirror show command.

For relationships with "Relationship Capability" of "Pre 8.2", a job will be spawned to operate on the SnapMirror relationship, and the job id will be shown in the command output. The progress of the job can be tracked using the job show and job history show commands.

The snapmirror initialize command must be used from the destination Vserver or cluster.

Parameters

{ [-source-path | -S {<[vserver:][volume]>|<[[cluster:]//vserver/]volume>|<hostip:/lun/name>|<hostip:/share/share-name>}] - Source Path
This parameter specifies the source endpoint of the SnapMirror relationship in one of four path formats. The normal format includes the names of the Vserver (vserver) and/or the volume (volume). To support relationships with "Relationship Capability" of "Pre 8.2", a format which also includes the name of the cluster (cluster) is provided. The "Pre 8.2" format cannot be used when operating in a Vserver context on relationships with "Relationship Capability" of "8.2 and above". For SnapMirror relationships with an AltaVault source, the source endpoint is specified in the form hostip:/share/share-name. For SnapMirror relationships with a SolidFire source, the source endpoint is specified in the form hostip:/lun/name.
| [-source-cluster <Cluster name>] - Source Cluster
Specifies the source cluster of the SnapMirror relationship. If this parameter is specified, the -source-vserver and -source-volume parameters must also be specified. This parameter is only applicable for relationships with "Relationship Capability" of "Pre 8.2". This parameter cannot be specified when operating in a Vserver context on relationships with "Relationship Capability" of "8.2 and above".
[-source-vserver <vserver name>] - Source Vserver
Specifies the source Vserver of the SnapMirror relationship. For relationships with volumes as endpoints, if this parameter is specified, parameters -source-volume and for relationships with "Relationship Capability" of "Pre 8.2", -source-cluster must also be specified. This parameter is not supported for relationships with non-Data ONTAP source endpoints.
[-source-volume <volume name>]} - Source Volume
Specifies the source volume of the SnapMirror relationship. If this parameter is specified, parameters -source-vserver and for relationships with "Relationship Capability" of "Pre 8.2", -source-cluster must also be specified. This parameter is not supported for relationships with non-Data ONTAP source endpoints.
{ -destination-path {<[vserver:][volume]>|<[[cluster:]//vserver/]volume>|<hostip:/lun/name>|<hostip:/share/share-name>} - Destination Path
This parameter specifies the destination endpoint of the SnapMirror relationship in one of four path formats. The normal format includes the names of the Vserver (vserver) and/or volume (volume). To support relationships with "Relationship Capability" of "Pre 8.2", a format which also includes the name of the cluster (cluster) is provided. The "Pre 8.2" format cannot be used when operating in a Vserver context on relationships with "Relationship Capability" of "8.2 and above". For SnapMirror relationships with AltaVault destinations, the destination endpoint is specified in the form hostip:/share/share-name. For relationships with SolidFire destinations, the destination endpoint is specified in the form hostip:/lun/name.
| [-destination-cluster <Cluster name>] - Destination Cluster
Specifies the destination cluster of the SnapMirror relationship. If this parameter is specified, parameters -destination-vserver and -destination-volume must also be specified. This parameter is only applicable for relationships with "Relationship Capability" of "Pre 8.2". This parameter cannot be specified when operating in a Vserver context on relationships with "Relationship Capability" of "8.2 and above".
-destination-vserver <vserver name> - Destination Vserver
Specifies the destination Vserver of the SnapMirror relationship. For relationships with volumes as endpoints, if this parameter is specified, parameters -destination-volume and for relationships with "Relationship Capability" of "Pre 8.2", -destination-cluster must also be specified. This parameter is not supported for relationships with non-Data ONTAP destination endpoints.
-destination-volume <volume name>} - Destination Volume
Specifies the destination volume of the SnapMirror relationship. If this parameter is specified, parameters -destination-vserver and for relationships with "Relationship Capability" of "Pre 8.2", -destination-cluster must also be specified. This parameter is not supported for relationships with non-Data ONTAP destination endpoints.
[-source-snapshot | -s <text>] - Source Snapshot
This optional parameter specifies the Snapshot copy that snapmirror initialize will use for the baseline transfer. For data protection (DP) relationships, the baseline transfer will include all of the Snapshot copies up to and including the specified Snapshot copy. For extended data protection (XDP) relationships, the snapmirror initialize command behavior depends on the snapmirror policy associated with the relationship. If the policy type is async-mirror then depending on the rules in the policy it can transfer either all the Snapshot copies up to and including the specified Snapshot copy or only the specified Snapshot copy from the source volume to the destination volume. For extended data protection (XDP) relationships with policy type vault or mirror-vault the snapmirror initialize transfers only the specified Snapshot copy. This parameter is not supported for relationships with "Relationship Capability" of "Pre 8.2".
[-type <snapmirrorType>] - Snapmirror Relationship Type
Specifies the type of SnapMirror relationship if a relationship is implicitly created. This parameter is the same as the one used in the snapmirror create command.
[-policy <sm_policy>] - SnapMirror Policy
This optional parameter designates the name of the SnapMirror policy which is associated with the SnapMirror relationship. If you do not designate a policy, the current policy will be retained. This parameter is not applicable to relationships with "Relationship Capability" of "Pre 8.2".
Note: You define and name a policy using the snapmirror policy create command.
[-throttle | -k <throttleType>] - Throttle (KB/sec)
This optional parameter limits the network bandwidth used for the initialize transfer. It sets the maximum rate (in Kbytes/sec) at which data can be transferred during the operation. If this parameter is not specified, the throttle value configured for the relationship with the snapmirror create or snapmirror modify command will be used. To fully use the network bandwidth available, set the throttle value to unlimited or 0. The minimum throttle value is four Kbytes/sec, so if you specify a throttle value between 1 and 4, it will be treated as if you specified 4. For FlexGroup relationships, the throttle value is applied individually to each constituent relationship. The -throttle parameter does not affect load-sharing transfers and transfers for other relationships with "Relationship Capability" of "Pre 8.2" confined to a single cluster.
[-transfer-priority {low|normal}] - Transfer Priority
This optional parameter specifies the priority at which the transfer runs. The default value for this parameter is the value in the SnapMirror policy associated with this relationship. This parameter is not applicable to relationships with a "Relationship Capability" of "Pre 8.2".
[-is-auto-expand-enabled {true|false}] - Is Auto Expand Enabled
This optional parameter specifies whether or not a FlexGroup SnapMirror relationship and its destination FlexGroup should be auto-expanded if the source FlexGroup is expanded. This parameter is supported only for FlexGroup SnapMirror relationships. If this initialize is creating a new Snapmirror relationship, the default value is true. If it is not creating a new relationship, if a value is specified, it must match the current value for the existing relationship. If the parameter is not specified the existing value will be retained.
[-foreground | -w [true]] - Foreground Process
This specifies whether the operation runs as a foreground process. If this parameter is specified, the default setting is true (the operation runs in the foreground). When set to true, the command will not return until the process completes. This parameter is only applicable to relationships with "Relationship Capability" of "Pre 8.2".

Examples

To start the initial transfer for the SnapMirror relationship with the destination endpoint vs2.example.com:dept_eng_dp_mirror2 after the relationship has been created with the snapmirror create command, type the following command:

vs2.example.com::> snapmirror initialize -destination-path
       vs2.example.com:dept_eng_dp_mirror2

For relationships with "Relationship Capability" of "Pre 8.2", to start the initial transfer for the SnapMirror relationship with the destination endpoint cluster2://vs2.example.com/dept_eng_dp_mirror2 after the relationship has been created with the snapmirror create command, type the following command:

cluster2::> snapmirror initialize -destination-path
         cluster2://vs2.example.com/dept_eng_dp_mirror2

To create a data protection mirror relationship between the source endpoint vs1.example.com:dept_mkt, and the destination endpoint vs2.example.com:dep_mkt_dp_mirror, and start the initial transfer, type the following command:

vs2.example.com::> snapmirror initialize -destination-path
         vs.example.com2:dept_mkt_dp_mirror
         -source-path vs1.example.com:dept_mkt

To create a data protection mirror relationship between the source endpoint cluster1://vs1.example.com/dept_mkt, and the destination endpoint cluster2://vs2.example.com/dep_mkt_dp_mirror, and start the initial transfer when the source cluster is running Data ONTAP 8.1 software, type the following command:

cluster2::> snapmirror initialize -destination-path
         cluster2://vs2.example.com/dept_mkt_dp_mirror
         -source-path cluster1://vs1.example.com/dept_mkt
 

To create an extended data protection (XDP) relationship between the Data ONTAP source endpoint vs1.example.com:data_ontap_vol, and the AltaVault destination endpoint 10.0.0.11:/share/share1, and start the initial transfer, type the following command:

vs1.example.com::> snapmirror initialize -destination-path
	10.0.0.11:/share/share1
	-source-path vs1.example.com:data_ontap_vol -type XDP

To start the initial transfer for the Vserver SnapMirror relationship with destination endpoint dvs1.example.com: after the relationship was created with the snapmirror create command, type the following command:

cluster2::> snapmirror initialize -destination-path
         dvs1.example.com:
Under PVR control to create a SnapMirror synchronous Consistency Group relationship with the following attributes:
  • It is between the source Consistency Group cg_src in Vserver vs1.example.com, and the destination Consistency Group cg_dst in Vserver vs2.example.com.
  • It has item mappings between lun1 and lun2 on volume srcvol and lun1 and lun2 on volume dstvol.
  • It uses a policy named Sync that has a policy type of sync-mirror that the user has previously created.
and initialize it and bring it InSync, type the following command:
vs2.example.com::> snapmirror initialize -destination-path
         vs2.example.com:/cg/cg_dst -source-path
         vs1.example.com:/cg/cg_src -type XDP -policy Sync
         -cg-item-mappings /vol/srcvol/lun1:@/vol/dstvol/lun1,
                           /vol/srcvol/lun2:@/vol/dstvol/lun2

Under PVR control to initialize the relationship with destination Consistency Group cg_dst in Vserver vs2.example.com that has been created with the snapmirror create command and bring it InSync, type the following command:

vs2.example.com::> snapmirror initialize -destination-path
         vs2.example.com:/cg/cg_dst