Registry / http-networking / virl2-client

virl2-client

JSON →
library2.10.0pypypi✓ verified 84d ago

The official Cisco VIRL2 / Cisco Modeling Labs (CML) client library for Python. Provides programmatic access to CML 2.x instances, supporting lab lifecycle management, node configuration, and system administration. Current version 2.9.1 (released 2025-01-06). Release cadence follows CML versions approximately twice a year.

pip install virl2-client
INSTALL
IMPORT
SIG · VIRL2-CLIENT
V
virl2-client
http-networkingpythonv2.10.0
Install
2.2s avg
Import
—
Disk
21MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.9–3.13
musl
3.9–3.13
Install & Compatibility
Where this runs
tested against v2.10.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.000s · 22.6MB
glibc
py 3.10–3.95 runs
installs and imports cleanly · install 2.2s · import 0.000s · 23MB
21MB installed
● package 21MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

ClientLibrary
✓ from virl2_client import ClientLibrary
✗ from virl2_client import CMLClient
ClientConfig
✓ from virl2_client import ClientConfig
InitializationError
✓ from virl2_client import InitializationError

Connects to a CML controller and prints server version and number of labs.

from virl2_client import CMLClient url = os.environ.get('CML_URL', 'https://cml-controller.example.com') username = os.environ.get('CML_USER', 'admin') password = os.environ.get('CML_PASS', '') client = CMLClient(url, username, password, ssl_verify=False) print(f"Connected to CML version {client.info.version}") print(f"Labs on server: {len(client.labs)}")
virl2 --version
Debug
Known issues
breakingFrom v2.7.0, the offline/local lab functionality is deprecated and will be removed in a future release. Do not rely on it for new projects.
fix
Use only controller-managed labs. If you need offline functionality, consider exporting/importing lab files manually.
affects: >=2.7.0
gotchaSSL verification defaults to True. If your CML controller uses a self-signed certificate, you must pass ssl_verify=False or provide a CA bundle.
fix
client = CMLClient(url, username, password, ssl_verify=False)
affects: all
Upgrade
Version history
2.10.0latest on PyPI · released May 15, 2026
Audit
Dependencies

No dependency data recorded yet.

Agent activity
17 hits · last 30 days
node
14
OpenAI (training)
1
Resources
virl2-client — pip install virl2-client · libregistry