Merge pull request #72 from CiscoISE/develop

Develop

CHANGELOG.md

@@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [2.2.3] - 2024-08-05
+- Update `endpoint.get_endpoints` in 3.3 patch 1 change `filterType` to `filtertype` json request 
+- Update `SupportBundleDownload` API to remove unused parameters
+- Update User-Agent header in RestSession
 - Update requirements:
   + python = "^3.8"
   + requests = "^2.32.0"
@@ -454,4 +459,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [2.2.0]: https://github.com/CiscoISE/ciscoisesdk/compare/v2.1.2...v2.2.0
 [2.2.1]: https://github.com/CiscoISE/ciscoisesdk/compare/v2.2.0...v2.2.1
 [2.2.2]: https://github.com/CiscoISE/ciscoisesdk/compare/v2.2.1...v2.2.2
-[Unreleased]: https://github.com/CiscoISE/ciscoisesdk/compare/v2.2.2...develop
+[2.2.3]: https://github.com/CiscoISE/ciscoisesdk/compare/v2.2.2...v2.2.3
+[Unreleased]: https://github.com/CiscoISE/ciscoisesdk/compare/v2.2.3...develop

README.rst

@@ -139,7 +139,7 @@ The following table shows the supported versions.
    * - 3.2_beta
      - 2.1.2
    * - 3.3_patch_1
-     - 2.2.2
+     - 2.2.3
 
 If your SDK is older please consider updating it first.
 

ciscoisesdk/api/v3_3_patch_1/endpoint.py

@@ -1145,7 +1145,7 @@ def get_endpoints(self,
                 sortdsc,
             'filter':
                 filter,
-            'filterType':
+            'filtertype': ## Issue #116 ansible-ise
                 filter_type,
         }
         _params.update(query_parameters)

ciscoisesdk/api/v3_3_patch_1/endpoint_identity_group.py

@@ -67,6 +67,8 @@ class EndpointIdentityGroup(object):
     +---------------+----------+--------------+-------------------------------------+--------------------+-------------------------------------------------+
     | systemDefined | Boolean  | Yes          |                                     | false              | true                                            |
     +---------------+----------+--------------+-------------------------------------+--------------------+-------------------------------------------------+
+    | parentId      | String   | Yes          |                                     |                                                                      |
+    +---------------+----------+--------------+-------------------------------------+--------------------+-------------------------------------------------+
 
     """
 

ciscoisesdk/api/v3_3_patch_1/support_bundle_download.py

@@ -92,22 +92,19 @@ def download_support_bundle(self,
                                 file_name=None,
                                 dirpath=None,
                                 save_file=None,
-                                filename=None,
                                 headers=None,
                                 payload=None,
                                 active_validation=True,
                                 **query_parameters):
         """This API allows the client to upload a support bundle.
 
         Args:
-            file_name(string): fileName, property of the request
-                body.
+            file_name(str): fileName, property of the request
+                body. fileName used to save the download file.
             dirpath(str): Directory absolute path. Defaults to
                 os.getcwd().
             save_file(bool): Enable or disable automatic file creation of
                 raw response.
-            filename(str): The filename used to save the download
-                file.
             headers(dict): Dictionary of HTTP Headers to send with the Request
                 .
             payload(dict): A JSON serializable Python object to send in the
@@ -185,12 +182,12 @@ def download_support_bundle(self,
         if with_custom_headers:
             _api_response = self._session.put(endpoint_full_url, params=_params,
                                               headers=_headers,
-                                              stream=True, dirpath=dirpath, save_file=save_file, filename=filename,
+                                              stream=True, dirpath=dirpath, save_file=save_file, filename=file_name,
                                               **request_params)
 
         else:
             _api_response = self._session.put(endpoint_full_url, params=_params,
-                                              stream=True, dirpath=dirpath, save_file=save_file, filename=filename,
+                                              stream=True, dirpath=dirpath, save_file=save_file, filename=file_name,
                                               **request_params)
 
         return self._object_factory('bpm_6d125b968b9d362a3458621d_v3_3_patch_1', _api_response)
@@ -199,7 +196,6 @@ def download(self,
                  file_name=None,
                  dirpath=None,
                  save_file=None,
-                 filename=None,
                  headers=None,
                  payload=None,
                  active_validation=True,
@@ -212,7 +208,6 @@ def download(self,
             file_name=file_name,
             dirpath=dirpath,
             save_file=save_file,
-            filename=filename,
             payload=payload,
             active_validation=active_validation,
             headers=headers,

ciscoisesdk/restsession.py

@@ -211,6 +211,7 @@ def __init__(self, get_access_token, access_token, base_url,
 
         # Update the headers of the `requests` session
         self.update_headers({'authorization': 'Basic ' + access_token})
+        self.update_headers({'User-Agent': f'python-cisco-ise/{version}'})
         if headers and isinstance(headers, dict):
             self.update_headers(headers)
 

docs/CHANGELOG.rst

@@ -8,15 +8,24 @@ Changelog <https://keepachangelog.com/en/1.0.0/>`__, and this project
 adheres to `Semantic
 Versioning <https://semver.org/spec/v2.0.0.html>`__.
 
-`Unreleased <https://github.com/CiscoISE/ciscoisesdk/compare/v2.2.2...develop>`__
+`Unreleased <https://github.com/CiscoISE/ciscoisesdk/compare/v2.2.3...develop>`__
 ---------------------------------------------------------------------------------
 
+`2.2.3 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.2.2...v2.2.3>`__ - 2024-08-05
+----------------------------------------------------------------------------------------
+
+-  Update ``endpoint.get_endpoints`` in 3.3 patch 1 change
+   ``filterType`` to ``filtertype`` json request
+-  Update ``SupportBundleDownload`` API to remove unused parameters
+-  Update User-Agent header in RestSession
 -  Update requirements:
 
    -  python = “^3.8”
    -  requests = “^2.32.0”
    -  readthedocs-sphinx-search = “^0.3.2”
 
+.. _section-1:
+
 `2.2.2 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.2.1...v2.2.2>`__ - 2024-07-16
 ----------------------------------------------------------------------------------------
 
@@ -26,7 +35,7 @@ Fixed
 -  Update EndpointIdentityGroup API to include ``parent_id`` parameters
 -  Update requirements
 
-.. _section-1:
+.. _section-2:
 
 `2.2.1 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.2.0...v2.2.1>`__ - 2024-05-15
 ----------------------------------------------------------------------------------------
@@ -39,7 +48,7 @@ Fixed
 -  Update NetworkDeviceGroup API parameter name from ``ndgtype`` to
    ``othername`` in 3.3 patch 1.
 
-.. _section-2:
+.. _section-3:
 
 `2.2.0 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.1.2...v2.2.0>`__ - 2024-04-24
 ----------------------------------------------------------------------------------------
@@ -50,7 +59,7 @@ Added
 -  ``ciscoisesdk`` now supports ISE 3.3 patch 1 API services included:
    ``active_directories, ad_groups, custom_attributes, duo_identity_sync, duo_mfa, enable_mfa, endpoint_stop_replication_service, endpoints, full_upgrade, is_mfa_enabled, native_ipsec, px_grid_direct, sgt_range_reservation, user_equipment``
 
-.. _section-3:
+.. _section-4:
 
 `2.1.2 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.1.1...v2.1.2>`__ - 2023-11-10
 ----------------------------------------------------------------------------------------
@@ -62,7 +71,7 @@ Fixed
 
 -  Fix configuration import
 
-.. _section-4:
+.. _section-5:
 
 `2.1.1 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.1.0...v2.1.1>`__ - 2023-11-09
 ----------------------------------------------------------------------------------------
@@ -74,7 +83,7 @@ Fixed
 
 -  some imports that caused problems were removed
 
-.. _section-5:
+.. _section-6:
 
 `2.1.0 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.0.12...v2.1.0>`__ - 2023-11-07
 -----------------------------------------------------------------------------------------
@@ -87,14 +96,14 @@ Added
 -  ``ciscoisesdk`` now supports ISE 3.2-Beta API services included:
    ``configuration, edda, dataconnect_services, subscriber``
 
-.. _section-6:
+.. _section-7:
 
 `2.0.12 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.0.11...v2.0.12>`__ - 2023-08-25
 -------------------------------------------------------------------------------------------
 
 -  Update requirements and readthedocs settings
 
-.. _section-7:
+.. _section-8:
 
 `2.0.11 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.0.10...v2.0.11>`__ - 2023-08-24
 -------------------------------------------------------------------------------------------
@@ -104,7 +113,7 @@ Changed
 
 -  Update requirements
 
-.. _section-8:
+.. _section-9:
 
 `2.0.10 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.0.9...v2.0.10>`__ - 2023-07-25
 ------------------------------------------------------------------------------------------
@@ -117,7 +126,7 @@ Added
 -  Adding new param ``ersRestIDStoreUserAttributes`` on restid_store
    create function.
 
-.. _section-9:
+.. _section-10:
 
 `2.0.9 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.0.8...v2.0.9>`__ - 2023-04-19
 ----------------------------------------------------------------------------------------
@@ -129,7 +138,7 @@ Changed
 
 -  Updating request-toolbelt from 0.9.1 to 0.10.1
 
-.. _section-10:
+.. _section-11:
 
 `2.0.8 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.0.7...v2.0.8>`__ - 2022-11-07
 ----------------------------------------------------------------------------------------
@@ -144,7 +153,7 @@ Fixed
    -  ciscoisesdk.api.v3_1_1.certificates.delete_system_certificate_by_id
    -  ciscoisesdk.api.v3_1_patch_1.certificates.delete_system_certificate_by_id
 
-.. _section-11:
+.. _section-12:
 
 `2.0.7 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.0.6...v2.0.7>`__ - 2022-11-01
 ----------------------------------------------------------------------------------------
@@ -163,7 +172,7 @@ Fixed
       to
       /admin/API/mnt/CoA/Disconnect/{PSN_NAME}/{MAC}/{DISCONNECT_TYPE}/{NAS_IPV4}/{ENDPOINT_IP}
 
-.. _section-12:
+.. _section-13:
 
 `2.0.6 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.0.5...v2.0.6>`__ - 2022-10-27
 ----------------------------------------------------------------------------------------
@@ -197,7 +206,7 @@ Fixed
       to
       /admin/API/mnt/CoA/Disconnect/{PSN_NAME}/{MAC}/{DISCONNECT_TYPE}/{NAS_IPV4}/{{ENDPOINT_IP}}
 
-.. _section-13:
+.. _section-14:
 
 `2.0.5 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.0.4...v2.0.5>`__ - 2022-10-13
 ----------------------------------------------------------------------------------------
@@ -214,7 +223,7 @@ Fixed
    network_access_network_conditions.update_network_access_network_condition_by_id
    request 3.1_patch_1 and 3.1.1
 
-.. _section-14:
+.. _section-15:
 
 `2.0.4 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.0.3...v2.0.4>`__ - 2022-07-11
 ----------------------------------------------------------------------------------------
@@ -226,7 +235,7 @@ Fixed
 
 -  Update check_type to pass an instance of a list.
 
-.. _section-15:
+.. _section-16:
 
 `2.0.3 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.0.2...v2.0.3>`__ - 2022-06-07
 ----------------------------------------------------------------------------------------
@@ -239,7 +248,7 @@ Changed
 -  Default ISE DEFAULT_VERSION to 3.1_Patch_1
 -  Update documentation to use ISE v3.1_Patch_1
 
-.. _section-16:
+.. _section-17:
 
 `2.0.2 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.0.1...v2.0.2>`__ - 2022-05-02
 ----------------------------------------------------------------------------------------
@@ -253,7 +262,7 @@ Fixed
    when they attempt to get_next_page. Previous version only captured
    and ignored 404 Not Found and 400 Bad Request.
 
-.. _section-17:
+.. _section-18:
 
 `2.0.1 <https://github.com/CiscoISE/ciscoisesdk/compare/v2.0.0...v2.0.1>`__ - 2022-03-24
 ----------------------------------------------------------------------------------------
@@ -305,7 +314,7 @@ Changed
    -  ciscoisesdk.api.v3_1_1.support_bundle_download.SupportBundleDownload.download_support_bundle
    -  ciscoisesdk.api.v3_1_1.support_bundle_download.SupportBundleDownload.download
 
-.. _section-18:
+.. _section-19:
 
 `2.0.0 <https://github.com/CiscoISE/ciscoisesdk/compare/v1.5.1...v2.0.0>`__ - 2022-03-24
 ----------------------------------------------------------------------------------------
@@ -317,7 +326,7 @@ Removed
    and ``RestSession``.
 -  Drop ISE version 3.0.0 support.
 
-.. _section-19:
+.. _section-20:
 
 `1.5.1 <https://github.com/CiscoISE/ciscoisesdk/compare/v1.5.0...v1.5.1>`__ - 2022-02-25
 ----------------------------------------------------------------------------------------
@@ -329,7 +338,7 @@ Changed
 
 -  Update docstring documentation of modules and functions.
 
-.. _section-20:
+.. _section-21:
 
 `1.5.0 <https://github.com/CiscoISE/ciscoisesdk/compare/v1.4.2...v1.5.0>`__ - 2022-02-23
 ----------------------------------------------------------------------------------------
@@ -451,7 +460,7 @@ Fixed
    variables set after the module is imported, and not only before it.
 -  Fixed the docstring tables of the API modules.
 
-.. _section-21:
+.. _section-22:
 
 `1.4.2 <https://github.com/CiscoISE/ciscoisesdk/compare/v1.4.1...v1.4.2>`__ - 2022-02-18
 ----------------------------------------------------------------------------------------
@@ -465,7 +474,7 @@ Fixed
    when they attempt to get_next_page. Previous version only captured
    and ignored 404 Not Found.
 
-.. _section-22:
+.. _section-23:
 
 `1.4.1 <https://github.com/CiscoISE/ciscoisesdk/compare/v1.4.0...v1.4.1>`__ - 2022-01-20
 ----------------------------------------------------------------------------------------
@@ -478,7 +487,7 @@ Changed
 -  Update module inner documentation.
 -  Downgrade requirements file to use poetry versions.
 
-.. _section-23:
+.. _section-24:
 
 `1.4.0 <https://github.com/CiscoISE/ciscoisesdk/compare/v1.3.1...v1.4.0>`__ - 2022-01-19
 ----------------------------------------------------------------------------------------
@@ -498,7 +507,7 @@ Fixed
 -  Update pagination, get_next_page inner logic and location from utils
    to pagination.
 
-.. _section-24:
+.. _section-25:
 
 `1.3.1 <https://github.com/CiscoISE/ciscoisesdk/compare/v1.3.0...v1.3.1>`__ - 2021-12-13
 ----------------------------------------------------------------------------------------
@@ -510,7 +519,7 @@ Changed
 
 -  Fixes utils.get_next_page generator starting default page
 
-.. _section-25:
+.. _section-26:
 
 `1.3.0 <https://github.com/CiscoISE/ciscoisesdk/compare/v1.2.0...v1.3.0>`__ - 2021-12-13
 ----------------------------------------------------------------------------------------
@@ -544,7 +553,7 @@ Removed
 -  Removes replication_status module
 -  Removes sync_ise_node module
 
-.. _section-26:
+.. _section-27:
 
 `1.2.0 <https://github.com/CiscoISE/ciscoisesdk/compare/v1.1.0...v1.2.0>`__ - 2021-11-24
 ----------------------------------------------------------------------------------------
@@ -573,7 +582,7 @@ Removed
 
 -  Removes link of 3.1.0 modules to 3.0.0 version
 
-.. _section-27:
+.. _section-28:
 
 `1.1.0 <https://github.com/CiscoISE/ciscoisesdk/compare/v1.0.1...v1.1.0>`__ - 2021-10-22
 ----------------------------------------------------------------------------------------
@@ -593,7 +602,7 @@ Changed
 -  Default ISE DEFAULT_VERSION to 3.1.0
 -  Update documentation to use ISE v3.1.0
 
-.. _section-28:
+.. _section-29:
 
 `1.0.1 <https://github.com/CiscoISE/ciscoisesdk/compare/v1.0.0...v1.0.1>`__ - 2021-09-14
 ----------------------------------------------------------------------------------------
@@ -605,7 +614,7 @@ Changed
 
 -  Disabled warnings of urllib3 if verify is False
 
-.. _section-29:
+.. _section-30:
 
 `1.0.0 <https://github.com/CiscoISE/ciscoisesdk/compare/v0.5.1...v1.0.0>`__ - 2021-07-21
 ----------------------------------------------------------------------------------------