VIRL ² API Client

Subpackages

• VIRL ² Modules and Models
  • Authentication Module
    • Context
      • Context.__init__()
      • Context.base_url
      • Context.session
      • Context.uuid
    • TokenAuth
      • TokenAuth.__init__()
      • TokenAuth.authenticate()
      • TokenAuth.handle_401_unauthorized()
      • TokenAuth.logout()
  • pyATS Module
    • PyatsDeviceNotFound
    • PyatsNotInstalled
    • ClPyats
      • ClPyats.__init__()
      • ClPyats.cleanup()
      • ClPyats.run_command()
      • ClPyats.run_config_command()
      • ClPyats.sync_testbed()
  • Interface Model
    • Interface
      • Interface.__init__()
      • Interface.as_dict()
      • Interface.bring_up()
      • Interface.degree()
      • Interface.is_connected()
      • Interface.links()
      • Interface.peer_interfaces()
      • Interface.peer_nodes()
      • Interface.remove_on_server()
      • Interface.shutdown()
      • Interface.discovered_ipv4
      • Interface.discovered_ipv6
      • Interface.discovered_mac_address
      • Interface.is_physical
      • Interface.lab_base_url
      • Interface.readbytes
      • Interface.readpackets
      • Interface.state
      • Interface.writebytes
      • Interface.writepackets
  • Lab Model
    • Lab
      • Lab.__init__()
      • Lab.add_node_local()
      • Lab.build_configurations()
      • Lab.cleanup_pyats_connections()
      • Lab.connect_two_nodes()
      • Lab.create_interface()
      • Lab.create_interface_local()
      • Lab.create_link()
      • Lab.create_link_local()
      • Lab.create_node()
      • Lab.details()
      • Lab.download()
      • Lab.find_nodes_by_tag()
      • Lab.get_link_by_interfaces()
      • Lab.get_link_by_nodes()
      • Lab.get_node_by_id()
      • Lab.get_node_by_label()
      • Lab.get_pyats_testbed()
      • Lab.has_converged()
      • Lab.import_lab()
      • Lab.interfaces()
      • Lab.is_active()
      • Lab.links()
      • Lab.need_to_wait()
      • Lab.nodes()
      • Lab.remove()
      • Lab.remove_interface()
      • Lab.remove_link()
      • Lab.remove_node()
      • Lab.remove_nodes()
      • Lab.start()
      • Lab.state()
      • Lab.stop()
      • Lab.sync()
      • Lab.sync_events()
      • Lab.sync_l3_addresses_if_outdated()
      • Lab.sync_layer3_addresses()
      • Lab.sync_pyats()
      • Lab.sync_states()
      • Lab.sync_states_if_outdated()
      • Lab.sync_statistics()
      • Lab.sync_statistics_if_outdated()
      • Lab.sync_topology_if_outdated()
      • Lab.update_lab()
      • Lab.update_lab_groups()
      • Lab.wait_until_lab_converged()
      • Lab.wipe()
      • Lab.client_uuid
      • Lab.description
      • Lab.groups
      • Lab.id
      • Lab.lab_base_url
      • Lab.notes
      • Lab.owner
      • Lab.session
      • Lab.statistics
      • Lab.title
  • Link Model
    • Link
      • Link.__init__()
      • Link.as_dict()
      • Link.get_condition()
      • Link.has_converged()
      • Link.remove_condition()
      • Link.remove_on_server()
      • Link.set_condition()
      • Link.set_condition_by_name()
      • Link.start()
      • Link.stop()
      • Link.wait_until_converged()
      • Link.base_url
      • Link.interfaces
      • Link.lab_base_url
      • Link.node_a
      • Link.node_b
      • Link.nodes
      • Link.readbytes
      • Link.readpackets
      • Link.state
      • Link.writebytes
      • Link.writepackets
  • Node Model
    • Node
      • Node.__init__()
      • Node.add_tag()
      • Node.console_key()
      • Node.console_logs()
      • Node.create_interface()
      • Node.degree()
      • Node.extract_configuration()
      • Node.get_interface_by_label()
      • Node.get_interface_by_slot()
      • Node.has_converged()
      • Node.interfaces()
      • Node.is_active()
      • Node.is_booted()
      • Node.links()
      • Node.map_l3_addresses_to_interfaces()
      • Node.next_available_interface()
      • Node.peer_interfaces()
      • Node.peer_nodes()
      • Node.physical_interfaces()
      • Node.remove_on_server()
      • Node.remove_tag()
      • Node.run_pyats_command()
      • Node.run_pyats_config_command()
      • Node.start()
      • Node.stop()
      • Node.sync_layer3_addresses()
      • Node.tags()
      • Node.update()
      • Node.vnc_key()
      • Node.wait_until_converged()
      • Node.wipe()
      • Node.boot_disk_size
      • Node.config
      • Node.cpu_limit
      • Node.cpu_usage
      • Node.cpus
      • Node.data_volume
      • Node.disk_read
      • Node.disk_write
      • Node.image_definition
      • Node.lab_base_url
      • Node.label
      • Node.node_definition
      • Node.ram
      • Node.state
      • Node.x
      • Node.y
    • flatten()
  • Node and Image Definitions Model

Exceptions

exception virl2_client.exceptions.InterfaceNotFound

Bases: Exception

exception virl2_client.exceptions.LabNotFound

Bases: Exception

exception virl2_client.exceptions.LinkNotFound

Bases: Exception

exception virl2_client.exceptions.NodeNotFound

Bases: Exception

Utils

ClientLibrary