configure.flexfs (Enterprise)

Note

configure.flexfs is an Enterprise-only tool. It is not available in the Community edition. Community deployments are configured entirely through free.flexfs init creds.

configure.flexfs is the administrative CLI for managing flexFS Enterprise resources. It communicates with the admin server REST API to create, list, show, update, and delete resources such as volumes, accounts, block stores, and proxy groups.

Modes of Operation

REPL Mode (Interactive)

When run without arguments in a terminal, configure.flexfs launches an interactive shell with command history, tab completion, and a persistent prompt:

$ configure.flexfs
   __ _           _____ ____
  / _| | _____  _|  ___/ ___|
 | |_| |/ _ \ \/ / |_  \___ \
 |  _| |  __/>  <|  _|  ___) |
 |_| |_|\___/_/\_\_|   |____/

Interactive Management Shell
Type 'help' for commands or 'exit' to quit.
configure.flexfs>

In REPL mode, type commands directly without the configure.flexfs prefix:

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

Command history is saved to disk and persists across sessions. Tab completion works for commands, resource names, and flag names.

Single-Command Mode

Any command can be run directly from the shell without entering the REPL:

configure.flexfs list volumes
configure.flexfs show volume my-volume
configure.flexfs create volume --name my-volume --metaStoreID 1 --blockStoreID 1

This mode is suitable for scripting and automation.

JSON Output

Add --json to any command for machine-readable output:

configure.flexfs list volumes --json
configure.flexfs show volume my-volume --json

Credential Initialization

Before using configure.flexfs, initialize its credentials file with the admin server address and an account token:

configure.flexfs init --adminAddr admin-host:443 --token $TOKEN

If --token is omitted, the command prompts interactively.

init Flags

| Flag | Default | Description | |---|---|---| | --adminAddr | (required) | Admin server address (host:port) | | --force | false | Overwrite an existing credentials file | | --token | (prompt) | Account auth token (UUID) |

The credentials file is a TOML file written with 0600 permissions:

adminAddr = "admin-host:443"
token = "$TOKEN"

Remove Credentials

configure.flexfs deinit

Verb Commands

| Verb | Description | |---|---| | list <resource> | List all resources of a type, with optional filter flags | | list all | List all resources across every type | | show <resource> <id> | Show full details of 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 |

Resource Types

configure.flexfs manages 10 resource types:

| Resource | List Command | Primary Key | |---|---|---| | Accounts | list accounts | id | | Block APIs | list block-apis | code | | Block Stores | list block-stores | id | | Meta Stores | list meta-stores | id | | Providers | list providers | code | | Proxy Groups | list proxy-groups | id | | Regions | list regions | providerCode + code | | Volumes | list volumes | id (or name) | | Volume Proxy Groups | list volume-proxy-groups | volumeID + proxyGroupID | | Volume Tokens | list volume-tokens | token |

Accounts

User accounts. Created automatically during installation; managed with update.

Fields (update): name, email, token

configure.flexfs update account <id> --name "Admin User" --email admin@example.com

Block APIs

Read-only lookup table of supported block storage API codes: s3, gcs, azure, oci.

configure.flexfs list block-apis

Block Stores

Object storage backend configurations. See Block Stores for full details.

Fields (create): providerCode (required), regionCode (required), apiCode (required), bucket (required), username, password, address, prefix

Fields (update): username, password, address

configure.flexfs create block-store \
  --providerCode aws --regionCode us-east-1 --apiCode s3 \
  --bucket my-bucket --prefix flexfs \
  --username $USERNAME --password $PASSWORD

Meta Stores

Metadata server registrations. See Metadata Stores for full details.

Fields (create): providerCode (required), regionCode (required), address (required), token (auto-generated if omitted)

Fields (update): token, address

configure.flexfs create meta-store \
  --providerCode aws --regionCode us-east-1 \
  --address meta-host:443

Providers

Cloud provider definitions. See Providers and Regions for full details.

Fields (create): code (required), name (required)

Fields (update): code, name

configure.flexfs create provider --code aws --name "Amazon Web Services"

Proxy Groups

Groups of proxy servers. See the Proxy Server documentation.

Fields (create): providerCode (required), regionCode (required), addresses (required, comma-separated)

Fields (update): addresses

configure.flexfs create proxy-group \
  --providerCode aws --regionCode us-east-1 \
  --addresses proxy1:443,proxy2:443

Regions

Cloud regions under a provider. See Providers and Regions for full details.

Fields (create): providerCode (required), code (required), name (required)

Fields (update): code, name

configure.flexfs create region \
  --providerCode aws --code us-east-1 --name "US East (N. Virginia)"

Volumes

Filesystem volumes. See Volume Management for full details.

Fields (create): metaStoreID (required), blockStoreID (required), name (required), id, maxBlocks, maxInodes, maxProxied, flags, blockSize, compression, encryption, retention, notes

Fields (update): metaStoreID, blockStoreID, name, maxBlocks, maxInodes, maxProxied, flags, retention, notes

Volumes can be referenced by name or UUID in show, update, and delete commands.

Deleting a volume retires it rather than permanently removing it.

Volume Proxy Groups

Associations between volumes and proxy groups.

Fields (create): volumeID (required, accepts name), proxyGroupID (required)

configure.flexfs create volume-proxy-group \
  --volumeID my-volume --proxyGroupID 1

List with --volumeName to filter by volume:

configure.flexfs list volume-proxy-groups --volumeName my-volume

Volume Tokens

Access tokens for mounting volumes. See Volume Tokens for full details.

Fields (create): volumeID (required, accepts name), token, mountPath, flags, notes

Fields (update): mountPath, flags, notes

configure.flexfs create volume-token \
  --volumeID my-volume \
  --mountPath /data/project \
  --flags ro

List with --volumeName to filter by volume:

configure.flexfs list volume-tokens --volumeName my-volume

Filtering

All list commands accept filter flags corresponding to the resource’s columns. For example:

configure.flexfs list volumes --name my-volume
configure.flexfs list block-stores --providerCode aws
configure.flexfs list volume-tokens --volumeName my-volume

Volume tokens and volume proxy groups also accept the --volumeName convenience filter, which resolves a volume name to its ID before querying.

Persistent Flags

| Flag | Default | Description | |---|---|---| | --credsFile | ~/.flexfs/configure/creds | Credentials file path | | --json | false | Output results as JSON |