Key Operation Tasks

1. Log on to an SSH client, and connect to your system as the root user.
2. At the prompt, enter the following command to edit the .bash_profile file:

   vi ~/.bash_profile

3. Within the editor, press i to insert text.
4. Add the following lines to the bottom of the file:

   MANPATH=$MANPATH:/opt/quantum/flexsync/man

   export MANPATH

   Example

   # .bash_profile

   # Get the aliases and functions

   if q[ -f ~/.bashrc ]; then

   . ~/.bashrc

   fi

   # User specific environment and startup programs

   PATH=$PATH:$HOME/bin

   export PATH

   MANPATH=$MANPATH:/opt/quantum/flexsync/man

   export MANPATH

5. Press Esc and then enter :w to write the changes to the file.

6. Press Esc and then enter :q to exit the editor.

7. Log out of your system, and then log in to apply the changes.
8. At the prompt, enter the following command to view a man page for a command:

   man <command>

   The following information displays for each command:

   Command	Information
   flexsync	Name Synopsis Description General Options Examples See Also
   flexsyncd	Name Synopsis Description Options See Also
   flexsyncadmin	Name Synopsis Description Options Commands Task Editing SubCommands Examples See Also
   flexsyncadmind	Name Synopsis Description Options See Also
   flexsync_gather	Name Synopsis Description See Also

9. Press the Spacebar on the keyboard to page through the man page.
10. Type q and press Enter to exit the man page.

The hostgroup is a container for the hosts that you assign as a source and as a target system. If you have multiple systems you want to replicate, you can configure multiple Hostgroups. To configure a replication task, you must first add a hostgroup.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.
2. In the Hostgroup column, click to display the Hostgroup configuration dialog box.
3. In the Name field, enter a label for the hostgroup.

4. Click Submit to add the hostgroup.

Note: You can change the name of your hostgroup by clicking the cogwheel and then clicking the Edit icon.

You can now add one or more hosts to your hostgroup. A host is what you assign as either a source or target system.

Note: The host's flexsyncd daemon must be running and reachable at its configured DNS name or IP address to successfully complete this task.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.

2. In the Hosts column, click to display the Host configuration dialog box.

   Note: In the Hostgroups column, if you click a hostgroup, the hostgroup information is prepopulated in the Host configuration dialog box.

   Basic Tab

   1. In the Name field, enter a label for the host.
   2. In the Hostgroup field, select a hostgroup, unless it is already prepopulated.

   3. In the Hostname field, enter the DNS name or IP address for the replication transport.

   4. In the Admin port field, update the port number, as needed. The default port is 10453.

   5. In the Data port field, update the port number, as needed. The default port is 10454.

   6. In the SSL port field, update the port number, as needed. The default port is 10554.

   7. In the Username field, enter your FlexSync user name.

   8. In the Password field, enter your FlexSync password.

   Advanced Tab

   Select a check box to enable a setting or clear a check box to disable a setting, as needed:

   Check Box

   Description

   Bandwidth Throttling

   Select this option to restrict the bandwidth across all of the active tasks for the selected host, to the specified value. By default, bandwidth throttling is disabled. To enable: Check Bandwidth Throttling. In the bandwidth limit field, enter a value. Note: The minimum bandwidth limit value is 1 MiB per second (MiB/s). Select a data transfer rate from the list. Enter 0 to disable bandwidth throttling. Note: If you enable bandwidth throttling, the rate I/O is not guaranteed. Initially, your data transfers might experience a bit of variation where the host’s transfer rate, as shown in the GUI, can be slightly higher or lower than the requested transfer rate. The transfer rate eventually settles in to the requested transfer rate. Also, the transfer rate shown by the GUI is an average across the running time of all active tasks. If you update the bandwidth limit mid-stream, then FlexSync throttles up or down to that limit immediately, but it might take an extended period of time for the average to reflect the updated bandwidth limit. Caution: Use caution if you attempt to mix Bandwidth Throttling and Storage Manager. If you run FlexSync on a throttled link or if the link is substantially slower than the minimum tape drive read speed, see Considerations for Low Network Bandwidth Tape Retrieval for configuration options.

3. Click Submit to apply all of your changes and to add the host. The FlexSync dashboard now displays your configured hosts in the Hosts column. You can change the name of your hosts by clicking the cogwheel and then clicking the Edit icon.

4. (Optional) Repeat the procedure for each host participating in file replication.

A Task defines what files and directories to replicate from your source system to a location you define on the target system(s).

Note: When you configure a replication task, you can only configure one task to write to a destination directory. In other words, you cannot overlap or run multiple tasks to run the same replication on the same directory structure concurrently/simultaneously.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.

2. In the Tasks column, click to display the Task Configuration dialog box.

   Note: In the Hosts column, if you click a host, the host information is prepopulated in the Task Configuration dialog box.

3. On the Basic tab, complete the information to define the source and destination directories.
   Basic Tab

   1. In the Task name field, enter a label for the task.
   2. In the Hostgroup field, select a hostgroup.
   3. From the Source list, select the source host.
   4. In the /source/path field, enter the file system mount and relation path of the source host to replicate, such as /stornext/snfs1/data.
   5. From the Destination list, select the destination (or target) host.

   6. In the /destnation/path field, enter the file system mount and relation path of the destination host to replicate data to, such as /stornext/snfs2/target.

      Note: The target directory does not need to exist; the system automatically creates the directory if you do not include the last forward slash in the source directory path field.

      Caution: Do not assign a StorNext file system mount point as a destination path. If you assign a StorNext file system mount point as a destination path, some FlexSync features behave unexpectedly (such as versioning and extraneous file deletion).

      Additional Information

      Keep in mind that the syntax of the directory path will determine how it is replicated.

      Example 1: Replicate an Entire Directory

      Source: /stornext/snfs1/data → Target: /stornext/snfs2/target

      The entire source /stornext/snfs1/data directory is replicated to a new /stornext/snfs2/target/data directory on the target.

      Example 2: Replicate All Files Within a Directory

      Source: /stornext/snfs1/data/ → Target: /stornext/snfs2/target

      All source files in the /stornext/snfs1/data/ directory are replicated directly to the /stornext/snfs2/target/ directory without the creation of a new /data directory.

   7. (Optional) Click Allow mount point as a destination directory to confirm that you want to allow a mount point as a destination directory and disable a warning prompt, according to the rules below:

      Caution: If you upgraded to FlexSync 2.2.0 (or later) and your configuration contains a destination that is also a mount point, then you MUST enable the Allow mount point as a destination directory option to edit your existing task.

      • If your destination directory is a mount point, the source directory has a trailing slash and is NOT mounted then you receive a warning.
      • If your destination directory is a mount point, the source directory has a trailing slash and is mounted, and the Delete extraneous files on destination option is enabled, then you receive a warning.
      • If your destination directory is a mount point, the source directory has a trailing slash and is mounted, and the Delete extraneous files on destination option is NOT enabled, then you do NOT receive a warning.
      • If you receive a warning prompt, then you must confirm to continue; the Submit button is disabled and you must do one of the following:
        • Click Allow mount point as a destination directory to confirm.
        • Configure your source or destination path by removing the trailing slash.

      Note: If the destination path is a mount point and it is not mounted, then its contents and the results of a FlexSync replication can be hidden after it is mounted. If the destination path is a mount point and it is mounted, and the Delete extraneous files on destination option is enabled, then you can delete the files in the mounted directory.

4. On the Schedule tab, modify the default task schedule, as needed.
   Schedule Tab

   Edit the following values, as needed:

   Value	Description
   Synchronization Schedule	The schedule of replication passes. If the current replication runs beyond the next scheduled pass, the next pass starts immediately after the current pass ends. The default time is 15 minutes. To configure the synchronization schedule, you can modify the following parameters: Minutes Hourly Daily Weekly Monthly Yearly Advanced (You can optionally input a cron expression in the Schedule Cron Expression field in the Schedule > Advanced tab. See Construct a Cron Expression).
   Expire Logs	The minimum amount of time before a replication pass log is deleted. The default is 30 days. Enter 0 to keep logs indefinitely.
   Cool Down	The minimum file age before a file is replicated. Use this setting to skip replication of temporary files. The default is 5 minutes. Enter 0 to disables this option.
   Force Rescanning	The number of days to force file system scans. FlexSync does not scan the file system with every replication pass. The default is 7 days. Enter 0 to disable file system scans.
   Versioning	The smallest interval between version creations of replicated data. The default is 1 day. Enter 0 to disable this option. Note: The versioning option is not supported if you attempt to configure it on a relation point.
   Expire Versions	The period of time between when a version is created and when it is automatically removed. Note: This option has no effect if the Versioning option is disabled. The default is 30 days. Enter 0 to disable this option. Note: The Expire Versions feature is not supported if you attempt to configure it on a relation point.

5. On the Attributes tab, modify the default values, as needed.
   Attributes Tab

   Select a check box to enable a setting or clear a check box to disable a setting, as needed:

   Check Box	Description
   Preserve all	Preserve all standard attributes of the source. Selecting this option selects all sub-values. Note: This option must be selected separately.
   Preserve Unix permissions	Preserve original Unix file permissions of the source.
   Preserve Unix owner	Preserve the source owner.
   Preserve Unix group	Preserve the destination group name of the source.
   Preserve StorNext ACLs	Preserve StorNext ACL settings of the source. Note: This option is only effective when source and destination file systems are both StorNext.
   Preserve modification times	Preserve timestamps indicating the last time the source was updated.
   Preserve Unix device files	Copy Unix device files from the source to the destination.
   Preserve Unix special files	Transfer Unix named sockets and fifos from the source.
   Preserve extended attributes	Copy extended attributes to the destination. When the source and the destination both use native Linux file systems such as ext4, enabling this option may preserve Posix ACLs as a side effect. Note: This option is recommended for macOS clients

6. On the Advanced tab, modify the default values, as needed.
   Advanced Tab

   Select a check box to enable a setting or clear a check box to disable a setting, as needed:

   Check Box	Description
   Delete extraneous files on destination	Delete destination files not found on the source.
   Ignore times	Force update even when the time and size of files on the source match those on the destination.
   Extended logging	Enable auditing.
   File System ID Check	This option is enabled by default. The file system ID FSID is a file system identifier, and provides information about the underlying file system and if the file system has changed. For example, the file system can change when you unmount a mount point or when you change the mount point. Another example is when you exchange a cartridge that you use in an R-series appliance, since the underlying device has a different FSID. You must disable this option if you are using a work-flow where the source is a cartridge drive that can be exchanged. Caution: Do not disable this option for any normal file system to file system operations.
   Delta Compression	This option is enabled by default. The Delta Compression feature allows you to store and transmit the data in the form of differences (deltas) between sequential data rather than complete files. For example, this feature is particularly useful where archival histories of changes are required. Caution: The primary advantage of the delta compression option is to save network bandwidth; however, you must consider the trade-off between bandwidth usage and overall performance. The delta compression option can decrease the duration of the replication process if network speed is slow because it only transfers changed data rather than the full files. If the network speed is fast, then the delta compression option might increase the duration of the replication process due to the additional disk reads and heavy calculations required to calculate the deltas between source and target files; in this case, it might be faster to transfer the entire files by disabling the delta compression option.
   Skip newer files	Skip files that are newer on the destination.
   Don't cross file system boundaries	Do not allow file system mount points to cross.
   Transmit data using SSL	Enable encryption.
   Forced durability	Select one of the following options to define the durability of replicated data. None This option provides the least amount of durability to your replicated data. Example If you experience a power outage, you might lose content that has not been completely replicated. In addition, there might be gaps in data protection. After each task run The synchronization process does not wait for each file to synchronize before beginning the next replication pass. Instead, it waits for the whole file system to be synchronized at the end of the replication pass. After each task run mode has a much lower performance impact than After each file mode, so we recommend it for transfers within a single appliance's file system. However, After each task run mode is not effective in ensuring durability in all cases, such as across multiple appliances sharing a StorNext file system. Example If the kernel experiences a problem with the synchronization process, you may not be able to troubleshoot an issue. After each file The synchronization process waits for each file to finish writing and to be synchronized to the physical storage before beginning the next replication pass. After each file mode can significantly decrease replication performance, but it offers the most durability to your replicated data. We recommend this setting for environments supporting multiple appliances sharing a StorNext file system. Example If you experience a power outage, the file(s) should be guaranteed to survive.
   Exclusions	In the Exclusions field, you can specify an exclusion list of glob patterns, separated by a space, describing files the task should exclude. Note: You cannot use a leading space, an ending space, a file name that contains a space, and/or a directory that contains a space. Note: The pattern is applied in the order it is specified. The example below excludes all files whose names end with ".tmp" and ".pdf", respectively. Example *.tmp *.pdf You can also exclude a full path directory. Note: All paths are relative to the source path of the task to exclude. For example, to exclude the following directories: /stornext/source/group1/dir0 /stornext/source/group1/dir01 /stornext/source/group2/dir0 /stornext/source/group2/dir01 Where the task source path is: /stornext/source In the Exclusions field, enter the pattern: group?/dir* The pattern explicitly excludes any directory labeled group followed by a single character, along with any sub directory beginning with dir. The pattern does not exclude the following directory: /stornext/source/group3/media Note: Path names matching an exclusion pattern are not considered for any operation on the destination, including removal due to the Delete extraneous files on destination feature being enabled. Caution: The Delete extraneous files on destination feature does not apply to files on the exclusion list. If you add an exclusion list to a task that contains the Delete extraneous files on destination feature enabled, then the task discontinues to make new versions of the specified file, but the destination still contains the existing versions of the file made prior to adding the exclusion.

7. Click Submit to add the task.The configured task appears on the FlexSync dashboard. A progress bar displays in the Tasks column, indicating an estimated amount of time for the replication task to complete.

1. Log on to an SSH client, and connect to your system.
2. At the prompt, enter the following command to create a hostgroup:

   /opt/quantum/flexsync/bin/flexsyncadmin -U <username> -P <password> add-hostgroup <name>

   Example

   /opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password add-hostgroup myhostgroup

   Command Parameters

   <username>	User name for flexsyncadmind.
   <password>	Password for flexsyncadmind.
   <name>	Label for the hostgroup.

1. Log on to an SSH client, and connect to your system.

2. At the prompt, enter the following command to add a source host:

   /opt/quantum/flexsync/bin/flexsyncadmin -U <username> -P <password> add-host <hostgroup_name> <host_name> <dns/ip> <username> <password> [admin_port data_port data_ssl_port]

   Example

   /opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password add-host myhostgroup mdc1 10.12.345.678 root passw0rd

   Command Parameters

   <username>	User name for flexsyncadmind.
   <password>	Password for flexsyncadmind.
   <hostgroup_name>	Label for the hostgroup for which you are adding a source host.
   <host_name>	Label for the source host.
   <dns/ip>	DNS name or IP address for the source host.
   <username>	User name to access the source host.
   <password>	Password to access the source host.
   [admin_port]	(Optional) Update the Admin port number, as needed. The default port is 10453.
   [data_port]	(Optional) Update the Data port number, as needed. The default port is 10454.
   [data_ssl_port]	(Optional) Update the SSL port number, as needed. The default port is 10554.

3. At the prompt, enter the following command to add a target host:

   /opt/quantum/flexsync/bin/flexsyncadmin -U <username> -P <password> add-host <hostgroup_name> <host_name> <dns/ip> <username> <password> [admin_port data_port data_ssl_port]

   Example

   /opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password add-host myhostgroup mdc2 10.12.345.679 root passw0rd

   Command Parameters

   <username>	User name for flexsyncadmind.
   <password>	Password for flexsyncadmind.
   <hostgroup_name>	Label for the hostgroup for which you are adding a target host.
   <host_name>	Label for the target host.
   <dns/ip>	DNS name or IP address for the target host.
   <username>	User name to access the target host.
   <password>	Password to access the target host.
   [admin_port]	(Optional) Update the Admin port number, as needed. The default port is 10453.
   [data_port]	(Optional) Update the Data port number, as needed. The default port is 10454.
   [data_ssl_port]	(Optional) Update the SSL port number, as needed. The default port is 10554.

1. Log on to an SSH client, and connect to your system.

2. At the prompt, enter the following command to add a task:

   /opt/quantum/flexsync/bin/flexsyncadmin -U <username> -P <password> add-task <source_host_name> <dest_host_name> <task_ name> <source dir> <destination dir>

   Example

   /opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password add-task mdc1 mdc2 project1 /stornext/snfs1/data /stornext/snfs2/backup

   Command Parameters

   <username>	User name for flexsyncadmind.
   <password>	Password for flexsyncadmind.
   <source_host_name>	Label for the source host.
   <dest_host_name>	Label for the target host.
   <task_name>	Label for the task.
   <source_dir>	File system mount and relation path of the source host to replicate.
   <destination_dir>	File system mount and relation path of the destination host to replicate data to. Caution: Do not assign a StorNext file system mount point as a destination path. If you assign a StorNext file system mount point as a destination path, some FlexSync features behave unexpectedly (such as versioning and extraneous file deletion).

1. Log on to an SSH client, and connect to your system.
2. At the prompt, enter the following command to suspend the task:

   /opt/quantum/flexsync/bin/flexsyncadmin -U <username> -P <password> suspend-task <hostgroup_name> [<dest_host_name> [<task_name>]]

   Example

   /opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password suspend-task myhostgroup mdc2 project1

   Command Parameters

   <username>	User name for flexsyncadmind.
   <password>	Password for flexsyncadmind.
   <hostgroup_name>	Label for the hostgroup for which you are suspending a task.
   <dest_host_name>	(Optional) Label for the target host for which you are suspending a task.
   <task_ name>	(Optional) Label for the task that you are suspending.

3. At the prompt, enter the following commands to update task intervals:
   Replication Interval

   /opt/quantum/flexsync/bin/flexsyncadmin -U <username> -P <password> edit-task <dest_host_name> <task_name> set sync_interval <sec>

   Example

   /opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password edit-task mdc2 project1 set sync_interval 60

   Command Parameters

   <username>	User name for flexsyncadmind.
   <password>	Password for flexsyncadmind.
   <dest_host_name>	Label for the target host for which you are updating the replication interval.
   <task_ name>	Label for the task for which you are updating the replication interval.
   <sec>	Number of seconds to which to update the replication interval.

   Version Interval

   /opt/quantum/flexsync/bin/flexsyncadmin -U <username> -P <password> edit-task <dest_host_name> <task_name> set version_interval <sec>

   Example

   /opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password edit-task mdc2 project1 set version_interval 300

   Command Parameters

   <username>	User name for flexsyncadmind.
   <password>	Password for flexsyncadmind.
   <dest_host_name>	Label for the target host for which you are updating the replication interval.
   <task_ name>	Label for the task for which you are updating the replication interval.
   <sec>	Number of seconds to which to update the version interval.

   Cool Down Interval

   /opt/quantum/flexsync/bin/flexsyncadmin -U <username> -P <password> edit-task <dest_host_name> <task_name> set cool-down <sec>

   Example

   /opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password edit-task mdc2 project1 set cool_down 120

   Command Parameters

   <username>	User name for flexsyncadmind.
   <password>	Password for flexsyncadmind.
   <dest_host_name>	Label for the target host for which you are updating the replication interval.
   <task_ name>	Label for the task for which you are updating the replication interval.
   <sec>	Number of seconds to which to update the cool down interval.

4. At the prompt, enter the following command to resume the task:

   /opt/quantum/flexsync/bin/flexsyncadmin -U <username> -P <password> resume-task <hostgroup_name> [<dest_host_name> [<task_name>]]

   Example

   /opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password resume-task myhostgroup mdc2 project1

   Note: The changes take effect when the task becomes idle.

1. Log on to an SSH client, and connect to your system.
2. At the prompt, enter the following command to check a task configuration:

   /opt/quantum/flexsync/bin/flexsyncadmin -U <username> -P <password> status [--active] [<hostgroup_name> [<dest_host_name> [<task_name>]]

   Example

   /opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password status

    

   myhostgroup:

   mdc1 (10.12.345.678:10453,10454): online

   Task summary: (0 of 1 active) 0 bytes/sec 0 files/sec

    

   mdc2 (10.12.345.679:10453,10454): online

   Task summary: (0 of 1 active) 0 bytes/sec 0 files/sec

    

   Task: project1

   Source: 10.12.345.678:/stornext/snfs1/data

   Dest: 10.12.345.679:/stornext/snfs2/backup

   Copied: Thu Jun 8 12:28:42 2017

   Versioned: Thu Jun 8 12:28:42 2017

   Synchronized. Waiting 45 seconds for next pass...

   Command Parameters

   <username>	User name for flexsyncadmind.
   <password>	Password for flexsyncadmind.
   --active	(Optional) Check status for active tasks only
   <hostgroup_name>	(Optional) Check status for tasks assigned to the specified hostgroup only.
   <dest_host_name>	(Optional) Check status for tasks assigned to the specified target host only.
   <task_name>	(Optional) Check status for the specified task.

To start a replication task from the FlexSync CLI, use the command for the flexsyncadmind host. Keep in mind that tasks started from the flexsyncadmind host command are exempt from the flexsyncd(8) maximum concurrent task limit. As a result, your system might experience higher than normal system resource usage.

Start a Replication Task

1. Log on to an SSH client, and connect to your system.
2. At the prompt, enter the following command to start a task:

   /opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password start-task <dest_host_name> <task_name>

   Example

   /opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password start-task mdc2 project1

   Command Parameters

   <username>	User name for flexsyncadmind.
   <password>	Password for flexsyncadmind.
   <dest_host_name>	(Optional) Label for the target host for which you are starting a task.
   <task_ name>	(Optional) Label for the task that you are starting.

Large Replication Task Examples

If your environment requires large configurations, review the following examples of simplified scripts to use in configuring and managing tasks from the FlexSync CLI.

You can easily modify and extend these examples to manage a more complicated configuration, and change the scripts to read the variables from a file or other source. The script must be executed on the host system that is running flexsyncadmind.

Example 1: Add Multiple Tasks

The following script adds 99 tasks for a source and target host pair. The source file system directory is based on the source host-name.

View Contents of .sh File

[root@mdc1 ~]# more taskcreate.sh

#!/bin/bash

hostgrp=$1

host1=$2

host2=$3

f1=$4

f2=$5

Command To Call Script

/opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password add-task $hostgrp $host1 $host2 task$<nn> $f1/$host1$<nn> $f2

The parameter is:

<nn>

Task 1-99

Example 2: Edit Multiple Tasks

The following script edits the original 99 tasks by modifying the sync_interval, version_interval, and cool_down period parameters.

View Contents of .sh File

[root@dexter ~]# more taskedit.sh

#!/bin/bash

hostgrp=$1

host2=$2

Commands To Call Script

/opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password edit-task $hostgrp $host2 task$<nn> set sync_interval 60

/opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password edit-task $hostgrp $host2 task$<nn> set version_interval 90

/opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password edit-task $hostgrp $host2 task$<nn> set cool_down 300

The parameter is:

<nn>

Task 1-99

Example 3: Start Multiple Tasks

The following script starts the original 99 tasks.

View Contents of .sh File

[root@dexter ~]# more taskstart.sh

#!/bin/bash

hostgrp=$1

host1=$2

Command To Call Script

/opt/quantum/flexsync/bin/flexsyncadmin -u admin -p password start-task $hostgrp $host1 task$<nn>

The parameter is:

<nn>

Task 1-99

Example 4: Suspend Multiple Tasks

The following script suspends the original 99 tasks.

View Contents of .sh File

[root@dexter ~]# more tasksuspend.sh

#!/bin/bash

hostgrp=$1

host1=$2

Command To Call Script

/opt/quantum/flexsync/bin/flexsyncadmin -u admin -p password suspend-task $hostgrp $host1 task$<nn>

The parameter is:

<nn>

Task 1-99

Example 5: Resume Multiple Tasks

The following script resumes the original 99 tasks.

View Contents of .sh File

[root@dexter ~]# more taskresume.sh

#!/bin/bash

hostgrp=$1

host1=$2

Command To Call Script

/opt/quantum/flexsync/bin/flexsyncadmin -u admin -p password resume-task $hostgrp $host1 task$<nn>

The parameter is:

<nn>

Task 1-99

View the status of replication tasks from the FlexSync Admin Console.

1. Log on to an SSH client, and connect to your system.
2. At the prompt, enter the following command to access the FlexSync Admin console:

   /opt/quantum/flexsync/bin/flexsyncadmin -U <username> -P <password>

3. At the prompt, enter the following command to view replication task status:

   status [--active] [hostgroup_name [dest_host_name [task_name]]]

   Example

   FlexSync Admin console

    

   > status

   MyHostGroup:

    

   MyHost (mdc1.com:10453,10454): online

   Task summary: (0 of 1 active) 0 bytes/sec 0 files/sec

    

   Task: MyTask

   Source: /stornext/snfs1/mydir

   Dest: /stornext/snfs2/mydir

   Initial copy pending

   Suspended

   Command Parameters

   <username>	User name for flexsyncadmind.
   <password>	Password for flexsyncadmind.
   [--active]	(Optional) Display status only for tasks that are currently estimating replication requirements or that are actively replicating.
   [<hostgroup_name>]	(Optional) Display status only for tasks within the specified hostgroup.
   [<dest_host_name>]	(Optional) Display status only for tasks being run for the specified destination host.
   [<task_name>]	(Optional) Display status only for the specified task.

To configure (enable) email reporting from the FlexSync Dashboard, complete the following steps.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.

2. Click the Hamburger icon, and then click Email Reporting. The Email Reporting dialog appears.

   

3. Select the Enabled check box.

4. Complete the Email Reporting form.

   Note: To add multiple recipient email addresses, separate each email address with a comma.

   Note: You can optionally input a cron expression in the Schedule (Cron Expression) field in the Advanced tab. See Construct a Cron Expression.

5. Click Submit, or click Cancel to abort the operation and return to the previous page.

To disable email reporting from the FlexSync Dashboard, complete the following steps.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.

2. Click the Hamburger icon, and then click Email Reporting. The Email Reporting dialog appears.

   

3. Clear the Enabled check box.

4. Click Submit, or click Cancel to abort the operation and return to the previous page.

To configure (enable) email reporting from the FlexSync CLI, use the flexsyncadmin command.

1. Log on to an SSH client, and connect to your system.
2. At the prompt, enter the following command to configure email reporting:

   /opt/quantum/flexsync/bin/flexsyncadmin -U <username> -P <password> set-email-reporting <enabled|disabled> <smtp_hostname> <smtp_port> <tls|none> <none|username:password> <sender address> <recipient_address,recipient_address> 'cron expression'

   Example

   /opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password set-email-reporting enabled smtphostname.mycompany.com 25 tls smtpuser:smtppassword sender-email@mycompany.com recipient-email1@mycompany.com,recipient-email2@mycompany.com '0 0 * * *'

   Command Parameters

   <username>	User name for flexsyncadmind.
   <password>	Password for flexsyncadmind.
   <enabled|disabled>	Enable or disable email reporting.
   <smtp_hostname>	The SMTP hostname.
   <smtp_port>	The SMTP port number.
   <tls|none>	Enable or disable TLS protocol.
   <none|username:password>	The SMTP user name and the SMTP password.
   <sender address>	Sender email address.
   <recipient_address,recipient_address>	Recipient email address(es). Note: To add multiple recipient email addresses, separate each email address with a comma.
   'cron expression'	A cron expression gives you more control over the frequency, compared to the default schedules available using the GUI. For example, you could define a cron expression to notify you at 8:15 AM on the second Friday of every month. See Construct a Cron Expression.

Construct a Cron Expression

A cron expression is a string of fields separated by spaces. The following table displays the fields of a cron expression, in the order that they must be specified (from left to right):

Note: Cron expressions are not case-sensitive.

For example:

The above expression literally translates to 0 second, 15 minute, 8 hour, any day of the month, January.

In other words, this represents 8:15 AM on every Monday during January.

Note: The ? character means "no particular value".

In this example, the Day-of-month is set to no particular value. We do not need to specify it, as we have specified a Day-of-week value. See Special Characters for more information about special characters.

See Examples of Cron Expressions for more examples of cron expressions and their explanations.

Special Characters

Examples of Cron Expressions

To disable email reporting from the FlexSync CLI, use the flexsyncadmin command.

1. Log on to an SSH client, and connect to your system.
2. At the prompt, enter the following command to disable email reporting:

   /opt/quantum/flexsync/bin/flexsyncadmin -U <username> -P <password> set-email-reporting <enabled|disabled>

   Example

   /opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password set-email-reporting disabled

   Command Parameters

   <username>	User name for flexsyncadmind.
   <password>	Password for flexsyncadmind.

To display the email reporting configuration from the FlexSync CLI, use the flexsyncadmin command.

1. Log on to an SSH client, and connect to your system.
2. At the prompt, enter the following command to display the email reporting configuration:

   /opt/quantum/flexsync/bin/flexsyncadmin -U <username> -P <password> show-email-reporting

   Example

   /opt/quantum/flexsync/bin/flexsyncadmin -U admin -P password show-email-reporting

   Command Parameters

   <username>	User name for flexsyncadmind.
   <password>	Password for flexsyncadmind.

Below is an example of the show-email-reporting command output if email reporting is enabled and configured:

Below is an example of the show-email-reporting command output if email reporting is disabled:

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI
2. In the Hostgroup column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click the Trashcan to display a confirmation dialog.
4. Click Delete to remove the selected hostgroup and its hosts and tasks.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI
2. In the Hostgroup column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click Suspend to pause the replication tasks for the hostgroup.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI
2. In the Hostgroup column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click Resume to restart the replication tasks for the hostgroup.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI
2. In the Hostgroup column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click Edit to display the Hostgroup configuration dialog box.
4. In the Name field, enter a label for the hostgroup.

5. Click Submit to apply your changes.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.
2. In the Hosts column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click the Trashcan to display a confirmation dialog.
4. Click Delete to remove the selected host.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.
2. In the Host column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click Suspend to pause the replication tasks for the hosts.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.
2. In the Host column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click Resume to resume the replication tasks for the selected host.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI
2. In the Hosts column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click Edit to display the Host configuration dialog box.

   Basic Tab

   1. In the Name field, enter a label for the host.
   2. In the Hostgroup field, select a hostgroup, unless it is already prepopulated.

   3. In the Hostname field, enter the DNS name or IP address for the replication transport.

   4. In the Admin port field, update the port number, as needed. The default port is 10453.

   5. In the Data port field, update the port number, as needed. The default port is 10454.

   6. In the SSL port field, update the port number, as needed. The default port is 10554.

   7. In the Username field, enter your FlexSync user name.

   8. In the Password field, enter your FlexSync password.

   Advanced Tab

   Select a check box to enable a setting or clear a check box to disable a setting, as needed:

   Check Box

   Description

   Bandwidth Throttling

   Select this option to restrict the bandwidth across all of the active tasks for the selected host, to the specified value. By default, bandwidth throttling is disabled. To enable: Check Bandwidth Throttling. In the bandwidth limit field, enter a value. Select a data transfer speed from the list. Enter 0 to disable bandwidth throttling. Note: If you enable bandwidth throttling, the rate I/O is not guaranteed. Initially, your data transfers might experience a bit of variation where the host’s transfer rate, as shown in the GUI, can be slightly higher or lower than the requested transfer rate. The transfer rate eventually settles in to the requested transfer rate. Also, the transfer rate shown by the GUI is an average across the running time of all active tasks. If you update the bandwidth limit mid-stream, then FlexSync throttles up or down to that limit immediately, but it might take an extended period of time for the average to reflect the updated bandwidth limit.

4. Click Submit to apply your changes.

See FlexSync Hosts Tips and FAQs.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.
2. In the Tasks column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click Reverse task to reverse the direction of the replication.

WARNING: If you attempt to delete a task and you select the Remove destination directory tree option, you must delete all of the Storage Manager policies for any relation points on the destination. If you do not remove the Storage Manager polices, then the operation results in a failure to delete the task.

WARNING: If a task attempts to delete directories because the Delete extraneous files on destination option is enabled on the task, you must delete all of the Storage Manager policies for any relation points on the destination for directories that were deleted on the source. If you do not remove the Storage Manager policies, then the operation results in an error when it attempts to delete the extraneous files.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.
2. in the Tasks column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click the Trashcan to display a confirmation dialog that contains the following additional options:

   • Remove destination directory tree

     WARNING: If you select the Remove destination directory tree option, your data is permanently deleted. This process cannot be undone.

   • Remove version directories

     WARNING: If you select the Remove version directories option, your data is permanently deleted. This process cannot be undone.

   • Remove audit trail

4. A dialog appears and you are prompted with the following message, Are you sure you would like to delete task task-name?. If you are sure you want to proceed with the operation, enter DELETEMYDATA.
5. Click Delete to remove the selected task and its respective data, or click Back to abort the operation and return to the previous page.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.
2. In the Tasks column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click Start task to initiate the replication task.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.
2. In the Tasks column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click Repair destination to perform a full cross-check between the source and the destination directories.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.
2. In the Tasks column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click Suspend to pause the replication task. The icon for the task changes from a laptop icon to a pause icon.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.
2. In the Tasks column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click Suspend, as needed.
4. Click Edit to display the Task configuration dialog box.
5. Update the task parameters, as needed. See Step 3: Add a Task

6. Click Submit to apply your changes.

7. Click Resume task to resume the replication task, as needed.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.
2. In the Tasks column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click Clone task.
4. In the dialog box, enter a name for you task.

5. Click Clone to apply your changes, or click Cancel to abort the operation and return to the previous page.

6. Click Start task to resume the replication task, as needed.

1. Log in to the FlexSync Dashboard. See Access the FlexSync GUI.
2. In the Tasks column, hover over the Cogwheel to expand and display additional menu options.

   

3. Click Task Report to display the Task reports for <task_name> dialog box.
4. Review the displayed information for the task:

   

5. Perform the following optional steps:
   • Click the Cogwheel button to expand and display the Logfile and Delete Log options, as needed:
     • Click Logfile to display the log file of the selected log entry, as needed.
     • Click Delete Log to remove the log file of the selected log entry, as needed.
   • Click Purge to clear the entire log file, as needed .
6. Click Close to return to the previous page.

   Additional Information for Task Logs

   The following 2 icons identify a task log that contains an error:

   Figure 1: Normal Error

   

   Figure 2: Fatal Error

   

Using either the FlexSync Dashboard (see FlexSync Dashboard: Generate a FlexSync Configuration Backup File) or CLI (see FlexSync CLI: Generate a FlexSync Configuration Backup File), you must first create the FlexSync configuration to use for your backup file. After you have completed your FlexSync configuration, you can save it as the backup file in the backup_pathname directory of the flexsyncadmin daemon.

You must use the FlexSync Admin console of the FlexSync CLI to restore your configuration from the backup file. See FlexSync CLI: Restore a FlexSync Configuration.