Return the GNS3 controller version and whether it runs in local mode.

Return controller-wide statistics (counts of projects, computes, etc.).

Return the configured Cisco IOU license (if any).

Set the Cisco IOU license. iourc_content is the raw iourc file text.

Reload the GNS3 controller. Requires confirm=true.

Shut down the GNS3 controller process. Requires confirm=true. Destructive.

List all projects on the controller (id, name, status).

Get full details for a project.

Get node/link/drawing/snapshot counts for a project.

Return whether the project is currently locked.

Create a new project. Optionally pin a specific project_id (UUID).

Update project attributes (e.g. {"name": "...", "auto_start": true}).

Delete a project permanently. Requires confirm=true. Destructive.

Open a closed project so its nodes can run.

Close an open project (stops nodes, frees resources).

Load a project from a .gns3 file path on the controller host.

Duplicate a project under a new name.

Lock a project to prevent topology edits.

Unlock a project.

Export a project to a local .gns3project archive at dest_path.

Import a project from a local .gns3project archive.

Read a text file from inside the project directory.

Write a text file inside the project directory.

List nodes in a project (id, name, type, status, console).

Get full details for a single node.

List the links attached to a node.

Get Dynamips idle-PC proposals for a node.

Create a node directly (node_type e.g. vpcs, qemu, docker, dynamips, ethernet_switch).

Prefer node_create_from_template when a suitable template exists.

Instantiate a node from a template at canvas position (x, y).

Update node attributes (e.g. {"name": "...", "properties": {...}}).

Delete a node from the project.

Duplicate a node, offset by (dx, dy) on the canvas.

Start a node.

Stop a node.

Suspend a node.

Reload (restart) a node.

Isolate a node: suspend all its links (cut traffic without deleting links).

Re-enable all links on a previously isolated node.

Reset the console server connection for a node.

Start every node in the project.

Stop every node in the project.

Suspend every node in the project.

Reload every node in the project.

Auto-compute a Dynamips idle-PC value for a node.

Read a text file from inside a node's working directory.

Write a text file into a node's working directory (e.g. startup-config).

List links in a project (id, endpoints, capture state, filters).

Get full details for a link.

List packet filters available on a link (delay, drop, corrupt, etc.).

Create a link between two node ports.

Use a node's ports (from node_get/nodes_list) to find adapter_number/port_number.

Update a link: set {"suspend": true} or {"filters": {"delay": [50]}} etc.

Delete a link.

Reset a link (reconnect both ends).

List drawings (SVG annotations) in a project.

Create a drawing from an SVG string at canvas position (x, y).

Update a drawing (svg/x/y/z/rotation).

Delete a drawing.

List snapshots of a project.

Create a snapshot of the current project state.

Restore the project to a snapshot. The current state is overwritten.

Delete a snapshot.

List device templates (id, name, type, category).

Get full details for a template (all properties).

Create a template. template must include name and template_type plus props.

Update a template's attributes.

Delete a template.

Duplicate a template.

List compute servers (id, name, host, connected state, load).

Get full details for a compute server.

Query an emulator on a compute, e.g. emulator='docker' action='images', emulator='virtualbox' action='vms', emulator='vmware' action='vms'.

Register a compute server. compute needs protocol/host/port/name (+ auth).

Update a compute server's connection settings.

Unregister a compute server.

List disk images known to the controller (qemu/ios/iou/docker).

Get metadata for an image by its path.

Upload a local image file to the controller under image_path.

Install/register images so templates can use them (optionally one path).

Delete an image by path.

Delete all images not used by any template. Requires confirm=true.

List appliances from the GNS3 catalog. Set update=true to refresh from registry.

Get full details for an appliance (versions, images required).

Install an appliance as a template (optionally a specific version).

List resource pools.

Get a resource pool.

List the resources contained in a pool.

Create a resource pool.

Update a resource pool (e.g. rename).

Delete a resource pool.

Add a resource (project/template/compute id) to a pool.

Remove a resource from a pool.

Return the currently authenticated user.

List user accounts.

Get a user account.

List the groups a user belongs to.

List user groups.

List members of a user group.

List roles.

List the privileges granted to a role.

List all assignable privileges in the system.

List Access Control Entries (ACEs) in the ACL.