hostname

hostname

string

If the host name to be used in FSR
is not set, the host name of the device is used.

resources_path

.

directory path

It operates as a relative path based on the location of the path setting file where resource files are located.

paths/resources/

database_path

../db

directory path

It operates as a relative path based on the path setting file location for saving the resource state.

paths/database/

enable_auto_up
(auto_up in 1.0.x)

true

true / false

Boolean

If true, resource UP is performed at FSR start.

1.1-A1

rpc_address

0.0.0.0:5168

IPv4 / IPv6

{ip}:{port}

gRPC Listen address

addresses/rpc/

rest_address

0.0.0.0:5167

IPv4 / IPv6

{ip}:{port}

REST-API Listen address

addresses/rest/

file_handle_limit

128

32-bit integer

Count

Limit the number of concurrently open file handles for replication
Use default value when set to 0

sync_hash_type

crc32

crc32 / md5 / sha1 / sha256 / sha512

hash type

The type of hash algorithm to use for synchronization

0.9

max_block_size

One

1 to 30

MB

Max Replicated I/O Block Size

1.0-A2

level

debug

debug / info / warn / error / fatal / panic

log level

log output level

console

enable

true

true / false

Boolean

log console output

console/

file

enable

true

true / false

Boolean

Whether to use log files

file/

location

../logs

file path

Log file path and file name
settings Operate as a relative path based on the file location.

file/

size_limit

10

32-bit integer

MB

Use the default value when setting the log file individual size limit to 0

file/

rotate_count

10

32-bit integer

Count

Number of log files to retain when rolling,
use default value when set to 0

file/

location

../buffer

directory path

file buffer default location

limit

1024M

32-bit integer

MB

maximum size. When dynamically applied, the resource adjustment command must also be executed to apply.
When set to 0, the file buffer is not used.

warn

10M

32-bit integer

MB

Disabling Alerts when Usage Alert Threshold is set to 0

auto_recover

false

true / false

Boolean

-

Whether to automatically restart when the stop motion threshold is reached

unused

minimum

1024

32-bit integer

MB

Stopping operation due to remaining disk capacity Threshold
Disable monitoring when set to 0

period

30

32-bit integer

candle

Disable monitoring when disk remaining capacity check cycle is set to 0

period

0

32-bit integer

Storage period (day)

Deleted/orphaned files are
kept indefinitely when set to 0

location

../archives

directory path

Set the storage location for deleted/orphaned files
Operates with a relative path based on the file location

type

copy

not_set / copy / full / incremental / differential

backup type

Snapshot Backup Type

1.2

id

Must be available as filename

string

The ID of the resource
must be the same as the resource file name

description

string

Description of the resource

description/

unused

auto_up

true

true / false

Boolean

If true, resource UP is performed at FSR start.

index

0

32-bit integer

a number greater than or equal to 0

node's unique number

1.0-A3

name

string

node name or host name

hostname

string

node's hostname

hostname/

url

IPv4 / IPv6

{ip}:{port}

replication connection address

files
(list)

path

directory path

clone target

files/file/

type

directory

directory / file

target type

Replication target type

files/file/

0.9

recursive

true

true / false

Boolean

Whether to include subdirectories

files/file/

exclude_patterns (list)

exclusion pattern

exclusion pattern

files/file/exclude_patterns/pattern/

sync

attributes

true

true / false

Boolean

Attribute sync?

files/file/sync/

1.0

permissions

name

name / sid / none

string flag

Security Settings Replication Criteria

files/file/sync/

0.9.1

archive

enable

false

true / false

Boolean

Whether to keep orphaned files

files/file/archive/

period

0

32-bit integer

Storage period (day)

Orphaned file retention period
Indefinite if set to 0

files/file/archive/

location

directory path

Where to keep orphan files

files/file/archive/

periodic_sync

period

ex) 30s, 30m, 1h

hour

periodic synchronization cycle

files/file/periodic_sync/

1.1-A1

comparison_level

One

0/1/2

sync file comparison level

files/file/periodic_sync/

1.1-A1

report

nothing

nothing / summary / full

Report generation level

files/file/periodic_sync/

1.1-A1

buffer

size

10

32-bit integer

MB

Memory buffer not used when BAB size is set to 0

buffer/

1.0-A3

file_buffer

limit

1024M

32-bit integer

MB

File buffer max size
set to 0 disables file buffer

file_buffer/

warn

10M

32-bit integer

MB

Disabling Alerts when Usage Alert Threshold is set to 0

file_buffer/

0.9.1

location

directory path

file buffer location

file_buffer/

auto_up

true / false

Boolean

Auto Up

0.9.4

auto_file_lock

off, on, read_only

string

Automatic file locking type

0.9

database_path

directory path

path to store resource state

database_path/

1.1-A1

group

string

group name

1.1-A1

node1

name

string

The hostname of the node to establish a connection to

node1/

type

node

node / group

string

the type specified by the name entry

node1/

1.1-A2

url

IPv4 / IPv6

{ip}:{port}

replication connection address

node1/

proxy

DRX connection settings

node1/proxy

1.2

node2

name

string

The hostname of the node to establish a connection to

node2/

type

node

node / group

string

the type specified by the name entry

node1/

1.1-A2

url

IPv4 / IPv6

{ip}:{port}

replication connection address

node2/

proxy

DRX connection settings (written separately below)

node2/proxy

1.2

buffer

size

10

32-bit integer

MB

Memory buffer not used when BAB size is set to 0

buffer/

file_buffer

limit

1024

32-bit integer

MB

File buffer max size
set to 0 disables file buffer

file_buffer/

warn

10M

32-bit integer

MB

Disabling Alerts when Usage Alert Threshold is set to 0

file_buffer/

0.9.1

network

ping_interval

10

32-bit integer

candle

Disable when PING transmission interval is set to 0

network/

compress

false

true / false

Boolean

protocol compression

network/

tls

false

true / false

Boolean

Encrypted communication

network/

limit

0

32-bit integer

bps

No limit if bits per seconds is set to 0

network/

sync_ratio

{replication}:{sync}

Transmission amount of synchronization data compared to replication data transmission.
Only whole numbers are supported for two numbers. (eg: 1:1, 100:50)

network/

1.2

sync_min

0

32-bit integer

bps

Sync transfer amount minimum guaranteed value

network/

1.2

sync_max

0

32-bit integer

bps

Synchronization transmission amount maximum value limit

network/

1.2

name

string

-

Connection name used by DRX

1.2

inside

IPv4 / IPv6

{ip}:{port}

Address of the local DRX to connect to in FSR

1.2

outside

IPv4 / IPv6

{ip}:{port}

Address of the local DRX to be connected from the other DRX

1.2

hostname

string

-

Hostname of the DRX device

1.2

options

the murmur

1M

{number}:{unit}

-

TX BAB size

options/

1.2

bullimt

{number}:{unit}

-

Transmission per second limit

options/

1.2

plugin

svc_autostart

true

true, yes, on,1

false, no, off, 0

String or Boolean

-

Automatically start resources on DRX startup

-

1.2

rx_memlimit

{number}:{unit}

-

RX BAB size

-

1.2

crypto

openssl

string

-

encryption plugin

-

1.2

compressor

zlib or lz4

string

-

compression plugin

-

1.2

compressor_level

One

string or 32-bit integer

-

Compression level of the compression plugin

-

1.2

recursive

true

true / false

Boolean

Whether to include subdirectories

exclude_patterns (list)

exclusion pattern

exclusion pattern

exclude_patterns/patterns/

auto_file_lock

read_only

off, on, read_only

string

File lock type

0.9

database_path

directory path

path to store resource state

database_path/

sync

attributes

true

true / false

Boolean

Attribute sync?

sync/

0.9.1

permissions

name

name / sid / none

string flag

Security Settings Replication Criteria

sync/

comparison_level

One

0/1/2

sync file comparison level

sync/

1.1-A1

hash_type

crc32 / md5 / sha1 / sha256 / sha512

hash algorithm

Synchronized Hash Comparison Algorithm Type

sync/

1.1-A1

ping_interval

10

32-bit integer

candle

Disable when PING transmission interval is set to 0

compress

false

true / false

Boolean

protocol compression

tls

false

true / false

Boolean

Encrypted communication

limit

0

32-bit integer

bps

No limit if bits per seconds is set to 0

sync_ratio

{replication}:{sync}

Transmission amount of synchronization data compared to replication data transmission.
Only whole numbers are supported for two numbers. (eg: 1:1, 100:50)

1.2

sync_min

0

32-bit integer

bps

Sync transfer amount minimum guaranteed value

1.2

sync_max

0

32-bit integer

bps

Synchronization transmission amount maximum value limit

1.2

options

timeout

0

32-bit integer

candle

Handler Execution Timeout
No limit when set to 0

options/

timeout_action

kill

kill / continue

string flag

Behavior after run time

options/

after_resync_target

string

script

Script to run on target after synchronization

scripts/after_resync_target/

before_resync_target

string

script

Script to run on target before sync

scripts/before_resync_target/

before_resync_source

string

script

Script to run on source before synchronization

scripts/before_resync_source/

out_of_sync

string

script

Script to be executed when OOS occurs in synchronization or consistency verification

scripts/out_of_sync/

local_io_error

string

script

Script to run when an IO error occurs

scripts/local_io_error/

before_snapshot_create

string

script

Script to run before snapshot creation

scripts/before_snapshot_create/

1.2

after_snapshot_create

string

script

Script to run after snapshot creation

scripts/after_snapshot_create/

1.2

before_snapshot_recovery

string

script

Script to run before snapshot recovery

scripts/before_snapshot_recovery/

1.2

after_snapshot_recovery

string

script

Script to run after snapshot restore

scripts/after_snapshot_recovery/

1.2

the murmur

1M

{number}:{unit}

-

TX BAB size

1.2

bullimt

{number}:{unit}

-

Transmission per second limit

1.2

plugin

svc_autostart

true

true, yes, on,1

false, no, off, 0

String or Boolean

-

Automatically start resources on DRX startup

-

1.2

rx_memlimit

{number}:{unit}

-

RX BAB size

-

1.2

crypto

openssl

string

-

encryption plugin

-

1.2

compressor

zlib or lz4

string

-

compression plugin

-

1.2

compressor_level

One

string or 32-bit integer

-

Compression level of the compression plugin

-

1.2

type

not_set

not_set / copy / full / incremental / differential

backup type

Snapshot Backup Type

1.2