Skip to content

fm scale-group

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

fm scale-group

text
Manage auto-scaling groups of compute instances.

Scale groups automatically maintain a fleet of instances based on desired capacity,
health checks, and scaling policies.

Examples:
  fm scale-group list
  fm scale-group get sg-123
  fm scale-group create --name web-fleet --template lt-123 --min-size 2 --max-size 10 --desired 3 --subnet sub-456
  fm scale-group set-capacity sg-123 --desired 5
  fm scale-group instances sg-123
  fm scale-group activity sg-123
  fm scale-group delete sg-123

Usage:
  fm scale-group [command]

Aliases:
  scale-group, scale-groups

Available Commands:
  activity     List scaling activities
  create       Create a scale group
  delete       Delete a scale group
  get          Get scale group details
  instances    List instances in scale group
  list         List scale groups
  set-capacity Set desired capacity
  tags         Read and replace a scale group's tags

Flags:
  -h, --help   help for scale-group

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 scale-group [command] --help" for more information about a command.

fm scale-group activity

text
List scaling activities for a scale group.

Usage:
  fm scale-group activity <scale-group-id> [flags]

Aliases:
  activity, activities

Flags:
  -h, --help   help for activity

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 scale-group create

text
Create a new auto-scaling group.

Examples:
  fm scale-group create --name web-fleet --template lt-123 --min-size 2 --max-size 10 --desired 3 --subnet sub-456
  fm scale-group create --name api-fleet --template lt-456 --min-size 1 --max-size 5 --desired 2 --subnet sub-1 --subnet sub-2 --lb-pool pool-789
  fm scale-group create --name web-fleet --template lt-123 --min-size 2 --max-size 10 --desired 3 --subnet sub-456 --tag env=prod --tag owner=team-a

Usage:
  fm scale-group create [flags]

Flags:
      --desired int                 desired number of instances (required)
      --health-check string         health check type: instance, lb, both (default "instance")
  -h, --help                        help for create
      --lb-pool strings             load balancer pool ID(s) (optional, repeatable)
      --max-size int                maximum number of instances (required)
      --min-size int                minimum number of instances (required)
      --name string                 scale group name (required)
      --subnet strings              subnet ID(s) (required, repeatable)
      --tag strings                 tags in key=value format (repeatable)
      --template string             launch template ID (required)
      --termination-policy string   termination policy: oldest_first, newest_first (default "oldest_first")

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 scale-group delete

text
Delete a scale group and terminate all its instances.

Usage:
  fm scale-group delete <scale-group-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 scale-group get

text
Get detailed information about a specific scale group.

Usage:
  fm scale-group get <scale-group-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 scale-group instances

text
List all instances belonging to a scale group.

Usage:
  fm scale-group instances <scale-group-id> [flags]

Flags:
  -h, --help   help for instances

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 scale-group list

text
List all scale groups.

Usage:
  fm scale-group 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 scale-group set-capacity

text
Set the desired capacity of a scale group.

Examples:
  fm scale-group set-capacity sg-123 --desired 5

Usage:
  fm scale-group set-capacity <scale-group-id> [flags]

Flags:
      --desired int   desired number of instances (required)
  -h, --help          help for set-capacity

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 scale-group tags

text
Read and replace a scale group's tags

Usage:
  fm scale-group tags [command]

Aliases:
  tags, tag

Available Commands:
  get         Show a scale group's tags
  set         Replace a scale group's 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 scale-group tags [command] --help" for more information about a command.

fm scale-group tags get

text
Show a scale group's tags

Usage:
  fm scale-group tags get <scale-group-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 scale-group tags set

text
Replace a scale group's tags in place with exactly the given set
(replace semantics — any tag not listed is removed).

The set you pass IS the resulting set. To ADD one tag without disturbing the
others, read the current ones first with 'fm scale-group tags get' and pass them
all back.

Use --clear to remove every tag.

These are labels on the scale group itself. They are not stamped onto the
instances it launches, so changing them never touches a running instance.

Examples:
  fm scale-group tags set sg-123 --tag env=prod --tag owner=team-a
  fm scale-group tags set sg-123 --clear

Usage:
  fm scale-group tags set <scale-group-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)