-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathdevices.py
More file actions
391 lines (315 loc) · 10.3 KB
/
Copy pathdevices.py
File metadata and controls
391 lines (315 loc) · 10.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
"""
--------------------------------------------------------------------------------
------------------------- 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 listInstallerListOfRecentlyClaimedDevices(
mist_session: _APISession,
org_id: str,
model: str | None = None,
site_name: str | None = None,
site_id: str | None = None,
limit: int | None = None,
page: int | None = None,
) -> _APIResponse:
"""
API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer/list-installer-list-of-recently-claimed-devices
PARAMS
-----------
mistapi.APISession : mist_session
mistapi session including authentication and Mist host information
PATH PARAMS
-----------
org_id : str
QUERY PARAMS
------------
model : str
Filter results by device model
site_name : str
Filter results by site name
site_id : str
Filter results by site identifier
limit : int, default: 100
Maximum number of results to return per page
page : int, default: 1
Select the page number to return when using page-based pagination; starts at `1`
RETURN
-----------
mistapi.APIResponse
response from the API call
"""
uri = f"/api/v1/installer/orgs/{org_id}/devices"
query_params: dict[str, str] = {}
if model:
query_params["model"] = str(model)
if site_name:
query_params["site_name"] = str(site_name)
if site_id:
query_params["site_id"] = str(site_id)
if limit:
query_params["limit"] = str(limit)
if page:
query_params["page"] = str(page)
resp = mist_session.mist_get(uri=uri, query=query_params)
return resp
def claimInstallerDevices(
mist_session: _APISession, org_id: str, body: dict | list
) -> _APIResponse:
"""
API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer/claim-installer-devices
PARAMS
-----------
mistapi.APISession : mist_session
mistapi session including authentication and Mist host information
PATH PARAMS
-----------
org_id : str
BODY PARAMS
-----------
body : dict
JSON object to send to Mist Cloud (see API doc above for more details)
RETURN
-----------
mistapi.APIResponse
response from the API call
"""
uri = f"/api/v1/installer/orgs/{org_id}/devices"
resp = mist_session.mist_post(uri=uri, body=body)
return resp
def unassignInstallerRecentlyClaimedDevice(
mist_session: _APISession, org_id: str, device_mac: str
) -> _APIResponse:
"""
API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer/unassign-installer-recently-claimed-device
PARAMS
-----------
mistapi.APISession : mist_session
mistapi session including authentication and Mist host information
PATH PARAMS
-----------
org_id : str
device_mac : str
RETURN
-----------
mistapi.APIResponse
response from the API call
"""
uri = f"/api/v1/installer/orgs/{org_id}/devices/{device_mac}"
query_params: dict[str, str] = {}
resp = mist_session.mist_delete(uri=uri, query=query_params)
return resp
def provisionInstallerDevices(
mist_session: _APISession, org_id: str, device_mac: str, body: dict
) -> _APIResponse:
"""
API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer/provision-installer-devices
PARAMS
-----------
mistapi.APISession : mist_session
mistapi session including authentication and Mist host information
PATH PARAMS
-----------
org_id : str
device_mac : str
BODY PARAMS
-----------
body : dict
JSON object to send to Mist Cloud (see API doc above for more details)
RETURN
-----------
mistapi.APIResponse
response from the API call
"""
uri = f"/api/v1/installer/orgs/{org_id}/devices/{device_mac}"
resp = mist_session.mist_put(uri=uri, body=body)
return resp
def startInstallerLocateDevice(
mist_session: _APISession, org_id: str, device_mac: str
) -> _APIResponse:
"""
API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer/start-installer-locate-device
PARAMS
-----------
mistapi.APISession : mist_session
mistapi session including authentication and Mist host information
PATH PARAMS
-----------
org_id : str
device_mac : str
RETURN
-----------
mistapi.APIResponse
response from the API call
"""
uri = f"/api/v1/installer/orgs/{org_id}/devices/{device_mac}/locate"
resp = mist_session.mist_post(uri=uri)
return resp
def stopInstallerLocateDevice(
mist_session: _APISession, org_id: str, device_mac: str
) -> _APIResponse:
"""
API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer/stop-installer-locate-device
PARAMS
-----------
mistapi.APISession : mist_session
mistapi session including authentication and Mist host information
PATH PARAMS
-----------
org_id : str
device_mac : str
RETURN
-----------
mistapi.APIResponse
response from the API call
"""
uri = f"/api/v1/installer/orgs/{org_id}/devices/{device_mac}/unlocate"
resp = mist_session.mist_post(uri=uri)
return resp
def deleteInstallerDeviceImage(
mist_session: _APISession, org_id: str, image_name: str, device_mac: str
) -> _APIResponse:
"""
API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer/delete-installer-device-image
PARAMS
-----------
mistapi.APISession : mist_session
mistapi session including authentication and Mist host information
PATH PARAMS
-----------
org_id : str
image_name : str
device_mac : str
RETURN
-----------
mistapi.APIResponse
response from the API call
"""
uri = f"/api/v1/installer/orgs/{org_id}/devices/{device_mac}/{image_name}"
query_params: dict[str, str] = {}
resp = mist_session.mist_delete(uri=uri, query=query_params)
return resp
def addInstallerDeviceImageFile(
mist_session: _APISession,
org_id: str,
image_name: str,
device_mac: str,
auto_deviceprofile_assignment: bool | None = None,
csv: str | None = None,
file: str | None = None,
json: dict | None = None,
) -> _APIResponse:
"""
API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer/add-installer-device-image
PARAMS
-----------
mistapi.APISession : mist_session
mistapi session including authentication and Mist host information
PATH PARAMS
-----------
org_id : str
image_name : str
device_mac : str
BODY PARAMS
-----------
auto_deviceprofile_assignment : bool
Whether to auto assign device to deviceprofile by name
csv : str
path to the file to upload. Optional AP name-mapping CSV file
file : str
path to the file to upload. Ekahau or iBwave floorplan file to import
json : dict
Import options for the site map file
RETURN
-----------
mistapi.APIResponse
response from the API call
"""
multipart_form_data = {
"auto_deviceprofile_assignment": auto_deviceprofile_assignment,
"csv": csv,
"file": file,
"json": json,
}
uri = f"/api/v1/installer/orgs/{org_id}/devices/{device_mac}/{image_name}"
resp = mist_session.mist_post_file(uri=uri, multipart_form_data=multipart_form_data)
return resp
def getInstallerDeviceVirtualChassis(
mist_session: _APISession, org_id: str, fpc0_mac: str
) -> _APIResponse:
"""
API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer/get-installer-device-virtual-chassis
PARAMS
-----------
mistapi.APISession : mist_session
mistapi session including authentication and Mist host information
PATH PARAMS
-----------
org_id : str
fpc0_mac : str
FPC0 MAC address
RETURN
-----------
mistapi.APIResponse
response from the API call
"""
uri = f"/api/v1/installer/orgs/{org_id}/devices/{fpc0_mac}/vc"
query_params: dict[str, str] = {}
resp = mist_session.mist_get(uri=uri, query=query_params)
return resp
def createInstallerVirtualChassis(
mist_session: _APISession, org_id: str, fpc0_mac: str, body: dict | list
) -> _APIResponse:
"""
API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer/create-installer-virtual-chassis
PARAMS
-----------
mistapi.APISession : mist_session
mistapi session including authentication and Mist host information
PATH PARAMS
-----------
org_id : str
fpc0_mac : str
FPC0 MAC address
BODY PARAMS
-----------
body : dict
JSON object to send to Mist Cloud (see API doc above for more details)
RETURN
-----------
mistapi.APIResponse
response from the API call
"""
uri = f"/api/v1/installer/orgs/{org_id}/devices/{fpc0_mac}/vc"
resp = mist_session.mist_post(uri=uri, body=body)
return resp
def updateInstallerVirtualChassisMember(
mist_session: _APISession, org_id: str, fpc0_mac: str, body: dict
) -> _APIResponse:
"""
API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer/update-installer-virtual-chassis-member
PARAMS
-----------
mistapi.APISession : mist_session
mistapi session including authentication and Mist host information
PATH PARAMS
-----------
org_id : str
fpc0_mac : str
FPC0 MAC address
BODY PARAMS
-----------
body : dict
JSON object to send to Mist Cloud (see API doc above for more details)
RETURN
-----------
mistapi.APIResponse
response from the API call
"""
uri = f"/api/v1/installer/orgs/{org_id}/devices/{fpc0_mac}/vc"
resp = mist_session.mist_put(uri=uri, body=body)
return resp