final commit for version increment to 0.15.0

Author: zachcamara-hpe

_version.py

@@ -1 +1 @@
-version = "0.14.0a2.dev1"
+version = "0.15.0a2.dev0"

docs/source/conf.py

@@ -10,13 +10,13 @@
 # -- Project information -----------------------------------------------------
 
 project = "pyedgeconnect"
-copyright = "2021 Hewlett Packard Enterprise Development LP"
+copyright = "2022 Hewlett Packard Enterprise Development LP"
 author = "Zach Camara"
 
 # Main version number
-version = "0.14"
+version = "0.15"
 # The full version, including alpha/beta/rc tags
-release = "0.14.0-a2"
+release = "0.15.0-a1"
 
 
 # -- General configuration ---------------------------------------------------

docs/source/release-notes/0.15.0-a1.rst

@@ -1,14 +1,80 @@
-0.15.0-a1 -- 2022-01-18
+0.15.0-a1 -- 2022-03-26
 -----------------------
 
+💥 Breaking Changes
+~~~~~~~~~~~~~~~~~~~~
+
+The first parameter for multiple Preconfig functions has been renamed to
+``preconfig_name`` to better represent that the name of the preconfnig does
+not need to be the hostname of the appliance it will be applied to. Existing
+code that does not use keyword arguments will be unaffected. For those
+explicitly assigning ``hostname=`` will need to update to ``preconfig_name=``
+
+The validate function no longer requires the ``auto_apply`` paramter as
+it now defaults to ``False``. The parameter has no effect on the validation
+call.
+
+.. code:: python
+
+    # OLD syntax
+    validate = orch.validate_preconfig(
+        hostname="edgeconnect-preconfig-01",
+        yaml_preconfig=yaml_preconfig,
+        auto_apply=auto_apply,
+    )
+
+    orch.create_preconfig(
+        hostname="edgeconnect-preconfig-01",
+        yaml_preconfig=yaml_preconfig,
+        auto_apply=auto_apply,
+        tag="tag value",
+        comment="New preconfig for appliance"
+        )
+
+    # NEW syntax
+    validate = orch.validate_preconfig(
+        preconfig_name="edgeconnect-preconfig-01",
+        yaml_preconfig=yaml_preconfig,
+    )
+
+    orch.create_preconfig(
+        preconfig_name="edgeconnect-preconfig-01",
+        yaml_preconfig=yaml_preconfig,
+        auto_apply=auto_apply,
+        tag="tag value",
+        comment="New preconfig for appliance"
+        )
+
+    # CODE REQUIRING NO CHANGE syntax
+    validate = orch.validate_preconfig(
+        "edgeconnect-preconfig-01",
+        yaml_preconfig=yaml_preconfig,
+    )
+
+    orch.create_preconfig(
+        "edgeconnect-preconfig-01",
+        yaml_preconfig=yaml_preconfig,
+        auto_apply=auto_apply,
+        tag="tag value",
+        comment="New preconfig for appliance"
+        )
+
+Affected functions:
+
+  - :func:`~pyedgeconnect.Orchestrator.create_preconfig`
+  - :func:`~pyedgeconnect.Orchestrator.modify_preconfig`
+  - :func:`~pyedgeconnect.Orchestrator.validate_preconfig`
 
 🚀 Features
 ~~~~~~~~~~~~~
 
-531 functions
-
 Added the following Orchestrator functions from Swagger:
 
+from .orch._advanced_properties
+  - get_orchestrator_advanced_properties
+  - update_orchestrator_advanced_properties
+  - get_orchestrator_advanced_properties_metadata
+
 from .orch._app_system_deploy_info
   - get_appliance_system_deployment_info
   - get_discovered_appliance_system_deployment_info
@@ -21,6 +87,30 @@ from .orch._appliance
   - delete_denied_appliances
   - rediscover_denied_appliance
 
+from .orch._appliance_extra_info
+  - delete_appliance_extra_info
+  - get_appliance_extra_info
+  - set_appliance_extra_info
+
+from .orch._appliance_resync
+  - appliance_resync
+
+from .orch._appliance_upgrade
+  - get_ecos_images
+  - delete_ecos_image
+
+from .orch._bridge_interface_state
+  - get_appliance_bridge_interface_state
+
+from .orch._deployment
+  - get_appliance_deployment
+  - get_all_appliance_deployment
+  - get_single_appliance_deployment
+
+from .orch._gms_registration
+  - get_orchestrator_registration_setting
+  - set_orchestrator_registration_setting
+
 from .orch._link_aggregation
   - get_link_aggregation_data
 
@@ -30,19 +120,18 @@ from .orch._loopback_orch
   - get_loopback_orchestration_pool_detail
   - reclaim_delete_loopback_orchestration_ips
   - reclaim_single_deleted_loopback_orchestration_ip
-  - get_deleted_loopback_orchestration_ips *** NOT IN SWAGGER
+  - get_deleted_loopback_orchestration_ips
 
 from .orch._network_role_and_site
   - get_appliance_network_role_and_site
+  - update_appliance_network_role_and_site
 
-########
-
-
-
-
-
-
-
+from .orch._overlay_association
+  - get_all_appliance_overlay_association
+  - add_appliance_overlay_association
+  - remove_appliance_overlay_association
+  - get_appliance_overlay_association
+  - remove_single_appliance_overlay_association
 
 from .orch._rbac_appliance_access_group
   - get_all_appliance_access_groups
@@ -56,13 +145,20 @@ from .orch._releases
   - delay_release_notification
   - dismiss_release_notification
 
+from .orch._schedule_timezone
+  - get_schedule_timezone
+  - set_schedule_timezone
+
 from .orch._session
   - get_orchestrator_sessions
 
 from .orch._session_timeout
   - get_orch_session_timeout
   - set_orch_session_timeout
 
+from .orch._snmp
+  - get_appliance_snmp
+
 from .orch._ssl
   - get_appliance_ssl_certs
 
@@ -78,30 +174,40 @@ from .orch._subnets
   - get_discovered_appliance_subnets
   - set_appliance_subnet_sharing_options
 
+from .orch._upgrade_appliances
+  - validate_appliance_upgrade
+  - upgrade_appliances
+
 from .orch._user_account
   - get_appliance_user_accounts
 
 
 
-# IP Objects (Address Groups and Service Groups) introduced in Orchestrator 9.1+
+IP Objects (Address Groups and Service Groups) introduced in Orchestrator 9.1+
 
 from .orch._ip_objects
   - get_all_address_groups
   - create_address_group
   - update_address_group
   - get_address_group
   - delete_address_group
-  - bulk_upload_address_group **** NEED TO TEST ON LOCAL LAB ORCH
-  - merge_address_groups **** NEED TO TEST ON LOCAL LAB ORCH
+
+  - merge_address_groups
   - get_all_service_groups
   - create_service_group
   - update_service_group
   - get_service_group
   - delete_service_group
-  - bulk_upload_service_group **** NEED TO TEST ON LOCAL LAB ORCH
-  - merge_service_groups **** NEED TO TEST ON LOCAL LAB ORCH
+  - merge_service_groups
+
+.. warning::
+
+  The following two functions for the _ip_objects submodule exprience
+  errors at this time. These function do work in the Orchestrator UI:
+  :func:`pyedgeconnect.Orchestrator.bulk_upload_address_group` and
+  :func:`pyedgeconnect.Orchestrator.bulk_upload_service_group`
 
-# Clearpass id integration introduced in Orchestrator 9.1+
+Clearpass id integration introduced in Orchestrator 9.1+
 
 from .orch._third_party_services
   - clearpass_add_account
@@ -126,21 +232,25 @@ from .orch._third_party_services
   - central_get_site_mapping
   - central_assign_appliance_to_site
 
-# Existing Function Updates:
+Existing Function Updates:
 
- - :func:`~pyedgeconnect.Orchestrator.change_appliance_license` to
-   account for new Advance Security licensing
- - :func:`~pyedgeconnect.Orchestrator.get_zones` to account for new
-   option to filter for unique zone names vs. all zones accross segments
+- :func:`pyedgeconnect.Orchestrator._post` and
+  :func:`pyedgeconnect.Orchestrator._req_post` updated to included
+  parameter ``files`` for file upload functions
+- :func:`~pyedgeconnect.Orchestrator.change_appliance_license` to
+  account for new Advance Security licensing
+- :func:`~pyedgeconnect.Orchestrator.get_zones` to account for new
+  option to filter for unique zone names vs. all zones accross segments
 
 
 📚 Documentation
 ~~~~~~~~~~~~~~~~~~
 
 - Include PyPI download stats to README
-- Updated README with Swagger coverage %
 - Added .readthedocs.yaml configuration for hosted ReadTheDocs build
   to account for python3.9 support in the online docs.
+- ✨ **Added new code example!** -> Generate YAML preconfig from
+  Jinja template from CSV file, validate, and upload to Orchestrator
 
 🐛 Bug Fixes
 ~~~~~~~~~~~~~~
@@ -154,4 +264,17 @@ from .orch._third_party_services
 - Add query parameter delete_dependencies for
   :func:`~pyedgeconnect.Orchestrator.update_zones`, variable was defined
   but not included in POST
-
+- Fix function name (and import to init) for `_link_integrity` submodule
+  function to perform a link integrity test between appliances. New
+  function is :func:`~pyedgeconnect.Orchestrator.link_integrity_test`
+- Fix return type for
+  :func:`~pyedgeconnect.Orchestrator.get_orchestrator_hello` to text
+  instead of defaulting to JSON
+- Fix expected status for
+  :func:`~pyedgeconnect.Orchestrator.associate_template_group_to_appliance`
+  to 204 rather than default 200, would incorrectly log a successful
+  POST as an ERROR
+- Added .readthedocs.yaml configuration for hosted ReadTheDocs build
+  to account for python3.9 support in the online docs. This fixes the
+  autodoc module not building for per-function documentation in the
+  hosted docs.