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 remote install gns3

Install GNS3 server on a remote machine

​
Synopsis

Install GNS3 server on a remote machine via SSH. This command will:
  • Install GNS3 server and dependencies
  • Configure GNS3 server with specified options
  • Set up systemd service for GNS3
  • Optionally install Docker, VirtualBox, VMware support
  • Optionally configure IOU support
The installation supports Ubuntu LTS releases and requires Python 3.9+. 
gns3util remote install gns3 [user] [flags]

​
Options

      --disable-kvm          Disable KVM hardware acceleration
      --enable-i386          Enable i386 architecture for legacy IOU
      --gns3-port int        Port for GNS3 server to listen on (default 3080)
  -h, --help                 help for gns3
      --home-dir string      Home directory for GNS3 user (default "/opt/gns3")
      --install-docker       Install Docker for GNS3 appliances
      --install-virtualbox   Install VirtualBox support
      --install-vmware       Install VMware integration packages
      --interactive          Set the options for this command interactively
      --key string           Path to a custom SSH private key file
      --listen-host string   Host address for GNS3 server to bind to (default "0.0.0.0")
      --port int             SSH port (default 22)
      --use-iou              Install IOU support (requires valid license)
      --username string      Username for GNS3 service (default "gns3")
      --verbose              Run this command with extra logging

​
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