Skip to content

fm dns

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

fm dns

text
Manage managed DNS zones and records.

Each primary zone is assigned a delegation nameserver set; delegate your domain
at your registrar to the zone's name servers (shown by "fm dns zone get").

Examples:
  fm dns zone create --name example.com. --email admin@example.com
  fm dns zone get <zone-id>
  fm dns record create <zone-id> --name www --type A --value 203.0.113.10

Usage:
  fm dns [command]

Available Commands:
  record      Manage DNS records
  zone        Manage DNS zones

Flags:
  -h, --help   help for dns

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

fm dns record

text
Manage DNS records within a zone.

Usage:
  fm dns record [command]

Aliases:
  record, records, rr

Available Commands:
  create      Create a DNS record
  delete      Delete a DNS record
  get         Get DNS record details
  list        List DNS records
  update      Update a DNS record

Flags:
  -h, --help   help for record

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

fm dns record create

text
Create a DNS record (recordset) in a zone.

Use "@" as the name for the zone apex. Repeat --value for multiple values.
MX/SRV values include their priority in the value string.

Examples:
  fm dns record create <zone-id> --name www --type A --value 203.0.113.10
  fm dns record create <zone-id> --name @ --type MX --value "10 mail.example.com."
  fm dns record create <zone-id> --name www --type A --value 203.0.113.10 --value 203.0.113.11

Usage:
  fm dns record create <zone-id> [flags]

Flags:
      --comment string      record comment
  -h, --help                help for create
      --name string         record name, or @ for the apex (required)
      --ttl int             record TTL in seconds
      --type string         record type: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA, PTR (required)
      --value stringArray   record value (repeatable)

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 dns record delete

text
Delete a DNS record from a zone.

Usage:
  fm dns record delete <zone-id> <record-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 dns record get

text
Get detailed information about a specific DNS record.

Usage:
  fm dns record get <zone-id> <record-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 dns record list

text
List the records in a DNS zone.

Usage:
  fm dns record list <zone-id> [flags]

Flags:
  -h, --help          help for list
      --name string   filter by record name
      --type string   filter by record type

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 dns record update

text
Update a DNS record's values, TTL, or comment.

Passing --value replaces the entire value set. Only the flags you pass change.

Usage:
  fm dns record update <zone-id> <record-id> [flags]

Flags:
      --comment string      record comment
  -h, --help                help for update
      --ttl int             record TTL in seconds
      --value stringArray   record value (repeatable, replaces the whole 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 dns zone

text
Manage DNS zones.

Usage:
  fm dns zone [command]

Aliases:
  zone, zones

Available Commands:
  create      Create a DNS zone
  delete      Delete a DNS zone
  get         Get DNS zone details
  list        List DNS zones
  update      Update a DNS zone

Flags:
  -h, --help   help for zone

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

fm dns zone create

text
Create a new DNS zone.

The zone name must be a fully qualified domain name ending with a dot.

Examples:
  fm dns zone create --name example.com. --email admin@example.com
  fm dns zone create --name example.com. --email admin@example.com --ttl 1800

Usage:
  fm dns zone create [flags]

Flags:
      --description string   zone description
      --email string         SOA admin contact email (required)
  -h, --help                 help for create
      --name string          zone name as a FQDN ending with a dot (required)
      --tag strings          tags in key=value format (repeatable)
      --ttl int              default record TTL in seconds

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 dns zone delete

text
Delete a DNS zone and all of its records.

Usage:
  fm dns zone delete <zone-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 dns zone get

text
Get detailed information about a specific DNS zone, including its delegation name servers.

Usage:
  fm dns zone get <zone-id> [flags]

Aliases:
  get, show

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 dns zone list

text
List all DNS zones.

Usage:
  fm dns zone list [flags]

Flags:
  -h, --help          help for list
      --name string   filter by zone name

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 dns zone update

text
Update a DNS zone's email, description, or default TTL.

Only the flags you pass are changed.

Usage:
  fm dns zone update <zone-id> [flags]

Flags:
      --description string   zone description
      --email string         SOA admin contact email
  -h, --help                 help for update
      --tag strings          tags in key=value format (repeatable; replaces the whole set, empty clears)
      --ttl int              default record TTL in seconds

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)