setting

Query system settings

GET

/api/v1/config

Returns the setting in action

-

Query system settings (file)

GET

/api/v1/config/dump

read file and return

-

Query system settings (file, XML)

GET

/api/v1/config/dump-xml

Read the file and return it as XML

-

Change system settings

PUT

/api/v1/config

save to file

-

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

Update system settings

POST

/api/v1/config/adjust

Reading from a file and updating the settings in operation

-

Resource list lookup

GET

/api/v1/resources

Return a list of resource IDs

Necessity check required

Query individual resource settings

GET

/api/v1/resource/{ID}

Returns the setting in action

all available

Look up individual resource settings (file)

GET

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

read file and return

all available

Look up individual resource settings (file, XML)

GET

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

Read the file and return it as XML

all available

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

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

Updating individual resource settings

POST

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

Reading from a file and updating the settings in operation

all available

Delete individual resource settings

DELETE

/api/v1/resource/{ID}

delete file

Running resources are not affected.

control

Generate metadata

POST

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

Generate resource metadata

all available

Delete metadata

POST

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

Delete resource metadata

all available

Reset metadata

POST

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

Reset resource metadata

all available. 1.2 or higher

Metadata Cleanup

POST

/api/v1/resource/cleanup-meta

Delete obsolete metadata

-

Add resource

POST

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

Read and load resource files

all available

delete resource

POST

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

Remove resource from list

all available

Load resource file

POST

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

Loading a file into a resource

all available

Separate resource files

POST

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

Separate files from resources

all available

resource startup

POST

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

Load resources and run

all available.
add, attach, connect operations

stop resource

POST

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

Disconnect and detach resources

all available.
disconnect, detach, del actions

promotion

POST

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

Attempt to promote to Primary

-

demotion

POST

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

Demote to Secondary

-

connection

POST

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

Change to Connecting state

all available. All connections when peer is omitted

Disconnect

POST

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

Change to standalone status

all available. Disconnect all connections when peer is omitted

sync start

POST

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

Synchronize partner node as source

all available

Start remote sync

POST

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

Start syncing this node as source

all available

Consistency Verification Start

POST

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

Start consistency verification with partner node as source

all available

Consistency check stopped

POST

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

Aborting Consistency Verification in Progress

all available. 1.1 or later

pause

POST

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

Synchronization or replication paused

all available. Full pause when peer is omitted

resumption

POST

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

Resume synchronization or replication

all available. Full resume when peer is omitted

file protection

POST

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

Start file protection

all available. Write protection, read/write protection

Unprotect the file

POST

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

Unprotect the file

all available

RID renewal

POST

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

Renew the resource's RID (Rotate)

-

Force RID

POST

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

Change the RID of a resource

-

Close open files

POST

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

Close all open files for cloning

all available

Network bandwidth change

PUT

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

Randomly change network bandwidth

all available

Revert Network Bandwidth

DELETE

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

Return network bandwidth to configured values

all available

check

Resource Status Query

GET

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

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

all available

Resource Performance Query

GET

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

Returns performance information such as BAB and sockets

all available

Query resource replication latency

GET

/api/v1/resource/{ID}/lag

Returns a list of replication processing times

all available. 1.1 or later

Consistency verification/synchronization result query (summary)

GET

/api/v1/resource/{ID}/result

Returns a summary of synchronization or consistency verification results

-

Consistency verification/synchronization result query (range)

GET

/api/v1/resource/{ID}/result/batch/{index}/{count}

Returns file results of synchronization or consistency verification

Specify starting index and number of requests

Consistency verification/synchronization result inquiry (file)

GET

/api/v1/resource/{ID}/result/file/{dir}/{name}

Returns file results of synchronization or consistency verification

Specify directory index and file name

RID lookup

GET

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

Returns the resource's RID value (abbreviated Old ULID)

all available

RID lookup (all)

GET

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

Return RID value of resource (full Old ULID)

all available

EFS

Certificate list lookup

GET

/api/v1/efs/cert

Return a list of certificates for the Run As account

-

export certificate

POST

/api/v1/efs/cert/{Thumbprint}/export

Return the specified certificate in pfx format

The certificate content is passed in base64 encoding.

import certificate

POST

/api/v1/efs/cert

Import the certificate into your store

The certificate content is passed in base64 encoding.

Specify the current certificate for encryption

POST

/api/v1/efs/cert/{Thumbprint}/set-current

Make the specified certificate the current certificate

-

Delete certificate

DELETE

/api/v1/efs/cert/{Thumbprint}

Delete designated certificate

-

Snapshot
(1.2+)

Snapshot list query

GET

/api/v1/resource/{ID}/snapshot

Returns a list of snapshots of a specified resource

all available

View individual snapshots

GET

/api/v1/resource/{ID}/snapshot/{SnapshotID}

Return details of a specified snapshot

-

create snapshot

PUT

/api/v1/resource/{ID}/snapshot/{SnapshotID}

Create a snapshot of the specified ID

-

Remove Snapshot

DELETE

/api/v1/resource/{ID}/snapshot/{SnapshotID}

Remove specified snapshot

-

Rename snapshot

POST

/api/v1/resource/{ID}/snapshot/{SnapshotID}/rename-to/{NewSnapshotID}

Change the ID of a given snapshot

-

Snapshot restore

POST

/api/v1/resource/{ID}/snapshot/{SnapshotID}/recovery

Pointed Snapshot Restore

-

Export snapshot

POST

/api/v1/resource/{ID}/snapshot/{SnapshotID}/export

Export Specified Snapshots

-

Cancel Snapshot

POST

/api/v1/resource/{ID}/snapshot/cancel

Cancel snapshot restore or export

-

Snapshot Cleanup

POST

/api/v1/resource/{ID}/snapshot/cleanup

Delete snapshot information where no real image exists

all available

Link Snapshot to Letter

POST

/api/v1/resource/{ID}/snapshot/{SnapshotID}/expose/{SnapshotIndex}

Associate the specified snapshot image to letter

-

Unlink Snapshot Letter

POST

/api/v1/resource/{ID}/snapshot/{SnapshotID}/unexpose/{SnapshotIndex}

Unlink the letter of the specified snapshot image

-

Snapshot
image
(1.2+)

Snapshot image list query

GET

/api/v1/snapshot-image

Return a list of snapshot images

-

Delete snapshot image

DELETE

/api/v1/snapshot-image/{image}

Delete the specified snapshot image

-

Link snapshot image to letter

POST

/api/v1/snapshot-image/{image}/expose

Associate the specified snapshot image to letter

-

Unlink Snapshot Image Letter

POST

/api/v1/snapshot-image/{image}/unexpose

Unlink the letter of the specified snapshot image

-

Unlink snapshot image via letter

POST

/api/v1/snapshot-image/unexpose-by-path

Unlink snapshot image via letter

-

Snapshot
Storage
(1.2+)

Snapshot Storage List Query

GET

/api/v1/snapshot-storage

Return snapshot storage list

-

Add snapshot storage

PUT

/api/v1/snapshot-storage/{volume}/to/{storage}

Add Storage for Designated Letters

-

Change snapshot storage

POST

/api/v1/snapshot-storage/{volume}/to/{storage}

Change storage settings for designated letters

-

Delete snapshot storage

DELETE

/api/v1/snapshot-storage/{volume}/to/{storage}

Clear Storage for Designated Letter

-

Network filesystem
(1.2 or higher)

NFS List Query

GET

/api/v1/nfs

Returns a list of registered NFS connection information

-

Add NFS

PUT

/api/v1/nfs

Add NFS connection information

-

Delete NFS

DELETE

/api/v1/nfs/{name}

Delete specified NFS connection information

-

NFS connection

POST

/api/v1/nfs/{name}/connect

Connect to designated NFS

-

Disconnect NFS

POST

/api/v1/nfs/{name}/disconnect

Disconnect from designated NFS

-

management

FSR information inquiry

GET

/api/v1/system

Return general information such as version

-

FSR restart

POST

/api/v1/system/restart

Restart the FSR process

-

Stop FSR

POST

/api/v1/system/stop

Stop the FSR process

-

equipment

RID comparison

POST

/api/v1/tool/rid_compare

Compare two RIDs

-

license

License Lookup

GET

/api/v1/license

License Status Inquiry

-

License settings

PUT

/api/v1/license

License settings

-

system config dump
sys conf dump

-

-

GET /api/v1/config/dump

Output the contents of a system configuration file as JSON.

system config dump-xml
sys conf dump-xml

-

-

GET /api/v1/config/dump-xml

Output the contents of system configuration files to XML.

system config show
sys conf show

-

-

GET /api/v1/config

Outputs system configuration contents in operation as JSON.

system config adjust
sys conf adjust

-

-

POST /api/v1/config/adjust

The contents of the system configuration file are applied to running resources and activated.

system config edit
sys conf edit

-u, -user

Edit with text editor

GET /api/v1/config
PUT/api/v1/config
POST /api/v1/config/adjust

Interactively edit and apply system configurations.

system config property get {key}
sys conf prop get {key}

-

-

GET/api/v1/config

Outputs the value of the specified property in the system configuration file.

system config property set <key> <value>
sys conf prop set <key> <value>

--adjust
-a

apply to resource

GET/api/v1/config
PUT/api/v1/config
POST/api/v1/config/adjust

Changes the specified property value in the system configuration file.

system config property unset <key>
sys conf prop unset <key>

-

-

same

Change the specified properties in the system configuration file to default values.

control config dump <id|all>
conf dump <id>

-

-

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

Output the contents of a resource configuration file as JSON.

control config dump-xml <id|all>
conf dump-xml <id>

-

-

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

Output the content of a resource configuration file to XML.

control config show <id|all>
conf show <id|all>

-

-

GET /api/v1/resource/{ID}

Outputs the contents of the resource configuration in operation as JSON.

control config adjust <id|all>
conf adjust <id|all>

-

-

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

The contents of the resource configuration file are applied to the running resource and activated.

control config add <id>
conf add <id>

--force
-f

force overwrite

PUT /api/v1/resource/{ID}

Add resource configuration file.

--interactive
-i

Interactive setting mode

<id>
conf check config<id>

--force
-f

force delete

DELETE/api/v1/resource/{ID}

Delete the resource configuration file.

control config edit <id>
conf edit <id>

--user
-u

Edit with text editor

GET/api/v1/resource/{ID}
PUT/api/v1/resource/{ID}
POST/api/v1/resource/{ID}/adjust

Interactively edit and apply resource configurations.

control config property get <id> {key}
conf prop get <id> {key}

-

-

GET/api/v1/resource/{ID}

Outputs the value of the specified property in the resource configuration file.

control config property add <id> <key> <value>
conf prop add <id> <key> <value>

--adjust
-a

apply to resource

GET/api/v1/resource/{ID}
PUT/api/v1/resource/{ID}
POST/api/v1/resource/{ID}/adjust

Adds a value to a specified attribute in a resource configuration.
Valid only for properties in list form.

--index <숫자>

• i

<숫자>

insert at specified index

<id> <key>
conf prop control config property<id> <key>

--adjust
-a

apply to resource

same

Delete the specified attribute of the resource configuration.
Valid only for properties in list form.

control config property set <id> <key> <value>
conf prop set <id> <key> <value>

same

same

same

Changes the value of the specified attribute in the resource configuration file.

control config property unset <id> <key>
conf prop unset <id> <key>

same

same

same

Change the specified properties in the resource configuration file to default values.

control meta create <id|all>
meta create <id|all>

--force
-f

force overwrite

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

Generate resource metadata.
It can be performed only when the resources are separated.

control meta delete <id|all>
meta delete <id|all>

--force
-f

force delete

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

Delete resource metadata.
It can be performed only when the resources are separated.

control meta cleanup
meta cleanup

-

-

POST /api/v1/resource/cleanup-meta

Clean up unused metadata.

control add <id|all>
add <id|all>

-

-

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

Read the resource configuration file and load it into the resource list.

control of <id|all>
the<id|all>

-

-

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

Remove loaded resources from the list.

control attach <id|all>
attach <id|all>

-

-

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

Load resource file.

control detach <id|all>
detach <id|all>

-

-

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

Separate resource files.

control up <id|all>
up <id|all>

-

-

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

resource activation. (load, file load, connect)

control down <id|all>
down <id|all>

-

-

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

Disable resource. (end connection, disconnect file, disconnect)

control primary <id|all>
primary <id|all>

--force
-f

forced promotion

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

Promote a resource to Primary.

--unlock
-u

unlock file

control secondary <id|all>
secondary <id|all>

--timeout <num>
-t <num>

time limit

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

Demote a resource to Secondary.
If there is a timeout value, it waits for the buffer to be emptied for that amount of time. After that time, the buffer is forcibly emptied and demoted.

The --read-only option must be used together with the --lock option.

--lock
-l

file lock

--read-only

lock to read only

control connect <id|all> {peer|all}
connect <id|all> {peer|all}

--discard-my-data

throw away my data

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

Linking resources to partner nodes. It changes to connecting state.

control disconnect <id|all> {peer|all}
disconnect <id|all> {peer|all}

-

-

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

Disconnection with partner node. It changes to standalone status.

control invalidate <id|all> {peer}
invalidate <id|all> {peer}

--level <num>
-l <num>

synchronization level

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

Synchronization starts with partner node as source.

--report <mode>

Report generation scope

control invalidate-remote <id|all> {peer|all}
invalidate-remote <id|all> {peer|all}

--level <num>
-l <num>

synchronization level

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

Start synchronization with this node as source.

--report<mode>

Report generation scope

control verify <id|all> {peer}
verify <id|all> {peer}

-

-

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

Start consistency verification with partner node as source.

control verify-stop <id|all> {peer}
verify-stop <id|all> {peer}

-

-

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

Abort Consistency Verification in progress. 1.1 or higher.

control pause <id|all> {peer|all}
pause <id|all> {peer|all}

-

-

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

Synchronization or replication paused.

control resume <id|all> {peer|all}
resume <id|all> {peer|all}

-

-

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

Resume synchronization or replication.

control lock <id|all>
lock <id|all>

--read-only

lock to read only

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

Start protecting your files.

control unlock <id|all>
unlock <id|all>

-

-

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

Unprotect the file.

control close-files <id|all>
close-files <id|all>

-

-

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

Closes handles to files that are open for cloning.

control override network-limit <res-id|all> <peer-node|all> <value>
override network-limit <res-id|all> <peer-node|all> <value>

-

-

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

Randomly change the network bandwidth.

control restore network-limit <res-id|all> {peer-node|all}
restore network-limit <res-id|all> {peer-node|all}

-

-

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

Return the network bandwidth to the configured value.

system info
sys info

-

-

GET /api/v1/system

Engine information output.

control status {id|all}
status{id|all}

--verbose
-v

verbose output

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

Status output of resources and connections.

--watch
-w

monitoring

--interval <시간>
-i <시간>

Renewal cycle when monitoring

control perf {id|all}
perf {id|all}

--verbose
-v

verbose output

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

Performance statistics output, such as buffers and networks for resource connections.

--watch
-w

monitoring

--interval <시간>
-i <시간>

Renewal cycle when monitoring

control latency {id|all}
latency {id|all}

--verbose
-v

verbose output

GET /api/v1/resource/{ID}/lag

Output of the time required for each phase of replication data processing. 1.1 or higher.

--watch
-w

monitoring

--interval <시간>
-i <시간>

Renewal cycle when monitoring

control result <id> {dir-index} {filename}
result <id> {dir-index} {filename}

--verbose
-v

verbose output

GET /api/v1/resource/{ID}/result

Output the results of the most recent synchronization or consistency verification.
Since the result is stored in the target, it can be output only on the target.
If a directory and file name are specified, summary information is omitted and the result of the specified file is output.

control rid show <id|all>
rid show <id|all>

--verbose
-v

verbose output

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

RID output of the resource.
By default, only 2 old ULIDs are output, and all 32 are output when the long version option is specified.

--long
-l

Long version of RID output

events
ev

--json
-j

output in JSON format

GRPC SubscribeEvents

event monitoring.
Synchronization progress and performance statistics are basically transmitted every update cycle, but are omitted if there is no change with previous data.

--sync

Include sync progress

--perf

Include performance statistics

--interval <시간>
-i <시간>

Synchronization progress and performance statistics refresh rate

log
l

--home <경로>

engine home path

GRPCSubscribeEvents

Print the contents of the log file.
It operates similarly to the tail command and reads the system configuration file of the engine directly to determine the location of the log file, so it can be used even when the engine is shut down.
Receives resource loading events through gRPC and changes log files that should be output in real time.

--lines <숫자>
-n <숫자>

number of lines to output

--resource <id>
-t <id>

resource designation

--no-main

Disable main log

--no-resource

Disable resource log

--no-color

do not produce

--follow
-f

continuous output

perfmon {id|all}
p {id|all}

--json <파일명>
-j <파일명>

Export to JSON file

GRPC SubscribePerfs

Displays performance monitor information.
If you do not use the option to export to JSON or CSV, it will be output to the console screen.

If you use the --display option, you can output to the screen while exporting to a file.

--csv <파일명>
-c<파일명>

Export to CSV file

--interval <시간>
-i <시간>

information update cycle

--display
-d

output to console screen

--watch
-w

monitoring mode

RPC connection status

rpc

state

connection status

connected, disconnected

-

cause

error content

Used only in disconnected state

Program start/end

program

state

program startup status

started, exit

-

cause

error content

Used only in exit state

Update system settings

system_updated

-

-

-

Occurs when adjust is performed

crashed

crashed

cause

error content

-

In case of abnormal termination before starting the program.
1.1-A2

Add resource

added

resource

resource ID

-

-

node

own node name

-

group

your group name

-

delete resource

deleted

resource

resource ID

-

-

node

own node name

-

group

your group name

-

Add resource relative node

peer_added

resource

resource ID

-

-

node

own node name

-

group

your group name

-

peer

partner node name

-

peer_group

partner group name

-

Remove resource relative node

peer_deleted

resource

resource ID

-

-

node

own node name

-

group

your group name

-

peer

partner node name

-

peer_group

partner group name

-

Change resource node name

renamed

resource

resource ID

-

-

node

own node name

-

group

your group name

-

value

new node name

-

Change resource node name (relative)

peer_renamed

resource

resource ID

-

-

node

own node name

-

group

your group name

-

peer

partner node name

-

peer_group

partner group name

-

value

Opponent's new node name

-

Change resource group name

group_renamed

resource

resource ID

-

1.1-A5

node

own node name

-

group

your group name

-

value

new group name

-

Change resource group name (relative)

peer_group_renamed

resource

resource ID

-

1.1-A5

node

own node name

-

group

your group name

-

peer

partner node name

-

peer_group

partner group name

-

value

Opponent's new group name

-

Update resource settings

updated

resource

resource ID

-

Occurs when adjust is performed

node

own node name

-

group

your group name

-

resource connection status

state

resource

resource ID

-

-

node

own node name

-

group

your group name

-

peer

partner node name

-

peer_group

partner group name

-

value

state value

standalone, established 등

resource connection state (relative)

peer_state

resource

resource ID

-

-

node

own node name

-

group

your group name

peer

partner node name

-

peer_group

partner group name

-

value

state value

standalone, established 등

resource file status

file_state

resource

resource ID

-

node

own node name

-

group

your group name

-

value

state value

inconsistent, consistent 등

resource file state (relative)

peer_file_state

resource

resource ID

-

-

node

own node name

-

group

your group name

-

peer

partner node name

-

peer_group

partner group name

-

value

state value

inconsistent, consistent 등

resource role

role

resource

resource ID

-

-

node

own node name

-

group

your group name

-

value

role value

primary, secondary

resource role (relative)

peer_role

resource

resource ID

-

-

node

own node name

-

group

your group name

-

peer

partner node name

-

peer_group

partner group name

-

value

role value

primary, secondary

Node Connection Behavior

connection

resource

resource ID

-

-

node

own node name

-

group

your group name

-

peer

partner node name

-

peer_group

partner group name

-

state

connection status

connected, accepted, disconnected

url

IP:Port

address of peer node

cause

error content

Used only with disconnected

Connection refused from peer node

refuse

resource

resource ID

-

-

node

own node name

-

group

your group name

-

peer

partner node name

-

peer_group

partner group name

-

cause

reason for refusal

irrelevance (irrelevant node), split-brain
two-primary, invalid-direction

younger

younger node name

-

Recognize partner node name

peer_recognized

resource

resource ID

-

Occurs only when the partner node is a group.
Remove name attribute from 1.1-A1 and later 1.1-A5

node

own node name

-

group

your group name

-

peer

partner node name

-

peer_group

partner group name

-

Error during state operation

state_err

resource

resource ID

-

1.2 or higher

node

own node name

-

group

your group name

-

peer

partner node name

-

peer_group

partner group name

-

value

error content

-

next

next state

Output only when automatically transitioning to the next state

write error

write_error

resource

resource ID

-

-

node

own node name

-

group

your group name

-

filename

file name

absolute path

cause

error content

-

disk space status

diskspace

resource

resource ID

-

-

node

own node name

-

group

your group name

-

state

space state

not_enough, enough

remain

remaining capacity

units of bytes. string format

performance information

perf

resource

resource ID

-

--perf option required

node

own node name

-

group

your group name

-

peer

partner node name

-

peer_group

partner group name

-

perf

performance information

It is the same as the performance information of REST-API.

sync status

sync

resource

resource ID

-

--sync option required

node

own node name

-

group

your group name

-

peer

partner node name

-

peer_group

partner group name

-

status

sync status

It is the same as the sync state of REST-API.

file lock

file_lock

resource

resource ID

-

-

state

locked state

It is the same as the file lock status of REST-API.

node

own node name

-

group

your group name

-

consistency warning

consistency_warn

resource

resource ID

-

An event that occurs when the target node unlocks a file.
To be removed in 1.2

node

own node name

-

group

your group name

-

RID

rid

resource

resource ID

-

node

own node name

group

your group name

-

value

RID value

consistency

flag

true if the file state is Consistent or higher

outdated

flag

true if the file status is Outdated

primary

flag

true if promoted

crashed_primary

flag

true if abnormal termination in Primary state

File buffer usage warning

file_buf_warn

resource

resource ID

-

0.9.1

node

own node name

-

group

your group name

-

peer

partner node name

-

peer_group

partner group name

-

buffer overflow

overflowed

resource

resource ID

-

0.9.1

node

own node name

-

group

your group name

-

peer

partner node name

-

peer_group

partner group name

-

snapshot state

snapshot_state

resource

resource ID

-

1.2

node

own node name

-

group

your group name

-

snapshot

situation

available, creating, … etc.

err

error content

Used only in case of error

Add snapshot

snapshot_added

resource

resource ID

-

1.2

node

own node name

-

group

your group name

-

snapshot

Snapshot ID

-

images

List of image GUIDs

-

Delete snapshot

snapshot_deleted

resource

resource ID

-

1.2

node

own node name

-

group

your group name

-

snapshot

Snapshot ID

-

images

List of image GUIDs

-

Rename snapshot

snapshot_renamed

resource

resource ID

-

1.2

node

own node name

-

group

your group name

-

snapshot

Snapshot ID (source)

-

value

Changed ID (dest)

-

Add snapshot image

snapshot_image_added

image

Image GUID

-

1.2

path

original volume letter path

-

volume

Source Volume GUID Path

-

Delete snapshot image

snapshot_image_deleted

image

Image GUID

-

1.2

Attach snapshot image

snapshot_image_exposed

resource

resource ID

Used only if the snapshot image belongs to a resource

1.2

node

own node name

Used only if the snapshot image belongs to a resource

group

your group name

Used only if the snapshot image belongs to a resource

snapshot

Snapshot ID

Used only if the snapshot image belongs to a resource

image

Image GUID

-

value

Linked Letters

-

Unlink snapshot image

snapshot_image_unexposed

resource

resource ID

Used only if the snapshot image belongs to a resource

1.2

node

own node name

Used only if the snapshot image belongs to a resource

group

your group name

Used only if the snapshot image belongs to a resource

snapshot

Snapshot ID

Used only if the snapshot image belongs to a resource

image

Image GUID

-

value

linked letters

-

Snapshot images and resources are disconnected

snapshot_image_unlinked

resource

resource ID

-

1.2

node

own node name

-

group

your group name

-

snapshot

Snapshot ID

-

image

Image GUID

-

license status

license

status

license status

invalid, expired, not exist, valid

-

license-type

License type

temporary, permanent

expires-at

Limited time (date)

Year-Month-Day (e.g. 2020-11-30)

expires-in

Time limit (remaining days)

-

efs analyze dir <dir…>
efs analyze by-dir <dir…>

--json
-j

output in JSON format

GRPCEFSA analysis

Searches encrypted files under the specified directory to analyze the list of certificates required for decryption and the installation status.

--verbose
-v

verbose output

efs analyze resource <id>
efs analyze by-res <id>

--json
-j

output in JSON format

GRPCEFSA analysis

Searches encrypted files under the replication path of the specified resource to analyze the list of certificates required for decryption and the installation status.

--verbose
-v

verbose output

efs cert list

-

-

GET /api/v1/efs/cert

Prints a list of certificates in the certificate store.

efs cert export <thumbprint> <file>

--password <password>
-p <password>

certificate password

POST /api/v1/efs/cert/{Thumbprint}/export

Analyzes the list of certificates required for decryption and the installation status by looking up encrypted files under the replication path of the specified resource.

efs cert import <file>

--password <password>
-p <password>

certificate password

POST/api/v1/efs/cert

Import the certificate in the specified file and register it in the certificate store

--set-current
-c

set as current certificate

efs cert set-current <thumbprint>

-

-

POST/api/v1/efs/cert/{Thumbprint}/set-current

Make the specified certificate in the certificate store the current certificate for encryption

efs cert delete <thumbprint>

-

-

DELETE /api/v1/efs/cert/{Thumbprint}

Delete a given certificate from the certificate store

efs usercert list

-

-

GET/api/v1/efs/cert

Prints a list of certificates in the certificate store.

efs usercert export <thumbprint> <file>

--password <password>
-p <password>

certificate password

POST/api/v1/efs/cert/{Thumbprint}/export

Analyzes the list of certificates required for decryption and the installation status by looking up encrypted files under the replication path of the specified resource.

efs usercert import <file>

--password <password>
-p <password>

certificate password

POST/api/v1/efs/cert

Import the certificate in the specified file and register it in the certificate store

--set-current
-c

set as current certificate

efs usercert set-current <thumbprint>

-

-

POST /api/v1/efs/cert/{Thumbprint}/set-current

Make the specified certificate in the certificate store the current certificate for encryption

efs usercert delete <thumbprint>

-

-

DELETE /api/v1/efs/cert/{Thumbprint}

Delete a given certificate from the certificate store

nfs list

-

-

GET /api/v1/nfs

Displays a list of network file system connection information registered in the FSR execution account.

nfs add <remote-path>

--username <username>
-u <username>

username

PUT/api/v1/nfs

Register network file system connection information in the FSR execution account.

--password <password>
-p <password>

password

nfs del <remote-path>

-

-

DELETE /api/v1/nfs/{name}

Deletes the network file system connection information registered in the FSR execution account.

nfs connect <remote-path>

-

-

POST /api/v1/nfs/{name}/connect

Connect to the specified network file system.

nfs disconnect <remote-path>

-

-

POST /api/v1/nfs/{name}/disconnect

Terminate the connection to the specified network file system.

snapshot list <id|all>

--verbose
-v

verbose output

GET /api/v1/resource/{ID}/snapshot

Prints a list of snapshots of the specified resource.

--desc
-d

sort in reverse order

snapshot list-exposed

--desc
-d

sort in reverse order

GET/api/v1/resource/{ID}/snapshot

Prints a list of snapshots linked to the letter.

snapshot show <id> <snapshot>

-

-

GET /api/v1/resource/{ID}/snapshot/{SnapshotID}

Display detailed information of the specified snapshot.

snapshot create <id> <snapshot>

-

-

PUT /api/v1/resource/{ID}/snapshot/{SnapshotID}

Creates a snapshot of the specified ID.

snapshot delete <id> <snapshot>

-

-

DELETE/api/v1/resource/{ID}/snapshot/{SnapshotID}

Delete the specified snapshot.

snapshot rename <id> <snapshot> <rename-to>

-

-

POST /api/v1/resource/{ID}/snapshot/{SnapshotID}/rename-to/{NewSnapshotID}

Changes the ID of the specified snapshot.

snapshot recovery <id> <snapshot>

-

-

POST /api/v1/resource/{ID}/snapshot/{SnapshotID}/recovery

Restores the resource replication path to the specified snapshot.

snapshot export <id> <snapshot> <target-paths...>

--combine

Copy multiple replication paths to one destination

POST /api/v1/resource/{ID}/snapshot/{SnapshotID}/export

Copy the files to be copied from the snapshot to the specified path.

snapshot cancel <id>

-

-

POST /api/v1/resource/{ID}/snapshot/cancel

Cancels the snapshot-related operation of the specified resource.

snapshot cleanup <id|all>

-

-

POST /api/v1/resource/{ID}/snapshot/cleanup

Cycles through the snapshots of the specified resource and deletes the snapshots whose images have been deleted.

snapshot expose <id> <snapshot> <image-index> <expose-path>

-

-

POST /api/v1/resource/{ID}/snapshot/{SnapshotID}/expose/{SnapshotIndex}

Links the specified snapshot image to the specified path (letter).

snapshot unexpose <id> <snapshot>

-

-

POST /api/v1/resource/{ID}/snapshot/{SnapshotID}/unexpose/{SnapshotIndex}

Disconnect the path (letter) of the specified snapshot image.

snapshot-image list

--unlinked-only
-u

Outputs only lists that are not associated with resources

GET /api/v1/snapshot-image

Prints a list of snapshot images.

--local
-l

Doing fsradm itself

snapshot-image delete <guid>
snapshot-image del <guid>

--local
-l

Doing fsradm itself

DELETE /api/v1/snapshot-image/{image}

Delete the specified snapshot image.

snapshot-image expose <guid> <expose-path>

--local
-l

Doing fsradm itself

POST /api/v1/snapshot-image/{image}/expose

Links the specified snapshot image to the specified path (letter).

snapshot-image unexpose <guid>

--local
-l

Doing fsradm itself

POST /api/v1/snapshot-image/{image}/unexpose

Disconnect the path (letter) of the specified snapshot image.

snapshot-image unexpose-by-path <expose-path>

--local
-l

Doing fsradm itself

POST /api/v1/snapshot-image/unexpose-by-path

Disconnects the specified path (letter) and the snapshot image.

snapshot-storage list

--for

Query the storage where snapshots of a given letter are stored

GET /api/v1/snapshot-storage

Prints the snapshot storage list.

--on

Storage inquiry in designated letter

--local
-l

Doing fsradm itself

snapshot-storage add <for> <on> {max-size|unbounded}

--local
-l

Doing fsradm itself

PUT /api/v1/snapshot-storage/{volume}/to/{storage}

Add snapshot storage.
The last argument has a default value of unbouned, and is limited so that it cannot exceed the size when entered in units of capacity.

snapshot-storage change <for> <on> {max-size|unbounded}

--local
-l

Doing fsradm itself

POST/api/v1/snapshot-storage/{volume}/to/{storage}

Change the settings of snapshot storage.

snapshot-storage delete <for> <on>
snapshot-storage del <for> <on>

--local
-l

Doing fsradm itself

DELETE/api/v1/snapshot-storage/{volume}/to/{storage}

Delete the snapshot storage.

driver installation

driver install

--force
-f

force install

-

Install the driver. Fails when the driver is loading.
When using the forced installation option, remove the driver being loaded before installing it.

remove driver

driver uninstall

--force
-f

forced removal

-

uninstall the driver Fails when the driver is loading.
When using the forced installation option, separate and remove the driver being loaded.

engine restart

system restart
sys restart

-

POST /api/v1/system/restart

Restarts the entire operation of the engine while maintaining the current process PID.

engine shutdown

system stop
sys stop

-

POST /api/v1/system/stop

Sends a shutdown command to the running engine to shut itself down. If running as a service, it will automatically restart.