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. 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...

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

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. 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

• 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

Release 2.4.0

This is the VIRL (CML) Client Library for the CML release 2.4.0. It is functionally equivalent to the bundled version, there are a few minor changes to accommodate the GitHub CI.

What's changed

• update all the dependencies as of June 2022
• removal of the integration tests as they can't be used on GitHub anyway
• changes to licensing SSMS URLs
• when connecting to nodes in a topology with PyATS to e.g. retrieve the configuration the extraction would fail if the expected hostname is different from the actual hostname. This is fixed
• changes to adapt to the changes of the 2.4 API

Known issues

• get_link_by_nodes and get_link_by_interfaces are broken -- will be addressed in a subsequent release

Note
Due to changes on the controller (everything is now kept in a database, IDs are all UUIDs created at database insertion time), elements can not be created locally anymore. E.g. offline operation of the client library has been deprecated.

Release 2.3.0

This is the VIRL (CML) Client Library for the CML release 2.3.0. It is functionally equivalent to the bundled version, there are a few minor changes to accommodate the GitHub CI.

2.2.1 post 2 release

This is a minor release with only a few fixes/changes. No API has changed and it is functionally equivalent to the 2.2.1 release.

What's Changed

• Show progress bar when uploading image by @exjobo in #15
• Small changes to the Makefiles to allow building the Sphinx docs and better cleanup
• Updated Python dependencies to get rid of dependency security vulnerability with urllib

New Contributors

• @exjobo made their first contribution in #15

Full Changelog: v2.2.1-update1...v2.2.1-post2

2.2.1-update1 Release

"Final" is too much of a word -- it's absolute. Especially when you realize that final in this case wasn't really final. Due to the nature of a "split brain", where we have the client as part of a private repository and this repository, things did not work out as planned and a few files and updates have missed the boat ride from "private" to "public".

While at it, we added some GitHub workflow to run the included (and now working) tests when doing PRs and merges to master. In more detail:

• added missing dependency requests_toolbelt which solved #10
• added test configuration files to allow running the non-integration tests
• while at it, also added GitHub workflow configuration to run those tests for the supported Python versions 3.5 - 3.9.

This should now be complete and consistent. And the next release will be a regular one :-)

Final 2.2.1 Release

• added logout method to log-out / de-authorize the current session
• added GroupManagement, UserManagement and SystemManagement classes
• added set_product_license method to the licensing class
• fixed various typos