configure.flexfs

Note

configure.flexfs is an Enterprise-only tool. It is not available in the Community edition.

configure.flexfs is the management CLI for flexFS Enterprise. It provides both an interactive REPL and single-command mode for CRUD operations on all admin server resource types. It communicates with the admin server over its REST API.

Interactive Mode

When run without arguments from a terminal, configure.flexfs starts an interactive shell with tab completion and command history:

configure.flexfs> list volumes
configure.flexfs> show volume my-vol
configure.flexfs> create volume --name test --metaStoreID 1 --blockStoreID 1
configure.flexfs> exit

Single-Command Mode

Commands can also be run directly from the shell:

configure.flexfs list volumes --json
configure.flexfs create volume --name test --metaStoreID 1 --blockStoreID 1

Verbs

Verb	Description
list <resource>	List all instances of a resource
show <resource> <id>	Show details for a single resource
create <resource> --field=value ...	Create a new resource
update <resource> <id> --field=value ...	Update an existing resource
delete <resource> <id>	Delete a resource

Resources

Resource	API Name	Description
account	accounts	User account
block-api	block-apis	Block store API type
block-store	block-stores	Block store (bucket configuration)
meta-store	meta-stores	Metadata store
provider	providers	Cloud provider
proxy-group	proxy-groups	Proxy group
region	regions	Provider region
volume	volumes	Volume
volume-proxy-group	volume-proxy-groups	Volume-to-proxy-group association
volume-token	volume-tokens	Volume access token

Global Flags

Flag	Type	Default	Description	Visibility
--credsFile	string	~/.flexfs/configure/creds	Credentials file path	Public
--json	bool	false	Output results as JSON	Public
--adminAddr	string		Admin server address (overrides creds file)	Internal
--noAdminSSL	bool	false	Disable SSL for admin server connections	Internal
--token	string		Account auth token (overrides creds file)	Internal

Volume Fields

When creating or updating volumes, the following fields are available:

Flag	Type	Default	Description
--metaStoreID	int		Metadata store ID (required for create)
--blockStoreID	int		Block store ID (required for create)
--name	string		Volume name (required for create)
--id	string	auto-generated	Volume ID (UUID)
--blockSize	string	4MiB	Block size (e.g. 4MiB, 256KiB, or raw bytes)
--compression	string	lz4	Compression algorithm: lz4, snappy, zstd, or none
--encryption	bool	false	Enable end-to-end encryption
--retention	string	7d	Retention duration (e.g. 7d, 168h, 30m) or seconds; -1 = forever
--maxBlocks	int	0	Max block count, 0 = unlimited
--maxInodes	int	0	Max inode count, 0 = unlimited
--maxProxied	int	0	Max proxied blocks per file, 0 = unlimited
--flags	string		Comma-separated mount flags (ro, noatime, acl, xattr, …)
--notes	string		Free-form notes

Volume Token Fields

Flag	Type	Default	Description
--volumeID	string		Volume ID or name (required for create)
--token	string	auto-generated	Access token (UUID)
--mountPath	string		Subdirectory path to mount as root (e.g. /data/project)
--flags	string		Comma-separated mount flags
--notes	string		Free-form notes