Skip to main content

Documentation Index

Fetch the complete documentation index at: https://gns3util.saygex.xyz/llms.txt

Use this file to discover all available pages before exploring further.

​
gns3util cluster-control auth add-user

Store a user’s JWT token for a cluster in the keyfile

​
Synopsis

Store a user credential in the keyfile for a cluster so you can switch between multiple users with —user. The token is sent to the cluster master’s /auth/status endpoint to verify it and retrieve the username - no local JWT decoding needed. If [token] is omitted you will be prompted to paste it. Use ‘ctl auth set-default-user’ to change which user is the default. 
gns3util cluster-control auth add-user [token] [flags]

​
Examples

  gns3util ctl auth add-user eyJhbGci... -c mycluster
  gns3util ctl auth add-user -c mycluster   # prompts for token

​
Options

  -h, --help   help for add-user

​
Options inherited from parent commands

  -c, --cluster string      Cluster name from keyfile. Mutually exclusive with --server
  -i, --insecure            Ignore unsigned SSL-Certificates. Can be set via GNS3_INSECURE
  -k, --key-file string     Path to authentication keyfile. Can be set via GNS3_KEY_FILE or config.toml
  -o, --output string       Output format: [json, json-colorless, collapsed, yaml, toml, table, table-ascii]. Can be set via GNS3_OUTPUT (default "table")
  -s, --server string       GNS3v3 Server URL. Can be set via GNS3_SERVER or config.toml
      --user string[="~"]   User to select from the keyfile. Omit the value to open a fuzzy picker (--user), or pass a name (--user alice).

​
SEE ALSO

Auto generated by spf13/cobra on 9-May-2026