Related articles

Profiles

Profile is a set of settings configuration that agents receive from Management Console to perform a job. You can see Profiles in Management Console -> Settings -> Profile. There are two big blocks with default settings - Agent profile and Job profile. You can also create customized profiles or edit settings in default ones. Settings and their values are explained below in expandable table, including setting name for API.

To create a new profile click button "Add". There you can check and uncheck certain settings. Unchecked ones are inherited from default profile (also means that if param changes there, it changes accordingly in a new profile). Checked one can be edited.

Agent profile:

This set of settings is assigned to an agent or a group of agents. If no profile is selected, default one is applied. This profile determines settings for agents in the group. A job may be performed by a few groups of agents, each of which having their own settings.

Job profile:

This set of settings is assigned to the job on step "Settings" of creating the job and later can be changed when editing a job.

All agents doing this job have common settings from Job profile. These add to settings from Agent profile and make configuration complete.

Agent profile

Expand/Collapse

Name

Value

Purpose

Limit LAN bandwidth

rate_limit_local_peers

No

Applies the limit configured in the current schedule to local traffic as well

Use tracker

folder_defaults.use_tracker

Yes

Enables/disables peer discovery using the tracker server

LAN broadcast

folder_defaults.use_lan_broadcast

Yes

Enables/disables peer discovery in LAN using broadcast / multicast traffic. You can disable this option if multicast traffic is not allowed in your network

Delete to trash

use_synctrash_folder

Yes

Enables/disables storing deleted files in the folder Archive

Known hosts

folder_defaults.known_hosts

<not set>

Hosts should be entered as a single line of IP:port pairs (or DNS name:port pairs*) comma-separated (no other delimiters allowed)

Delete files absent on RW peer

folder_defaults.delete_unknown_files

No

Forces Read-only agents to delete local files from the share, if these files are absent on Read-Write agent

Time period for which a file will be kept in Archive. After that will be removed from computer for good.

Event logs max age (days)

history_time_limit

30

Number of days during which an agent keeps events log file

Bind port

bind_port

3839

Specifies default listening port for Connect Agents.

Bind interface

bind_interface

<not set>

Specifies network interface which will be used by Agent. Can be: - a text name of an interface for Linux and OS X clients (for example: eth0, bind0) - a MAC address for Windows OS (for example 08:00:27:17:a0:ba). - an network range (for example, 192.168.0.0/16 for all NICs with IPs starting with 192.168)If not specified, Agent will get default interface. If specified interface is not available, Agent will pick up the first default interface too. To prevent it, set the "Use bind interface only" value to "yes"

Use bind interface only

use_only_bind_interface

No

Forces Agent to only connect to interface specified in "Bind interface" parameter. If no such interface found, Agent will not bind to a default interface and will stay unconnected.

Custom trackers

custom_tracker

<not set>

Trackers should be entered as a single line of IP:port pairs. For multilple trackers add each on a serapate line

Custom tracker modes (custom_tracker)

tracker_mode

Load balancing

Controls the mode which is used by Agent if multiple trackers are defined. "Load balancing" - agent will connect to only one tracker."High availability" - agent will connect to all trackers available.

Keep folder data

extra_folders

Remove from agent

Defines what will happen with files after admin removes job from agent's group or from Management Console:"Remove from agent" means that files will just stop syncing and will remain on the workstation."Delete from disk" means that files will be physically deleted from workstation, skipping Trash bin and Archive.

Overwrite any changed files (Sync job only)

overwrite_changes

Yes

Specifies if Agent will overwrite changed files / download again deleted files in read-only folders. If set to "No", changed files will no longer get updates and deleted files won't be re-downloaded from other Agents.

Peer queue factor

peer_queue_factor

2.0

Integer. Factor multiplies current bandwidth to automatically determine the size of requested data by incearsing the number of requests per time unit. Set bigger value for high latency networks. Max is 10.

Console's events detalization

events_logging_level

All

Sets the detalization level for agent's event log which is sent to Management Console UI, or disabled showing the events. See here for details about events types

The interval in seconds when agents send their current resources status to MC (CPU, RAM). The larger is the interval, the lesser MC is loaded. Zero means detecting interval automatically depending on number of connected agents.

Agent status update interval (sec)

agent_status_update_interval

0

The interval in seconds when agents send their current transfer status to MC (% synced, count of files, etc). The larger is the interval, the lesser MC is loaded.Zero means detecting interval automatically depending on number of connected agents.

Unbuffered disk I/O

unbuffered_io

No

When option disabled, Agent will use OS cache for synced files.

Ignore symlinks

ignore_symlinks

No

Agents will skip symbolic links during transfer, these won't be synced. Junctions and symlinks don't sync in a Sync job cause it leads filename Conflicts.

Skip locked files (Transfer jobs)

transfer_job_skip_locked_files

No

If set "Yes", files will be skipped and not transferred, works for transfer jobs only. Agent will not attempt to transfer them again until job is stopped and launched again. This option also removes locked file error from UI. However, files are not skipped if lazy_indexing is False in Profile

Debug logging

Yes

Enables or disables debug logs for agent. Debug logs are necessary to troubleshoot any issues with agents performance

WAN optimization in LAN

prefer_utp2_lan

Yes

Enables WAN optimization options for local transfers as well.

MTU IPv6

net.udp_ipv6_mtu

1300

Max transmission unit value. Set it lower for slow networks with high rate of packet drops

MTU IPv4

net.udp_ipv4_mtu

1300

Max transmission unit value. Set it lower for slow networks with high rate of packet drops

Job profile

Expand/Collapse

Name

Value

Purpose

Synchronize posix permissions

posix_fs_acl_mode

None

Synchronizes POSIX permissions including owner and owner group:"By id", will set proper owner and group ID after file and folder synchronization."By name", will attempt to set same username as on seeding peer, regardless of actual UID.

Synchronize NTFS permissions

windows_fs_acl_mode

None

"By DACL” will synchronize user’s SID and permissions "By owner group", will sync same as for “DACL” but also will synchronize file’s owner and owner group.

Console's events detalization

events_logging_level

Agent's level

Sets the delatization level for agent's event log, or disabled even logging. If value is "Agent's level" detalization will be same as in Agent profile. If certain level is slected, all events above it in the list are also included. See here for details about event types

Automatically stop job after (sec)

timeout

None

Use this setting to force job completion in N second in case it stucks for a reason. Works only for Consolidation and Distribution jobs.

Force complete job for offline agents (Transfer jobs only)

ignore_offline_agents

No

If there are offline agents, count the job as complete for them. Otherwise, job will wait for the agents to be online. Works only for Consolidation and Distribution jobs.