/
Commands

Commands

Target

  • FSR 1.1-A5, 1.2-A1

  • kernel filter driver

  • Applied Replication Engine

  • Linked Application

    • user

    • clone console

    • HA/DR

outline

  • The user/replication console application can perform all operations related to the operation of the FSR by passing CLI commands to the FSR.

  • All FSR CLIs are provided as REST-API.

  • Individual settings for each node are set or controlled with commands on each node. (Cluster-level control commands are not provided)

  • All settings can be dynamically applied during operation by default (except for some settings such as essential properties).

setting

  • Create, modify, delete configuration files

  • Modify the properties of the configuration file.

  • Applies the changes made to the configuration file.

  • Set up the replication engine.

    • Set the required/optional option items of the configuration file.

    • Set the kernel path filter by resource.

      • Set the destination path.

      • Set exclusion filters.

      • Set file lock information.

      • Set the memory buffer.

      • Set up the file buffer.

check

  • Query the (detailed) status of a resource.

    • Kernel path filters are queried by resource.

  • Query the (detailed) performance of a resource.

  • Query (detailed) statistics of a resource.

  • Query the current settings of a resource.

  • Dump the configuration file of the resource.

control

  • Start/stop the replication engine.

    • Activates/stops the kernel path filter for each resource.

  • Start/stop synchronization.

  • start the resource

    • Attach the resource configuration.

    • Connect resource replication.

  • stop the resource

    • Detach resource configuration.

    • Disconnect resource replication.

  • Promote/demote a resource.

  • Enable/disable resource file locking.

watch

  • (Real-time) Search logs.

  • Request notification (event) subscription.

management

  • Install/Uninstall

  • update

  • license

REST-API

All REST-APIs are based on gRPC and operate in the form of JSON-RPC over HTTP .
The function for monitoring requires continuous data delivery, so only gRPC is provided.

classification

item

REST-API

movement

note

classification

item

REST-API

movement

note

1

setting

Query system settings

GET

/api/v1/config

Returns the setting in action

-

2

Query system settings (file)

GET

/api/v1/config/dump

read file and return

-

3

Query system settings (file, XML)

GET

/api/v1/config/dump-xml

Read the file and return it as XML

-

4

Change system settings

PUT

/api/v1/config

save to file

-

5

Change system settings (update)

PUT

/api/v1/config/update

Apply settings and save to file

Accepts and processes only the parts to change,
no need to call adjust

6

Update system settings

POST

/api/v1/config/adjust

Reading from a file and updating the settings in operation

-

7

Resource list lookup

GET

/api/v1/resources

Return a list of resource IDs

Necessity check required

8

Query individual resource settings

GET

/api/v1/resource/{ID}

Returns the setting in action

all available

9

Look up individual resource settings (file)

GET

/api/v1/resource/{ID}/dump

read file and return

all available

10

Look up individual resource settings (file, XML)

GET

/api/v1/resource/{ID}/dump-xml

Read the file and return it as XML

all available

11

Change individual resource settings

PUT

/api/v1/resource/{ID}

save to file

Create a new resource file when specifying an ID that does not exist

12

Change individual resource settings (update)

PUT

/api/v1/resource/{ID}/update

Apply settings and save to file

Accepts and processes only the parts to change,
no need to call adjust

13

Updating individual resource settings

POST

/api/v1/resource/{ID}/adjust

Reading from a file and updating the settings in operation

all available

14

Delete individual resource settings

DELETE

/api/v1/resource/{ID}

delete file

Running resources are not affected.

15

control

Generate metadata

POST

/api/v1/resource/{ID}/create-meta

Generate resource metadata

all available

16

Delete metadata

POST

/api/v1/resource/{ID}/delete-meta

Delete resource metadata

all available

17

Reset metadata

POST

/api/v1/resource/{ID}/reset-meta

Reset resource metadata

all available. 1.2 or higher

18

Metadata Cleanup

POST

/api/v1/resource/cleanup-meta

Delete obsolete metadata

-

19

Add resource

POST

/api/v1/resource/{ID}/add

Read and load resource files

all available

20

delete resource

POST

/api/v1/resource/{ID}/delete

Remove resource from list

all available

21

Load resource file

POST

/api/v1/resource/{ID}/attach

Loading a file into a resource

all available

22

Separate resource files

POST

/api/v1/resource/{ID}/detach

Separate files from resources

all available

23

resource startup

POST

/api/v1/resource/{ID}/up

Load resources and run

all available.
add, attach, connect operations

24

stop resource

POST

/api/v1/resource/{ID}/down

Disconnect and detach resources

all available.
disconnect, detach, del actions

25

promotion

POST

/api/v1/resource/{ID}/primary

Attempt to promote to Primary

-

26

demotion

POST

/api/v1/resource/{ID}/secondary

Demote to Secondary

-

27

connection

POST

/api/v1/resource/{ID}/connect/{PEER}

Change to Connecting state

all available. All connections when peer is omitted

28

Disconnect

POST

/api/v1/resource/{ID}/disconnect/{PEER}

Change to standalone status

all available. Disconnect all connections when peer is omitted

29

sync start

POST

/api/v1/resource/{ID}/resync/{PEER}

Synchronize partner node as source

all available

30

Start remote sync

POST

/api/v1/resource/{ID}/resync-remote/{PEER}

Start syncing this node as source

all available

31

Consistency Verification Start

POST

/api/v1/resource/{ID}/verify/{PEER}

Start consistency verification with partner node as source

all available

32

Consistency check stopped

POST

/api/v1/resource/{ID}/verify-stop/{PEER}

Aborting Consistency Verification in Progress

all available. 1.1 or later

33

pause

POST

/api/v1/resource/{ID}/pause

Synchronization or replication paused

all available. Full pause when peer is omitted

34

resumption

POST

/api/v1/resource/{ID}/resume

Resume synchronization or replication

all available. Full resume when peer is omitted

35

file protection

POST

/api/v1/resource/{ID}/lock/{LEVEL}

Start file protection

all available. Write protection, read/write protection

36

Unprotect the file

POST

/api/v1/resource/{ID}/unlock

Unprotect the file

all available

37

RID renewal

POST

/api/v1/resource/{ID}/rid/update

Renew the resource's RID (Rotate)

-

38

Force RID

POST

/api/v1/resource/{ID}/rid

Change the RID of a resource

-

39

Close open files

POST

/api/v1/resource/{ID}/close-files

Close all open files for cloning

all available

40

Network bandwidth change

PUT

/api/v1/resource/{ID}/override/network-limit/{PEER}

Randomly change network bandwidth

all available

41

Revert Network Bandwidth

DELETE

/api/v1/resource/{ID}/override/network-limit/{PEER}

Return network bandwidth to configured values

all available

42

check

Resource Status Query

GET

/api/v1/resource/{ID}/status

Returns a list of status values ​​for resources and connections

all available

43

Resource Performance Query

GET

/api/v1/resource/{ID}/perf

Returns performance information such as BAB and sockets

all available

44

Query resource replication latency

GET