Replication Action Properties

Language:

The replication action properties in the BUI and CLI differ slightly, as described in the following table.

Note - When you change a replication action property, the new setting takes effect with the next replication update unless specified otherwise.

Table 132 Replication Action Properties (BUI and CLI)

BUI Property	CLI Property	Description
Disable compression	`compression`	The replication stream is compressed by default. Disable if compression is provided by another means, such as a WAN accelerator. For more information, see Compressed Replication.
Update frequency: Scheduled or Continuous	`continuous` (True or False)	Select Scheduled or Continuous. For more information, see Replication Update Frequency.
Enable deduplication	`dedup`	When set, enables deduplication on replication streams. For more information, see Deduplicated Replication.
Power icon	`enabled`	When enabled (`true` in the CLI), replication updates can be sent. When disabled (`false` in the CLI), the power icon is not highlighted and replication updates cannot be sent.
Export data path	`export_path`	Specifies the path to an NFS share for this action, using the format: nfs://`server`/`path`. This property exports the replication stream to a file on an NFS server, which can be physically moved to the remote target site, and then imported to a replication target. For procedures, see Creating an Offline Replication BUI, CLI.
Include clone origin as data	`include_clone_origin_as_data`	Controls the replication of each share that was cloned from a share that is external to the replication package on the target. Select this option to insert a complete copy of the clone origin snapshot's data into the replica of the clone. If you deselect this option, a clone created from an external origin snapshot will share storage with the replica of the clone origin snapshot that resides in replication target's pool. Sharing storage saves space, but if the replication target does not contain the external clone origin snapshot, the replication of the clone will fail. For details, see Cloning a Replication Package or Share.
Include Snapshots	`include_snaps`	Determines whether replication updates include non-replication snapshots. For details, see Replication Snapshot Management.
Limit bandwidth	`max_bandwidth`	Specifies a maximum speed for this replication update (in terms of amount of data transferred over the network per second). Use this property to limit bandwidth, especially during an initial replication update. If you change this property during a replication update, the new setting takes effect immediately.
Pool	`pool`	Storage pool on the target where this project will be replicated. This property is specified when an action is initially configured and not shown thereafter.
Recovery point objective [_] `unit of time`	`recovery_point_objective`	Specifies the maximum tolerable amount of data loss in the event of a disaster or major outage. The recovery point objective (RPO) can be specified as days, hours, minutes, or seconds. Set this property when creating or editing a replication action. This property is only used in conjunction with the replica lag warning and error alerts.
Replica lag error alert [_] % of Recovery Point Objective	`replica_lag_error_alert`	Specifies a limit represented as a percentage of the RPO. The source appliance generates a major alert when the replica lag exceeds the specified limit. When the replica lag falls below this value, a minor alert indicates the replica lag is within the error limit.
Replica lag warning alert [_] % of Recovery Point Objective	`replica_lag_warning_alert`	Specifies a limit represented as a percentage of the RPO. The source appliance generates a minor alert when the replica lag exceeds the specified limit. When the replica lag falls below this value, a minor alert indicates the replica lag is within the warning limit.
Retain user snapshots on target	`retain_user_snaps_on_target`	Retains user-generated snapshots on the replication target for the associated action, even after the snapshots are destroyed on the source appliance. The snapshots retained on the target can then be used as part of a disk-to-disk or data backup solution. For details, see Managing User-Generated Snapshots.
Target	`target`	Unique identifier for the replication target system. This property is specified when an action is initially configured and cannot be edited.
Target Pool	`target_pool`	Storage pool on the target where this project will be replicated. This property is displayed when editing an existing replication action.
Enable SSL-encryption	`use_ssl`	When set, encrypts data on the wire using SSL. Using this feature may have an impact on per-action replication performance.

The following table describes the CLI child nodes of replication actions.

Table 133 Replication Action Child Nodes (CLI only)

Replication Action Child Node

Description

autosnaps

Automatically scheduled snapshots, with sub-node automatic. To change the number of snapshots retained for a replication package, select an individual automatic node and modify the keep property.

For information about automatic snapshot management, see Replication Automatic Snapshot Management.

For more information about configuring auto snapshots, see Configuring Automatic Snapshot Retention on a Target (CLI).

stats

Statistics for the most recent replication update, and the accumulated statistics over the lifetime of this replication action. Statistics are updated after replication update completion.

For more information on the stats node properties, see Deduplicated Replication.

The following table describes the CLI read-only replication action properties.

Table 134 Replication Action Properties (CLI Read-only)

CLI Property	Description
`average_throughput`	Describes the average replication throughput.
`bytes_sent`	Number of bytes sent to the replication target.
`estimated_size`	Estimated size of the data to be replicated.
`estimated_time_left`	Estimated time remaining until completion of the replication update.
`export_pending`	Indicates whether an export is pending. Value is `true` or `false`.
`id`	The replication action's unique identifier. The identifier can be used to select an action or its associated replication package using the syntax: `select id=<uniqueid>.`
`last_result`	The result of the last update. Value is `success` or `failed`.
`last_sync`	The last time an update was successfully sent. This value may be unknown if the system has not sent a successful update since boot.
`last_try`	The last time an update was attempted. This value may be unknown if the system has not attempted to send an update since boot.
`next_update`	Date and time when the next attempt will be made. This value could be a date (for a scheduled update), `Sync now`, or `continuous`.
`offline`	Indicates whether the replication update is offline. Value is `true` or `false`.
`origin_pkg_id`	The unique identifier of the replication package from which this action was created when the package was reversed. The origin package identifier is displayed after the first successful replication update completes.
`replica_data_timestamp`	Creation time of the snapshot used in the last successful update.
`replica_lag`	Current replica lag with a format of `hh:mm:ss`.
`replica_lag_over_error_limit`	`true` when the replica lag has exceeded the error limit specified by the combination of the recovery_point_objective and the replica_lag_error_alert threshold.
`replica_lag_over_warning_limit`	`true` when the replica lag has exceeded the warning limit specified by the combination of the recovery_point_objective and the replica_lag_warning_alert threshold.
`replication_of`	Project or share name (under project) where the action is configured.
`source_pool`	Pool name of the source project/share.
`state`	Describes if replication is in progress or not. Values are `sending` or `idle`.
`state_description`	Specifies details on replication progress. The different states are: `Connecting to replication target` `Receiving checkpoint from target` `Estimating size of update` `Building deduplication tables` `Sending update` State `Building deduplication tables` is displayed only if the project or share has deduplication enabled.
`target_id`	The unique identifier of the replication target object that describes the target of this replication action.

Related Topics