Remote Mount Backends

A Remote Mount Backend is used to provide high availability for a Remote Server Mount Folder Behavior.

List Remote Mount Backends

Command

files-cli remote-mount-backends list

Output

Outputs a list of RemoteMountBackend objects according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

files-cli remote-mount-backends list

Show Remote Mount Backend

Command

files-cli remote-mount-backends find

Output

Outputs a RemoteMountBackend object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--id=
int64
Required		Remote Mount Backend ID.

Example Request

files-cli remote-mount-backends find \
  --id=1

Create Remote Mount Backend

Command

files-cli remote-mount-backends create

Output

Outputs a RemoteMountBackend object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDefaultDescription
--enabled
boolean		trueTrue if this backend is enabled.
--fall=
int64		1Number of consecutive failures before considering the backend unhealthy.
--health-check-enabled
boolean		trueTrue if health checks are enabled for this backend.
--health-check-type=
string		"active"Type of health check to perform.
Possible values: active, passive
--interval=
int64		60Interval in seconds between health checks.
--min-free-cpu=
double		Minimum free CPU percentage required for this backend to be considered healthy.
--min-free-mem=
double		Minimum free memory percentage required for this backend to be considered healthy.
--priority=
int64		1Priority of this backend.
--remote-path=
string		""Path on the remote server to treat as the root of this mount.
--rise=
int64		1Number of consecutive successes before considering the backend healthy.
--canary-file-path=
string
Required		Path to the canary file used for health checks.
--remote-server-mount-id=
int64
Required		The mount ID of the Remote Server Mount that this backend is associated with.
--remote-server-id=
int64
Required		The remote server that this backend is associated with.

Example Request

files-cli remote-mount-backends create \
  --canary-file-path="backend1.txt" \
  --remote-server-mount-id=1 \
  --remote-server-id=1

Reset backend status to healthy

Command

files-cli remote-mount-backends reset-status

Output

No output is returned.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--id=
int64
Required		Remote Mount Backend ID.

Example Request

files-cli remote-mount-backends reset-status \
  --id=1

Update Remote Mount Backend

Command

files-cli remote-mount-backends update

Output

Outputs a RemoteMountBackend object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--id=
int64
Required		Remote Mount Backend ID.
--enabled
boolean		True if this backend is enabled.
--fall=
int64		Number of consecutive failures before considering the backend unhealthy.
--health-check-enabled
boolean		True if health checks are enabled for this backend.
--health-check-type=
string		Type of health check to perform.
Possible values: active, passive
--interval=
int64		Interval in seconds between health checks.
--min-free-cpu=
double		Minimum free CPU percentage required for this backend to be considered healthy.
--min-free-mem=
double		Minimum free memory percentage required for this backend to be considered healthy.
--priority=
int64		Priority of this backend.
--remote-path=
string		Path on the remote server to treat as the root of this mount.
--rise=
int64		Number of consecutive successes before considering the backend healthy.
--canary-file-path=
string		Path to the canary file used for health checks.
--remote-server-id=
int64		The remote server that this backend is associated with.

Example Request

files-cli remote-mount-backends update \
  --id=1

Delete Remote Mount Backend

Command

files-cli remote-mount-backends delete

Output

No output is returned.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--id=
int64
Required		Remote Mount Backend ID.

Example Request

files-cli remote-mount-backends delete \
  --id=1

The RemoteMountBackend Object

Some of the commands above return a RemoteMountBackend object. The attributes of this object are listed below.

AttributeDescription
canary_file_path
string		Path to the canary file used for health checks.
enabled
boolean		True if this backend is enabled.
fall
int64		Number of consecutive failures before considering the backend unhealthy.
health_check_enabled
boolean		True if health checks are enabled for this backend.
health_check_results
array(object)		Array of recent health check results.
health_check_type
string		Type of health check to perform.
Possible values: active, passive
id
int64		Unique identifier for this backend.
interval
int64		Interval in seconds between health checks.
min_free_cpu
decimal		Minimum free CPU percentage required for this backend to be considered healthy.
min_free_mem
decimal		Minimum free memory percentage required for this backend to be considered healthy.
priority
int64		Priority of this backend.
remote_path
string		Path on the remote server to treat as the root of this mount.
remote_server_id
int64		The remote server that this backend is associated with.
remote_server_mount_id
int64		The mount ID of the Remote Server Mount that this backend is associated with.
rise
int64		Number of consecutive successes before considering the backend healthy.
status
string		Status of this backend.
Possible values: healthy, degraded, failed, desynced
undergoing_maintenance
boolean		True if this backend is undergoing maintenance.