Skip to content

fm messaging

Reference for the fm messaging command group (auto-generated from fm messaging --help).

fm messaging

text
Cross-engine Messaging management commands.

Use the engine-specific subcommands (listed below) for instance lifecycle:
  fm messaging <engine> instance create --name ... --version ... --flavor ... --vpc ... --subnet ...

This command group provides cross-engine views only:
  fm messaging instance list     List all instances (all engines)
  fm messaging instance get      Get instance details
  fm messaging version list      List all versions (all engines)
  fm messaging flavor list       List all flavors (all engines)

Usage:
  fm messaging [command]

Available Commands:
  flavor      Manage Messaging flavors
  instance    View Messaging instances (all engines)
  lavinmq     Manage LavinMQ messaging
  version     Manage Messaging versions

Flags:
  -h, --help   help for messaging

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

Use "fm messaging [command] --help" for more information about a command.

fm messaging flavor

text
List available Messaging instance sizes.

Usage:
  fm messaging flavor [command]

Aliases:
  flavor, flavors

Available Commands:
  list        List Messaging flavors

Flags:
  -h, --help   help for flavor

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

Use "fm messaging flavor [command] --help" for more information about a command.

fm messaging flavor list

text
List all available Messaging instance sizes.

Usage:
  fm messaging flavor list [flags]

Flags:
  -h, --help   help for list

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm messaging instance

text
View managed Messaging instances across all engines.

Usage:
  fm messaging instance [command]

Aliases:
  instance, instances

Available Commands:
  get         Get Messaging instance details
  list        List Messaging instances

Flags:
  -h, --help   help for instance

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

Use "fm messaging instance [command] --help" for more information about a command.

fm messaging instance get

text
Get detailed information about a specific Messaging instance.

Usage:
  fm messaging instance get <instance-id> [flags]

Flags:
  -h, --help   help for get

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm messaging instance list

text
List all Messaging instances.

Usage:
  fm messaging instance list [flags]

Flags:
  -h, --help   help for list

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm messaging lavinmq

text
Manage LavinMQ messaging instances and more.

Usage:
  fm messaging lavinmq [command]

Available Commands:
  config      Manage LavinMQ configuration
  flavor      Manage LavinMQ flavors
  instance    Manage LavinMQ instances
  version     Manage LavinMQ versions

Flags:
  -h, --help   help for lavinmq

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

Use "fm messaging lavinmq [command] --help" for more information about a command.

fm messaging lavinmq config

text
Get and set LavinMQ instance configuration parameters.

Usage:
  fm messaging lavinmq config [command]

Available Commands:
  get         Get LavinMQ configuration
  set         Set LavinMQ configuration value

Flags:
  -h, --help   help for config

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

Use "fm messaging lavinmq config [command] --help" for more information about a command.
fm messaging lavinmq config get
text
Get the current configuration parameters for a LavinMQ instance.

Usage:
  fm messaging lavinmq config get <instance-id> [flags]

Flags:
  -h, --help   help for get

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)
fm messaging lavinmq config set
text
Set a configuration parameter for a LavinMQ instance.

Examples:
  fm lavinmq config set instance-123 maxmemory-policy allkeys-lru
  fm lavinmq config set instance-123 save "3600 1 300 100"

Usage:
  fm messaging lavinmq config set <instance-id> <key> <value> [flags]

Flags:
  -h, --help   help for set

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm messaging lavinmq flavor

text
List available LavinMQ instance sizes.

Usage:
  fm messaging lavinmq flavor [command]

Aliases:
  flavor, flavors

Available Commands:
  list        List LavinMQ flavors

Flags:
  -h, --help   help for flavor

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

Use "fm messaging lavinmq flavor [command] --help" for more information about a command.
fm messaging lavinmq flavor list
text
List all available LavinMQ instance sizes.

Usage:
  fm messaging lavinmq flavor list [flags]

Flags:
  -h, --help   help for list

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm messaging lavinmq instance

text
Manage LavinMQ broker instances.

Usage:
  fm messaging lavinmq instance [command]

Aliases:
  instance, instances

Available Commands:
  create      Create a LavinMQ instance
  credentials Get LavinMQ connection credentials
  delete      Delete a LavinMQ instance
  get         Get LavinMQ instance details
  list        List LavinMQ instances
  resize      Resize a LavinMQ instance
  restart     Restart a LavinMQ instance

Flags:
  -h, --help   help for instance

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

Use "fm messaging lavinmq instance [command] --help" for more information about a command.
fm messaging lavinmq instance create
text
Create a new managed LavinMQ instance.

Examples:
  fm messaging lavinmq instance create --name my-broker --engine-version 2.4 --flavor msg.gp1.small --vpc vpc-123 --subnet subnet-456
  fm messaging lavinmq instance create --name my-broker --engine-version 2.4 --flavor msg.gp1.small --vpc vpc-123 --subnet subnet-456 --persistence-mode persistent

Usage:
  fm messaging lavinmq instance create [flags]

Flags:
      --engine-version string     LavinMQ version (required)
      --flavor string             flavor ID (required, e.g. db.gp1.micro — see 'flavors list')
  -h, --help                      help for create
      --name string               instance name (required)
      --no-wait                   return immediately instead of waiting for provisioning to complete
      --persistence-mode string   persistence mode (none, persistent)
      --subnet string             subnet ID (required)
      --vpc string                VPC ID (required)

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)
fm messaging lavinmq instance credentials
text
Get the connection credentials for a LavinMQ instance.

Examples:
  fm lavinmq instance credentials db-123
  fm lavinmq instance credentials db-123 --rotate

Usage:
  fm messaging lavinmq instance credentials <instance-id> [flags]

Flags:
  -h, --help     help for credentials
      --rotate   rotate credentials

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)
fm messaging lavinmq instance delete
text
Delete a managed LavinMQ instance.

Usage:
  fm messaging lavinmq instance delete <instance-id> [flags]

Flags:
  -h, --help   help for delete

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)
fm messaging lavinmq instance get
text
Get detailed information about a specific LavinMQ instance.

Usage:
  fm messaging lavinmq instance get <instance-id> [flags]

Flags:
  -h, --help   help for get

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)
fm messaging lavinmq instance list
text
List all LavinMQ instances.

Usage:
  fm messaging lavinmq instance list [flags]

Flags:
  -h, --help   help for list

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)
fm messaging lavinmq instance resize
text
Grow the storage of a LavinMQ instance. Storage can only be increased (volumes cannot shrink); flavor resize is not yet supported.

Examples:
  fm lavinmq instance resize <instance-id> --storage 20

Usage:
  fm messaging lavinmq instance resize <instance-id> [flags]

Flags:
  -h, --help          help for resize
      --storage int   new storage size in GB

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)
fm messaging lavinmq instance restart
text
Restart a LavinMQ instance.

Usage:
  fm messaging lavinmq instance restart <instance-id> [flags]

Flags:
  -h, --help   help for restart

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm messaging lavinmq version

text
List available LavinMQ versions.

Usage:
  fm messaging lavinmq version [command]

Aliases:
  version, versions

Available Commands:
  list        List available LavinMQ versions

Flags:
  -h, --help   help for version

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

Use "fm messaging lavinmq version [command] --help" for more information about a command.
fm messaging lavinmq version list
text
List all available LavinMQ engine versions.

Usage:
  fm messaging lavinmq version list [flags]

Flags:
  -h, --help   help for list

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm messaging version

text
List available Messaging versions.

Usage:
  fm messaging version [command]

Aliases:
  version, versions

Available Commands:
  list        List available Messaging versions

Flags:
  -h, --help   help for version

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

Use "fm messaging version [command] --help" for more information about a command.

fm messaging version list

text
List all available Messaging engine versions.

Usage:
  fm messaging version list [flags]

Flags:
  -h, --help   help for list

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)