{"id":48181404,"url":"https://github.com/davidban77/gns3fy","last_synced_at":"2026-04-04T17:45:12.956Z","repository":{"id":35044246,"uuid":"199626894","full_name":"davidban77/gns3fy","owner":"davidban77","description":"Python library wrapper around GNS3 Server REST API","archived":false,"fork":false,"pushed_at":"2026-03-14T17:43:11.000Z","size":1235,"stargazers_count":68,"open_issues_count":18,"forks_count":33,"subscribers_count":8,"default_branch":"develop","last_synced_at":"2026-03-15T00:58:25.551Z","etag":null,"topics":["gns3","gns3-server","netdev","netdevops","network","rest-api"],"latest_commit_sha":null,"homepage":"https://davidban77.github.io/gns3fy/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/davidban77.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-30T10:08:42.000Z","updated_at":"2026-01-01T13:05:35.000Z","dependencies_parsed_at":"2023-10-16T18:27:03.844Z","dependency_job_id":"6c30a420-9aa9-44fd-9ef2-7dc5b44d0112","html_url":"https://github.com/davidban77/gns3fy","commit_stats":{"total_commits":85,"total_committers":8,"mean_commits":10.625,"dds":"0.23529411764705888","last_synced_commit":"4005a10adb84ae48ba8c39ea309622648adc0cad"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/davidban77/gns3fy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidban77%2Fgns3fy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidban77%2Fgns3fy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidban77%2Fgns3fy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidban77%2Fgns3fy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/davidban77","download_url":"https://codeload.github.com/davidban77/gns3fy/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidban77%2Fgns3fy/sbom","scorecard":{"id":326083,"data":{"date":"2025-08-11","repo":{"name":"github.com/davidban77/gns3fy","commit":"8697b038a9ed66c58ce013de5a1a5f21c170d5ce"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.8,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":4,"reason":"Found 10/22 approved changesets -- score normalized to 4","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/tests.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/davidban77/gns3fy/tests.yml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/davidban77/gns3fy/tests.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/davidban77/gns3fy/tests.yml/develop?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/davidban77/gns3fy/tests.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/davidban77/gns3fy/tests.yml/develop?enable=pin","Warn: containerImage not pinned by hash: .devcontainer/Dockerfile:5: pin your Docker image by updating circleci/python:3.7 to circleci/python:3.7@sha256:3de62879e0b899d3de2a836957c736e6711c5a3faabd0ea2ce28bb49cf5e4ae2","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during GetBranch(master): error during branchesHandler.query: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"21 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2024-48 / GHSA-fj7x-q9j7-g6q6","Warn: Project is vulnerable to: PYSEC-2024-230 / GHSA-248v-346w-9cwc","Warn: Project is vulnerable to: PYSEC-2023-135 / GHSA-xqr8-7jwr-rhp7","Warn: Project is vulnerable to: PYSEC-2024-60 / GHSA-jjg7-2v4v-x38h","Warn: Project is vulnerable to: GHSA-cpwx-vrp4-4pq7","Warn: Project is vulnerable to: GHSA-gmj6-6f8f-6699","Warn: Project is vulnerable to: GHSA-h5c8-rqwp-cp95","Warn: Project is vulnerable to: GHSA-h75v-3vvj-5mfj","Warn: Project is vulnerable to: GHSA-q2x7-8rv6-6q7h","Warn: Project is vulnerable to: PYSEC-2022-42969","Warn: Project is vulnerable to: GHSA-mr82-8j83-vxmv","Warn: Project is vulnerable to: PYSEC-2023-117 / GHSA-mrwq-x4v8-fh7p","Warn: Project is vulnerable to: GHSA-jh85-wwv9-24hv","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2023-74 / GHSA-j8r2-6x86-q33q","Warn: Project is vulnerable to: GHSA-34jh-p97f-mpxf","Warn: Project is vulnerable to: PYSEC-2023-212 / GHSA-g4mx-q9vg-27p4","Warn: Project is vulnerable to: GHSA-pq67-6m6q-mj2v","Warn: Project is vulnerable to: PYSEC-2023-192 / GHSA-v845-jxx5-vc9f","Warn: Project is vulnerable to: GHSA-jfmj-5v4g-7637"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 29 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-18T02:30:50.559Z","repository_id":35044246,"created_at":"2025-08-18T02:30:50.559Z","updated_at":"2025-08-18T02:30:50.559Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31407651,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T10:20:44.708Z","status":"ssl_error","status_checked_at":"2026-04-04T10:20:06.846Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gns3","gns3-server","netdev","netdevops","network","rest-api"],"created_at":"2026-04-04T17:45:12.150Z","updated_at":"2026-04-04T17:45:12.941Z","avatar_url":"https://github.com/davidban77.png","language":"Python","readme":"# gns3fy\n\n![Tests](https://github.com/davidban77/gns3fy/actions/workflows/tests.yml/badge.svg)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![codecov](https://codecov.io/gh/davidban77/gns3fy/branch/develop/graph/badge.svg)](https://codecov.io/gh/davidban77/gns3fy)\n[![Total alerts](https://img.shields.io/lgtm/alerts/g/davidban77/gns3fy.svg?logo=lgtm\u0026logoWidth=18)](https://lgtm.com/projects/g/davidban77/gns3fy/alerts/)\n[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/davidban77/gns3fy.svg?logo=lgtm\u0026logoWidth=18)](https://lgtm.com/projects/g/davidban77/gns3fy/context:python)\n[![pypi](https://img.shields.io/pypi/v/gns3fy.svg)](https://pypi.python.org/pypi/gns3fy)\n[![versions](https://img.shields.io/pypi/pyversions/gns3fy.svg)](https://github.com/davidban77/gns3fy)\n\nPython wrapper around [GNS3 Server API](http://api.gns3.net/en/2.2/index.html). Minimal GNS3 version is 2.2.\n\nIts main objective is to interact with the GNS3 server in a programatic way, so it can be integrated with the likes of Ansible, docker and scripts. Ideal for network CI/CD pipeline tooling.\n\n## Documentation\n\nCheck out the [Documentation](https://davidban77.github.io/gns3fy/) to explore use cases and the API Reference\n\n## Use cases\n\nHere are some examples where gns3fy is used in a programmatic way:\n\n- [Ansible-collection-gns3](https://galaxy.ansible.com/davidban77/gns3): Useful for CI/CD pipelines to interact with GNS3 server using Ansible. It can create/delete projects, nodes and links in an ansible playbook.\n- Terraform: Coming soon... (although it might be a Go version of it)\n- [Migrate templates between GNS3 servers](https://davidban77.github.io/gns3fy/user-guide/#migrate-templates-between-gns3-servers)\n- [Check server usage](https://davidban77.github.io/gns3fy/user-guide/#check-server-cpu-and-memory-usage) before turning up resource-hungry nodes\n- [Manipulate project snapshots](https://davidban77.github.io/gns3fy/user-guide/#create-and-list-project-snapshots) like create, delete or list the snapshots configured for the project.\n\n## Install\n\n```shell\npip install gns3fy\n```\n\n### Development version\n\nUse [uv](https://github.com/astral-sh/uv) to install the package when cloning it.\n\n## How it works\n\nYou can start the library and use the `Gns3Connector` object and the `Project` object.\n\nFor example:\n\n```python\n\u003e\u003e\u003e import gns3fy\n\u003e\u003e\u003e from tabulate import tabulate\n\n# Define the server object to establish the connection\n\u003e\u003e\u003e gns3_server = gns3fy.Gns3Connector(\"http://\u003cserver address\u003e:3080\")\n\n# Show the available projects on the server\n\u003e\u003e\u003e print(\n        tabulate(\n            gns3_server.projects_summary(is_print=False),\n            headers=[\"Project Name\", \"Project ID\", \"Total Nodes\", \"Total Links\", \"Status\"],\n        )\n    )\n\"\"\"\nProject Name    Project ID                              Total Nodes    Total Links  Status\n--------------  ------------------------------------  -------------  -------------  --------\ntest2           c9dc56bf-37b9-453b-8f95-2845ce8908e3             10              9  opened\nAPI_TEST        4b21dfb3-675a-4efa-8613-2f7fb32e76fe              6              4  opened\nmpls-bgpv2      f5de5917-0ac5-4850-82b1-1d7e3c777fa1             30             40  closed\n\"\"\"\n\n# Define the lab you want to load and assign the server connector\n\u003e\u003e\u003e lab = gns3fy.Project(name=\"API_TEST\", connector=gns3_server)\n\n# Retrieve its information and display\n\u003e\u003e\u003e lab.get()\n\u003e\u003e\u003e print(lab)\n\"Project(project_id='4b21dfb3-675a-4efa-8613-2f7fb32e76fe', name='API_TEST', status='opened', ...)\"\n\n# Access the project attributes\n\u003e\u003e\u003e print(f\"Name: {lab.name} -- Status: {lab.status} -- Is auto_closed?: {lab.auto_close}\")\n\"Name: API_TEST -- Status: closed -- Is auto_closed?: False\"\n\n# Open the project\n\u003e\u003e\u003e lab.open()\n\u003e\u003e\u003e lab.status\nopened\n\n# Verify the stats\n\u003e\u003e\u003e lab.stats\n{'drawings': 0, 'links': 4, 'nodes': 6, 'snapshots': 0}\n\n# List the names and status of all the nodes in the project\n\u003e\u003e\u003e for node in lab.nodes:\n...    print(f\"Node: {node.name} -- Node Type: {node.node_type} -- Status: {node.status}\")\n\n\"Node: Ethernetswitch-1 -- Node Type: ethernet_switch -- Status: started\"\n...\n```\n\nTake a look at the API documentation for complete information about the attributes retrieved.\n\n### Usage of Node and Link objects\n\nYou have access to the `Node` and `Link` objects as well, this gives you the ability to start, stop, suspend the individual element in a GNS3 project.\n\n```python\n\u003e\u003e\u003e from gns3fy import Node, Link, Gns3Connector\n\n\u003e\u003e\u003e PROJECT_ID = \"\u003csome project id\u003e\"\n\u003e\u003e\u003e server = Gns3Connector(\"http://\u003cserver address\u003e:3080\")\n\n\u003e\u003e\u003e alpine1 = Node(project_id=PROJECT_ID, name=\"alpine-1\", connector=server)\n\n\u003e\u003e\u003e alpine1.get()\n\u003e\u003e\u003e print(alpine1)\n\"Node(name='alpine-1', node_type='docker', node_directory= ...)\"\n\n# And you can access the attributes the same way as the project\n\u003e\u003e\u003e print(f\"Name: {alpine1.name} -- Status: {alpine1.status} -- Console: {alpine1.console}\")\n\"Name: alpine-1 -- Status: started -- Console: 5005\"\n\n# Stop the node and start (you can just restart it as well)\n\u003e\u003e\u003e alpine1.stop()\n\u003e\u003e\u003e alpine1.status\nstopped\n\n\u003e\u003e\u003e alpine1.start()\n\u003e\u003e\u003e alpine1.status\nstarted\n\n# You can also see the Link objects assigned to this node\n\u003e\u003e\u003e alpine1.links\n[Link(link_id='4d9f1235-7fd1-466b-ad26-0b4b08beb778', link_type='ethernet', ...)]\n\n# And in the same way you can interact with a Link object\n\u003e\u003e\u003e link1 = alpine1.links[0]\n\u003e\u003e\u003e print(f\"Link Type: {link1.link_type} -- Capturing?: {link1.capturing} -- Endpoints: {link1.nodes}\")\n\"Link Type: ethernet -- Capturing?: False -- Endpoints: [{'adapter_number': 2, ...}]\"\n```\n\n### Useful functions\n\nYou also have some commodity methods like the `nodes_summary` and `links_summary`, that if used with a library like `tabulate` you can see the following:\n\n```python\n\n\u003e\u003e\u003e from tabulate import tabulate\n\n\u003e\u003e\u003e nodes_summary = lab.nodes_summary(is_print=False)\n\n\u003e\u003e\u003e print(\n...     tabulate(nodes_summary, headers=[\"Node\", \"Status\", \"Console Port\", \"ID\"])\n... )\n\"\"\"\nNode              Status      Console Port  ID\n----------------  --------  --------------  ------------------------------------\nEthernetswitch-1  started             5000  da28e1c0-9465-4f7c-b42c-49b2f4e1c64d\nIOU1              started             5001  de23a89a-aa1f-446a-a950-31d4bf98653c\nIOU2              started             5002  0d10d697-ef8d-40af-a4f3-fafe71f5458b\nvEOS-4.21.5F-1    started             5003  8283b923-df0e-4bc1-8199-be6fea40f500\nalpine-1          started             5005  ef503c45-e998-499d-88fc-2765614b313e\nCloud-1           started                   cde85a31-c97f-4551-9596-a3ed12c08498\n\"\"\"\n\u003e\u003e\u003e links_summary = lab.links_summary(is_print=False)\n\u003e\u003e\u003e print(\n...     tabulate(links_summary, headers=[\"Node A\", \"Port A\", \"Node B\", \"Port B\"])\n... )\n\"\"\"\nNode A          Port A       Node B            Port B\n--------------  -----------  ----------------  -----------\nIOU1            Ethernet1/0  IOU2              Ethernet1/0\nvEOS-4.21.5F-1  Management1  Ethernetswitch-1  Ethernet0\nvEOS-4.21.5F-1  Ethernet1    alpine-1          eth0\nCloud-1         eth1         Ethernetswitch-1  Ethernet7\n\"\"\"\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidban77%2Fgns3fy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavidban77%2Fgns3fy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidban77%2Fgns3fy/lists"}