Resilio Connect suggests the following types of synchronization jobs. Each of them is best suited for specific tasks and use cases.
Overview
Synchronization job is an on-going continuous file transfer across multiple agents back and forth, or perform one-way synchronization. It allows to create a mirror of the folder. Files in the shares can be modified, new file added and some deleted, and these changes synced to other agents in real time. With this job you can make scheduled backup or file exchange, for example. Sync Job has only one Job Run.
1) Create a new job
Go to Jobs tab -> Configure jobs -> Create new job, pick Synchronization.
2) Give the job a name and description
This is optional and defaults can be used.
3) Select the Agents
Choose an existing group, create a new group, or select the Agents directly, provided the agents do not produce 'already used' conflicts. Choose which Agents will have Read-Only permissions in the job, which will be in TSS mode. At least one RW Agent must be in the job to seed data.
Select the directories paths for syncing. You can pick the custom directories or use defaults. If the configured directory does not exist on the Agent's computer, it'll be created.
4) Choose Reference Agent
Among the Read-Write Agents selected on the previous step. Reference Agent is required in the jobs that Synchronize file permissions. Read more about Reference Agent here.
5) Settings
Select Job's priority and Job's profile. New profile can be created on this step. Starting with MC v3.8.0 it's possible to set profile parameters outside of a profile and apply them only for this job.
6) Review the job and save
Once created, the job will start automatically. Agents will index the files in the folders and start syncing with each other.
Overview
Distribution job is a one-time data transfer from a server to selected agents, performed within a job run. A new job run can be launched manually or by schedule, distributing a new set of files or running with different parameters or agents. Distribution job is commonly used for delivering software updates or important documents to remote workstations.
Android devices can participate in Distribution job starting with version of Management Console 2.5.0.
1) Create a new job
Go to JOBS tab -> Configure jobs -> Create new job, pick Distribution.
2) Give the job a name and description
This is optional and defaults can be used.
3) Select the source agent
The agent that will be uploading data to others. Only one agent can be a source. Select the path from where this agent will upload files. This directory must already exist and files shall be there before you start the job.
4) Select destination agents
It can be a group or separately selected agents, provided the agents do not produce 'already used' conflicts. Note, these ones won't be automatically added to any group. Select the path for these to store files from source agent.
- See here for more details about creating and using groups.
5) Specify Triggers
Distribution job supports post commands which make it possible to run a command once transfer is complete. Triggers indicate the moment when the script will be executed. This step can be skipped.
- Before file-indexing begins
Right after job is created, the agent will start indexing files in the specified directory. A script, triggered at this moment can "cook the files before serving", for example, re-arrange the them, add/remove new and do things alike, so that the folder is indexed and distributed in a proper manner the way you need. - After an agent completes downloading
The script will run on each destination agent after it finishes download. Other agents may be still downloading the files, thus it's recommended not to remove or update the distributed files with this trigger. Otherwise the file will be re-downloaded from source again. It's possible to schedule the script for the agent's local time. This script will run even if the Agents are paused and there's nothing to transfer in the job or there are only zero-sized files. - After all agents complete downloading
As opposed to the trigger above, in this case script will run only after all destination agents finish downloading all the files. This script will also be executed on the source agent.
6) Job scheduler
defines when the job will be launched. Shows current admin's local time, which may be different from time the physical server where Console is installed!
- Run at - at the preferred date/time (local agents' time);
- Run manually - job won't start until manually launched with "Start" button;
- Repeat hourly/daily/weekly - job will run at a specified frequency. It's possible to select the when the first run shall be started (a starting point for schedules run) and when schedule expires.
By default, if time to start next run has come but the previous run hasn't finished yet, active run will be aborted and new one started. There's a checkbox to change this behavior and not launch the new run until active finishes:
Run At: new job run will be started only if the previous one completed no later than ran_at_time + 5 mins. Examples:
- job run was launched manually and finished at 11:00. scheduler is "run at 10:56". A new job run starts during a minute.
- job run was launched manually and finished at 11:00. scheduler is "run at 10:54". No new run.
Run every minute/hour: start a new job run asap in case job run was completed later than expected schedule time. otherwise default behavior. Examples:
- job run started at 11:00 and finished at 11:08, scheduler is "run every 5 minutes". A new job run starts during a minute.
- job run started at 11:00 and finished at 11:03, the same scheduler. Wait till 11:05.
Run daily/weekly at specific time: the same principles as in Run At. Examples:
- job run started 01.01 at 11:00, finished 02.01 at 12:00. scheduler is "run every day at 11:30". New run is expected 03.01 at 11:30
- job run started on Monday at 11:00, finished on Wednesday at 12:03. scheduler is "run on Mon at 11:00, Wed at 12:00". A new run starts during a minute.
7) Settings
Select Job's priority and Job's profile. New profile can be created on this step. Starting with MC v3.8.0 it's possible to set profile parameters outside of a profile and apply them only for this job.
8) Notifications
Setup and e-mail notification if necessary.
Done! Depending on the job scheduler, the job will be launched or shall be started manually. Watch its execution on Job Runs page.
Overview
Consolidation job is a one-time data transfer , consolidating files from multiple endpoints on one or several servers. A new job run can be launched manually or by schedule, collecting a new set of files or running with different parameters or agents. Consolidation job is commonly used, for example, to collect periodic reports from workstations.
Android devices can participate in Consolidation job starting with version of Management Console 2.5.0.
1) Create a new job
Go to JOBS -> Configure jobs -> Create new job -> Consolidation.
2) Give it a name and description
It's optional and defaults can be used.
3) Choose the source agents
Select a group of agent or some agents separately, provided agents do not produce 'already used' conflicts. Specify the path from where agents will be uploading files. These directories must exist and files shall be there before you start the job.
See here for more details on creating and managing groups.
4) Choose the destination agents
Destination agents will be collecting data from source agents. Select a group of agent or some agents separately, provided agents do not produce 'already used' conflicts. Specify the path from where agents will be storing the files. Using Agent tags is also possible.
5) Specify Triggers (optional)
Consolidation job supports post commands which make it possible to run a command once transfer is complete. Triggers indicate the moment when the script will be executed. This step can be skipped.
- Before file-indexing begins: right after job is created, the agent will start indexing files in the specified directory. A script, triggered at this moment can "cook the files before serving", for example, re-arrange the them, add/remove new and do things alike, so that the folder is indexed and distributed in a proper manner the way you need.
- After an agent completes downloading: the script will run on each destination agent after it finishes download. Other agents may be still downloading the files, thus it's recommended not to remove or update the distributed files with this trigger. Otherwise the file will be re-downloaded from source again. It's possible to schedule the script for the agent's local time. This script will run even if the Agents are paused and there's nothing to transfer in the job or there are only zero-sized files.
- After all agents complete downloading: as opposed to the trigger above, in this case script will run only after all destination agents finish downloading all the files. This script will also be executed on the source agent.
6) Job scheduler
defines when the job will be launched. Shows current admin's local time, which may be different from time the physical server where Console is installed!
- Run at - at the preferred date/time (local agents' time);
- Run manually - job won't start until manually launched with "Start" button;
- Repeat hourly/daily/weekly - job will run at a specified frequency. It's possible to select the when the first run shall be started (a starting point for schedules run) and when schedule expires.
By default, if time to start next run has come but the previous run hasn't finished yet, active run will be aborted and new one started. There's a checkbox to change this behavior and not launch the new run until active finishes:
Run At: new job run should be started in case the previous one completed no later than ran_at_time + 5 mins. Examples:
- job run was launched manually and finished at 11:00. scheduler is "run at 10:56". A new job run starts during a minute.
- job run was launched manually and finished at 11:00. scheduler is "run at 10:54". No new run.
Run every minute/hour: start a new job run asap in case job run was completed later than expected schedule time. otherwise default behavior. Examples:
- job run started at 11:00 and finished at 11:08, scheduler is "run every 5 minutes". A new job run starts during a minute.
- job run started at 11:00 and finished at 11:03, the same scheduler. Wait till 11:05.
Run daily/weekly at specific time: the same principles as in Run At. Examples:
- job run started 01.01 at 11:00, finished 02.01 at 12:00. scheduler is "run every day at 11:30". New run is expected 03.01 at 11:30
- job run started on Monday at 11:00, finished on Wednesday at 12:03. scheduler is "run on Mon at 11:00, Wed at 12:00". A new run starts during a minute.
7) Settings
Select Job's priority and Job's profile. New profile can be created on this step. Starting with MC v3.8.0 it's possible to set profile parameters outside of a profile and apply them only for this job.
8) Notifications
Setup and e-mail notification if necessary.
Done! Depending on the job scheduler, the job will be launched or shall be started manually. Watch its execution on Job Runs page.
Overview
Script job allows to remotely run a script or execute a command on agents. Basically these are Script commands.
1) Create a new Script job
Go to Jobs tab -> Create new job and pick "Script job". In step-by-step wizard give it the name, edit description and pick the group of agents where the script is to be executed.
2) On step Script define the script itself.
This can be a standalone batch command (for example, to execute a binary, copy the files around) or a bash script prepared and delivered to the agent in advance. PowerShell is not supported directly. As an option either add the commands to a .ps script and execute it with "powershell.exe -File <script name>" or run with "powershell -noprofile -command <command>".
3) Step Path allows to pick the current directory for script execution.
This can be default Path Macro or a custom location. After script execution, either successful or not, agent will dump job's log into .sync folder inside this directory.
4) Job scheduler
Defines when the job will be launched. Shows current admin's local time, which may be different from time the physical server where Console is installed!
- Run at - at the preferred date/time (local agents' time);
- Repeat manually - job won't start until manually launched with "Start" button;
- Repeat hourly - job will run every N hours. Scale is 1 hour, integer.
- Repeat daily - job will run on a daily basis at the selected time. Scale is 1 day, integer.
- Repeat weekly - job will run on selected days on the week, additionally you can set the exact time of the day.
In all those periodic schedules (hourly, daily and weekly) it's possible to select the starting and ending points for the job.
5) Revise the job and save.