Skip to main content

gns3util node update

Update a Node in a Project

Synopsis

Update a Node in a Project. To use custom adapters the —use-json option has to be used.
gns3util node update [project-name/id] [node-name/id] [flags]

Examples

gns3util -s https://controller:3080 update [project-name/id] [node-name/id] --name new-name

Options

  -a, --aux int                        Auxiliary console TCP port
      --aux-type string                Type of the aux console
      --compute-id string              Compute on that the Node gets created (default "local")
  -p, --console int                    TCP port of the console
      --console-auto-start             Automatically start the console when the node has started
      --console-type string            Type of the console interface
      --first-port-name string         Name of the first port
  -h, --help                           help for update
      --label-rotation int             Rotation of the label
      --label-style-attribute string   SVG style attribute
      --label-text string              Text of the label of the Node
      --label-x-position int           X-Position of the label
      --label-y-position int           Y-Position of the label
  -l, --locked                         Whether the node is locked or not
  -n, --name string                    Desired name for the Node
  -t, --node-type string               Type of Node
      --port-name-format string        Name format for the port for example: Ethernet{0}
      --port-segment-size int          Port segment size
      --properties string              Custom properties JSON
      --symbol string                  Name of the desired symbol
  -j, --use-json string                Provide a raw JSON string to send instead of flags
  -x, --x int                          X-Position of the node
  -y, --y int                          Y-Position of the node
  -z, --z int                          Z-Position (layer) of the node (default 1)

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

SEE ALSO

Auto generated by spf13/cobra on 24-Mar-2026