pyiqcsdk 2.1.2__tar.gz → 2.1.4__tar.gz

{pyiqcsdk-2.1.2 → pyiqcsdk-2.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyiqcsdk
-Version: 2.1.2
+Version: 2.1.4
 Summary: A Python SDK library for ExtremeCloud IQ Controller
 Home-page: https://github.com/extremenetworks/pyxccsdk
 Author: Extreme Networks
@@ -301,6 +301,24 @@ pip install pydoc-markdown   # only needed once
 pydoc-markdown | python strip_anchors.py docs/api_reference.md
 ```
 
+To install the required packages and build the documentation site on Windows without `make`, run the helper script from the repository root:
+
+```bash
+python build_docs.py
+```
+
+If you also need to regenerate `mkdocs/docs/api_reference.md` before building:
+
+```bash
+python build_docs.py --regen-api
+```
+
+If your environment already has the dependencies installed:
+
+```bash
+python build_docs.py --skip-install
+```
+
 This configuration intentionally generates a GitHub-friendly public API reference.
 
 # Support

{pyiqcsdk-2.1.2 → pyiqcsdk-2.1.4}/README.md

@@ -269,6 +269,24 @@ pip install pydoc-markdown   # only needed once
 pydoc-markdown | python strip_anchors.py docs/api_reference.md
 ```
 
+To install the required packages and build the documentation site on Windows without `make`, run the helper script from the repository root:
+
+```bash
+python build_docs.py
+```
+
+If you also need to regenerate `mkdocs/docs/api_reference.md` before building:
+
+```bash
+python build_docs.py --regen-api
+```
+
+If your environment already has the dependencies installed:
+
+```bash
+python build_docs.py --skip-install
+```
+
 This configuration intentionally generates a GitHub-friendly public API reference.
 
 # Support

{pyiqcsdk-2.1.2 → pyiqcsdk-2.1.4}/pyiqcsdk/api.py

@@ -7,11 +7,11 @@ import logging
 import time
 import datetime
 
-from .parts import (actionParams, AAAPolicy, AccessRules, Airdefense, AnalyticsProfiles, Appkeys, Aps, APTestRun,
-                    APTestSuite, BestPracticesMgr, ChannelInspector, ConcentratorManager, ContainerTemplates, Cos,
-                    GeoLocation, GlobalSettings, iotProfiles, LDAP, Licenses, Location, Mus, Networks, Pcap, PcapFiles, PlatformMgr,
-                    Plans, Positioning, Profiles, Radios, Radius, Ratelimiters, Reports, RfMgmtProfiles, Roles,
-                    RTLS, Sites, Scheduler, TechSupport, Topologies)
+from .parts import (actionParams, AAAPolicy, AccessRules, AdoptionRules, Airdefense, AnalyticsProfiles, Appkeys, Apps, Aps, APTestRun,
+                    APTestSuite, BestPracticesMgr, ChannelInspector, ConcentratorManager, ContainerTemplates, Cos, Eguest,
+                    GeoLocation, GlobalSettings, iotProfiles, LDAP, Licenses, Location, Mus, Networks, Pcap, PcapFiles,
+                    PKITrustpoints, PlatformMgr, Plans, Positioning, Profiles, Radios, Radius, Ratelimiters, Reports,
+                    RfMgmtProfiles, Roles, RTLS, Sites, Scheduler, TechSupport, Topologies)
 
 
 class Client:
@@ -41,6 +41,9 @@ class Client:
         accessrules() -> AccessRules:
             Get the AccessRules instance.
 
+        adoptionrules() -> AdoptionRules:
+            Get the AdoptionRules instance.
+
         airdefense() -> Airdefense:
             Get the Airdefense instance.
 
@@ -77,6 +80,9 @@ class Client:
         cos() -> Cos:
             Get the Cos instance.
 
+        eguest() -> Eguest:
+            Get the Eguest instance.
+
         geolocation() -> GeoLocation:
             Get the GeoLocation instance.
 
@@ -169,6 +175,7 @@ class Client:
             "accesseventslog": "platformmanager/v1/logging/accessevents",
             "admin": "platformmanager/v1/admin",
             "administrators": "management/v1/administrators",
+            "adoptionrules": "management/v1/devices/adoptionrules",
             "afc": "management/v1/aps/afc/query",
             "airdefense": "management/v4/airdefense",
             "airdefenseidmap": "management/v4/airdefense/nametoidmap",
@@ -195,7 +202,6 @@ class Client:
             "concentratorsidmap": "management/v1/concentrators/nametoidmap",
             "cos": "management/v1/cos",
             "cosidmap": "management/v1/cos/nametoidmap",
-            "containerSchedule": "apps/extreme-scheduler/api/v1/schedule",
             "containerTemplates": "orchestration/v1/templates",
             "createbackup": "platformmanager/v1/configuration/createbackup",
             "defaultgateway": "platformmanager/v1/routes/defaultgateway",
@@ -203,6 +209,7 @@ class Client:
             "delbackupfile": "platformmanager/v1/configuration/backupfile",
             "delImage": "/platformmanager/v1/upgrades/upgradeimage",
             "diagnosticcredentials": "access-control/v1/nac_engine_settings/diagnostic_credentials",
+            "eguest": "management/v1/eguest",
             "eventslog": "platformmanager/v1/logging/events/query/columns",
             "floorloc": "management/v3/sites/report/location/floor/{fid}",
             "ftpBackupTo": "platformmanager/v1/configuration/copybackupto/ftp",
@@ -235,7 +242,6 @@ class Client:
             "meshpoints": "management/v3/meshpoints",
             "meshpointstree": "management/v3/meshpoints/tree",
             "mudisassociate": "management/v1/stations/disassociate",
-            "mu_report": "management/v1/report/stations",
             "muactions": "access-control/v1/end_systems",
             "muloc": "management/v1/stations/{mac}/location",
             "mus": "management/v1/stations/query",
@@ -251,6 +257,7 @@ class Client:
             "pcap_files": "platformmanager/v3/packetcapture/files",
             "pcapidmap": "platformmanager/v3/packetcapture/nametoidmap",
             "ping": "platformmanager/v1/network/test/ping",
+            "pki_trustpoints": "platformmanager/v1/interface/cert",
             "platformMgr": "platformmanager/v1",
             "portals": "access-control/v1/portals/locations",
             "portals_ecp": "access-control/v1/portals/ffecp/locations",
@@ -281,11 +288,13 @@ class Client:
             "rtls": "management/v1/rtlsprofile",
             "rules": "access-control/v1/rules",
             "scpBackupTo": "platformmanager/v1/configuration/copybackupto/scp",
+            "scheduler": "apps/extreme-scheduler/api/v1",
             "scpImage": "platformmanager/v1/upgrades/copyupgradefrom/scp",
             "scpRestoreFrom": "platformmanager/v1/configuration/copyrestorefrom/scp",
             "session_token": "management/v1/oauth2/token",
             "shutdown": "platformmanager/v1/shutdown",
             "sites": "management/v3/sites",
+            "sitesv1": "management/v1/sites",
             "sitesidmap": "management/v3/sites/nametoidmap",
             "smartrf": "management/v2/aps",
             "smartrflog": "platformmanager/v1/logging/smartrf/events/query",
@@ -293,6 +302,7 @@ class Client:
             "state": "management/v1/state",
             "stationlog": "platformmanager/v1/logging/stations/events/query",
             "stationQuery": "management/v1/stations/query",
+            "stations": "management/v1/stations",
             "statistics": "management/v1/report/aps",
             "syslog": "platformmanager/v1/logging/syslog",
             "syslogv2": "platformmanager/v2/logging/syslog",
@@ -309,6 +319,7 @@ class Client:
             "topologiesidmap": "management/v1/topologies/nametoidmap",
             "traceroute": "platformmanager/v1/network/test/traceroute",
             "upgradedevices": "management/v1/report/upgrade/devices",
+            "upgradedevices_v2": "management/v2/report/upgrade/devices",
             "utilization": "management/v1/report/aps",
             "version": "platformmanager/v1/productversion",
             "websessiontimeout": "platformmanager/v1/websessiontimeout",
@@ -564,6 +575,17 @@ class Client:
         """
         return AccessRules(client=self)
 
+    @property
+    def adoptionrules(self) -> AdoptionRules:
+        """
+        An object for managing adoption rules on the Appliance.
+
+        Usage::
+
+            >>> c.adoptionrules.get()
+        """
+        return AdoptionRules(client=self)
+
     @property
     def airdefense(self) -> Airdefense:
         """
@@ -594,6 +616,15 @@ class Client:
         """
         return Appkeys(client=self)
 
+    def apps(self, app_name: str) -> Apps:
+        """
+        An object for managing apps on the Appliance.
+
+        Usage:
+            >>> c.apps("stadium").uploadImage("path/to/image")
+        """
+        return Apps(client=self, app_name=app_name)
+    
     @property
     def aps(self) -> Aps:
         """
@@ -684,6 +715,16 @@ class Client:
         """
         return Cos(client=self)
 
+    @property
+    def eguest(self) -> Eguest:
+        """
+        An object for managing Eguest on the Appliance.
+
+        Usage:
+            >>> c.eguest.get()
+        """
+        return Eguest(client=self)
+
     @property
     def geolocation(self) -> GeoLocation:
         """
@@ -785,6 +826,16 @@ class Client:
         """
         return PcapFiles(client=self)
 
+    @property
+    def pki(self) -> PKITrustpoints:
+        """
+        An object for managing PKI trustpoints on the Appliance.
+
+        Usage:
+            >>> c.pki.apply("my_trustpoint", "cert.crt", "cert.key", "password")
+        """
+        return PKITrustpoints(client=self)
+
     @property
     def platformMgr(self) -> PlatformMgr:
         """