Skip to content

fm messaging ​

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

fm messaging ​

text
Cross-type Messaging management commands.

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

This command group provides read-only views across every type:
  fm messaging instance list     List all instances (all types)
  fm messaging instance get      Get instance details
  fm messaging version list      List all versions (all types)
  fm messaging flavor list       List all flavors (all types)

Usage:
  fm messaging [command]

Available Commands:
  flavor      Manage Messaging flavors
  instance    View Messaging instances (all types)
  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 types.

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.

--tag key=value (repeatable) lists only the instances carrying EVERY given resource
tag with exactly that value; key= matches a tag whose value is empty.

Usage:
  fm messaging instance list [flags]

Flags:
  -h, --help          help for list
      --tag strings   only instances with this tag, key=value (repeatable; every one must match; key= matches an empty value)

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
  tags        Read and replace a LavinMQ instance's resource tags

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 --type-version 2.4 --flavor mq.gp1.small --vpc vpc-123 --subnet subnet-456
  fm messaging lavinmq instance create --name my-broker --type-version 2.4 --flavor mq.gp1.small --vpc vpc-123 --subnet subnet-456 --persistence-mode persistent

Usage:
  fm messaging lavinmq instance create [flags]

Flags:
      --flavor string             flavor ID (required, e.g. mq.gp1.small — 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)
      --tag strings               resource tag in key=value format (repeatable). The tenant's default tags are merged in; a key you set wins
      --type-version string       LavinMQ version (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.

--rotate changes the admin password inside the running instance. It starts the rotation,
waits for the platform to confirm it (up to --wait-timeout), and then prints the
new credentials. Your current credentials stay valid until the rotation
completes, and stay valid if it fails. Instances created before in-place
rotation was available cannot rotate and are refused.

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

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

Flags:
  -h, --help                    help for credentials
      --no-wait                 with --rotate: start the rotation and print its operation id instead of waiting
      --rotate                  rotate the admin password inside the instance, then print the new credentials
      --wait-timeout duration   with --rotate: how long to wait for the rotation to complete (default 5m0s)

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.

--tag key=value (repeatable) lists only the instances carrying EVERY given resource
tag with exactly that value; key= matches a tag whose value is empty.

Usage:
  fm messaging lavinmq instance list [flags]

Flags:
  -h, --help          help for list
      --tag strings   only instances with this tag, key=value (repeatable; every one must match; key= matches an empty value)

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 instance tags ​
text
Read and replace a LavinMQ instance's resource tags

Usage:
  fm messaging lavinmq instance tags [command]

Aliases:
  tags, tag

Available Commands:
  get         Show a LavinMQ instance's resource tags
  set         Replace a LavinMQ instance's resource tags

Flags:
  -h, --help   help for tags

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 tags [command] --help" for more information about a command.
fm messaging lavinmq instance tags get ​
text
Show a LavinMQ instance's resource tags

Usage:
  fm messaging lavinmq instance tags 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 tags set ​
text
Replace a LavinMQ instance's resource tags in place with exactly the given set
(replace semantics — any tag not listed is removed). Resource tags are your own
metadata for search and filtering: nothing else about the LavinMQ instance changes, and the
running service is not touched.

The set you pass IS the resulting set. To ADD one tag without disturbing the
others, read the current ones first with 'fm messaging lavinmq instance tags get' and pass them all
back. Use --clear to remove every tag. The tenant's default tags are not
re-applied.

A tag change restarts nothing, and is accepted while the instance is busy (resizing, backing up). Its backups and replicas keep their own tags.

Keys beginning frostmoln_ or frostmoln- (any letter case) are reserved and
refused. At most 32 tags; a key is 1-64 bytes, a value at most 256 bytes.

Examples:
  fm messaging lavinmq instance tags set inst-123 --tag env=prod --tag owner=team-a
  fm messaging lavinmq instance tags set inst-123 --clear

Usage:
  fm messaging lavinmq instance tags set <instance-id> --tag <key=value> [--tag <key=value> ...] [flags]

Flags:
      --clear         remove ALL tags (mutually exclusive with --tag)
  -h, --help          help for set
      --tag strings   tag in key=value format (repeatable; replace semantics)

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 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 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)