Skip to main content

lucid config

Set local or global scope filespace configurations

Usage

lucid config [options]

Options

Option

Description

[--effective]

Currently effective filespace configurations for this client

[--local]

Local configurations scope. Affects only client where setting is applied

[--global]

Global configurations scope. Affects each client that connects to the filespace unless overridden with --local for a particular client

[--set]

Set configuration key(s). Defaults to `local` scope

[--delete]

Delete configuration key(s). Defaults to `local` scope

[--password <password>]

An admin user's password. Used with --global and --local options

[--list]

Display the configuration settings per scope

[--no-trim]

Do not trim long configuration values

[--explain]

Describe what each configuration key affects within Lucid and list its value constraints. Can be used with --KEY Configuration keys:

[--Audit.FsEvents [<value>]]

Flag denoting whether the audit log for filesystem events is enabled. The option must always be preceded by the '--global' option.

[--Compressor.Concurrency [<value>]]

Maximum parallel compression/decompression tasks (0 means auto).

[--Compressor.DestageThreshold [<value>]]

The threshold block size in bytes, at which blocks get destaged for parallel execution.

[--Compressor.Enabled [<value>]]

Turns compression on and off.

[--Compressor.Lz4Acceleration [<value>]]

Controls compression ratio vs. compression speed. 1 means maximum data compression (takes more resources on the local machine but reduces the network traffic).

[--CryptoStore.Concurrency [<value>]]

Maximum parallel encryption/decryption tasks (0 means auto).

[--CryptoStore.DestageThreshold [<value>]]

The threshold block size in bytes, at which blocks get destaged for parallel execution.

[--DataCache.Location [<value>]]

Change the location of your data cache.

[--DataCache.Size [<value>]]

Local data cache size. The default is 25GiB. 80% of the size is available for pinning.

[--FileLockingGC.RetentionTime [<value>]]

The amount of time lucid service will wait disconnected clients, before collecting their file locks

[--FileStore.MemCachePrefetch [<value>]]

When enabled, prefetched data is stored in the in-memory cache in addition to the persistent data cache.

[--FileStore.MemCacheSize [<value>]]

In-memory data cache size. The default is 64MiB.

[--FileStore.StuckStateInterval [<value>]]

The Stuck State Interval represents the length of time that has elapsed since the last known activity observed for that unique upload. Once this interval has been reached, the visible icon indicating an upload is in progress will change to indicate that there is a problem with that upload. Default value is 7200 seconds (2 hours).

[--FileSystem.DefaultMountPointScheme [<value>]]

Determines where the filespace will be mounted when no mount point is explicitly provided.

[--FileSystem.ForbidSpecialCharacters [<value>]]

Forbid creating file names which are not compatible with Windows. These are names containing a special character \/:*?"<>| , have a trailing space or dot or represent a reserved name on Windows. Since Lucid version 2.0.3633, this setting is set globally to 1 upon Filespace initialization

[--FileSystem.FuseAllowOtherLinux [<value>]]

Linux only. Enables the FUSE 'allow_other' mount option.When enabled, allows users other than the mounting user or root to access the filesystem.

[--FileSystem.LockingExtensions [<value>]]

Windows only. File extensions for which locking will be applied on open.

[--FileSystem.MountPointLinux [<value>]]

Linux only. Path which will be used as a mount point.

[--FileSystem.MountPointOSX [<value>]]

macOS only. Path which will be used as a mount point.

[--FileSystem.MountPointWindows [<value>]]

Windows only. Path which will be used as a mount point and drive letter.

[--FileSystem.MountPointWindowsLabel [<value>]]

Windows only. The label of the filespace drive.

[--FileSystem.RootPoint [<value>]]

Folder within the filespace to appear as the root folder. Path starts at the Lucid filespace root, not the local file system root.

[--FileSystem.WindowsPermissions [<value>]]

Windows only. Enable or disable Windows NTFS permissions. Requires admin privileges.

[--ObjectScheduler.GetLatencyHighAlert [<value>]]

GET request latency high alert threshold in milliseconds.

[--ObjectScheduler.GetLatencyLowAlert [<value>]]

GET request latency low alert threshold in milliseconds.

[--ObjectScheduler.GetLatencyMediumAlert [<value>]]

GET request latency medium alert threshold in milliseconds.

[--ObjectScheduler.MaxDownloadConns [<value>]]

Maximum parallel download connections - object store to client.

[--ObjectScheduler.MaxDownloadRate [<value>]]

Maximum download rate in bytes/s - object store to client. The default is unlimited.

[--ObjectScheduler.MaxUploadConns [<value>]]

Maximum parallel upload connections - client to object store.

[--ObjectScheduler.MaxUploadRate [<value>]]

Maximum upload rate in bytes/s - client to object store. The default is unlimited.

[--ObjectScheduler.PutLatencyHighAlert [<value>]]

PUT request latency high alert threshold in milliseconds.

[--ObjectScheduler.PutLatencyLowAlert [<value>]]

PUT request latency low alert threshold in milliseconds.

[--ObjectScheduler.PutLatencyMediumAlert [<value>]]

PUT request latency medium alert threshold in milliseconds.

[--RemoteKeystore.MetadataUpdatesTimeout [<value>]]

File index sync request timeout. The default is 120 (2 min).

[--TeamCache.Location [<value>]]

Location of the TeamCache proxy.

[--effective]

Description

Currently effective filespace configurations for this client

[--local]

Description

Local configurations scope. Affects only client where setting is applied

[--global]

Description

Global configurations scope. Affects each client that connects to the filespace unless overridden with --local for a particular client

[--set]

Description

Set configuration key(s). Defaults to `local` scope

[--delete]

Description

Delete configuration key(s). Defaults to `local` scope

[--password <password>]

Description

An admin user's password. Used with --global and --local options

[--list]

Description

Display the configuration settings per scope

[--no-trim]

Description

Do not trim long configuration values

[--explain]

Description

Describe what each configuration key affects within Lucid and list its value constraints. Can be used with --KEY Configuration keys:

[--Audit.FsEvents [<value>]]

Description

Flag denoting whether the audit log for filesystem events is enabled. The option must always be preceded by the '--global' option.

[--Compressor.Concurrency [<value>]]

Description

Maximum parallel compression/decompression tasks (0 means auto).

[--Compressor.DestageThreshold [<value>]]

Description

The threshold block size in bytes, at which blocks get destaged for parallel execution.

[--Compressor.Enabled [<value>]]

Description

Turns compression on and off.

[--Compressor.Lz4Acceleration [<value>]]

Description

Controls compression ratio vs. compression speed. 1 means maximum data compression (takes more resources on the local machine but reduces the network traffic).

[--CryptoStore.Concurrency [<value>]]

Description

Maximum parallel encryption/decryption tasks (0 means auto).

[--CryptoStore.DestageThreshold [<value>]]

Description

The threshold block size in bytes, at which blocks get destaged for parallel execution.

[--DataCache.Location [<value>]]

Description

Change the location of your data cache.

[--DataCache.Size [<value>]]

Description

Local data cache size. The default is 25GiB. 80% of the size is available for pinning.

[--FileLockingGC.RetentionTime [<value>]]

Description

The amount of time lucid service will wait disconnected clients, before collecting their file locks

[--FileStore.MemCachePrefetch [<value>]]

Description

When enabled, prefetched data is stored in the in-memory cache in addition to the persistent data cache.

[--FileStore.MemCacheSize [<value>]]

Description

In-memory data cache size. The default is 64MiB.

[--FileStore.StuckStateInterval [<value>]]

Description

The Stuck State Interval represents the length of time that has elapsed since the last known activity observed for that unique upload. Once this interval has been reached, the visible icon indicating an upload is in progress will change to indicate that there is a problem with that upload. Default value is 7200 seconds (2 hours).

[--FileSystem.DefaultMountPointScheme [<value>]]

Description

Determines where the filespace will be mounted when no mount point is explicitly provided.

[--FileSystem.ForbidSpecialCharacters [<value>]]

Description

Forbid creating file names which are not compatible with Windows. These are names containing a special character \/:*?"<>| , have a trailing space or dot or represent a reserved name on Windows. Since Lucid version 2.0.3633, this setting is set globally to 1 upon Filespace initialization

[--FileSystem.FuseAllowOtherLinux [<value>]]

Description

Linux only. Enables the FUSE 'allow_other' mount option.When enabled, allows users other than the mounting user or root to access the filesystem.

[--FileSystem.LockingExtensions [<value>]]

Description

Windows only. File extensions for which locking will be applied on open.

[--FileSystem.MountPointLinux [<value>]]

Description

Linux only. Path which will be used as a mount point.

[--FileSystem.MountPointOSX [<value>]]

Description

macOS only. Path which will be used as a mount point.

[--FileSystem.MountPointWindows [<value>]]

Description

Windows only. Path which will be used as a mount point and drive letter.

[--FileSystem.MountPointWindowsLabel [<value>]]

Description

Windows only. The label of the filespace drive.

[--FileSystem.RootPoint [<value>]]

Description

Folder within the filespace to appear as the root folder. Path starts at the Lucid filespace root, not the local file system root.

[--FileSystem.WindowsPermissions [<value>]]

Description

Windows only. Enable or disable Windows NTFS permissions. Requires admin privileges.

[--ObjectScheduler.GetLatencyHighAlert [<value>]]

Description

GET request latency high alert threshold in milliseconds.

[--ObjectScheduler.GetLatencyLowAlert [<value>]]

Description

GET request latency low alert threshold in milliseconds.

[--ObjectScheduler.GetLatencyMediumAlert [<value>]]

Description

GET request latency medium alert threshold in milliseconds.

[--ObjectScheduler.MaxDownloadConns [<value>]]

Description

Maximum parallel download connections - object store to client.

[--ObjectScheduler.MaxDownloadRate [<value>]]

Description

Maximum download rate in bytes/s - object store to client. The default is unlimited.

[--ObjectScheduler.MaxUploadConns [<value>]]

Description

Maximum parallel upload connections - client to object store.

[--ObjectScheduler.MaxUploadRate [<value>]]

Description

Maximum upload rate in bytes/s - client to object store. The default is unlimited.

[--ObjectScheduler.PutLatencyHighAlert [<value>]]

Description

PUT request latency high alert threshold in milliseconds.

[--ObjectScheduler.PutLatencyLowAlert [<value>]]

Description

PUT request latency low alert threshold in milliseconds.

[--ObjectScheduler.PutLatencyMediumAlert [<value>]]

Description

PUT request latency medium alert threshold in milliseconds.

[--RemoteKeystore.MetadataUpdatesTimeout [<value>]]

Description

File index sync request timeout. The default is 120 (2 min).

[--TeamCache.Location [<value>]]

Description

Location of the TeamCache proxy.

This command also accepts the global options, passed before the command name.