Creating a Replication Action (CLI)

A replication action describes the project or share to be replicated, the replication target, the replication schedule, and data transfer properties such as enabling or disabling encryption of the network link.

Caution:

Do not create more than three actions per project. One action per project is typical.

If you are setting up remote replication for the first time, it might be useful to replicate a minimal amount of data to ensure the sync completes successfully. You can either replicate an empty project or choose not to replicate the snapshots in the project/shares.

If you are replicating a large data set and bandwidth is limited due to distance between source and target appliances, you can export the replication to offline media, as described in Configuring Offline Replication (CLI).

Source appliance: Navigate to the project or share, and enter command action.
```
host_source:shares PROJECT1 replication> action
```

Display the properties using the get command.

host_source:shares PROJECT1 action (uncommitted)> get
                        target = (unset)
                          pool = (unset)
                       enabled = true
                    continuous = false
          update_cascade_delay =
                 include_snaps = true
   retain_user_snaps_on_target = false
                         dedup = false
  include_clone_origin_as_data = false
                 max_bandwidth = unlimited
                    bytes_sent = 0
                estimated_size = 0
           estimated_time_left = 00:00:00
 pending_update_estimated_size = 0
 pending_update_estimated_time = 00:00:00
            average_throughput = 0B/s
                       use_ssl = true
                   compression = on
                   export_path =
      recovery_point_objective =
     replica_lag_warning_alert =
       replica_lag_error_alert =
              potential_source = false
                distant_target = false
                     rawcrypto = off

Set the properties for this action.

See Replication Action Properties for a description of CLI properties.

host_source:shares PROJECT1 action-000 (uncommitted)> set target=repl_sys
                         target = repl_sys (uncommitted)
host_source:shares PROJECT1 action-000 (uncommitted)> set pool=pool-0
                             pool = pool-0 (uncommitted)
host_source:shares PROJECT1 action-000 (uncommitted)> set include_snaps=false
                     include_snaps = false (uncommitted)
host_source:shares PROJECT1 action-000 (uncommitted)> set use_ssl=false
                       use_ssl = false (uncommitted)
host_source:shares PROJECT1 action-000> schedule
host_source:shares PROJECT1 action-000 schedule (uncommitted)> set frequency=day
                            frequency = day (uncommitted)
host_source:shares PROJECT1 action-000 schedule (uncommitted)> set hour=23
                                 hour = 23 (uncommitted)
host_source:shares PROJECT1 action-000 schedule (uncommitted)> set minute=05
                               minute = 05 (uncommitted)

Commit the new replication action.

host_source:shares PROJECT1 action-000 schedule (uncommitted)> commit

To view the properties of the newly created action, enter ls:

host_source:shares PROJECT1 replication> ls
 Properties:             
      inherited = false
 Actions:
      TARGET                    STATUS     NEXT
     action-000  repl_sys       idle       manual

host_source:shares PROJECT1 action-000> ls
Properties:

                            id = 49b1ec85-cb8b-436f-8a56-87189c18e066
                     target_id = 45f8a28e-218d-4634-94a2-c913cc582a44
                        target = repl_sys
                  target_pkgid = 49b1ec85-cb8b-436f-8a56-87189c18e066
                   target_pool = pool-0
                       enabled = true
                    continuous = false
          update_cascade_delay =
                 include_snaps = false
   retain_user_snaps_on_target = false
                         dedup = false
  include_clone_origin_as_data = false
                 max_bandwidth = unlimited
                    bytes_sent = 0
                estimated_size = 0
           estimated_time_left = 00:00:00
 pending_update_estimated_size = 25.0329161G
 pending_update_estimated_time = 00:01:25
            average_throughput = 0B/s
                       use_ssl = false
                   compression = on
                   export_path =
                         state = idle
             state_description = Idle (no update in progress)
                export_pending = false
                       offline = false
                   next_update = Tue Apr 08 2025 23:05:00 GMT+0000 (UTC)
        replica_data_timestamp = Tue Apr 08 2025 20:56:51 GMT+0000 (UTC)
                     last_sync = Tue Apr 08 2025 20:57:58 GMT+0000 (UTC)
                      last_try = Tue Apr 08 2025 20:57:58 GMT+0000 (UTC)
                   last_result = success
                   replica_lag = 00:03:33
      recovery_point_objective =
     replica_lag_warning_alert =
       replica_lag_error_alert =
replica_lag_over_warning_limit = false
  replica_lag_over_error_limit = false
              potential_source = false
                distant_target = false
                     rawcrypto = off

Schedules:


NAME                 FREQUENCY            DAY                  HH:MM
schedule-000         day                  -                    23:05

Children:
                        autosnaps => Configure automatic snapshots on target
                        schedules => Configure replication update schedules
                            stats => Replication Action Statistics Properties

The pending_update_estimated_size property shows the estimated data size for the pending replication update (25.0329161G). The pending_update_estimated_time property shows the estimated data transfer time for the pending replication update (00:01:25).

To view the ID of the newly created action, use the last command, which navigates to the node with the new action, combined with get id, which retrieves the action ID.
The ID is used later to select the correct replication action node.
```
host_source:shares PROJECT1 replication> last get id
                               id = 49b1ec85-cb8b-436f-8a56-87189c18e066
```