fm tenant

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

fm tenant

Manage tenants within a Frostmoln organization.

Usage:
  fm tenant [command]

Aliases:
  tenant, tenants

Available Commands:
  create      Create a tenant in an organization
  current     Show the active tenant
  list        List tenants in an organization
  rename      Rename a tenant
  use         Set the active tenant for subsequent commands

Flags:
  -h, --help                  help for tenant
      --organization string   organization ID (defaults to your only organization)

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

fm tenant create

Create an additional tenant in an organization.

The tenant is provisioned asynchronously (isolation, roles, quotas,
billing account); it is returned in status=provisioning and becomes active
once provisioning completes.

If you belong to a single organization it is used automatically; otherwise
pass --organization with the organization ID.

Examples:
  fm tenant create --name "Staging"
  fm tenant create --name "Production" --organization 0c4f...

Usage:
  fm tenant create [flags]

Flags:
  -h, --help          help for create
      --name string   tenant display name (required)

Global Flags:
      --config string         config file (default is $HOME/.fm/config.yaml)
  -d, --debug                 enable debug/verbose output
      --no-color              disable colored output
      --organization string   organization ID (defaults to your only organization)
  -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 tenant current

Show the tenant the CLI currently operates on (the --tenant flag,
FM_TENANT, the persisted 'fm tenant use' selection, or your default tenant).

Use -o json or -o yaml for a machine-readable value.

Usage:
  fm tenant current [flags]

Flags:
  -h, --help   help for current

Global Flags:
      --config string         config file (default is $HOME/.fm/config.yaml)
  -d, --debug                 enable debug/verbose output
      --no-color              disable colored output
      --organization string   organization ID (defaults to your only organization)
  -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 tenant list

List the tenants in an organization.

If you belong to a single organization it is used automatically; otherwise
pass --organization with the organization ID, or --all to list the tenants
across every organization you belong to (the same set 'fm tenant use' accepts).

Usage:
  fm tenant list [flags]

Flags:
      --all    list tenants across all your organizations
  -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
      --organization string   organization ID (defaults to your only organization)
  -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 tenant rename

Change the display name of a tenant.

Only the label changes. The tenant's ID and its internal slug-form name are
immutable: the slug is carried into the isolation project name when the tenant
is provisioned, so it is deliberately frozen. Display names do not have to be
unique.

Requires an admin or owner role in the tenant's organization.

Examples:
  fm tenant rename 0c4f... --name "Production"

Usage:
  fm tenant rename <tenant-id> [flags]

Flags:
  -h, --help          help for rename
      --name string   new tenant display name (required)

Global Flags:
      --config string         config file (default is $HOME/.fm/config.yaml)
  -d, --debug                 enable debug/verbose output
      --no-color              disable colored output
      --organization string   organization ID (defaults to your only organization)
  -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 tenant use

Set the active tenant the CLI operates on.

The selection is persisted to the current context, so subsequent commands
(e.g. fm compute instance list) target this tenant until you switch again.
A one-off --tenant <id> flag (or FM_TENANT) overrides it for a single command.

The tenant ID is validated against the tenants you are entitled to.

Example:
  fm tenant use 0c4f1e2a-...

Usage:
  fm tenant use <tenant-id> [flags]

Flags:
  -h, --help   help for use

Global Flags:
      --config string         config file (default is $HOME/.fm/config.yaml)
  -d, --debug                 enable debug/verbose output
      --no-color              disable colored output
      --organization string   organization ID (defaults to your only organization)
  -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)