Skip to content

fm forward

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

fm forward

text
Forward a local TCP port to a managed database instance over a secure
session — no public IP, open port, or VPN required. The instance needs the
'instance-access' entitlement on its tenant.

The remote port defaults to the instance's engine port (5432 for PostgreSQL,
3306 for MySQL) and only the engine port is allowed.

Sessions are time-limited by the platform: the forward ends after 10 minutes
of inactivity or 1 hour total.

Usage:
  fm forward <instance-id> <local-port>[:<remote-port>] [flags]

Examples:
  # Forward local port 15432 to the instance's engine port
  fm forward db-instance-id 15432

  # Explicit remote port
  fm forward db-instance-id 15432:5432

Flags:
  -h, --help   help for forward

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)