Table of Contents

개요

사용자/복제 콘솔 응용은 FSR에 CLI 명령어를 전달하여 FSR의 운영과 관련한 모든 동작을 수행할 수 있습니다.
FSR CLI 는 모두 REST-API 로 제공합니다.
노드 별 개별 설정은 각 노드상에서 명령어로 설정하거나 제어합니다.(클러스터 단위의 제어명령은 제공하지 않는다)
모든 설정은 기본적으로 운영 중 동적 적용 가능합니다.(필수 속성 등 일부 설정 제외)

REST-API

모든 REST-API는 gRPC 기반으로 제작되었으며, JSON-RPC over HTTP 형태로 동작합니다. 감시를 위한 기능은 지속적인 데이터 전달이 필요하므로 gRPC만 제공됩니다.

...

분류

...

항목

...

REST-API

...

동작

...

비고

...

설정

...

시스템 설정 조회

...

Status

title	GET

...

/api/v1/config

...

동작 중인 설정을 반환

...

-

...

시스템 설정 조회 (파일)

...

Status

title	GET

...

/api/v1/config/dump

...

파일을 읽어 반환

...

-

...

시스템 설정 조회 (파일, XML)

...

Status

title	GET

...

/api/v1/config/dump-xml

...

파일을 읽어 XML로 반환

...

-

...

시스템 설정 변경

...

Status

colour	Purple
title	PUT

...

/api/v1/config

...

파일에 저장

...

-

...

시스템 설정 변경 (업데이트)

...

Status

colour	Purple
title	PUT

...

/api/v1/config/update

...

설정을 적용하고 파일에 저장

...

변경할 부분만 받아 처리함
adjust 호출 필요 없음

...

시스템 설정 갱신

...

Status

colour	Blue
title	POST

...

/api/v1/config/adjust

...

파일로부터 읽어 동작 중인 설정을 갱신

...

-

...

리소스 목록 조회

...

Status

title	GET

...

/api/v1/resources

...

리소스 ID 목록 반환

...

필요성 점검 필요

...

개별 리소스 설정 조회

...

Status

title	GET

...

/api/v1/resource/{ID}

...

동작 중인 설정을 반환

...

all 사용 가능

...

개별 리소스 설정 조회 (파일)

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

1

setting

Query system settings

Status

title	GET

/api/v1/

resource/{ID}/dump

파일을 읽어 반환

all 사용 가능

10개별 리소스 설정 조회 (파일, XML

config

Returns the setting in action

-

2

Query system settings (file)

Status

title	GET

/api/v1/

resource/{ID}

config/dump

read file and return

-

xml

파일을 읽어 XML로 반환

all 사용 가능

11개별 리소스 설정 변경

3

Query system settings (file, XML)

Status

title	GET

/api/v1/config/dump-xml

Read the file and return it as XML

-

4

Change system settings

Status

colour	Purple
title	PUT

/api/v1/

resource/{ID}

파일에 저장

없는 ID 지정 시 새 리소스 파일 생성

12개별 리소스 설정 변경 (업데이트

config

save to file

-

5

Change system settings (update)

Status

colour	Purple
title	PUT

/api/v1/

resource

config/

{ID}/13개별 리소스 설정 갱신

update

설정을 적용하고 파일에 저장

변경할 부분만 받아 처리함
adjust 호출 필요 없음

Apply settings and save to file

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

6

Update system settings

Status

colour	Blue
title	POST

/api/v1/

resource

config/

{ID}/adjust

파일로부터 읽어 동작 중인 설정을 갱신

all 사용 가능

14

개별 리소스 설정 삭제

StatuscolourRedtitleDELETE

adjust

Reading from a file and updating the settings in operation

-

7

Resource list lookup

Status

title	GET

/api/v1/

resource/{ID}

파일 삭제

동작 중인 리소스에는 영향이 없다

15

제어

메타 데이터 생성

StatuscolourBluetitlePOST

resources

Return a list of resource IDs

Necessity check required

8

Query individual resource settings

Status

title	GET

/api/v1/resource/{ID}

/create-meta

리소스 메타 데이터 생성

all 사용 가능

16

메타 데이터 삭제

StatuscolourBluetitlePOST

Returns the setting in action

all available

9

Look up individual resource settings (file)

Status

title	GET

/api/v1/resource/{ID}/

delete-meta

리소스 메타 데이터 삭제

all 사용 가능

17

메타 데이터 정리

StatuscolourBluetitlePOST

dump

read file and return

all available

10

Look up individual resource settings (file, XML)

Status

title	GET

/api/v1/resource/

cleanup-meta

사용되지 않는 메타 데이터 삭제

-

18리소스 추가

{ID}/dump-xml

Read the file and return it as XML

all available

11

Change individual resource settings

Status

colour

Blue

title
Purple

POST

PUT

/api/v1/resource/{ID}

/add

리소스 파일을 읽어 적재

all 사용 가능

19리소스 삭제

save to file

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

12

Change individual resource settings (update)

Status

colour

Blue

title
Purple

POST

PUT

/api/v1/resource/{ID}/

delete

리소스를 목록에서 제거

all 사용 가능

20리소스 파일 적재

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

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

attach

리소스에 파일 적재

all 사용 가능

21리소스 파일 분리

adjust

Reading from a file and updating the settings in operation

all available

14

Delete individual resource settings

Status

colour

Blue

title
Red

POST

DELETE

/api/v1/resource/{ID}

/detach

리소스에서 파일 분리

all 사용 가능

22리소스 기동

delete file

Running resources are not affected.

15

control

Generate metadata

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

up

리소스를 적재하여 실행

all 사용 가능.
add, attach, connect 동작

23

리소스 중지

create-meta

Generate resource metadata

all available

16

Delete metadata

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

down

리소스의 연결을 끊고 분리

all 사용 가능.
disconnect, detach, del 동작

24승격

delete-meta

Delete resource metadata

all available

17

Reset metadata

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

primary

Primary로 승격 시도

-

25강등

reset-meta

Reset resource metadata

all available. 1.2 or higher

18

Metadata Cleanup

Status

colour	Blue
title	POST

/api/v1/resource/

{ID}/secondarySecondary로 강등

cleanup-meta

Delete obsolete metadata

-

26

19

연결

Add resource

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

connect/{PEER}

Connecting 상태로 변경

all 사용 가능. peer 생략 시 전체 연결

27연결 해제

add

Read and load resource files

all available

20

delete resource

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

disconnect/{PEER}

Standalone 상태로 변경

all 사용 가능. peer 생략 시 전체 연결 해제

28동기화 시작

delete

Remove resource from list

all available

21

Load resource file

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

resync/{PEER}

상대 노드를 소스로 동기화 시작

all 사용 가능

29원격 동기화 시작

attach

Loading a file into a resource

all available

22

Separate resource files

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

resync-remote/{PEER}

이 노드를 소스로 동기화 시작

all 사용 가능

30정합성 검증 시작

detach

Separate files from resources

all available

23

resource startup

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

verify/{PEER}

상대 노드를 소스로 정합성 검증 시작

all 사용 가능

31일시 중지

up

Load resources and run

all available.
add, attach, connect operations

24

stop resource

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

pause

동기화 또는 복제 일시 중지

all 사용 가능. peer 생략 시 전체 일시 중지

32재개

down

Disconnect and detach resources

all available.
disconnect, detach, del actions

25

promotion

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

resume

동기화 또는 복제 재개

all 사용 가능. peer 생략 시 전체 재개

33파일 보호

primary

Attempt to promote to Primary

-

26

demotion

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

lock/{LEVEL}

파일 보호 시작

all 사용 가능. 쓰기 방지, 읽기/쓰기 방지

34파일 보호 해제

secondary

Demote to Secondary

-

27

connection

Status

colour	Blue
title	POST

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

unlock

파일 보호 해제

all 사용 가능

35RID 갱신

{PEER}

Change to Connecting state

all available. All connections when peer is omitted

28

Disconnect

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

rid

disconnect/

update

리소스의 RID 갱신 (Rotate)

-

36RID 강제 설정

{PEER}

Change to standalone status

all available. Disconnect all connections when peer is omitted

29

sync start

Status

colour	Blue
title	POST

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

rid

리소스의 RID를 변경

-

37열려있는 파일 닫기

{PEER}

Synchronize partner node as source

all available

30

Start remote sync

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

close-files

복제를 위해 열려있는 파일을 모두 닫음

all 사용 가능

38네트워크 대역폭 변경

resync-remote/{PEER}

Start syncing this node as source

all available

31

Consistency Verification Start

Status

colour

Purple

title
Blue

PUT

POST

/api/v1/resource/{ID}/

override

verify/

network-limit/

{PEER}

네트워크 대역폭을 임의로 변경

Start consistency verification with partner node as source

all

사용 가능네트워크 대역폭 되돌리기

available

39

32

Consistency check stopped

Status

colour

Red

title
Blue

DELETE

POST

/api/v1/resource/{ID}/

override/network

verify-

limit40

조회

리소스 상태 조회

StatustitleGET

stop/{PEER}

네트워크 대역폭을 구성 값으로 되돌리기

all 사용 가능

Aborting Consistency Verification in Progress

all available. 1.1 or later

33

pause

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

status

리소스와 연결의 상태 값 목록 반환

all 사용 가능

41

리소스 성능 조회

StatustitleGET

pause

Synchronization or replication paused

all available. Full pause when peer is omitted

34

resumption

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

perf

BAB, 소켓 등의 성능 정보 반환

all 사용 가능

42

정합성 검증/동기화 결과 조회 (요약)

StatustitleGET

resume

Resume synchronization or replication

all available. Full resume when peer is omitted

35

file protection

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

result

동기화 또는 정합성 검증의 결과 요약 내용 반환

-

43

정합성 검증/동기화 결과 조회 (범위)

StatustitleGET

lock/{LEVEL}

Start file protection

all available. Write protection, read/write protection

36

Unprotect the file

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

result/batch/{index}/{count}

동기화 또는 정합성 검증의 파일 결과 반환

시작 인덱스와 요청 개수 지정

44

정합성 검증/동기화 결과 조회 (파일)

StatustitleGET

unlock

Unprotect the file

all available

37

RID renewal

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

result/file/{dir}/{name}

동기화 또는 정합성 검증의 파일 결과 반환

디렉토리 인덱스와 파일명 지정

45

RID 조회

StatustitleGET StatustitleGET

rid/update

Renew the resource's RID (Rotate)

-

38

Force RID

Status

colour	Blue
title	POST

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

리소스의 RID 값 반환 (Old ULID 축약)

all 사용 가능

46

RID 조회 (전체)

Change the RID of a resource

-

39

Close open files

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

rid

close-

long

리소스의 RID 값 반환 (전체 Old ULID)

all 사용 가능

47

EFS

인증서 목록 조회

StatustitleGET

files

Close all open files for cloning

all available

40

Network bandwidth change

Status

colour	Purple
title	PUT

/api/v1/

efs/cert

실행 계정의 인증서 목록 반환

-

48인증서 내보내기

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

Randomly change network bandwidth

all available

41

Revert Network Bandwidth

Status

colour

Blue

title
Red

POST

DELETE

/api/v1/

efs/cert

resource/{

Thumbprint}/export

지정 인증서를 pfx 포맷으로 반환

인증서 내용은 base64 인코딩으로 전달

49

인증서 가져오기

StatuscolourBluetitlePOST

ID}/override/network-limit/{PEER}

Return network bandwidth to configured values

all available

42

check

Resource Status Query

Status

title	GET

/api/v1/resource/

efs

{ID}/

cert

인증서를 스토어로 가져오기

인증서 내용은 base64 인코딩으로 전달

50

암호화를 위한 현재 인증서 지정

StatuscolourBluetitlePOST

status

Returns a list of status values for resources and connections

all available

43

Resource Performance Query

Status

title	GET

/api/v1/

efs/cert

resource/{

Thumbprint

ID}/

set-current

지정 인증서를 현재 인증서로 지정

-

51

인증서 삭제

StatuscolourRedtitleDELETE

perf

Returns performance information such as BAB and sockets

all available

44

Query resource replication latency

Status

title	GET

/api/v1/

efs/cert

resource/{

Thumbprint

ID}

지정 인증서 삭제

-

52

관리

FSR 정보 조회

/lag

Returns a list of replication processing times

all available. 1.1 or later

45

Consistency verification/synchronization result query (summary)

Status

title	GET

/api/v1

/system버전 등의 일반적인 정보 반환FSR 재시작

/resource/{ID}/result

Returns a summary of synchronization or consistency verification results

-

53

46

Consistency verification/synchronization result query (range)

Status

colour

Blue

title

POST

GET

/api/v1/

system/restart

FSR 프로세스 재시작

-

54

FSR 중지

StatuscolourBluetitlePOST

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

Returns file results of synchronization or consistency verification

Specify starting index and number of requests

47

Consistency verification/synchronization result inquiry (file)

Status

title	GET

/api/v1

/system/stop

FSR 프로세스 중지

-

55

도구

RID 비교

StatuscolourBluetitlePOST

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

Returns file results of synchronization or consistency verification

Specify directory index and file name

48

RID lookup

Status

title	GET

/api/v1/

tool

resource/{ID}/rid

_compare

두 RID 비교

-

56

라이선스

라이선스 조회

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

all available

49

RID lookup (all)

Status

title	GET

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

Return RID value of resource (full Old ULID)

all available

50

EFS

Certificate list lookup

Status

title	GET

/api/v1/

license라이선스 상태 조회

efs/cert

Return a list of certificates for the Run As account

-

57

51

라이선스 설정

export certificate

Status

colour

Purple

title
Blue

PUT

POST

/api/v1/

license

라이선스 설정

-

리소스 ID 확장

0.7에서 로컬 복제 기능이 추가되면서 하나의 리소스 파일에 두 개 이상의 노드가 로컬에 적재 될 수 있게 되었습니다. 이런 경우 리소스 ID만으로는 노드를 구분할 수 없으므로 다음과 같이 노드명을 추가로 지정해야 합니다.

리소스ID:노드명

호스트명을 인식하여 자신의 노드로 인식되는 노드만 지정 할 수 있습니다.
노드명을 생략하여 리소스 ID만 지정하면 자신의 모든 노드에 일괄 적용합니다.
- 단, 다음의 명령은 노드가 1개인 경우에만 노드명을 생략 할 수 있습니다.
  - 승격, 강등, 동기화/정합성 검증 시작

사용 예)

노드명 지정: fsradm up r0:node1
노드명 생략: fsradm up r0

조회 명령의 출력 내용

리소스 상태 조회

Resources(Array)
- id: 리소스 ID
- node: 자신의 노드명
- role: 역할
- file_state: 파일 상태
- lock: 파일 잠금 상태
- last_promoted: 마지막으로 승격된 시간
- pending: 다운로드 중인 파일 개수
- connections(Array): 상대 노드와의 연결 목록
  - peer: 상대 노드명
  - state: 내 상태
  - role: 상대 노드의 역할
  - peer_state: 상대 노드 상태
  - file_state: 상대 노드 파일 상태
  - repl_started: 복제가 시작된 시간
  - last_synced: 최근 동기화 완료 시간
  - out_of_sync: 타겟에 적용되지 않았고 버퍼링 되지 않은 데이터량
  - sync_errors: 동기화 오류 발생 수
  - sync: 동기화 상태. 진행 중인 아니면 NULL
    - message: 상태 메시지
    - errored_files: 오류가 발생한 파일 수
    - bytes_done: 동기화 완료된 바이트 수
    - bytes_total: 동기화 해야하는 총 바이트 수
    - progress: 진행률 (0~100%)

리소스 성능 조회

Resources(Array)
- id: 리소스 ID
- node: 자신의 노드명
- connections(Array): 상대 노드와의 연결 목록
  - peer: 상대 노드명
  - bytes_in: 초당 수신량
  - bytes_out: 초당 전송량
  - memory_buffer: 메모리 버퍼 상태
    - usage: 사용량
    - size: 크기
  - file_buffer: 파일 버퍼 상태
    - usage: 사용량
    - limit: 제한

명령어

fsradm의 모든 기능은 gRPC와 REST-API를 통해 동작합니다.
control 명령이 기본 명령으로 지정되어 있으므로 생략하고 하위 명령을 바로 사용 할 수 있습니다.

명령어 구조:

control, ctl: 리소스 관련 제어
- config, conf: 리소스 구성 파일 제어
  - property, prop: 개별 속성 제어
- meta: 메타 데이터 제어
- rid: RID 제어
driver: 드라이버 제어 (윈도 전용)
efs: NTFS EFS 분석 및 인증서 제어 (윈도 전용)
- cert: FSR 엔진 인증서 제어
- usercert: 사용자 인증서 제어
events, ev: 이벤트 모니터링
license: 라이선스 제어
log, l: 로그 모니터링
perfmon, p: 성능 모니터
system, sys: 시스템 제어
- config, conf: 시스템 구성 파일 제어
  - property, prop: 개별 속성 제어

이 문서에서 사용하는 명령어의 인수과 표기 방법은 다음과 같습니다.

생략 가능한 인수: {arg}
필수 인수: <arg>
리소스 ID: <id>
리소스 ID 또는 all: <id|all>

시간 값의 경우 다음과 같이 단위를 같이 기입 할 수 있습니다. 기본 단위는 '초'입니다.

100ms, 0.1s, 1m, 1h

설정

명령어

옵션

옵션 설명

사용 API

설명

1

system config dump
sys conf dump

-

Status

title	GET

/api/v1/config/dump

시스템 구성 파일의 내용을 JSON으로 출력.

2

system config dump-xml
sys conf dump-xml

-

Status

title	GET

/api/v1/config/dump-xml

시스템 구성 파일의 내용을 XML로 출력.

3

system config show
sys conf show

-

Status

title	GET

/api/v1/config

동작 중인 시스템 구성 내용을 JSON으로 출력.

4

system config adjust
sys conf adjust

-

efs/cert/{Thumbprint}/export

Return the specified certificate in pfx format

The certificate content is passed in base64 encoding.

52

import certificate

Status

colour	Blue
title	POST

/api/v1/efs/cert

Import the certificate into your store

The certificate content is passed in base64 encoding.

53

Specify the current certificate for encryption

Status

colour	Blue
title	POST

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

Make the specified certificate the current certificate

-

54

Delete certificate

Status

colour	Red
title	DELETE

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

Delete designated certificate

-

55

Snapshot
(1.2+)

Snapshot list query

Status

title	GET

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

Returns a list of snapshots of a specified resource

all available

56

View individual snapshots

Status

title	GET

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

Return details of a specified snapshot

-

57

create snapshot

Status

colour	Purple
title	PUT

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

Create a snapshot of the specified ID

-

58

Remove Snapshot

Status

colour	Red
title	DELETE

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

Remove specified snapshot

-

59

Rename snapshot

Status

colour	Blue
title	POST

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

Change the ID of a given snapshot

-

60

Snapshot restore

Status

colour	Blue
title	POST

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

Pointed Snapshot Restore

-

61

Export snapshot

Status

colour	Blue
title	POST

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

Export Specified Snapshots

-

62

Cancel Snapshot

Status

colour	Blue
title	POST

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

Cancel snapshot restore or export

-

63

Snapshot Cleanup

Status

colour	Blue
title	POST

/api/v1/

config/adjust

시스템 구성 파일의 내용을 동작 중인 리소스에 적용하고 활성화한다.

5

system config edit
sys conf edit

-u, -user

텍스트 에디터로 수정

StatustitleGET

resource/{ID}/snapshot/cleanup

Delete snapshot information where no real image exists

all available

64

Link Snapshot to Letter

Status

colour	Blue
title	POST

/api/v1/

config

Status

colour	Purple
title	PUT

/api/v1/config

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

Associate the specified snapshot image to letter

-

65

Unlink Snapshot Letter

Status

colour	Blue
title	POST

/api/v1/

config/adjust

시스템 구성 내용을 대화형으로 편집하고 적용한다.

6

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

-

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

Unlink the letter of the specified snapshot image

-

66

Snapshot
image
(1.2+)

Snapshot image list query

Status

title	GET

/api/v1/

config

시스템 구성 파일의 지정 속성 값을 출력한다.

7

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

--adjust
-a

리소스에 적용한다

Status

title	GET

/api/v1/config

snapshot-image

Return a list of snapshot images

-

67

Delete snapshot image

Status

colour

Purple

title
Red

PUT

DELETE

/api/v1/

config
status

snapshot-image/{image}

Delete the specified snapshot image

-

68

Link snapshot image to letter

Status

colour	Blue
title	POST

/api/v1

/config/adjust

시스템 구성 파일의 지정 속성 값을 변경한다.

8

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

-

상동

시스템 구성 파일의 지정 속성을 기본 값으로 변경한다.

9

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

-

StatustitleGET

/snapshot-image/{image}/expose

Associate the specified snapshot image to letter

-

69

Unlink Snapshot Image Letter

Status

colour	Blue
title	POST

/api/v1/

resource

snapshot-image/{

ID

image}/

dump

리소스 구성 파일의 내용을 JSON으로 출력.

10

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

-

StatustitleGET

unexpose

Unlink the letter of the specified snapshot image

-

70

Unlink snapshot image via letter

Status

colour	Blue
title	POST

/api/v1/

resource/{ID}/dump-xml

리소스 구성 파일의 내용을 XML로 출력.

11

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

-

snapshot-image/unexpose-by-path

Unlink snapshot image via letter

-

71

Snapshot
Storage
(1.2+)

Snapshot Storage List Query

Status

title	GET

/api/v1/

resource/{ID}

동작 중인 리소스 구성 내용을 JSON으로 출력.

12

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

-

snapshot-storage

Return snapshot storage list

-

72

Add snapshot storage

Status

colour

Blue

title
Purple

POST

PUT

/api/v1/

resource

snapshot-storage/{

ID

volume}/

adjust

리소스 구성 파일의 내용을 동작 중인 리소스에 적용하고 활성화한다.

13

control config add <id>
conf add <id>

--force
-f

강제로 덮어 씌우기

to/{storage}

Add Storage for Designated Letters

-

73

Change snapshot storage

Status

colour

Purple

title
Blue

PUT

POST

/api/v1

/resource

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

ID

storage}

리소스 구성 파일을 추가한다.

14

--interactive
-i

대화형 설정 모드

15

control config del <id>
conf del <id>

--force
-f

강제 삭제

Change storage settings for designated letters

-

74

Delete snapshot storage

Status

colour	Red
title	DELETE

/api/v1

/resource

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

ID16

control config edit <id>
conf edit <id>

--user
-u

텍스트 에디터로 수정

storage}

리소스 구성 파일을 삭제한다.

Clear Storage for Designated Letter

-

75

Network filesystem
(1.2 or higher)

NFS List Query

Status

title	GET

/api/v1/

resource/{ID}
StatuscolourPurpletitle

nfs

Returns a list of registered NFS connection information

-

76

Add NFS

Status

colour	Purple
title	PUT

/api/v1/

resource/{ID}

nfs

Add NFS connection information

-

77

Delete NFS

Status

colour	Red
title	DELETE

/api/v1/nfs/{name}

Delete specified NFS connection information

-

78

NFS connection

Status

colour	Blue
title	POST

/api/v1/

resource

nfs/{

ID

name}/

adjust

리소스 구성 내용을 대화형으로 편집하고 적용한다.

17

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

-

StatustitleGET

connect

Connect to designated NFS

-

79

Disconnect NFS

Status

colour	Blue
title	POST

/api/v1/

resource

nfs/{

ID

name}

리소스 구성 파일의 지정 속성 값을 출력한다.

18

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

--adjust
-a

리소스에 적용한다

/disconnect

Disconnect from designated NFS

-

80

management

FSR information inquiry

Status

title	GET

/api/v1/

resource/{ID}

system

Return general information such as version

-

81

FSR restart

Status

colour

Purple

title
Blue

PUT

POST

/api/v1/

resource/{ID}

system/restart

Restart the FSR process

-

82

Stop FSR

Status

colour	Blue
title	POST

/api/v1/

resource/{ID}/adjust

리소스 구성의 지정 속성에 값을 추가한다.
목록 형태의 속성에만 유효하다.

19

--index <숫자>

i

<숫자>

지정 인덱스에 삽입

20

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

--adjust
-a

리소스에 적용한다

상동

리소스 구성의 지정 속성을 삭제한다.
목록 형태의 속성에만 유효하다.

21

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

상동

리소스 구성 파일의 지정 속성 값을 변경한다.

22

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

상동

리소스 구성 파일의 지정 속성을 기본 값으로 변경한다.

개별 속성 설정

속성을 가르키는 key 값은 다음과 같은 방식으로 작성하며, 설정 가능한 모든 속성은 속성 명령(property)의 도움말에 출력됩니다.

구성 파일의 포맷에서 속성의 위치를 경로 형태로 작성합니다.
Code Block
λ fsradm conf prop get r0 network/ping_interval 10
배열 형태의 속성은 인덱스 번호로 접근합니다.
Code Block
λ fsradm conf prop get r0 nodes/0/directories/0/path e:/test/local/main
노드명을 사용하는 속성의 경우 노드명을 통한 접근도 지원합니다.
- 노드 목록
  Code Block
  λ fsradm conf prop get r0 nodes/node1/url 192.168.35.151:9890
- 연결 목록
  두 노드의 순서가 바뀌어도 정상 접근됩니다.
  Code Block
  λ fsradm conf prop get r0 connections/node1,node2/buffer size: 100
배열 형태의 속성에 값을 추가 할 때는 속성에 맞는 문자열 값을 입력 합니다.
이미 존재하는 값일 경우 오류가 발생하지 않고 무시됩니다.
- 노드 목록
  Code Block
  λ fsradm conf prop add r0 nodes node3 done
- 연결 목록
  Code Block
  λ fsradm conf prop add r0 connections node1,node3 done
- 디렉토리
  Code Block
  λ fsradm conf prop add r0 nodes/node3/directories e:/test/local/main done
- 제외 필터
  Code Block
  λ fsradm conf prop add r0 options/exclude_patterns *.temp done
배열 형태의 속성에서 값을 제거 할 경우에도 인덱스 번호와 노드명을 사용할 수 있습니다.
Code Block
λ fsradm conf prop del r0 connections/node1,node3 done λ fsradm conf prop del r0 nodes/2 done

제어

명령어

옵션

옵션 설명

사용 API

설명

1

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

--force
-f

강제로 덮어 씌우기

Status

colour	Blue
title	POST

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

리소스 메타 데이터 생성.
리소스가 분리된 상태에서만 수행 가능하다.

2

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

--force
-f

강제로 삭제

Status

colour	Blue
title	POST

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

리소스 메타 데이터 삭제.
리소스가 분리된 상태에서만 수행 가능하다.

3

control meta cleanup
meta cleanup

-

Status

colour	Blue
title	POST

/api/v1/resource/cleanup-meta

사용하지 않는 메타 데이터 정리.

4

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

-

Status

colour	Blue
title	POST

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

리소스 구성 파일을 읽어 리소스 목록에 적재.

5

control del <id|all>
del <id|all>

-

Status

colour	Blue
title	POST

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

적재 된 리소스를 목록에서 제거.

6

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

-

Status

colour	Blue
title	POST

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

리소스 파일 적재.

7

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

-

Status

colour	Blue
title	POST

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

리소스 파일 분리.

8

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

-

Status

colour	Blue
title	POST

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

리소스 활성화. (적재, 파일 적재, 연결)

9

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

-

Status

colour	Blue
title	POST

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

리소스 비활성화. (연결 종료, 파일 분리, 분리)

10

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

--force
-f

강제 승격

system/stop

Stop the FSR process

-

83

equipment

RID comparison

Status

colour	Blue
title	POST

/api/v1/tool/rid_compare

Compare two RIDs

-

84

license

License Lookup

Status

title	GET

/api/v1/license

License Status Inquiry

-

85

License settings

Status

colour	Purple
title	PUT

/api/v1/license

License settings

-

Resource ID extension

With the addition of the local clone function in 0.7, two or more nodes can be loaded locally in one resource file.
In this case, since nodes cannot be identified only with resource IDs, node names must be additionally specified as follows.

Resource ID: Node Name

Only nodes that are recognized as own nodes by recognizing the host name can be specified.
If the node name is omitted and only the resource ID is specified, it is collectively applied to all of its own nodes.
- However, in the following command, the node name can be omitted only when there is only one node.
  - Promote, demote, start synchronization/consistency verification

Example of use)

Specify node name: fsradm up r0:node1
Omit node name: fsradm up r0

Output of query command

Resource Status Query

Resources(Array)
- id: resource ID
- node: your node name
- role: role
- file_state: file state
- lock: file lock status
- last_promoted: Last promoted time
- pending: number of files being downloaded
- filesystem_type: filesystem type (1.2+)
- snapshot_state: snapshot state (1.2+)
- snapshot_progress: Snapshot progress (1.2+)
- connections(Array): list of connections with partner nodes
  - peer: peer node name
  - state: my state
  - role: role of partner node
  - peer_state: peer node state
  - file_state: relative node file state
  - repl_started: Time when replication started
  - last_synced: Last sync completed time
  - out_of_sync: amount of unbuffered data that has not been applied to the target
  - sync_errors: number of sync errors
  - sync: Synchronization status. NULL if not in progress
    - message: status message
    - errored_files: number of files with errors
    - bytes_done: number of bytes synced
    - bytes_total: total number of bytes to sync
    - progress: progress (0-100%)
  - pending: The number of files that the other node is downloading
  - last_error: latest error content (1.2 or later)

Resource Performance Query

Resources(Array)
- id: resource ID
- node: your node name
- connections(Array): list of connections with partner nodes
  - peer: peer node name
  - bytes_in: received per second
  - bytes_out: Transmission per second
  - memory_buffer: memory buffer status
    - usage: usage
    - size: size
  - file_buffer: file buffer status
    - usage: usage
    - limit: limit

command

All functions of fsradm operate through gRPC and REST-API.
controlSince the command is designated as a basic command, you can omit it and use the subcommand directly.

Command structure:

control, ctl: resource-related control
- config, conf: control resource configuration files
  - property, prop: control individual properties
- meta: Meta data control
- rid: RID control
driver: driver control (Windows only)
efs: NTFS EFS analysis and certificate control (Windows only)
- cert: FSR engine certificate control
- usercert: User certificate control
events, ev: event monitoring
license: license control
log, l: log monitoring
perfmon, p: performance monitor
system, sys: system control
- config, conf: control system configuration files
  - property, prop: control individual properties

The arguments and notation of commands used in this document are as follows.

Arguments that can be omitted:{arg}
Required Arguments:<arg>
Resource ID:<id>
Resource ID or all:<id|all>

In the case of time values, units can be entered together as follows. The default unit is 'seconds'.

100ms, 0.1s, 1m, 1h

setting

command

option

Option Description

Usage API

descriptions

1

system config dump
sys conf dump

-

Status

title	GET

/api/v1/config/dump

Output the contents of a system configuration file as JSON.

2

system config dump-xml
sys conf dump-xml

-

Status

title	GET

/api/v1/config/dump-xml

Output the contents of system configuration files to XML.

3

system config show
sys conf show

-

Status

title	GET

/api/v1/config

Outputs system configuration contents in operation as JSON.

4

system config adjust
sys conf adjust

-

Status

colour	Blue
title	POST

/api/v1/

resource/{ID}/primary

리소스를 Primary로 승격.

11

--unlock
-u

파일 잠금 해제

12

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

--timeout <숫자>
-t <숫자>

시간 제한

Status

colour	Blue
title	POST

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

리소스를 Secondary로 강등.
시간 제한 값이 있으면 해당 시간 동안 버퍼가 비워지는 것을 대기한다. 해당 시간 이후 버퍼를 강제로 비우고 강등한다.

--read-only 옵션은 --lock 옵션과 함께 사용해야한다.

13

--lock
-l

파일 잠금

14

--read-only

읽기 전용으로 잠금

15

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

--discard-my-data

내 데이터를 버림

config/adjust

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

5

system config edit
sys conf edit

-u, -user

Edit with text editor

Status

title	GET

/api/v1/config

Status

colour	Purple
title	PUT

/api/v1/config

Status

colour	Blue
title	POST

/api/v1/config/adjust

Interactively edit and apply system configurations.

6

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

-

Status

title	GET

/api/v1/config

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

7

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

--adjust
-a

apply to resource

Status

title	GET

/api/v1/config

Status

colour	Purple
title	PUT

/api/v1/config

Status

colour	Blue
title	POST

/api/v1/

resource/{ID}/connect/{PEER}

리소스를 상대 노드에 연결. connecting 상태로 변경 된다.

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

config/adjust

Changes the specified property value in the system configuration file.

8

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

-

same

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

9

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

-

Status

colourBlue

title

POST

GET

/api/v1/resource/{ID}/

disconnect/{PEER}

상대 노드와의 연결 해제. standalone 상태로 변경 된다.

17

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

--level <숫자>
-l <숫자>

동기화 수준

StatuscolourBluetitlePOST

dump

Output the contents of a resource configuration file as JSON.

10

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

-

Status

title	GET

/api/v1/resource/{ID}/

resync/{PEER}

상대 노드를 소스로 동기화 시작.

18

--report <모드>

보고서 생성 범위

19

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

--level <숫자>
-l <숫자>

동기화 수준

StatuscolourBluetitlePOST

dump-xml

Output the content of a resource configuration file to XML.

11

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

-

Status

title	GET

/api/v1/resource/{ID}

/resync-remote/{PEER}

이 노드를 소스로 동기화 시작.

20

--report <모드>

보고서 생성 범위

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

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

12

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

-

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

verify/{PEER}

상대 노드를 소스로 정합성 검증 시작.

22

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

-

adjust

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

13

control config add <id>
conf add <id>

--force
-f

force overwrite

Status

colour

Blue

title
Purple

POST

PUT

/api/v1/resource/{ID}

/pause

동기화 또는 복제 일시 중지.

23

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

-

Add resource configuration file.

14

--interactive
-i

Interactive setting mode

15

<id>
conf check config<id>

--force
-f

force delete

Status

colour

Blue

title
Red

POST

DELETE

/api/v1/resource/{ID}

/resume동기화 또는 복제 재개

Delete the resource configuration file.

24

16

control

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

config edit <id>
conf edit <id>

--

read

user
-

only읽기 전용으로 잠금

u

Edit with text editor

Status

colourBlue

title

POST

파일 보호 시작.

25

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

-

GET

/api/v1/resource/{ID}

/lock/{LEVEL}

Status

colour	Purple
title	PUT

/api/v1/resource/{ID}

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

unlock파일 보호 해제

adjust

Interactively edit and apply resource configurations.

26

17

control

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

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

-

Status

colourBlue

title

POST

GET

/api/v1/resource/{ID}

/close-files

복제를 위해 열려있는 파일의 핸들을 닫는다.

27

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

-

명령어

옵션

옵션 설명

사용 API

설명

1

system info
sys info

-

Status

title	GET

/api/v1/system

엔진 정보 출력.

2

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

--verbose
-v

상세 출력

Status

title	GET

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

리소스와 연결의 상태 출력.

3

--watch
-w

모니터링

4

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

모니터링 시 갱신 주기

5

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

--verbose
-v

상세 출력

Status

title	GET

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

리소스 연결의 버퍼와 네트워크 등의 성능 통계 출력.

6

--watch
-w

모니터링

7

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

모니터링 시 갱신 주기

8

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

--verbose
-v

상세 출력

StatustitleGET

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

18

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

--adjust
-a

apply to resource

Status

title	GET

/api/v1/resource/{ID}

Status

colour	Purple
title	PUT

/api/v1/resource/{ID}

/override/network-limit/{PEER}

네트워크 대역폭을 임의로 변경한다.

28

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

-

Status

colour	Red
title	DELETE

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

네트워크 대역폭을 구성 값으로 되돌린다.

동기화 옵션

동기화 수준
- 0: 해시 비교 없이 모든 파일을 동기화 한다. 이전의 -f 옵션과 같습니다.
- 1: 속성이 완전히 같으면 파일 내용도 같은 것으로 판단합니다. (기본 값)
  - 대부분의 경우 이 옵션이면 충분하지만 다음과 같이 속성을 유지하면서 파일 내용만 변경하는 경우 동기화되지 않습니다.
    1. 파일의 용량 변화 없이 내용을 수정
    2. 파일의 수정 시간을 내용 변경 전의 값으로 원복
- 2: 속성이 같아도 해시 비교를 수행합니다.
보고서 생성 범위
- nothing: 보고서를 생성하지 않습니다.
  - 이전에 생성 된 보고서가 그대로 유지됩니다.
  - 동기화 명령 없이 자동으로 이루어지는 동기화는 모두 이 옵션으로 동작합니다.
- summary: 요약 정보만 생성합니다.
- full: 파일 단위의 정보까지 모두 생성합니다.

조회

Status

colour	Blue
title	POST

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

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

19

--index <숫자>

i

<숫자>

insert at specified index

20

<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.

21

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

same

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

22

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

same

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

Set individual properties

The key value pointing to the property is written in the following way, and all configurable properties are displayed in the help of the property command (property).

In the format of the configuration file, write the location of the attribute in the form of a path.
Code Block
λ fsradm conf prop get r0 network/ping_interval 10

Array type properties are accessed by index number.

Code Block
λ fsradm conf prop get r0 nodes/0/directories/0/path e:/test/local/main

For attributes that use node names, access through node names is also supported.
- node list
  Code Block
  λ fsradm conf prop get r0 nodes/node1/url 192.168.35.151:9890
- Even if the order of two nodes in the linked list
  is changed, they are normally accessed.
  Code Block
  λ fsradm conf prop get r0 connections/node1,node2/buffer size: 100

When adding a value to an array-type property, enter a string value suitable for the property.
If the value already exists, no error occurs and is ignored.

node list

Code Block
λ fsradm conf prop add r0 nodes node3 done

linked list

Code Block
λ fsradm conf prop add r0 connections node1,node3 done

control

command

option

Option Description

Usage API

Description

1

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

--force
-f

force overwrite

Status

colour	Blue
title	POST

/api/v1/resource/{ID}/

result

가장 최근의 동기화 또는 정합성 검증의 결과 출력.
결과는 타겟에 저장되므로 타겟에서만 출력 가능하다.
디렉토리 및 파일명을 지정하면 요약 정보를 생략하고 지정한 파일의 결과를 출력한다.

9control rid show <id|all>
rid show

create-meta	Generate resource metadata. It can be performed only when the resources are separated.
2	control meta delete `<id\|all>` meta delete `<id\|all>`	--

verbose

force
-

v

f

상세 출력

force delete

Status

title
colour	Blue

GET

POST

/api/v1/resource/{ID}/

rid

리소스의 RID 출력.
기본적으로 Old ULID를 2개만 출력하며, 긴 버전 옵션이 지정된 경우에는 32개를 모두 출력한다.

10

--long
-l

긴 버전의 RID 출력

11

events
ev

--json
-j

JSON 포맷으로 출력

Status

colour	Yellow
title	gRPC

SubscribeEvents

이벤트 모니터링.
동기화 진행률과 성능 통계는 기본적으로 갱신 주기 마다 전달되지만, 이전 데이터와 변화가 없는 경우 생략된다.

12

--sync

동기화 진행률 포함

13

--perf

성능 통계 포함

14

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

동기화 진행률과 성능 통계 갱신 주기

15

log
l

--home <경로>

엔진 홈 경로

Status

colour	Yellow
title	gRPC

SubscribeEvents

로그 파일의 내용을 출력한다.
tail 명령과 유사하게 동작하며, 엔진의 시스템 구성 파일을 직접 읽어 로그 파일의 위치를 파악하므로 엔진이 종료되어 있어도 사용 가능하다.
gRPC를 통해 리소스 적재 이벤트를 받아 출력해야 하는 로그 파일을 실시간으로 변경한다.

16

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

출력 할 라인 수

17

--resource <id>
-t <id>

리소스 지정

18

--no-main

메인 로그 비활성화

19

--no-resource

리소스 로그 비활성화

20

--no-color

생상을 입히지 않음

21

--follow
-f

지속 출력

22

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

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

JSON 파일로 내보내기

Status

colour	Yellow
title	gRPC

SubscribePerfs

성능 모니터의 정보를 출력한다.
JSON이나 CSV로 내보내는 옵션을 사용하지 않으면 콘솔 화면에 출력한다.

--display 옵션을 사용하면 파일로 내보내면서 화면에도 출력이 가능하다.

23

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

CSV 파일로 내보내기

24

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

정보 갱신 주기

25

--display
-d

콘솔 화면에 출력

26

--watch
-w

모니터링 모드

동기화 및 정합성 결과 조회

실행 인수 지정에 따라 다음과 같이 동작합니다.

리소스명만 지정 (예: fsradm result r0)
- 보고서의 요약 정보만 출력합니다.
- 동기화 시 보고서 생성 범위를 nothing로 지정한 경우 갱신되지 않으므로 이전에 생성 된 정보가 출력됩니다.
디렉토리 인덱스 지정 (예: fsradm result r0 0)
- 해당 복제 대상의 파일 결과 목록을 모두 출력합니다.
- 동기화 시 보고서 생성 범위를 full로 지정한 경우에만 이 정보가 생성되며, summary로 수행 한 경우 아무것도 출력되지 않습니다.
- 디렉토리 인덱스는 구성 파일에 작성한 복제 대상 – files 항목 – 에 정의된 복제 대상 경로의 번호입니다. 첫번째 복제 대상 경로가 0번이며 정의 된 순서대로 1씩 증가합니다.
파일 경로 지정 (예: fsradm result r0 0 data/)
- 지정 경로와 그 하위 파일 결과 목록을 모두 출력합니다.
- 파일 경로는 복제 대상 경로에 대하여 상대 경로로 입력합니다.
- 정확한 파일명을 입력하면 해당 파일에 대한 결과만 출력되며, 파일명 뒤에 경로 구분자인 /를 입력하면 해당 디렉토리 하위의 모든 파일 결과를 출력합니다.

이벤트 목록

이벤트 조회를 시작하면 각 리소스의 분류 별 최근 이벤트가 전달됩니다. 이런 이벤트의 경우 occur 필드를 통해 해당 이벤트의 발생시간을 얻을 수 있습니다.

...

분류

...

타입명

...

필드

...

값

...

데이터 범위

...

비고

...

RPC 연결 상태

...

rpc

...

state

...

연결 상태

...

connected, disconnected

...

-

...

cause

...

오류 내용

...

disconnected 상태에서만 사용 됨

...

프로그램 기동/종료

...

program

...

state

...

프로그램 기동 상태

...

started, exit

...

-

...

cause

...

오류 내용

...

exit 상태에서만 사용 됨

...

시스템 설정 갱신

...

system_updated

...

-

...

-

...

adjust 수행 시 발생한다

...

-

...

리소스 추가

...

added

...

resource

...

리소스 ID

...

-

...

-

...

node

...

자신의 노드명

...

-

...

리소스 삭제

...

deleted

...

resource

...

리소스 ID

...

-

...

-

...

node

...

자신의 노드명

...

-

...

리소스 상대 노드 추가

...

peer_added

...

resource

...

리소스 ID

...

-

...

-

...

node

...

자신의 노드명

...

-

...

peer

...

상대 노드명

...

-

...

리소스 상대 노드 제거

...

peer_deleted

...

resource

...

리소스 ID

...

-

...

-

...

node

...

자신의 노드명

...

-

...

peer

...

상대 노드명

...

-

...

리소스 노드명 변경

...

renamed

...

resource

...

리소스 ID

...

-

...

-

...

node

...

자신의 노드명

...

-

...

value

...

새로운 노드명

...

-

...

리소스 노드명 변경 (상대)

...

peer_renamed

...

resource

...

리소스 ID

...

-

...

-

...

node

...

자신의 노드명

...

-

...

peer

...

상대 노드명

...

-

...

value

...

상대의 새로운 노드명

...

-

...

리소스 설정 갱신

...

updated

...

resource

...

리소스 ID

...

adjust 수행 시 발생한다

...

-

...

node

...

자신의 노드명

...

-

...

리소스 연결 상태

...

state

...

resource

...

리소스 ID

...

-

...

-

...

node

...

자신의 노드명

...

-

...

peer

...

상대 노드명

...

-

...

value

...

상태 값

...

standalone, established 등

...

리소스 연결 상태 (상대)

...

peer_state

...

resource

...

리소스 ID

...

-

...

-

...

node

...

자신의 노드명

...

-

...

peer

...

상대 노드명

...

-

...

value

...

상태 값

...

standalone, established 등

...

리소스 파일 상태

...

file_state

...

resource

...

리소스 ID

...

-

...

node

...

자신의 노드명

...

-

...

value

...

상태 값

...

inconsistent, consistent 등

...

리소스 파일 상태 (상대)

...

peer_file_state

...

resource

...

리소스 ID

...

-

...

-

...

node

...

자신의 노드명

...

-

...

peer

...

상대 노드명

...

-

...

value

...

상태 값

...

inconsistent, consistent 등

...

리소스 역할

...

role

...

resource

...

리소스 ID

...

-

...

-

...

node

...

자신의 노드명

...

-

...

value

...

역할 값

...

primary, secondary

...

리소스 역할 (상대)

...

peer_role

...

resource

...

리소스 ID

...

-

...

-

...

node

...

자신의 노드명

...

-

...

peer

...

상대 노드명

...

-

...

value

...

역할 값

...

primary, secondary

...

노드 연결 동작

...

connection

...

resource

...

리소스 ID

...

-

...

-

...

node

...

자신의 노드명

...

-

...

peer

...

상대 노드명

...

-

...

state

...

연결 상태

...

connected, accepted, disconnected

...

url

...

IP:Port

...

상대 노드의 주소

...

cause

...

오류 내용

...

disconnected에서만 사용 됨

...

상대 노드로부터 연결이 거부 됨

...

refuse

...

resource

...

리소스 ID

...

-

...

-

...

node

...

자신의 노드명

...

-

...

peer

...

상대 노드명

...

-

...

cause

...

거부 이유

...

irrelevance(관계 없는 노드), split-brain
two-primary, invalid-direction

...

younger

...

younger 노드명

...

-

...

쓰기 오류

...

write_error

...

resource

...

리소스 ID

...

-

...

-

...

node

...

자신의 노드명

...

-

...

filename

...

파일명

...

절대 경로

...

cause

...

오류 내용

...

-

...

디스크 공간 상태

...

diskspace

...

resource

...

리소스 ID

...

-

...

-

...

node

...

자신의 노드명

...

-

...

state

...

공간 상태

...

not_enough, enough

...

remain

...

남은 용량

...

바이트 단위. 문자열 형식

...

성능 정보

...

perf

...

resource

...

리소스 ID

...

-

...

--perf 옵션 필요

...

node

...

자신의 노드명

...

-

...

peer

...

상대 노드명

...

-

...

perf

...

성능 정보

...

REST-API의 성능 정보와 같다.

...

동기화 상태

...

sync

...

resource

...

리소스 ID

...

-

...

--sync 옵션 필요

...

node

...

자신의 노드명

...

-

...

peer

...

상대 노드명

...

-

...

status

...

동기화 상태

...

REST-API의 동기화 상태와 같다.

...

파일 잠금

...

file_lock

...

resource

...

리소스 ID

...

-

...

-

...

state

...

잠금 상태

...

REST-API의 파일 잠금 상태와 같다.

...

node

...

자신의 노드명

...

-

...

RID

...

rid

...

resource

...

리소스 ID

...

-

...

node

...

자신의 노드명

...

value

...

RID 값

...

consistency

...

플래그

...

파일 상태가 Consistent 이상인 경우 true

...

outdated

...

플래그

...

파일 상태가 Outdated인 경우 true

...

primary

...

플래그

...

승격된 경우 true

...

crashed_primary

...

플래그

...

Primary 상태에서 비정상 종료된 경우 true

...

파일 버퍼 사용량 경고

...

file_buf_warn

...

resource

...

리소스 ID

...

-

...

0.9.1

...

node

...

자신의 노드명

...

-

...

peer

...

상대 노드명

...

-

...

버퍼 넘침

...

overflowed

...

resource

...

리소스 ID

...

-

...

0.9.1

...

node

...

자신의 노드명

...

-

...

peer

...

상대 노드명

...

-

...

라이선스 상태

...

license

...

status

...

라이선스 상태

...

invalid, expired, not exist, valid

...

-

...

license-type

...

라이선스 유형

...

temporary, permanent

...

expires-at

...

기간 제한 (날짜)

...

년-월-일 (예: 2020-11-30)

...

expires-in

...

기간 제한 (남은 일자)

...

-

EFS

윈도 전용 명령어로 리눅스에서는 사용 할 수 없습니다.

분석

...

명령어

...

옵션

...

옵션 설명

...

사용 API

...

설명

...

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

...

--json
-j

...

JSON 포맷으로 출력

...

Status

colour	Yellow
title	gRPC

EFSAnalyze

...

지정한 디렉토리 하위의 암호화 된 파일을 조회하여 복호화에 필요한 인증서 목록과 설치 상태를 분석한다.

...

--verbose
-v

...

상세 출력

...

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

...

--json
-j

...

JSON 포맷으로 출력

...

Status

colour	Yellow
title	gRPC

EFSAnalyze

...

지정한 리소스의 복제 경로 하위의 암호화 된 파일을 조회하여 복호화에 필요한 인증서 목록과 설치 상태를 분석한다.

...

--verbose
-v

...

상세 출력

엔진 실행 계정 스토어 제어

명령어

옵션

옵션 설명

사용 API

설명

1

efs cert list

-

Status

title	GET

/api/v1/efs/cert

인증서 스토어의 인증서 목록을 출력한다.

2

efs cert export <thumbprint> <file>

--password <password>
-p <password>

인증서 비밀번호

Status

colour	Blue
title	POST

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

지정한 리소스의 복제 경로 하위의 암호화 된 파일을 조회하여 복호화에 필요한 인증서 목록과 설치 상태를 분석.

3

efs cert import <file>

--password <password>
-p <password>

인증서 비밀번호

delete-meta

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

3

control meta cleanup
meta cleanup

-

Status

colour	Blue
title	POST

/api/v1/resource/cleanup-meta

Clean up unused metadata.

4

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

-

Status

colour	Blue
title	POST

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

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

5

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

-

Status

colour	Blue
title	POST

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

Remove loaded resources from the list.

6

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

-

Status

colour	Blue
title	POST

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

Load resource file.

7

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

-

Status

colour	Blue
title	POST

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

Separate resource files.

8

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

-

Status

colour	Blue
title	POST

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

resource activation. (load, file load, connect)

9

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

-

Status

colour	Blue
title	POST

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

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

10

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

--force
-f

forced promotion

Status

colour	Blue
title	POST

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

Promote a resource to Primary.

11

--unlock
-u

unlock file

12

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

--timeout <num>
-t <num>

time limit

Status

colour	Blue
title	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.

13

--lock
-l

file lock

14

--read-only

lock to read only

15

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

--discard-my-data

throw away my data

Status

colour	Blue
title	POST

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

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

16

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

-

Status

colour	Blue
title	POST

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

Disconnection with partner node. It changes to standalone status.

17

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

--level <num>
-l <num>

synchronization level

Status

colour	Blue
title	POST

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

Synchronization starts with partner node as source.

18

--report <mode>

Report generation scope

19

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

--level <num>
-l <num>

synchronization level

Status

colour	Blue
title	POST

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

Start synchronization with this node as source.

20

--report<mode>

Report generation scope

21

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

-

Status

colour	Blue
title	POST

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

Start consistency verification with partner node as source.

22

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

-

Status

colour	Blue
title	POST

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

Abort Consistency Verification in progress. 1.1 or higher.

23

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

-

Status

colour	Blue
title	POST

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

Synchronization or replication paused.

24

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

-

Status

colour	Blue
title	POST

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

Resume synchronization or replication.

25

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

--read-only

lock to read only

Status

colour	Blue
title	POST

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

Start protecting your files.

26

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

-

Status

colour	Blue
title	POST

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

Unprotect the file.

27

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

-

Status

colour	Blue
title	POST

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

Closes handles to files that are open for cloning.

28

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

-

Status

colour	Purple
title	PUT

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

Randomly change the network bandwidth.

29

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

-

Status

colour	Red
title	DELETE

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

Return the network bandwidth to the configured value.

sync options

synchronization level
- 0: Synchronize all files without hash comparison. Same as the previous -f option.
- 1: If the properties are exactly the same, the contents of the file are also determined to be the same. (default value)
  - In most cases, this option is sufficient, but if you change only the contents of a file while preserving properties, it will not sync, such as:
    1. Modify the content without changing the size of the file
    2. Restore the modification time of the file to the value before the content change
- 2: Hash comparison is performed even if the properties are the same.
Report generation scope
- nothing: do not generate reports
  - Previously generated reports are retained.
  - All automatic synchronizations without a synchronization command operate with this option.
- summary: generate summary information only
- full: Generates all file-level information

check

command

options

Option Description

Usage API

Description

1

system info
sys info

-

Status

title	GET

/api/v1/system

Engine information output.

2

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

--verbose
-v

verbose output

Status

title	GET

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

Status output of resources and connections.

3

--watch
-w

monitoring

4

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

Renewal cycle when monitoring

5

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

--verbose
-v

verbose output

Status

title	GET

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

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

6

--watch
-w

monitoring

7

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

Renewal cycle when monitoring

8

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

--verbose
-v

verbose output

Status

title	GET

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

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

9

--watch
-w

monitoring

10

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

Renewal cycle when monitoring

11

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

--verbose
-v

verbose output

Status

title	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.

12

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

--verbose
-v

verbose output

Status

title	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.

13

--long
-l

Long version of RID output

14

events
ev

--json
-j

output in JSON format

Status

colour	Yellow
title	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.

15

--sync

Include sync progress

16

--perf

Include performance statistics

17

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

Synchronization progress and performance statistics refresh rate

18

log
l

--home <경로>

engine home path

Status

colour	Yellow
title	GRPC

SubscribeEvents

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.

19

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

number of lines to output

20

--resource <id>
-t <id>

resource designation

21

--no-main

Disable main log

22

--no-resource

Disable resource log

23

--no-color

do not produce

24

--follow
-f

continuous output

25

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

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

Export to JSON file

Status

colour	Yellow
title	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.

26

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

Export to CSV file

27

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

information update cycle

28

--display
-d

output to console screen

29

--watch
-w

monitoring mode

Query synchronization and consistency results

Depending on the execution argument designation, it operates as follows.

Specify only the resource name (e.g. fsradm result r0)
- Only the summary information of the report is output.
- When synchronizing, if the report generation range nothingis specified as , it is not updated, so previously generated information is output.
Specify directory index (e.g. fsradm result r0 0)
- Outputs all file result lists of the replication target.
- fullWhen synchronizing , this information is created only when the report creation range is specified as , summaryand nothing is output when performed as .
- The directory index is the number of replication destination paths defined in the replication destination – files entry – you write in the configuration file. The first replication target path is number 0 and increments by 1 in the order defined.
Specify the file path (e.g. fsradm result r0 0 data/)
- Outputs a list of all the specified path and its subfiles.
- Enter the file path as a relative path to the replication target path.
- If you enter an exact file name, only the results for that file will be output, and /if you enter a path separator after the file name, the results of all files under that directory will be output.

event list

When you start looking up events, the latest events by category of each resource are delivered. For these events, occuryou can get the occurrence time of the event through the field.

	classification	type name	field	value	data range	note
1	RPC connection status	rpc	state	connection status	connected, disconnected	-
2	RPC connection status	rpc	cause	error content	Used only in disconnected state	-
3	Program start/end	program	state	program startup status	started, exit	-
4	Program start/end	program	cause	error content	Used only in exit state	-
5	Update system settings	system_updated	-	-	-	Occurs when adjust is performed
6	crashed	crashed	cause	error content	-	In case of abnormal termination before starting the program. 1.1-A2
7	Add resource	added	resource	resource ID	-	-
8			node	own node name	-
9			group	your group name	-
10	delete resource	deleted	resource	resource ID	-	-
11			node	own node name	-
12			group	your group name	-
13	Add resource relative node	peer_added	resource	resource ID	-	-
14			node	own node name	-
15			group	your group name	-
16			peer	partner node name	-
17			peer_group	partner group name	-
18	Remove resource relative node	peer_deleted	resource	resource ID	-	-
19			node	own node name	-
20			group	your group name	-
21			peer	partner node name	-
22			peer_group	partner group name	-
23	Change resource node name	renamed	resource	resource ID	-	-
24			node	own node name	-
25			group	your group name	-
26			value	new node name	-
27	Change resource node name (relative)	peer_renamed	resource	resource ID	-	-
28			node	own node name	-
29			group	your group name	-
30			peer	partner node name	-
31			peer_group	partner group name	-
32			value	Opponent's new node name	-
33	Change resource group name	group_renamed	resource	resource ID	-	1.1-A5
34			node	own node name	-
35			group	your group name	-
36			value	new group name	-
37	Change resource group name (relative)	peer_group_renamed	resource	resource ID	-	1.1-A5
38			node	own node name	-
39			group	your group name	-
40			peer	partner node name	-
41			peer_group	partner group name	-
42			value	Opponent's new group name	-
43	Update resource settings	updated	resource	resource ID	-	Occurs when adjust is performed
44			node	own node name	-
45			group	your group name	-
46	resource connection status	state	resource	resource ID	-	-
47			node	own node name	-
48			group	your group name	-
49			peer	partner node name	-
50			peer_group	partner group name	-
51			value	state value	standalone, established 등
52	resource connection state (relative)	peer_state	resource	resource ID	-	-
53			node	own node name	-
54			group	your group name
55			peer	partner node name	-
56			peer_group	partner group name	-
57			value	state value	standalone, established 등
58	resource file status	file_state	resource	resource ID	-
59			node	own node name	-
60			group	your group name	-
61			value	state value	inconsistent, consistent 등
62	resource file state (relative)	peer_file_state	resource	resource ID	-	-
63			node	own node name	-
64			group	your group name	-
65			peer	partner node name	-
66			peer_group	partner group name	-
67			value	state value	inconsistent, consistent 등
68	resource role	role	resource	resource ID	-	-
69			node	own node name	-
70			group	your group name	-
71			value	role value	primary, secondary
72	resource role (relative)	peer_role	resource	resource ID	-	-
73			node	own node name	-
74			group	your group name	-
75			peer	partner node name	-
76			peer_group	partner group name	-
77			value	role value	primary, secondary
78	Node Connection Behavior	connection	resource	resource ID	-	-
79			node	own node name	-
80			group	your group name	-
81			peer	partner node name	-
82			peer_group	partner group name	-
83			state	connection status	connected, accepted, disconnected
84			url	IP:Port	address of peer node
85			cause	error content	Used only with disconnected
86	Connection refused from peer node	refuse	resource	resource ID	-	-
87			node	own node name	-
88			group	your group name	-
89			peer	partner node name	-
90			peer_group	partner group name	-
91			cause	reason for refusal	irrelevance (irrelevant node), split-brain two-primary, invalid-direction
92			younger	younger node name	-
93	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
94			node	own node name	-
95			group	your group name	-
96			peer	partner node name	-
97			peer_group	partner group name	-
98	Error during state operation	state_err	resource	resource ID	-	1.2 or higher
99			node	own node name	-
100			group	your group name	-
101			peer	partner node name	-
102			peer_group	partner group name	-
103			value	error content	-
104			next	next state	Output only when automatically transitioning to the next state
105	write error	write_error	resource	resource ID	-	-
106			node	own node name	-
107			group	your group name	-
108			filename	file name	absolute path
109			cause	error content	-
110	disk space status	diskspace	resource	resource ID	-	-
111			node	own node name	-
112			group	your group name	-
113			state	space state	not_enough, enough
114			remain	remaining capacity	units of bytes. string format
115	performance information	perf	resource	resource ID	-	--perf option required
116			node	own node name	-
117			group	your group name	-
118			peer	partner node name	-
119			peer_group	partner group name	-
120			perf	performance information	It is the same as the performance information of REST-API.
121	sync status	sync	resource	resource ID	-	--sync option required
122			node	own node name	-
123			group	your group name	-
124			peer	partner node name	-
125			peer_group	partner group name	-
126			status	sync status	It is the same as the sync state of REST-API.
127	file lock	file_lock	resource	resource ID	-	-
128			state	locked state	It is the same as the file lock status of REST-API.
129			node	own node name	-
130			group	your group name	-
131	consistency warning	consistency_warn	resource	resource ID	-	An event that occurs when the target node unlocks a file. To be removed in 1.2
132			node	own node name	-
133			group	your group name	-
134	RID	rid	resource	resource ID		-
135			node	own node name
136			group	your group name	-
137			value	RID value
138			consistency	flag	true if the file state is Consistent or higher
139			outdated	flag	true if the file status is Outdated
140			primary	flag	true if promoted
141			crashed_primary	flag	true if abnormal termination in Primary state
142	File buffer usage warning	file_buf_warn	resource	resource ID	-	0.9.1
143			node	own node name	-
144			group	your group name	-
145			peer	partner node name	-
146			peer_group	partner group name	-
147	buffer overflow	overflowed	resource	resource ID	-	0.9.1
148			node	own node name	-
149			group	your group name	-
150			peer	partner node name	-
151			peer_group	partner group name	-
152	snapshot state	snapshot_state	resource	resource ID	-	1.2
153			node	own node name	-
154			group	your group name	-
155			snapshot	situation	available, creating, … etc.
156			err	error content	Used only in case of error
157	Add snapshot	snapshot_added	resource	resource ID	-	1.2
158			node	own node name	-
159			group	your group name	-
160			snapshot	Snapshot ID	-
161			images	List of image GUIDs	-
162	Delete snapshot	snapshot_deleted	resource	resource ID	-	1.2
163			node	own node name	-
164			group	your group name	-
165			snapshot	Snapshot ID	-
166			images	List of image GUIDs	-
167	Rename snapshot	snapshot_renamed	resource	resource ID	-	1.2
168			node	own node name	-
169			group	your group name	-
170			snapshot	Snapshot ID (source)	-
171			value	Changed ID (dest)	-
172	Add snapshot image	snapshot_image_added	image	Image GUID	-	1.2
173			path	original volume letter path	-
174			volume	Source Volume GUID Path	-
175	Delete snapshot image	snapshot_image_deleted	image	Image GUID	-	1.2
176	Attach snapshot image	snapshot_image_exposed	resource	resource ID	Used only if the snapshot image belongs to a resource	1.2
177			node	own node name	Used only if the snapshot image belongs to a resource
178			group	your group name	Used only if the snapshot image belongs to a resource
179			snapshot	Snapshot ID	Used only if the snapshot image belongs to a resource
180			image	Image GUID	-
181			value	Linked Letters	-
182	Unlink snapshot image	snapshot_image_unexposed	resource	resource ID	Used only if the snapshot image belongs to a resource	1.2
183			node	own node name	Used only if the snapshot image belongs to a resource
184			group	your group name	Used only if the snapshot image belongs to a resource
185			snapshot	Snapshot ID	Used only if the snapshot image belongs to a resource
186			image	Image GUID	-
187			value	linked letters	-
188	Snapshot images and resources are disconnected	snapshot_image_unlinked	resource	resource ID	-	1.2
189			node	own node name	-
190			group	your group name	-
191			snapshot	Snapshot ID	-
192			image	Image GUID	-
193	license status	license	status	license status	invalid, expired, not exist, valid	-
194			license-type	License type	temporary, permanent
195			expires-at	Limited time (date)	Year-Month-Day (e.g. 2020-11-30)
196			expires-in	Time limit (remaining days)	-

EFS

This is a Windows-only command and cannot be used on Linux.

analyze

command

option

Option Description

Usage API

Description

1

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

--json
-j

output in JSON format

Status

colour	Yellow
title	GRPC

EFSA analysis

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

2

--verbose
-v

verbose output

3

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

--json
-j

output in JSON format

Status

colour	Yellow
title	GRPC

EFSA 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.

4

--verbose
-v

verbose output

Control the engine execution account store

command

option

Option Description

Usage API

Description

1

efs cert list

-

Status

title	GET

/api/v1/efs/cert

Prints a list of certificates in the certificate store.

2

efs cert export <thumbprint> <file>

--password <password>
-p <password>

certificate password

Status

colour	Blue
title	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.

3

efs cert import <file>

--password <password>
-p <password>

certificate password

Status

colour	Blue
title	POST

/api/v1/efs/cert

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

4

--set-current
-c

set as current certificate

5

efs cert set-current <thumbprint>

-

Status

colour	Blue
title	POST

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

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

6

efs cert delete <thumbprint>

-

Status

colour	Red
title	DELETE

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

Delete a given certificate from the certificate store

CLI Run As Account Store Control

command

option

Option Description

Usage API

Description

1

efs usercert list

-

Status

title	GET

/api/v1/efs/cert

Prints a list of certificates in the certificate store.

2

efs usercert export <thumbprint> <file>

--password <password>
-p <password>

certificate password

Status

colour	Blue
title	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.

3

efs usercert import <file>

--password <password>
-p <password>

certificate password

Status

colour	Blue
title	POST

/api/v1/efs/cert

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

4

--set-current
-c

set as current certificate

5

efs usercert set-current <thumbprint>

-

Status

colour	Blue
title	POST

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

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

6

efs usercert delete <thumbprint>

-

Status

colour	Red
title	DELETE

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

Delete a given certificate from the certificate store

network file system

This is a Windows-only command and cannot be used on Linux. 1.2 or higher

command

option

Option Description

Usage API

Description

1

nfs list

-

Status

title	GET

/api/v1/nfs

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

2

nfs add <remote-path>

--username <username>
-u <username>

username

Status

colour	Purple
title	PUT

/api/v1/nfs

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

3

--password <password>
-p <password>

password

4

nfs del <remote-path>

-

Status

colour	Red
title	DELETE

/api/v1/nfs/{name}

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

5

nfs connect <remote-path>

-

Status

colour	Blue
title	POST

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

Connect to the specified network file system.

6

nfs disconnect <remote-path>

-

Status

colour	Blue
title	POST

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

Terminate the connection to the specified network file system.

snapshot

This is a Windows-only command and cannot be used on Linux. 1.2 or higher

command

option

Option Description

Usage API

Description

1

snapshot list <id|all>

--verbose
-v

verbose output

Status

title	GET

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

Prints a list of snapshots of the specified resource.

2

--desc
-d

sort in reverse order

3

snapshot list-exposed

--desc
-d

sort in reverse order

Status

title	GET

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

Prints a list of snapshots linked to the letter.

4

snapshot show <id> <snapshot>

-

Status

title	GET

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

Display detailed information of the specified snapshot.

5

snapshot create <id> <snapshot>

-

Status

colour	Purple
title	PUT

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

Creates a snapshot of the specified ID.

6

snapshot delete <id> <snapshot>

-

Status

colour	Red
title	DELETE

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

Delete the specified snapshot.

7

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

-

Status

colour	Blue
title	POST

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

Changes the ID of the specified snapshot.

8

snapshot recovery <id> <snapshot>

-

Status

colour	Blue
title	POST

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

Restores the resource replication path to the specified snapshot.

9

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

--combine

Copy multiple replication paths to one destination

Status

colour	Blue
title	POST

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

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

10

snapshot cancel <id>

-

Status

colour	Blue
title	POST

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

Cancels the snapshot-related operation of the specified resource.

11

snapshot cleanup <id|all>

-

Status

colour	Blue
title	POST

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

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

12

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

-

Status

colour	Blue
title	POST

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

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

13

snapshot unexpose <id> <snapshot>

-

Status

colour	Blue
title	POST

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

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

snapshot image

This is a Windows-only command and cannot be used on Linux. 1.2+ FSR option is provided
so that it can be done even with the service stopped .--local

command

option

Option Description

Usage API

Description

1

snapshot-image list

--unlinked-only
-u

Outputs only lists that are not associated with resources

Status

title	GET

/api/v1/snapshot-image

Prints a list of snapshot images.

2

--local
-l

Doing fsradm itself

3

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

--local
-l

Doing fsradm itself

Status

colour	Red
title	DELETE

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

Delete the specified snapshot image.

4

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

--local
-l

Doing fsradm itself

Status

colour	Blue
title	POST

/api/v1

/efs/cert

지정 파일의 인증서를 가져와 인증서 스토어에 등록

4

--set-current
-c

현재 인증서로 지정

5

efs cert set-current <thumbprint>

-

/snapshot-image/{image}/expose

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

5

snapshot-image unexpose <guid>

--local
-l

Doing fsradm itself

Status

colour	Blue
title	POST

/api/v1/

efs/cert

snapshot-image/{

Thumbprint

image}/

set-current

인증서 스토어의 지정 인증서를 암호화를 위한 현재 인증서로 지정

6

efs cert delete <thumbprint>

-

unexpose

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

6

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

--local
-l

Doing fsradm itself

Status

colour

Red

title
Blue

DELETE

POST

/api/v1/

efs/cert/{Thumbprint}

인증서 스토어에서 지정 인증서 삭제

CLI 실행 계정 스토어 제어

명령어

옵션

옵션 설명

사용 API

설명

1

efs usercert list

-

snapshot-image/unexpose-by-path

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

snapshot storage

This is a Windows-only command and cannot be used on Linux. 1.2+ FSR option is provided
so that it can be done even with the service stopped .--local

command

option

Option Description

Usage API

Description

1

snapshot-storage list

--for

Query the storage where snapshots of a given letter are stored

Status

title	GET

/api/v1/

efs/cert

인증서 스토어의 인증서 목록을 출력한다.

2

efs usercert export <thumbprint> <file>

--password <password>
-p <password>

인증서 비밀번호

snapshot-storage

Prints the snapshot storage list.

2

--on

Storage inquiry in designated letter

3

--local
-l

Doing fsradm itself

4

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

--local
-l

Doing fsradm itself

Status

colour

Blue

title
Purple

POST

PUT

/api/v1/

efs/cert

snapshot-storage/{volume}/to/{

Thumbprint

storage}

/export

지정한 리소스의 복제 경로 하위의 암호화 된 파일을 조회하여 복호화에 필요한 인증서 목록과 설치 상태를 분석.

3

efs usercert import <file>

--password <password>
-p <password>

인증서 비밀번호

Status

colour	Blue
title	POST

/api/v1/efs/cert

지정 파일의 인증서를 가져와 인증서 스토어에 등록

4

--set-current
-c

현재 인증서로 지정

5

efs usercert set-current <thumbprint>

-

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.

5

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

--local
-l

Doing fsradm itself

Status

colour	Blue
title	POST

/api/v1/

efs/cert

snapshot-storage/{volume}/to/{

Thumbprint

storage}

/set-current인증서 스토어의 지정 인증서를 암호화를 위한 현재 인증서로 지정-

	Change the settings of snapshot storage.
6

efs usercert delete <thumbprint>

-

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

--local
-l

Doing fsradm itself

Status

colour	Red
title	DELETE

/api/v1

/efs/cert

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

Thumbprint

storage}

인증서 스토어에서 지정 인증서 삭제

관리

driver 명령은 윈도 전용으로 리눅스에서는 사용할 수 없습니다.

분류

명령어

옵션

옵션 설명

사용 API

설명

1드라이버 설치

Delete the snapshot storage.

management

The driver command is for Windows only and is not available for Linux.

	classification	command	option	Option Description	Usage API	Description
1	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.

2

드라이버 제거

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.

3

엔진 재시작

engine restart

system restart
sys restart

-

Status

colour	Blue
title	POST

/api/v1/system/restart

현재 프로세스 PID는 유지하면서 엔진의 동작 전체를 재시작한다

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

4

엔진 종료

engine shutdown

system stop
sys stop

-

Status

colour	Blue
title	POST

/api/v1/system/stop

실행 중인 엔진에 종료 명령을 전달하여 스스로 종료하도록 한다. 서비스로 실행중이면 자동으로 재 시작 된다.

도구

분류

명령어

옵션

옵션 설명

사용 API

설명

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

equipment

	classification	command	option	Option Description	Usage API	Description
1	RID

비교

comparison

control rid compare <rid1> <rid2>
rid compare <rid1> <rid2>

-

Status

colour	Blue
title	POST

/api/v1/tool/rid_compare

두 RID의 비교 결과를 출력한다

Outputs the comparison result of two RIDs.

2

서포트 파일
생성

Create support file

system support
sys su

--dump <file>
-d <file>

포함할 덤프 파일 지정

서포트 파일 생성

라이선스

분류

명령어

옵션

사용 API

설명

1설정

Specify dump files to include

Create support file

license

classification

command

option

Usage API

Description

1

setting

license set <license-file>

-

Status

colour	Purple
title	PUT

/api/v1/license

지정한 파일을 읽어 라이선스를 설정한다

Read the specified file to set the license.

2

조회

check

license show

-

Status

title	GET

/api/v1/license

현재 라이선스 상태를 출력한다.

Print the current license status.

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

개요

REST-API

Target

outline

setting

check

control

watch

management

REST-API

리소스 ID 확장

조회 명령의 출력 내용

리소스 상태 조회

리소스 성능 조회

명령어

설정

개별 속성 설정

제어

Resource ID extension

Output of query command

Resource Status Query

Resource Performance Query

command

setting

동기화 옵션

조회

Set individual properties

control

동기화 및 정합성 결과 조회

이벤트 목록

EFS

분석

엔진 실행 계정 스토어 제어

sync options

check

Query synchronization and consistency results

event list

EFS

analyze

Control the engine execution account store

CLI Run As Account Store Control

network file system

snapshot

snapshot image

CLI 실행 계정 스토어 제어

snapshot storage

관리

management

도구

equipment

라이선스

license