|
14 | 14 | from mistapi.__api_response import APIResponse as _APIResponse |
15 | 15 |
|
16 | 16 |
|
| 17 | +def countOrgVars( |
| 18 | + mist_session: _APISession, |
| 19 | + org_id: str, |
| 20 | + distinct: str | None = None, |
| 21 | + site_id: str | None = None, |
| 22 | + var: str | None = None, |
| 23 | + src: str | None = None, |
| 24 | + start: str | None = None, |
| 25 | + end: str | None = None, |
| 26 | + duration: str | None = None, |
| 27 | + limit: int | None = None, |
| 28 | +) -> _APIResponse: |
| 29 | + """ |
| 30 | + API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/vars/count-org-vars |
| 31 | +
|
| 32 | + PARAMS |
| 33 | + ----------- |
| 34 | + mistapi.APISession : mist_session |
| 35 | + mistapi session including authentication and Mist host information |
| 36 | +
|
| 37 | + PATH PARAMS |
| 38 | + ----------- |
| 39 | + org_id : str |
| 40 | +
|
| 41 | + QUERY PARAMS |
| 42 | + ------------ |
| 43 | + distinct : str{'site_id', 'src', 'var'}, default: var |
| 44 | + Field used to group this count response. enum: `site_id`, `src`, `var` |
| 45 | + site_id : str |
| 46 | + Filter results by site identifier. Accepts multiple comma-separated values. |
| 47 | + var : str |
| 48 | + Filter variable results by variable name. Accepts multiple comma-separated values. |
| 49 | + src : str{'deviceprofile', 'site'} |
| 50 | + Filter results by source. enum: `deviceprofile`, `site` |
| 51 | + start : str |
| 52 | + Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` |
| 53 | + end : str |
| 54 | + Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` |
| 55 | + duration : str, default: 1d |
| 56 | + Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` |
| 57 | + limit : int, default: 100 |
| 58 | + Maximum number of results to return per page |
| 59 | +
|
| 60 | + RETURN |
| 61 | + ----------- |
| 62 | + mistapi.APIResponse |
| 63 | + response from the API call |
| 64 | + """ |
| 65 | + |
| 66 | + uri = f"/api/v1/orgs/{org_id}/vars/count" |
| 67 | + query_params: dict[str, str] = {} |
| 68 | + if distinct: |
| 69 | + query_params["distinct"] = str(distinct) |
| 70 | + if site_id: |
| 71 | + query_params["site_id"] = str(site_id) |
| 72 | + if var: |
| 73 | + query_params["var"] = str(var) |
| 74 | + if src: |
| 75 | + query_params["src"] = str(src) |
| 76 | + if start: |
| 77 | + query_params["start"] = str(start) |
| 78 | + if end: |
| 79 | + query_params["end"] = str(end) |
| 80 | + if duration: |
| 81 | + query_params["duration"] = str(duration) |
| 82 | + if limit: |
| 83 | + query_params["limit"] = str(limit) |
| 84 | + resp = mist_session.mist_get(uri=uri, query=query_params) |
| 85 | + return resp |
| 86 | + |
| 87 | + |
17 | 88 | def searchOrgVars( |
18 | 89 | mist_session: _APISession, |
19 | 90 | org_id: str, |
|
0 commit comments