VIRL ² API Client Documentation

This is the VIRL ² client library (virl2_client). It provides a Python package to programmatically create, edit, delete and control network simulations on a VIRL ² controller.

Content

• Introduction
  • Use Case Description
  • Installation
  • Usage
  • Compatibility
  • Known Issues
  • Getting Help
  • Getting Involved
  • Licensing Info
  • References
• Examples
  • Creating a lab with nodes and links
  • Stopping all the labs
  • Getting all lab names
  • Stopping all labs of a User
  • Uploading an image disk file
  • Using the Client Library with Netmiko
  • Licensing the System
  • Using Link Conditioning
• virl2_client package
  • Subpackages
  • Submodules
  • virl2_client.exceptions
  • virl2_client.utils
  • virl2_client.virl2_client
• virl2_client.models package
  • Submodules
  • virl2_client.models.authentication
  • virl2_client.models.cl_pyats
  • virl2_client.models.interface
  • virl2_client.models.lab
  • virl2_client.models.licensing
  • virl2_client.models.link
  • virl2_client.models.node
  • virl2_client.models.node_image_definitions

Download

Download the client library (Linux/Win/macOS)

Note that the above link only works when the documentation is viewed on the VIRL ² controller.

Indices and tables

• Index

• Module Index

• Search Page