1 Overview
- 1.1 version
- 1.2 XML notation
- 1.3 Dynamic adjusting notation
- 1.4 range of numeric datatypes
2 system settings
- 2.1 structure
- 2.2 Option by item
  - 2.2.1 options
- 2.3 log
  - 2.3.1 file_buffer
  - 2.3.2 disk
  - 2.3.3 archive
  - 2.3.4 snapshot
  - 2.3.5 userdata
3 resource settings
- 3.1 structure
- 3.2 Option by item
  - 3.2.1 top option
  - 3.2.2 nodes
  - 3.2.3 connections
    - 3.2.3.1 proxy
  - 3.2.4 options
  - 3.2.5 network
  - 3.2.6 handlers
  - 3.2.7 proxy
  - 3.2.8 snapshot
  - 3.2.9 userdata
4 Procedure for Applying Attributes

Overview

version

1.1-A5, 1.2-A1

XML notation

The configuration file content in XML format obtained via dump-xml is missing the userdata attribute.

tag name
- Indicates that a tag exists at the parent of the property as follows,
  Ex) tag1/tag2
  <tag1> <tag2></tag2> </tag1>
ATTRIBUTE
- Use the attribute of the tag
TEXT
- Use the text of that tag

Dynamic adjusting notation

NO
- Properties that are not dynamically applied. Service restart in case of system configuration, Down/Up procedure in case of resource configuration is required
ADJUST
- Attributes updated through configuration adjustment commands
ADJUST_EACH
- After running a system configuration adjustment command, to apply it to a running resource, you must also run a configuration adjustment command for that resource.
RECONN
- Attributes that require reconnection between nodes after executing a configuration adjustment command
PROMOTE
- Attributes that require demote/promote after configuration reconciliation command is executed

range of numeric datatypes

32-bit integer: 0 to 2 ³¹ -1 (2147483647)

system settings

{
  "options": {
    "hostname": "",
    "resources_path": ".",
    "database_path": "../db",
    "enable_auto_up": true,
    "rpc_address": "0.0.0.0:5168",
    "rest_address": "0.0.0.0:5167",
    "file_handle_limit": 128
  },
  "log": {
    "level": "debug",
    "console": {
      "enable": true
    },
    "file": {
      "enable": true,
      "location": "../logs",
      "size_limit": 10,
      "rotate_count": 10
    }
  },
  "file_buffer": {
    "location": "../buffer",
    "limit": 1024,
    "warn": 10,
    "auto_recover": false
  },
  "disk": {
    "minimum": 0,
    "period": 0
  },
  "archive": {
    "period": 0,
    "location": "../archives"
  },
  "userdata": null
}

<system>
  <options hostname="node1" auto_up="true" file_handle_limit="128" sync_hash_type="crc32">
    <paths>
      <resources>.</resources>
      <database>../db1</database>
    </paths>
    <addresses>
      <rpc>0.0.0.0:5168</rpc>
      <rest>0.0.0.0:5167</rest>
    </addresses>
  </options>
  <log level="info">
    <console enable="true"></console>
    <file enable="true" size_limit="10" rotate_count="10">../logs/node1</file>
  </log>
  <file_buffer limit="1024" warn="10" auto_recover="true">../buffer</file_buffer>
  <disk minimum="1024" period="3"></disk>
  <archive enable="true" period="3">../archive</archive>
</system>

structure

options
- hostname
- resources_path
- database_path
- enable_auto_up
- rpc_address
- rest_address
- file_handle_limit
- sync_hash_type
- max_block_size
log
- level
- console
  - enable
- file
  - enable
  - location
  - size_limit
  - size_limit
file_buffer
- location
- limit
- warn
- auto_recover
disk
- minimum
- period
archive
- period
- location
snapshot
- type
userdata

Option by item

options

Settings used at program startup. It is not applied dynamically.

item	default value	setting range	unit	dynamic adjusting	Description	XML	note

item	default value	setting range	unit	dynamic adjusting	Description	XML	note
hostname		hostname	string	NO	If the host name to be used in FSR is not set, the host name of the device is used.	ATTRIBUTE
resources_path	.		directory path	NO	It operates as a relative path based on the location of the path setting file where resource files are located.	paths/resources/TEXT
database_path	../db		directory path	NO	It operates as a relative path based on the path setting file location for saving the resource state.	paths/database/TEXT
enable_auto_up (auto_up in 1.0.x)	true	true / false	Boolean	NO	If true, resource UP is performed at FSR start.	ATTRIBUTE	1.1-A1
rpc_address	0.0.0.0:5168	IPv4 / IPv6	{ip}:{port}	NO	gRPC Listen address	addresses/rpc/TEXT
rest_address	0.0.0.0:5167	IPv4 / IPv6	{ip}:{port}	NO	REST-API Listen address	addresses/rest/TEXT
file_handle_limit	128	32-bit integer	Count	ADJUST	Limit the number of concurrently open file handles for replication Use default value when set to 0	ATTRIBUTE
sync_hash_type	crc32	crc32 / md5 / sha1 / sha256 / sha512	hash type	ADJUST	The type of hash algorithm to use for synchronization	ATTRIBUTE	0.9
max_block_size	One	1 to 30	MB	PROMOTE	Max Replicated I/O Block Size	ATTRIBUTE	1.0-A2

log

Log-related settings.

item		default value	setting range	unit	dynamic adjusting	Description	XML	note

item		default value	setting range	unit	dynamic adjusting	Description	XML
level		debug	debug / info / warn / error / fatal / panic	log level	ADJUST	log output level	ATTRIBUTE
console	enable	true	true / false	Boolean	ADJUST	log console output	console/ATTRIBUTE
file	enable	true	true / false	Boolean	ADJUST	Whether to use log files	file/ATTRIBUTE
	location	../logs		file path	ADJUST	Log file path and file name settings Operate as a relative path based on the file location.	file/TEXT
	size_limit	10	32-bit integer	MB	ADJUST	Use the default value when setting the log file individual size limit to 0	file/ATTRIBUTE
	rotate_count	10	32-bit integer	Count	ADJUST	Number of log files to retain when rolling, use default value when set to 0	file/ATTRIBUTE

file_buffer

File buffer settings.

item	default value	setting range	unit	dynamic adjusting	Description	XML	note

item	default value	setting range	unit	dynamic adjusting	Description	XML	note
location	../buffer		directory path	NO	file buffer default location	TEXT
limit	1024M	32-bit integer	MB	ADJUST_EACH	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.	ATTRIBUTE
warn	10M	32-bit integer	MB	ADJUST_EACH	Disabling Alerts when Usage Alert Threshold is set to 0	ATTRIBUTE
auto_recover	false	true / false	Boolean	-	Whether to automatically restart when the stop motion threshold is reached	ATTRIBUTE	unused

disk

disk monitoring.

item	default value	setting range	unit	dynamic adjusting	Description	XML	note

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

minimum

1024

32-bit integer

MB

ADJUST

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

ATTRIBUTE

period

30

32-bit integer

candle

ADJUST

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

ATTRIBUTE

snapshot

item	default value	setting range	unit	dynamic adjusting	Description	XML	note

item	default value	setting range	unit	dynamic adjusting	Description	XML	note
type	copy	not_set / copy / full / incremental / differential	backup type	ADJUST	Snapshot Backup Type	ATTRIBUTE	1.2

userdata

user properties. Object type data can be freely added.

resource settings

{
  "id": "r0",
  "description": "test resource",
  "auto_up": true,
  "nodes": [
    {
      "name": "node1",
      "url": "192.168.35.101:9876",
      "files": [
        {
          "path": "E:\\Repl\\Datas",
          "type": "directory",
          "recursive": true,
          "exclude_patterns": [],
        },
        {
          "path": "E:\\Repl\\data.xml",
          "type": "file",
        }
      ],
      "auto_file_lock": "off"
    },
    {
      "name": "node2",
      "url": "192.168.35.102:9876",
      "directories": [
        {
          "path": "F:\\Repl\\Datas",
          "type": "directory",
          "recursive": true,
          "exclude_patterns": [],
        },
        {
          "path": "F:\\Repl\\data.xml",
          "type": "file",
        }
      ],
      "auto_file_lock": "off"
    }
  ],
  "connections": [],
  "options": {
    "recursive": true,
    "exclude_patterns": [
      "*.tmp"
    ],
    "sync": {
      "attributes": false,
      "permissions": "none",
    },
    "auto_file_lock": "off",
    "database_path": ""
  },
  "userdata": null
}

<resource id="r0" auto_up="true">
  <nodes>
    <node name="node1" url="127.0.0.1:9810">
      <files>
        <file path="E:/test/node1">
          <exclude_patterns>
            <pattern>*.tmp</pattern>
            <pattern>*.bak</pattern>
          </exclude_patterns>
        </file>
        <file path="E:/test/data.dat" type="file">
          <exclude_patterns></exclude_patterns>
        </file>
      </files>
      <file_buffer limit="1024" warn="150">D:/Temp</file_buffer>
    </node>
    <node name="node2" url="127.0.0.1:9820">
      <files>
        <file path="F:/test/node2">
          <exclude_patterns>
            <pattern>*.tmp</pattern>
            <pattern>*.bak</pattern>
          </exclude_patterns>
        </file>
        <file path="F:/test/data.dat" type="file">
          <exclude_patterns></exclude_patterns>
        </file>
      </files>
    </node>
  </nodes>
  <connections>
    <connection>
      <node1 name="node1"></node1>
      <node2 name="node2"></node2>
      <buffer size="100"></buffer>
      <network ping_interval="10"></network>
    </connection>
  </connections>
  <options recursive="true" auto_file_lock="on">
    <exclude_patterns></exclude_patterns>
    <sync attributes="true"></sync>
  </options>
  <network ping_interval="10" compress="false" tls="false" limit="0"></network>
  <handlers>
    <options timeout="0" timeout_action="kill"></options>
    <scripts></scripts>
  </handlers>
</resource>

structure

id
description
auto_up
nodes
- index
- name
- hostname
- url
- files
  - path
  - type
  - recursive
  - exclude_patterns
  - sync
    - attributes
    - permissions
  - archive
    - enable
    - period
    - location
- periodic_sync
  - period
  - comparison_level
  - report
- buffer
  - size
- file_buffer
  - location
  - limit
  - warn
- auto_up
- auto_file_lock
- database_path
- group
connections
- node1
  - name
  - type
  - url
  - proxy
- node2
  - name
  - type
  - url
  - proxy
- buffer
  - size
- file_buffer
  - limit
  - warn
- network
  - ping_interval
  - compress
  - tls
  - limit
options
- recursive
- exclude_patterns
- auto_file_lock
- database_path
- sync
  - attributes
  - permissions
  - comparison_level
  - hash_type
network
- ping_interval
- compress
- tls
- limit
handlers
- options
  - timeout
  - timeout_action
- after_resync_target
- before_resync_target
- before_resync_source
- out_of_sync
- local_io_error
- before_snapshot_create
- after_snapshot_create
- before_snapshot_recovery
- after_snapshot_recovery
proxy
- the murmur
- bullimt
- plugin
snapshot
- type
userdata

Option by item

The node list is applied based on 'name' when applying dynamically, so the order of creation does not matter. Since there are network-related properties that require reconnection, the corresponding properties are specified as 'RECONN'.

top option

Default settings of resources

item	default value	setting range	unit	dynamic adjusting	Description	XML	note

item	default value	setting range	unit	dynamic adjusting	Description	XML	note
id		Must be available as filename	string	NO	The ID of the resource must be the same as the resource file name	ATTRIBUTE
description			string

item	default value	setting range	unit	dynamic adjusting	Description	XML	note
period	0	32-bit integer	Storage period (day)	ADJUST	Deleted/orphaned files are kept indefinitely when set to 0	ATTRIBUTE
location	../archives		directory path	ADJUST	Set the storage location for deleted/orphaned files Operates with a relative path based on the file location	TEXT

Attributes

Overview

version

XML notation

Dynamic adjusting notation

range of numeric datatypes

system settings

structure

Option by item

options

log

file_buffer

disk

archive

snapshot

userdata

resource settings

structure

Option by item

top option