0.60.0

OAS 2602.1.1

Author: tmunzer-AIDE

CHANGELOG.md

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "mistapi"
-version = "0.59.5"
+version = "0.60.0"
 authors = [{ name = "Thomas Munzer", email = "tmunzer@juniper.net" }]
 description = "Python package to simplify the Mist System APIs usage"
 keywords = ["Mist", "Juniper", "API"]

mist_openapi

@@ -1,2 +1,2 @@
-__version__ = "0.59.5"
+__version__ = "0.60.0"
 __author__ = "Thomas Munzer <tmunzer@juniper.net>"

pyproject.toml

@@ -16,6 +16,7 @@
     admins,
     alarms,
     alarmtemplates,
+    aos,
     apitokens,
     aptemplates,
     assetfilters,
@@ -98,6 +99,7 @@
     "admins",
     "alarms",
     "alarmtemplates",
+    "aos",
     "apitokens",
     "aptemplates",
     "assetfilters",

src/mistapi/__version.py

@@ -0,0 +1,39 @@
+"""
+--------------------------------------------------------------------------------
+------------------------- Mist API Python CLI Session --------------------------
+
+    Written by: Thomas Munzer (tmunzer@juniper.net)
+    Github    : https://github.com/tmunzer/mistapi_python
+
+    This package is licensed under the MIT License.
+
+--------------------------------------------------------------------------------
+"""
+
+from mistapi import APISession as _APISession
+from mistapi.__api_response import APIResponse as _APIResponse
+
+
+def getOrgAosRegisterCmd(mist_session: _APISession, org_id: str) -> _APIResponse:
+    """
+    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/aos/get-org-aos-register-cmd
+
+    PARAMS
+    -----------
+    mistapi.APISession : mist_session
+        mistapi session including authentication and Mist host information
+
+    PATH PARAMS
+    -----------
+    org_id : str
+
+    RETURN
+    -----------
+    mistapi.APIResponse
+        response from the API call
+    """
+
+    uri = f"/api/v1/orgs/{org_id}/aos/register_cmd"
+    query_params: dict[str, str] = {}
+    resp = mist_session.mist_get(uri=uri, query=query_params)
+    return resp

src/mistapi/api/v1/orgs/__init__.py

@@ -319,3 +319,237 @@ def searchOrgJsiAssetsAndContracts(
         query_params["search_after"] = str(search_after)
     resp = mist_session.mist_get(uri=uri, query=query_params)
     return resp
+
+
+def countOrgJsiPbn(
+    mist_session: _APISession,
+    org_id: str,
+    distinct: str,
+    limit: int | None = None,
+    start: str | None = None,
+    end: str | None = None,
+) -> _APIResponse:
+    """
+    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/jsi/count-org-jsi-pbn
+
+    PARAMS
+    -----------
+    mistapi.APISession : mist_session
+        mistapi session including authentication and Mist host information
+
+    PATH PARAMS
+    -----------
+    org_id : str
+
+    QUERY PARAMS
+    ------------
+    distinct : str{'versions', 'models', 'customer_risk', 'bug_type'}
+      Field to group by enum: `versions`, `models`, `customer_risk`, `bug_type`
+    limit : int, default: 100
+    start : str
+    end : str
+
+    RETURN
+    -----------
+    mistapi.APIResponse
+        response from the API call
+    """
+
+    uri = f"/api/v1/orgs/{org_id}/jsi/pbn/count"
+    query_params: dict[str, str] = {}
+    if distinct:
+        query_params["distinct"] = str(distinct)
+    if limit:
+        query_params["limit"] = str(limit)
+    if start:
+        query_params["start"] = str(start)
+    if end:
+        query_params["end"] = str(end)
+    resp = mist_session.mist_get(uri=uri, query=query_params)
+    return resp
+
+
+def searchOrgJsiPbn(
+    mist_session: _APISession,
+    org_id: str,
+    versions: str | None = None,
+    models: str | None = None,
+    customer_risk: str | None = None,
+    id: str | None = None,
+    bug_type: str | None = None,
+    limit: int | None = None,
+    page: int | None = None,
+    search_after: str | None = None,
+    start: str | None = None,
+    end: str | None = None,
+) -> _APIResponse:
+    """
+    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/jsi/search-org-jsi-pbn
+
+    PARAMS
+    -----------
+    mistapi.APISession : mist_session
+        mistapi session including authentication and Mist host information
+
+    PATH PARAMS
+    -----------
+    org_id : str
+
+    QUERY PARAMS
+    ------------
+    versions : str
+    models : str
+    customer_risk : str
+    id : str
+    bug_type : str
+    limit : int, default: 100
+    page : int, default: 1
+    search_after : str
+    start : str
+    end : str
+
+    RETURN
+    -----------
+    mistapi.APIResponse
+        response from the API call
+    """
+
+    uri = f"/api/v1/orgs/{org_id}/jsi/pbn/search"
+    query_params: dict[str, str] = {}
+    if versions:
+        query_params["versions"] = str(versions)
+    if models:
+        query_params["models"] = str(models)
+    if customer_risk:
+        query_params["customer_risk"] = str(customer_risk)
+    if id:
+        query_params["id"] = str(id)
+    if bug_type:
+        query_params["bug_type"] = str(bug_type)
+    if limit:
+        query_params["limit"] = str(limit)
+    if page:
+        query_params["page"] = str(page)
+    if search_after:
+        query_params["search_after"] = str(search_after)
+    if start:
+        query_params["start"] = str(start)
+    if end:
+        query_params["end"] = str(end)
+    resp = mist_session.mist_get(uri=uri, query=query_params)
+    return resp
+
+
+def countOrgJsiSirt(
+    mist_session: _APISession,
+    org_id: str,
+    distinct: str,
+    limit: int | None = None,
+    start: str | None = None,
+    end: str | None = None,
+) -> _APIResponse:
+    """
+    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/jsi/count-org-jsi-sirt
+
+    PARAMS
+    -----------
+    mistapi.APISession : mist_session
+        mistapi session including authentication and Mist host information
+
+    PATH PARAMS
+    -----------
+    org_id : str
+
+    QUERY PARAMS
+    ------------
+    distinct : str{'versions', 'models', 'severity', 'jsa_updated_date'}
+      Field to group by. enum: `jsa_updated_date`, `models`, `severity`, `versions`
+    limit : int, default: 100
+    start : str
+    end : str
+
+    RETURN
+    -----------
+    mistapi.APIResponse
+        response from the API call
+    """
+
+    uri = f"/api/v1/orgs/{org_id}/jsi/sirt/count"
+    query_params: dict[str, str] = {}
+    if distinct:
+        query_params["distinct"] = str(distinct)
+    if limit:
+        query_params["limit"] = str(limit)
+    if start:
+        query_params["start"] = str(start)
+    if end:
+        query_params["end"] = str(end)
+    resp = mist_session.mist_get(uri=uri, query=query_params)
+    return resp
+
+
+def searchOrgJsiSirt(
+    mist_session: _APISession,
+    org_id: str,
+    versions: str | None = None,
+    models: str | None = None,
+    severity: str | None = None,
+    id: str | None = None,
+    limit: int | None = None,
+    page: int | None = None,
+    search_after: str | None = None,
+    start: str | None = None,
+    end: str | None = None,
+) -> _APIResponse:
+    """
+    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/jsi/search-org-jsi-sirt
+
+    PARAMS
+    -----------
+    mistapi.APISession : mist_session
+        mistapi session including authentication and Mist host information
+
+    PATH PARAMS
+    -----------
+    org_id : str
+
+    QUERY PARAMS
+    ------------
+    versions : str
+    models : str
+    severity : str
+    id : str
+    limit : int, default: 100
+    page : int, default: 1
+    search_after : str
+    start : str
+    end : str
+
+    RETURN
+    -----------
+    mistapi.APIResponse
+        response from the API call
+    """
+
+    uri = f"/api/v1/orgs/{org_id}/jsi/sirt/search"
+    query_params: dict[str, str] = {}
+    if versions:
+        query_params["versions"] = str(versions)
+    if models:
+        query_params["models"] = str(models)
+    if severity:
+        query_params["severity"] = str(severity)
+    if id:
+        query_params["id"] = str(id)
+    if limit:
+        query_params["limit"] = str(limit)
+    if page:
+        query_params["page"] = str(page)
+    if search_after:
+        query_params["search_after"] = str(search_after)
+    if start:
+        query_params["start"] = str(start)
+    if end:
+        query_params["end"] = str(end)
+    resp = mist_session.mist_get(uri=uri, query=query_params)
+    return resp

src/mistapi/api/v1/orgs/aos.py

@@ -604,7 +604,7 @@ def getOrgMxEdgeUpgradeInfo(
         response from the API call
     """
 
-    uri = f"/api/v1/orgs/{org_id}/mxedges/version"
+    uri = f"/api/v1/orgs/{org_id}/mxedges/versions"
     query_params: dict[str, str] = {}
     if channel:
         query_params["channel"] = str(channel)
@@ -731,12 +731,13 @@ def deleteOrgMxEdgeImage(
     return resp
 
 
-def addOrgMxEdgeImage(
+def addOrgMxEdgeImageFile(
     mist_session: _APISession,
     org_id: str,
     mxedge_id: str,
     image_number: int,
-    body: dict | list,
+    file: str | None = None,
+    json: str | None = None,
 ) -> _APIResponse:
     """
     API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/add-org-mx-edge-image
@@ -754,17 +755,22 @@ def addOrgMxEdgeImage(
 
     BODY PARAMS
     -----------
-    body : dict
-        JSON object to send to Mist Cloud (see API doc above for more details)
+    file : str
+        path to the file to upload. Binary file
+    json : str
 
     RETURN
     -----------
     mistapi.APIResponse
         response from the API call
     """
 
+    multipart_form_data = {
+        "file": file,
+        "json": json,
+    }
     uri = f"/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/image/{image_number}"
-    resp = mist_session.mist_post(uri=uri, body=body)
+    resp = mist_session.mist_post_file(uri=uri, multipart_form_data=multipart_form_data)
     return resp
 
 
@@ -942,3 +948,31 @@ def unregisterOrgMxEdge(
     uri = f"/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/unregister"
     resp = mist_session.mist_post(uri=uri)
     return resp
+
+
+def getOrgMxEdgeVmParams(
+    mist_session: _APISession, org_id: str, mxedge_id: str
+) -> _APIResponse:
+    """
+    API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/get-org-mx-edge-vm-params
+
+    PARAMS
+    -----------
+    mistapi.APISession : mist_session
+        mistapi session including authentication and Mist host information
+
+    PATH PARAMS
+    -----------
+    org_id : str
+    mxedge_id : str
+
+    RETURN
+    -----------
+    mistapi.APIResponse
+        response from the API call
+    """
+
+    uri = f"/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/vm_params"
+    query_params: dict[str, str] = {}
+    resp = mist_session.mist_get(uri=uri, query=query_params)
+    return resp