v2.10.0

What's Changed

• Add support for a starting index when connecting nodes (#126)

• Add params to connection function (#134)

• SIMPLE-7407 - Diagnostics in client (#138)

• SIMPLE-7496 - Deprecate get_diagnostics with no args (#139)

• SIMPLE-7569 - API changes for RBAC (#141)

• SIMPLE-7461 - Consolidate exceptions (#144)

• SIMPLE-7622 - Fix GET NodeDefinition API call (#145)

• SIMPLE-7433 - Show all running nodes in compute hosts sysadmin (#146)

• SIMPLE-7745 - Allow .tar.gz image file extension (#147)

• SIMPLE-7783 - Use test_data_dir fixture, allow Path for image upload (#148)

• SIMPLE-7758 - Add client type identifier (#149)

• SIMPLE-6967 - Add pubkey for user create/update and testbed key_path setting (#151)

• SIMPLE-7993 - Deprecate original module names (#156)

• SIMPLE-7926 - Fix PCL operational data storage (#157)

• SIMPLE-8002 - Exclude unneeded files (#161)

• SIMPLE-8052 - Fix None fields (#162)

• SIMPLE-7778 - Update Poetry to version 2 (#163)

• SIMPLE-8078 - PCL support for lab repositories (#165)

• Fix PCL node configuration confusion with Main and default (#166)

• CMLDEV-377 - Support for clearing discovered addresses (#167)

• Make client version check optional, rearrange attribute setting in init (#169)

• CMLDEV-95 - Remove deprecated structures (#170)

• CMLDEV-531 - Implement lab_autostart support (#172)

• CMLDEV-537 - Implement node-staging feature (#173)

• CMLDEV-587 - Extend link conditioning parameters (#174)

• CMLDEV-617 - Drop support for Python 3.9 (#175)

• CMLDEV-376 - Fix pyATS relogin after node stop and start (#176)

• CMLDEV-12 - Add serial console switching for pyATS connections (#177)

• CMLDEV-655 - Refactor opt-in to enum (#178)

• CMLDEV-23 - Clean pyATS loggers (#179)

• CMLDEV-727 - JWT authentication (#182)

• CMLDEV-702 - Fix pyATS console switching (#184)

• CMLDEV-575 - PCAP support (#186)

• CMLDEV-786 - Switch to using link ID as capture key (#188)

• CMLDEV-727 - Revert old authentication for previous CML releases (#189)

• CMLDEV-428 - Make pyATS configurable per node image definition (#190)

• Move deprecation warning for configuration via input (#191)

• CMLDEV-689 - Implement RADIUS auth (#192)

• CMLDEV-910 - Raise APIError when JWT is incorrect and credentials not provided (#194)

• Fix bugs and apply improvements across client library (#197)

• Store users locally to improve performance when querying labs/nodes (#199)

• CMLDEV-1026 - Ignore removed nodes attribute from compute host response in previous CML releases (#206)

• CMLDEV-940 - Do not log SSL/TLS warnings when explicitly HTTP is requested (#207)

• CMLDEV-1026 - Add backward compatibility guards and tests for virl2_client 2.10 (#208)

• CMLDEV-923 - Ruff lint fixes (#209)

• CMLDEV-941 - Rename id parameters, fix LabRepository ownership, and protect object IDs (#210)

v2.9.1

What's Changed

• SIMPLE-7926-pcl-does-not-store-some-node-and-interface-operational-data (#157)

• SIMPLE-7927-pcl-system-management-controller-property-does-not-trigger-compute-load

• PCL node configuration confusion with Main and default (#166)

v2.9.0

What's Changed

• SIMPLE-7993 deprecated module names (#156)

• SIMPLE-7758 added client type identifier (#149)

• SIMPLE-6967 - add pubkey for user create and update, add testbed key_… (#151)

• SIMPLE-7783 Use test_data_dir fixture, allow Path for image upload (#148)

• SIMPLE-7745 - allow .tar.gz image file extension (#147)

• SIMPLE-7433 show all running nodes in compute hosts sysadmin (#146)

• SIMPLE-7461-consolidate-exceptions-in-virl2-client (#144)

• SIMPLE-7622 Fixed GET NodeDefinion API call (#145)

• SIMPLE-7569 API changes for RBAC (#141)

• SIMPLE-7496 Deprecated get_diagnostics with no args (#139)

• SIMPLE-7407 diagnostics in client (#138)

• Add params to connection function - fixed #134 (#135)

• Add support for a starting index when connecting nodes. (#126)

v2.8.0

What's Changed

• SIMPLE-7063 Added group_display_attribute and refactored test_auth (#122)

  Do not fail if importing topologies for previous CML versions

• Removed unexpected behavior of import lab method (#120)

  When a lab with a specific title existed on a CML instance,
  we joined that lab instead of creating a new lab with the same
  title which would had been perfectly fine. I believe that this
  was some obsolete feature request from pre-CML 2.0 era where labs
  possibly were enforced to have unique titles.

• SIMPLE-6969 Changed PUT to PATCH for /system/auth/config

• SIMPLE-6964 Dropped smart annotation tag and font properties (#119)

• SIMPLE-6883 Support for smart annotations (#118)

• SIMPLE-6813 Added deployed_mac_address property to Interface (#116)

• SIMPLE-6776 local groups should still work with unset group filter (#115)

• SIMPLE-6827 - removed MAC address block support (#114)

• Dropped support for python3.8 in github actions

• SIMPLE-6834 integration tests for ldap groups (#113)

• Added the virlutils option to disable SSL check via ENV (#111)

• SIMPLE-6706 fixed the 'owner' attribute of a joined lab (#108)

• SIMPLE-6764 ldap group tests and system auth test (#110)

• SIMPLE-6615 custom mac addresses implementation (#106)

• SIMPLE-6397 Added support for 2.8, updated obsolete controller versions (#102)

• SIMPLE-6345 refactored API error handling for better tracebacks (#98)

• SIMPLE-6506 removed/deprecated offline mode leftovers (#97)

• SIMPLE-6429 fix potentially mishandled data structures (#94)

• SIMPLE-6384 Added rotation attribute to ellipse and rectangle annotations (#96)

• Re-added api/* to the doc source tree removed by mistake

• SIMPLE-6410 SQ issues is PCL (#90)

Full Changelog: v2.7.1...v2.8.0

v2.7.1

Release 2.7.1

This is the VIRL (CML) Client Library for the CML release 2.7.1. It is functionally equivalent to the bundled version.

What's Changed

• Re-added api/* to the doc source tree removed by mistake
• Deprecated offline/local labs
• Fixed various problems in user and group modules
• Added missing properties into user methods
• Updated various libraries to non-vulnerable version

Full Changelog: v2.7.0...v2.7.1

v2.7.0

Release 2.7.0

This is the VIRL (CML) Client Library for the CML release 2.7.0. It is functionally equivalent to the bundled version.

What's Changed

• SIMPLE-5780 replace change test dir fixture (#54)
• SIMPLE-5377 PCL general improvements (#59)
• SIMPLE-5953 pcl update for smbios parameters (#61)
• SIMPLE-5974 Support for locked_compute_id (#64)
• SIMPLE-5806 PCL support for multiple config files (#60)
• SIMPLE-5806 fix for a missed bug (#65)
• SIMPLE-5949 Deprecated licensing certificate support in PCL (#66)
• updated pyproject.toml and poetry.lock; versions: poetry-1.4, lock for… (#68)
• SIMPLE-6084 Fixed regressions in create_node method to preserve compatibility with older CML releases
• SIMPLE-6020 sped up syncing operational by removing unneeded API calls (#72)
• SIMPLE-5747 added .iol files to list of accepted image files (#71)
• SIMPLE-5829 Backported fix for missing image extension
• SIMPLE-6087 creating a lab no longer raises a warning (#74)
• SIMPLE-6105 node.remove no longer always raises NodeNotFound (#75)
• SIMPLE-6073: Avoid using unneeded pyats features when parsing our generated testbed file, which uses none of them. Refactor checking whether pyats is installed. (#76)
• SIMPLE-6168 Added missing copyright info, fixed invalid copyright year
• SIMPLE-6204 rename locked compute to pinned (#79)
• SIMPLE-6093 Implemented controller property (#82)
• SIMPLE-6285 Improvements to multiple node configuration API (#83)
• SIMPLE-6124 Annotations support (#85)
• SIMPLE-6428 Fixed annotation update on lab sync (#89)

Full Changelog: v2.6.1...v2.7.0

Release 2.6.1

Release 2.6.1

This is the VIRL (CML) Client Library for the CML release 2.6.1. It is functionally equivalent to the bundled version.

What's Changed

• Fixed 'upload_image_file' method that stripped the extension of an uploaded file.
• Fixed various security vulnerabilities.

Release 2.6.0

Release 2.6.0

This is the VIRL (CML) Client Library for the CML release 2.6.0. It is functionally equivalent to the bundled version.

What's Changed

• added support for the new maintenance mode and notice features
• added support for LDAP feature
• added support for setting link conditioning
• added support for changing read-only state of node definitions
• added initial websocket support
• added support for staleness check before executing any operation
• added support for deleting variables (by sending None) in some methods (mostly for user and group features)
• added some additional configuration options (similarly to virlutils module)
• deprecated json argument in node_image_definitions.py

Full Changelog: v2.5.0...v2.6.0

v2.5.0

Release 2.5.0

This is the VIRL (CML) Client Library for the CML release 2.5.0. It is functionally equivalent to the bundled version. Note that the wheel on the server itself and the wheel here are not identical as they are using a different build process. Eventually, we want to have the Github version built ban automated workflow to be the "reference". We'll get there...

Going forward, we want to push changes to a development branch on Github and deprecate the internal-only BB repository. This will get rid of syncing and also will make the commit history consistent.

What's Changed

• this is a sync of the internal changes since 2.4.1 from BitBucket. At a high level
  • moved away from requests to httpx
  • added support for the new resource limiting feature
• 2.5.0 changes from BB by @tmikuska in #25

New Contributors

• @tmikuska made their first contribution in #25

Full Changelog: v2.4.0...v2.5.0

Release 2.4.1

This is the VIRL (CML) Client Library for the CML release 2.4.1. It is functionally equivalent to the bundled version.

What's Changed

• Missing changes from Bitbucket by @rschmied in #11

• SIMPLE-4483 replaced Lab.sync(with_node_configuration) argument with exclude_configurations

• SIMPLE-4496 deprecated multiple Interface methods in favor of better ones
  In Interface:

  • functions that return/expect multiple links replaced with singular versions, originals deprecated
  • deprecated .is_connected() and replaced with .connected
  • deprecated .is_physical and replaced with .physical

• SIMPLE-4389 replaced Lab.get_link_by_interfaces/nodes with Interface/Node.get_link(s)_to, Interface deprecations

  • Deprecated Lab.get_link_by_nodes/interfaces, used IDs instead of objects like the name would suggest
  • Added Node.get_links_to and .get_link_to, these replace get_link_by_nodes
  • Added Lab.get_interface_by_id

  Deprecations in Interface:

  • .links(), was pointlessly looking for multiple links despite one interface only being connected to one link
  • .degree, always 1 or 0, should be bool
  • .is_connected(), was a method instead of a parameter
  • .is_physical, for consistency with is_connected()

  Additions in Interface:

  • .link, replaces .links()
  • .connected, replaces .is_connected() and .degree
  • .physical, replaces .is_physical, to be consistent with .connected
  • .get_link_to(), replaces .get_link_by_interfaces

  Other changes:

  • reordered interface functions
  • first docstring letters capitalized for consistency
  • other minor docstring / syntax fixes

• SIMPLE-4313: update examples in client library docs, remove redundant typing

• SIMPLE-4463: PCL support for node compute ID

Note
For the future, we're moving the development of the PCL to Github, thus eliminating issues with commits and tags by maintaining different remotes / repositories. This should make everything a tad bit smoother.

Full Changelog: v2.4.0...v2.4.1