{"id":20588626,"url":"https://github.com/ciscodevnet/virl2-client","last_synced_at":"2025-04-13T05:07:56.981Z","repository":{"id":43164983,"uuid":"243301762","full_name":"CiscoDevNet/virl2-client","owner":"CiscoDevNet","description":"Client library for the Cisco VIRL 2 Network Simulation Platform","archived":false,"fork":false,"pushed_at":"2025-04-03T13:03:44.000Z","size":1258,"stargazers_count":59,"open_issues_count":2,"forks_count":20,"subscribers_count":20,"default_branch":"main","last_synced_at":"2025-04-13T05:07:45.745Z","etag":null,"topics":["automation","network-simulation","networking","simulation"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CiscoDevNet.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2020-02-26T15:50:56.000Z","updated_at":"2025-04-04T03:03:33.000Z","dependencies_parsed_at":"2024-04-17T12:45:14.123Z","dependency_job_id":"a61b857c-2d16-4eec-8903-525059f7243b","html_url":"https://github.com/CiscoDevNet/virl2-client","commit_stats":{"total_commits":39,"total_committers":7,"mean_commits":5.571428571428571,"dds":0.5384615384615384,"last_synced_commit":"af60c0b53345937d92402a8c114f9ceca7377a94"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fvirl2-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fvirl2-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fvirl2-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fvirl2-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CiscoDevNet","download_url":"https://codeload.github.com/CiscoDevNet/virl2-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248665747,"owners_count":21142123,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["automation","network-simulation","networking","simulation"],"created_at":"2024-11-16T07:25:36.353Z","updated_at":"2025-04-13T05:07:56.955Z","avatar_url":"https://github.com/CiscoDevNet.png","language":"Python","readme":"[![CI](https://github.com/CiscoDevNet/virl2-client/actions/workflows/main.yml/badge.svg)](https://github.com/CiscoDevNet/virl2-client/actions/workflows/main.yml)\n\n# VIRL 2 Client Library\n\n\u003e **Note:** The product has been renamed from *VIRL* to *Cisco Modeling Labs* /\n\u003e CML 2.  References to VIRL still exist in the product documentation and within\n\u003e code or examples.\n\u003e\n\u003e The name of the package itself has not been changed.  Throughout the\n\u003e documentation it is referred to as \"virl2_client\",  \"Python Client Library\" or\n\u003e \"PCL\".\n\n## Introduction\n\nThis is the client library for the *Cisco Modeling Labs* Platform\n(`virl2_client`). It provides a Python package to programmatically create,\nedit, delete and control network simulations on a CML 2 controller.\n\nIt is a pure Python implementation that requires Python 3. We've tested and\nwritten the package with Python 3.8.10.\n\nThe status of the package can be considered **stable**.  Issues with the\nsoftware should be raised via the [GitHub issue\ntracker](https://github.com/CiscoDevNet/virl2-client/issues).\n\n## Use Case Description\n\nThe client library provides a convenient interface to control the life-cycle of\na network simulation. This can be used for automation scripts directly in\nPython but also for third party integrations / plugins which need to integrate\nwith a simulated network. Examples already existing are an [Ansible\nplugin](https://github.com/CiscoDevNet/ansible-virl).\n\n## Installation\n\nThe package comes in form of a wheel that is downloadable from the CML\n2 controller. The package can be installed either from PyPI using\n\n    pip3 install virl2_client\n\nIf you want to interact with devices via the client library, you need to\nalso install the pyATS library. This can be achieved in one go using\n\n```\npip3 install \"virl2_client[pyats]\"\n```\n\nNote that this does *not* pull in the full pyATS package... See below how that is achieved.\n\nor, alternatively, the version that is bundled with the CML 2 controller can\nbe downloaded to the local filesystem and then directly installed via\n\n    pip3 install ./virl2_client-*.whl\n\nThe bundled version is available on the index site of the docs when viewed\ndirectly on the CML 2 controller.\n\nEnsure to replace and/or use the correct file name, replacing the wildcard with the\nproper version/build information. For example\n\n    pip3 install virl2_client-2.0.0b10-py3-none-any.whl\n\nWe recommend the use of a virtual environment for installation.\n\nIf you require the full version of the pyATS library including things like Genie\nthen you need to do this in a subsequent step like shown here:\n\n    pip3 install \"pyats[full]\"\n\n\u003e **IMPORTANT**: The version of the Python client library  must be compatible\n\u003e with the version of the controller.  If you are running an older controller\n\u003e version then it's likely that the latest client library version from PyPI can\n\u003e **not** be used.  In this case, you need to either use the version available\n\u003e from the controller itself or by specifying a version constraint.\n\u003e\n\u003e Example: When on a controller version 2.2.x, then you'd need to install with\n\u003e `pip3 install \"virl2-client\u003c2.3.0\"`. This will ensure that the version\n\u003e installed is compatible with 2.2.x.\n\n## Usage\n\nThe package itself is fairly well documented using *docstrings*. In addition, the\ndocumentation is available in HTML format on the controller itself, via the\n\"Tools -\u003e Client Library\" menu.\n\n## Compatibility\n\nThis package and the used API is specific to CML 2. It is not\nbackwards compatible with VIRL 1.x and therefore can not be used with VIRL\n1.x. If you are looking for a convenient tool to interface with the VIRL 1 API\nthen the [CML Utils tool](https://github.com/CiscoDevNet/virlutils) is\nrecommended.\n\n## Known Issues\n\nThere are no major known issues at this point. See the comment in the *Introduction*\nsection.  Also, see the *Issues* section in GitHub to learn about known issues or raise new ones, if needed.  Also see [CHANGES](CHANGES.md).\n\n## Getting Help\n\nIf you have questions, concerns, bug reports, etc., please create an issue\nagainst the [repository on\nGitHub](https://github.com/CiscoDevNet/virl2-client/)\n\n## Getting Involved\n\nWe welcome contributions. Whether you fixed a bug, added a new feature or\ncorrected a typo, all contributions are welcome. General instructions on how to\ncontribute can be found in the [CONTRIBUTING](CONTRIBUTING.md) file.\n\n## Licensing Info\n\nThis code is licensed under the Apache 2.0 License. See [LICENSE](LICENSE) for\ndetails.\n\n## References\n\nThis package is part of the CML 2 Network Simulation platform. For details, go\nto \u003chttps://developer.cisco.com/modeling-labs\u003e. Additional documentation for the\nproduct is available at \u003chttps://developer.cisco.com/docs/modeling-labs\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fciscodevnet%2Fvirl2-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fciscodevnet%2Fvirl2-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fciscodevnet%2Fvirl2-client/lists"}