@itentialopensource/adapter-aruba_airwave 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/.eslintignore +0 -1
  2. package/.jshintrc +3 -0
  3. package/AUTH.md +39 -0
  4. package/BROKER.md +199 -0
  5. package/CALLS.md +349 -0
  6. package/CHANGELOG.md +8 -0
  7. package/CODE_OF_CONDUCT.md +12 -17
  8. package/CONTRIBUTING.md +3 -148
  9. package/ENHANCE.md +69 -0
  10. package/LICENSE +0 -0
  11. package/PROPERTIES.md +641 -0
  12. package/README.md +240 -438
  13. package/SUMMARY.md +9 -0
  14. package/SYSTEMINFO.md +11 -0
  15. package/TROUBLESHOOT.md +47 -0
  16. package/adapter.js +482 -226
  17. package/adapterBase.js +883 -337
  18. package/changelogs/changelog.md +24 -0
  19. package/entities/.generic/action.json +214 -0
  20. package/entities/.generic/schema.json +28 -0
  21. package/error.json +6 -0
  22. package/metadata.json +47 -0
  23. package/package.json +23 -25
  24. package/pronghorn.json +774 -34
  25. package/propertiesDecorators.json +14 -0
  26. package/propertiesSchema.json +866 -6
  27. package/refs?service=git-upload-pack +0 -0
  28. package/report/adapter-openapi.json +1583 -0
  29. package/report/adapter-openapi.yaml +1300 -0
  30. package/report/adapterInfo.json +10 -0
  31. package/report/updateReport1691507584816.json +120 -0
  32. package/report/updateReport1692202582785.json +120 -0
  33. package/report/updateReport1694461838457.json +120 -0
  34. package/report/updateReport1698420960460.json +120 -0
  35. package/sampleProperties.json +163 -4
  36. package/test/integration/adapterTestBasicGet.js +3 -5
  37. package/test/integration/adapterTestConnectivity.js +91 -42
  38. package/test/integration/adapterTestIntegration.js +157 -98
  39. package/test/unit/adapterBaseTestUnit.js +400 -305
  40. package/test/unit/adapterTestUnit.js +917 -158
  41. package/utils/adapterInfo.js +206 -0
  42. package/utils/addAuth.js +94 -0
  43. package/utils/artifactize.js +1 -1
  44. package/utils/basicGet.js +1 -14
  45. package/utils/checkMigrate.js +63 -0
  46. package/utils/entitiesToDB.js +179 -0
  47. package/utils/findPath.js +74 -0
  48. package/utils/methodDocumentor.js +273 -0
  49. package/utils/modify.js +152 -0
  50. package/utils/packModificationScript.js +1 -1
  51. package/utils/patches2bundledDeps.js +90 -0
  52. package/utils/pre-commit.sh +5 -0
  53. package/utils/removeHooks.js +20 -0
  54. package/utils/setup.js +0 -0
  55. package/utils/taskMover.js +309 -0
  56. package/utils/tbScript.js +129 -53
  57. package/utils/tbUtils.js +152 -35
  58. package/utils/testRunner.js +17 -17
  59. package/utils/troubleshootingAdapter.js +17 -43
  60. package/workflows/README.md +0 -3
@@ -0,0 +1,1300 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: Aruba Andy's Airwave Collection
4
+ description: 'TODO: Add Description'
5
+ contact: {}
6
+ version: '1.0'
7
+ servers:
8
+ - url: https://{host}
9
+ variables:
10
+ host:
11
+ default: DefaultParameterValue
12
+ - url: https://192.168.1.176
13
+ variables: {}
14
+ paths:
15
+ /amp_stats.xml:
16
+ get:
17
+ tags:
18
+ - Query API's
19
+ summary: AMPStats
20
+ description: >-
21
+ AMP Stats
22
+
23
+ URL: https://{{host}}/amp_stats.xml
24
+
25
+ XML Schema: amp_stats.xsd
26
+
27
+ Parameters: Optionally include_bandwidth or include_all_stats can be passed in the request.
28
+
29
+ Example Output: https://{{host}}/amp_stats.xml?include_all_stats=1&include_bandwidth=1
30
+ operationId: AMPStats
31
+ parameters: []
32
+ responses:
33
+ '200':
34
+ description: ''
35
+ headers: {}
36
+ content: {}
37
+ deprecated: false
38
+ /folder_list.xml:
39
+ get:
40
+ tags:
41
+ - Query API's
42
+ summary: FolderList
43
+ description: >-
44
+ URL: https://{{host}}/folder_list.xml
45
+
46
+ XML Schema: amp_folder_list.xsd
47
+
48
+ Parameters: Optionally limit information returned to one or more folders by supplying folder IDs.
49
+
50
+ Example URL: https://1{{host}}/folder_list.xml?id=1
51
+ operationId: FolderList
52
+ parameters: []
53
+ responses:
54
+ '200':
55
+ description: ''
56
+ headers: {}
57
+ content: {}
58
+ deprecated: false
59
+ /static/catalog_repository.xml:
60
+ get:
61
+ tags:
62
+ - Query API's
63
+ summary: CatalogRepository
64
+ description: ''
65
+ operationId: CatalogRepository
66
+ parameters: []
67
+ responses:
68
+ '200':
69
+ description: ''
70
+ headers: {}
71
+ content: {}
72
+ deprecated: false
73
+ /alerts.xml:
74
+ get:
75
+ tags:
76
+ - Query API's
77
+ summary: AlertList
78
+ description: ''
79
+ operationId: AlertList
80
+ parameters: []
81
+ responses:
82
+ '200':
83
+ description: ''
84
+ headers: {}
85
+ content: {}
86
+ deprecated: false
87
+ /ap_list.xml:
88
+ get:
89
+ tags:
90
+ - Query API's
91
+ summary: APList
92
+ description: "URL: https://{{host}}/ap_list.xml\r\nXML Schema: amp_ap_list.xsd\r\nParameters: \r\n Optionally limit information returned to one or more APs by supplying AP IDs.\r\n Similarly, limit by AP folders, AP groups, and controllers by supplying their IDs.\r\nExample URL: https://{{host}}/ap_list.xml?id=79&id=3648&ap_folder_id=3&ap_group_id=1&controller_id=15"
93
+ operationId: APList
94
+ parameters: []
95
+ responses:
96
+ '200':
97
+ description: ''
98
+ headers: {}
99
+ content: {}
100
+ deprecated: false
101
+ /api/ap_bssid_list.xml:
102
+ get:
103
+ tags:
104
+ - Query API's
105
+ summary: APBSSIDList
106
+ description: "URL: https://{{host}}/api/ap_bssid_list.xml\r\nXML Schema: amp_ap_bssid_list.xsd\r\nParameters: \r\n Optionally limit information returned to one or more APs by supplying AP IDs.\r\n Similarly, limit by AP folders, AP groups, and controllers by supplying their IDs.\r\nExample URL: https://{{host}}/api/ap_bssid_list.xml?id=79&id=3648&ap_folder_id=3&ap_group_id=1&controller_id=15"
107
+ operationId: APBSSIDList
108
+ parameters: []
109
+ responses:
110
+ '200':
111
+ description: ''
112
+ headers: {}
113
+ content: {}
114
+ deprecated: false
115
+ /ap_detail.xml:
116
+ get:
117
+ tags:
118
+ - Query API's
119
+ summary: APDetail
120
+ description: "URL: https://{{host}}/ap_detail.xml\r\nXML Schema: amp_ap_detail.xsd\r\nParameters: \r\n Optionally limit information returned to one or more APs by supplying AP IDs.\r\n Similarly, limit by AP folders, AP groups, and controllers by supplying their IDs.\r\nOptional Tags: \r\n include=ignored - neighbors that have been ignored through the AMP UI are not included in the list of neighbor APs by default.\r\n Append this to the URL to include ignored neighbors in the output.\r\nExample URL: https://{{host}}/ap_detail.xml, https://192.168.1.176/ap_detail.xml?id=79&ap_folder_id=7&ap_group_id=1&controller_id=77"
121
+ operationId: APDetail
122
+ parameters: []
123
+ responses:
124
+ '200':
125
+ description: ''
126
+ headers: {}
127
+ content: {}
128
+ deprecated: false
129
+ /ap_log.xml:
130
+ get:
131
+ tags:
132
+ - Query API's
133
+ summary: APLog
134
+ description: >-
135
+ URL: https://{{host}}/ap_log.xml
136
+
137
+ XML Schema: amp_ap_log.xsd
138
+
139
+ Parameters: Must supply one or more AP IDs.
140
+
141
+ Optional Tags: limit - (defaults to 20)
142
+
143
+ Example URL: https://{{host}}/ap_log.xml?id=79&limit=5
144
+ operationId: APLog
145
+ parameters:
146
+ - name: id
147
+ in: query
148
+ description: ''
149
+ required: true
150
+ style: form
151
+ explode: true
152
+ schema:
153
+ type: integer
154
+ format: int32
155
+ example: 79
156
+ - name: limit
157
+ in: query
158
+ description: ''
159
+ required: true
160
+ style: form
161
+ explode: true
162
+ schema:
163
+ type: integer
164
+ format: int32
165
+ example: 5
166
+ responses:
167
+ '200':
168
+ description: ''
169
+ headers: {}
170
+ content: {}
171
+ deprecated: false
172
+ /rogue_detail.xml:
173
+ get:
174
+ tags:
175
+ - Query API's
176
+ summary: RogueDetail
177
+ description: >-
178
+ URL: https://{{host}}/rogue_detail.xml
179
+
180
+ XML Schema: amp_rogue_detail.xsd
181
+
182
+ Parameters: Must supply one or more Rogue AP IDs. Rogue IDs are obtained from a neighbor_ap ID in the AP Detail API, when the neighbor_type is rogue.
183
+
184
+ Optional Tags: limit - as explained above
185
+
186
+ Example URL: https://{{host}}/rogue_detail.xml?id=267
187
+ operationId: RogueDetail
188
+ parameters:
189
+ - name: id
190
+ in: query
191
+ description: ''
192
+ required: true
193
+ style: form
194
+ explode: true
195
+ schema:
196
+ type: integer
197
+ format: int32
198
+ example: 267
199
+ responses:
200
+ '200':
201
+ description: ''
202
+ headers: {}
203
+ content: {}
204
+ deprecated: false
205
+ /client_detail.xml:
206
+ get:
207
+ tags:
208
+ - Query API's
209
+ summary: ClientDetail
210
+ description: >-
211
+ URL: https://{{host}}/client_detail.xml
212
+
213
+ XML Schema: amp_client_detail.xsd
214
+
215
+ Parameters: Must supply one or more Client MAC Addresses.
216
+
217
+ Optional Tags: limit - as explained above
218
+
219
+ Example URL: https://{{host}}/client_detail.xml?mac=00:0E:35:52:8C:AB
220
+ operationId: ClientDetail
221
+ parameters:
222
+ - name: mac
223
+ in: query
224
+ description: ''
225
+ required: true
226
+ style: form
227
+ explode: true
228
+ schema:
229
+ type: string
230
+ example: 00:0E:35:52:8C:AB
231
+ responses:
232
+ '200':
233
+ description: ''
234
+ headers: {}
235
+ content: {}
236
+ deprecated: false
237
+ /visualrf_config.xml:
238
+ get:
239
+ tags:
240
+ - Query API's
241
+ summary: VisualRFConfig
242
+ description: >-
243
+ URL: https://192.168.1.176/visualrf_config.xml
244
+
245
+ XML Schema: amp_visualrf_config.xsd
246
+
247
+ Parameters: None.
248
+ operationId: VisualRFConfig
249
+ parameters: []
250
+ responses:
251
+ '200':
252
+ description: ''
253
+ headers: {}
254
+ content: {}
255
+ deprecated: false
256
+ /user_info.xml:
257
+ get:
258
+ tags:
259
+ - Query API's
260
+ summary: UserInfo
261
+ description: >-
262
+ URL: https://{{host}}/user_info.xml
263
+
264
+ XML Schema: amp_user_info.xsd
265
+
266
+ Parameters: None.
267
+ operationId: UserInfo
268
+ parameters: []
269
+ responses:
270
+ '200':
271
+ description: ''
272
+ headers: {}
273
+ content: {}
274
+ deprecated: false
275
+ /device_rrd_info.xml:
276
+ get:
277
+ tags:
278
+ - Query API's
279
+ summary: DeviceRRDInfo
280
+ description: >-
281
+ URL: https://{{host}}/device_rrd_info.xml
282
+
283
+ Parameters: None.
284
+
285
+ Note: RRD = Round-Robin Database
286
+ operationId: DeviceRRDInfo
287
+ parameters: []
288
+ responses:
289
+ '200':
290
+ description: ''
291
+ headers: {}
292
+ content: {}
293
+ deprecated: false
294
+ /user_rrd_info.xml:
295
+ get:
296
+ tags:
297
+ - Query API's
298
+ summary: ClientRRDInfo
299
+ description: >-
300
+ URL: https://{{host}}/user_rrd_info.xml
301
+
302
+ Parameters: None.
303
+
304
+ Note: RRD = Round-Robin Database
305
+ operationId: ClientRRDInfo
306
+ parameters: []
307
+ responses:
308
+ '200':
309
+ description: ''
310
+ headers: {}
311
+ content: {}
312
+ deprecated: false
313
+ /site_changes:
314
+ post:
315
+ tags:
316
+ - Configuration API's
317
+ summary: ChangeSet
318
+ description: >-
319
+ URL: https://{{host}}/site_changes
320
+
321
+ Request XML Schema: amp_change_set.xsd
322
+
323
+ Parameters:
324
+
325
+ site_id - unique identifier obtained from the Site List API
326
+
327
+ site_name - existing or new name for the site
328
+
329
+ changeset - XML document following the above schema
330
+
331
+ Response XML Schema: amp_redirect.xsd - Supplies a redirect to a change set confirm page, or one or more error messages
332
+ operationId: ChangeSet
333
+ parameters:
334
+ - name: Content-Type
335
+ in: header
336
+ description: ''
337
+ required: true
338
+ style: simple
339
+ schema:
340
+ enum:
341
+ - application/xml
342
+ type: string
343
+ - name: X-BISCOTTI
344
+ in: header
345
+ description: ''
346
+ required: true
347
+ style: simple
348
+ schema:
349
+ type: string
350
+ example: '{{session_token}}'
351
+ requestBody:
352
+ description: ''
353
+ content:
354
+ application/xml:
355
+ schema:
356
+ allOf:
357
+ - $ref: '#/components/schemas/amp_ap_update'
358
+ - xml:
359
+ name: amp_ap_update
360
+ attribute: false
361
+ wrapped: false
362
+ example: >-
363
+ <amp_ap_update version="1">
364
+
365
+ <ap id="7">
366
+
367
+ <name>new name</name>
368
+
369
+ <lan_ip>10.32.12.33</lan_ip>
370
+
371
+ <radio index="1">
372
+
373
+ <channel>6</channel>
374
+
375
+ <transmit_power>100%</transmit_power>
376
+
377
+ </radio>
378
+
379
+ <radio index="2">
380
+
381
+ <channel>60</channel>
382
+
383
+ <transmit_power>100%</transmit_power>
384
+
385
+ </radio>
386
+
387
+ </ap>
388
+
389
+ <ap id="21">
390
+
391
+ <name>District AP1</name>
392
+
393
+ <radio index="1">
394
+
395
+ <antenna>Left/Right</antenna>
396
+
397
+ <channel>11</channel>
398
+
399
+ <transmit_power>50 mW</transmit_power>
400
+
401
+ </radio>
402
+
403
+ </ap>
404
+
405
+ </amp_ap_update>
406
+ example: >-
407
+ <amp_ap_update version="1">
408
+
409
+ <ap id="7">
410
+
411
+ <name>new name</name>
412
+
413
+ <lan_ip>10.32.12.33</lan_ip>
414
+
415
+ <radio index="1">
416
+
417
+ <channel>6</channel>
418
+
419
+ <transmit_power>100%</transmit_power>
420
+
421
+ </radio>
422
+
423
+ <radio index="2">
424
+
425
+ <channel>60</channel>
426
+
427
+ <transmit_power>100%</transmit_power>
428
+
429
+ </radio>
430
+
431
+ </ap>
432
+
433
+ <ap id="21">
434
+
435
+ <name>District AP1</name>
436
+
437
+ <radio index="1">
438
+
439
+ <antenna>Left/Right</antenna>
440
+
441
+ <channel>11</channel>
442
+
443
+ <transmit_power>50 mW</transmit_power>
444
+
445
+ </radio>
446
+
447
+ </ap>
448
+
449
+ </amp_ap_update>
450
+ required: true
451
+ responses:
452
+ '200':
453
+ description: ''
454
+ headers: {}
455
+ content: {}
456
+ deprecated: false
457
+ /guest_user_api:
458
+ post:
459
+ tags:
460
+ - Configuration API's
461
+ summary: GuestUser:CreateUser
462
+ description: >-
463
+ URL: https://{{host}}/guest_user_api
464
+
465
+ Parameters: None.
466
+
467
+ The guest user API will accept either requests with a Content-Type of application/x-www-form-urlencoded or text/xml. Requests with Content-Type application/x-www-form-urlencoded must submit the url encoded XML data in a parameter named 'xml'.
468
+ operationId: GuestUser:CreateUser
469
+ parameters:
470
+ - name: X-BISCOTTI
471
+ in: header
472
+ description: ''
473
+ required: true
474
+ style: simple
475
+ schema:
476
+ type: string
477
+ example: '{{session_token}}'
478
+ requestBody:
479
+ description: ''
480
+ content:
481
+ text/plain:
482
+ schema: {}
483
+ required: true
484
+ responses:
485
+ '200':
486
+ description: ''
487
+ headers: {}
488
+ content: {}
489
+ deprecated: false
490
+ /template_variable_api:
491
+ post:
492
+ tags:
493
+ - Configuration API's
494
+ summary: ModifyTemplateVariables
495
+ description: >-
496
+ URL: https://{{host}}/template_variable_api
497
+
498
+ Parameters: None.
499
+
500
+ The modify template variable API will accept either requests with a Content-Type of application/x-www-form-urlencoded or text/xml. Requests with Content-Type application/x-www-form-urlencoded must submit the url encoded XML data in a parameter named 'xml'.
501
+ operationId: ModifyTemplateVariables
502
+ parameters:
503
+ - name: Content-Type
504
+ in: header
505
+ description: ''
506
+ required: true
507
+ style: simple
508
+ schema:
509
+ enum:
510
+ - application/xml
511
+ type: string
512
+ - name: X-BISCOTTI
513
+ in: header
514
+ description: ''
515
+ required: true
516
+ style: simple
517
+ schema:
518
+ type: string
519
+ example: '{{session_token}}'
520
+ requestBody:
521
+ description: ''
522
+ content:
523
+ application/xml:
524
+ schema:
525
+ allOf:
526
+ - $ref: '#/components/schemas/amp_template_variable_update'
527
+ - xml:
528
+ name: amp_template_variable_update
529
+ attribute: false
530
+ wrapped: false
531
+ example: >-
532
+ <amp_template_variable_update version="1">
533
+
534
+ <ap id="4370">
535
+
536
+ <custom_variable_9>Malayo-javanese-Hydrocotyle</custom_variable_9>
537
+
538
+ <swarm_radius_servers>10.250.244.121,10.14.112.234</swarm_radius_servers>
539
+
540
+ <prefer_master>1</prefer_master>
541
+
542
+ <custom_variable_1>Goerke-bristling</custom_variable_1>
543
+
544
+ <pppoe_username>patrol-mutuel</pppoe_username>
545
+
546
+ <instant_networking_mode>1</instant_networking_mode>
547
+
548
+ <zone_name>Beta Sales, Inc</zone_name>
549
+
550
+ </ap>
551
+
552
+ <ap id="4371">
553
+
554
+ <custom_variable_9>Malayo-javanese-Hydrocotyle</custom_variable_9>
555
+
556
+ <swarm_radius_servers>10.250.244.121,10.14.112.234</swarm_radius_servers>
557
+
558
+ <prefer_master>1</prefer_master>
559
+
560
+ <custom_variable_1>Goerke-bristling</custom_variable_1>
561
+
562
+ <pppoe_username>patrol-mutuel</pppoe_username>
563
+
564
+ <instant_networking_mode>1</instant_networking_mode>
565
+
566
+ <zone_name>Beta Sales, Inc</zone_name>
567
+
568
+ </ap>
569
+
570
+ </amp_template_variable_update>
571
+ example: >-
572
+ <amp_template_variable_update version="1">
573
+
574
+ <ap id="4370">
575
+
576
+ <custom_variable_9>Malayo-javanese-Hydrocotyle</custom_variable_9>
577
+
578
+ <swarm_radius_servers>10.250.244.121,10.14.112.234</swarm_radius_servers>
579
+
580
+ <prefer_master>1</prefer_master>
581
+
582
+ <custom_variable_1>Goerke-bristling</custom_variable_1>
583
+
584
+ <pppoe_username>patrol-mutuel</pppoe_username>
585
+
586
+ <instant_networking_mode>1</instant_networking_mode>
587
+
588
+ <zone_name>Beta Sales, Inc</zone_name>
589
+
590
+ </ap>
591
+
592
+ <ap id="4371">
593
+
594
+ <custom_variable_9>Malayo-javanese-Hydrocotyle</custom_variable_9>
595
+
596
+ <swarm_radius_servers>10.250.244.121,10.14.112.234</swarm_radius_servers>
597
+
598
+ <prefer_master>1</prefer_master>
599
+
600
+ <custom_variable_1>Goerke-bristling</custom_variable_1>
601
+
602
+ <pppoe_username>patrol-mutuel</pppoe_username>
603
+
604
+ <instant_networking_mode>1</instant_networking_mode>
605
+
606
+ <zone_name>Beta Sales, Inc</zone_name>
607
+
608
+ </ap>
609
+
610
+ </amp_template_variable_update>
611
+ required: true
612
+ responses:
613
+ '200':
614
+ description: ''
615
+ headers: {}
616
+ content: {}
617
+ deprecated: false
618
+ /api/ap_whitelist_upload:
619
+ post:
620
+ tags:
621
+ - Configuration API's
622
+ summary: ImportAPWhitelist
623
+ description: >-
624
+ URL: https://{{host}}/api/ap_whitelist_upload
625
+
626
+ Parameters:
627
+
628
+ csv - AP whitelist in csv format
629
+
630
+ append_whitelist - 0: Replace the whole list 1: Update list without removing
631
+ operationId: ImportAPWhitelist
632
+ parameters:
633
+ - name: append_whitelist
634
+ in: query
635
+ description: ''
636
+ required: true
637
+ style: form
638
+ explode: true
639
+ schema:
640
+ type: integer
641
+ format: int32
642
+ example: 1
643
+ - name: Content-Type
644
+ in: header
645
+ description: ''
646
+ required: true
647
+ style: simple
648
+ schema:
649
+ enum:
650
+ - application/xml
651
+ type: string
652
+ - name: X-BISCOTTI
653
+ in: header
654
+ description: ''
655
+ required: true
656
+ style: simple
657
+ schema:
658
+ type: string
659
+ example: '{{session_token}}'
660
+ requestBody:
661
+ description: ''
662
+ content:
663
+ application/xml:
664
+ schema:
665
+ type: string
666
+ xml:
667
+ name: Body
668
+ attribute: false
669
+ wrapped: false
670
+ required: true
671
+ responses:
672
+ '200':
673
+ description: ''
674
+ headers: {}
675
+ content: {}
676
+ deprecated: false
677
+ /deauthenticate_user.xml:
678
+ get:
679
+ tags:
680
+ - Configuration API's
681
+ summary: DeauthenticateClient
682
+ description: "URL: https://{{host}}/deauthenticate_user.xml\r\nParameters: mac - client MAC address\r\nThe MAC addresses must correspond to clients who are connected to a device which supports this operation; the device must be in \"Manage Read/Write\" mode, and editable by the user making the request. \r\nExample URL: https://{{host}}/deauthenticate_user.xml?mac=88:88:B3:93:7D:0D&mac=88:88:B3:ED:FD:C3"
683
+ operationId: DeauthenticateClient
684
+ parameters:
685
+ - name: mac
686
+ in: query
687
+ description: ''
688
+ required: true
689
+ style: form
690
+ explode: true
691
+ schema:
692
+ type: string
693
+ example: 88:88:B3:93:7D:0D
694
+ responses:
695
+ '200':
696
+ description: ''
697
+ headers: {}
698
+ content: {}
699
+ deprecated: false
700
+ /down_status_message.xml:
701
+ get:
702
+ tags:
703
+ - Configuration API's
704
+ summary: DownStatusMessage
705
+ description: >-
706
+ URL: https://{{host}}/down_status_message.xml
707
+
708
+ Parameters:
709
+
710
+ At least one of:
711
+
712
+ ap_id - the database ID of a Device.
713
+
714
+ ap_group_id - the database ID of an AP Group. All Devices in the specified AP Group will be updated.
715
+
716
+ Either or both of:
717
+
718
+ down_status_message - the message to set on the specified devices.
719
+
720
+ auto_clear_down_status_message - whether to automatically clear the Down Status Message when the Device comes back up. Send 1 or 0 to toggle this behavior on and off.
721
+
722
+ The specified devices must be editable by the user making the request.
723
+
724
+ Example URL: https://{{host}}/down_status_message.xml?ap_id=1&ap_id=2&ap_group_id=27&down_status_message=Scheduled+maintenance+until+Friday+at+12pm&auto_clear_down_status_message=1
725
+ operationId: DownStatusMessage
726
+ parameters:
727
+ - name: ap_id
728
+ in: query
729
+ description: ''
730
+ required: true
731
+ style: form
732
+ explode: true
733
+ schema:
734
+ type: integer
735
+ format: int32
736
+ example: 1
737
+ - name: ap_group_id
738
+ in: query
739
+ description: ''
740
+ required: true
741
+ style: form
742
+ explode: true
743
+ schema:
744
+ type: integer
745
+ format: int32
746
+ example: 27
747
+ - name: down_status_message
748
+ in: query
749
+ description: ''
750
+ required: true
751
+ style: form
752
+ explode: true
753
+ schema:
754
+ type: string
755
+ example: Scheduled+maintenance+until+Friday+at+12pm
756
+ - name: auto_clear_down_status_message
757
+ in: query
758
+ description: ''
759
+ required: true
760
+ style: form
761
+ explode: true
762
+ schema:
763
+ type: integer
764
+ format: int32
765
+ example: 1
766
+ responses:
767
+ '200':
768
+ description: ''
769
+ headers: {}
770
+ content: {}
771
+ deprecated: false
772
+ /ap_search.xml:
773
+ get:
774
+ tags:
775
+ - Search API's
776
+ summary: APSearch
777
+ description: >-
778
+ URL: https://{{host}}/ap_search.xml
779
+
780
+ Parameters: query - search string
781
+
782
+ Example URL: https://{{host}}/ap_search.xml?query=00:40:96
783
+ operationId: APSearch
784
+ parameters:
785
+ - name: query
786
+ in: query
787
+ description: ''
788
+ required: true
789
+ style: form
790
+ explode: true
791
+ schema:
792
+ type: string
793
+ example: 00:40:96
794
+ responses:
795
+ '200':
796
+ description: ''
797
+ headers: {}
798
+ content: {}
799
+ deprecated: false
800
+ /client_search.xml:
801
+ get:
802
+ tags:
803
+ - Search API's
804
+ summary: ClientSearch
805
+ description: >-
806
+ URL: https://{{host}}/client_search.xml
807
+
808
+ Parameters: query - search string
809
+
810
+ Example URL: https://{{host}}/client_search.xml?query=8C:AB
811
+ operationId: ClientSearch
812
+ parameters:
813
+ - name: query
814
+ in: query
815
+ description: ''
816
+ required: true
817
+ style: form
818
+ explode: true
819
+ schema:
820
+ type: string
821
+ example: 8C:AB
822
+ responses:
823
+ '200':
824
+ description: ''
825
+ headers: {}
826
+ content: {}
827
+ deprecated: false
828
+ /vpn_user_search.xml:
829
+ get:
830
+ tags:
831
+ - Search API's
832
+ summary: VPNUserSearch
833
+ description: >-
834
+ URL: https://{{host}}/vpn_user_search.xml
835
+
836
+ Parameters: query - search string
837
+
838
+ Example URL: https://{{host}}/vpn_user_search.xml?query=lionizers
839
+ operationId: VPNUserSearch
840
+ parameters:
841
+ - name: query
842
+ in: query
843
+ description: ''
844
+ required: true
845
+ style: form
846
+ explode: true
847
+ schema:
848
+ type: string
849
+ example: lionizers
850
+ responses:
851
+ '200':
852
+ description: ''
853
+ headers: {}
854
+ content: {}
855
+ deprecated: false
856
+ /latest_report.xml:
857
+ get:
858
+ tags:
859
+ - Report API's
860
+ summary: LatestReport
861
+ description: "URL: https://{{host}}/latest_report.xml\r\nParameters:\r\n report_definition_id - Get it from the URL of a Report Definition Edit Page, ex. https://{{host}}/reports_definition?definitions_edit=1&id=42 "
862
+ operationId: LatestReport
863
+ parameters:
864
+ - name: definitions_edit
865
+ in: query
866
+ description: ''
867
+ required: true
868
+ style: form
869
+ explode: true
870
+ schema:
871
+ type: integer
872
+ format: int32
873
+ example: 1
874
+ - name: id
875
+ in: query
876
+ description: ''
877
+ required: true
878
+ style: form
879
+ explode: true
880
+ schema:
881
+ type: integer
882
+ format: int32
883
+ example: 42
884
+ responses:
885
+ '200':
886
+ description: ''
887
+ headers: {}
888
+ content: {}
889
+ deprecated: false
890
+ /api/batch_command_execute:
891
+ post:
892
+ tags:
893
+ - Batch Execute AP Commands API's
894
+ summary: BatchExecuteAPCommand
895
+ description: "URL: https://{{host}}/api/batch_command_execute\r\nParameters:\r\n cmds - Must provide the commands to execute. Multiple commands must be separated by enter or comma. \r\n cmd_type - Optional. Execute commands on ap type of selected. Valid value: thin_ap not_thin_ap (Other values or not provided is for all ap types). \r\n Optionally limit information returned to one or more APs by supplying AP IDs.\r\n Similarly, limit by AP folders, AP groups, and controllers by supplying their IDs.\r\nThe batch execute ap commands API will accept either requests with a Content-Type of application/x-www-form-urlencoded or text/xml. Requests with Content-Type application/x-www-form-urlencoded must submit the url encoded XML data in a parameter named 'xml'."
896
+ operationId: BatchExecuteAPCommand
897
+ parameters:
898
+ - name: Content-Type
899
+ in: header
900
+ description: ''
901
+ required: true
902
+ style: simple
903
+ schema:
904
+ enum:
905
+ - application/xml
906
+ type: string
907
+ - name: X-BISCOTTI
908
+ in: header
909
+ description: ''
910
+ required: true
911
+ style: simple
912
+ schema:
913
+ type: string
914
+ example: '{{session_token}}'
915
+ requestBody:
916
+ description: ''
917
+ content:
918
+ application/xml:
919
+ schema:
920
+ allOf:
921
+ - $ref: '#/components/schemas/amp_batch_command_execute'
922
+ - xml:
923
+ name: amp_batch_command_execute
924
+ attribute: false
925
+ wrapped: false
926
+ required: true
927
+ responses:
928
+ '200':
929
+ description: ''
930
+ headers: {}
931
+ content: {}
932
+ deprecated: false
933
+ /api/batch_command_execute_result:
934
+ get:
935
+ tags:
936
+ - Batch Execute AP Commands API's
937
+ summary: BatchExecuteAPCommandResult
938
+ description: >-
939
+ URL: https://{{host}}/api/batch_command_execute_result
940
+
941
+ Parameters: None
942
+ operationId: BatchExecuteAPCommandResult
943
+ parameters: []
944
+ responses:
945
+ '200':
946
+ description: ''
947
+ headers: {}
948
+ content: {}
949
+ deprecated: false
950
+ /LOGIN:
951
+ post:
952
+ summary: AMP:Login
953
+ description: Login to Airwave Appliance
954
+ operationId: AMP:Login
955
+ parameters:
956
+ - name: Content-Type
957
+ in: header
958
+ description: ''
959
+ required: true
960
+ style: simple
961
+ schema:
962
+ enum:
963
+ - application/x-www-form-urlencoded
964
+ type: string
965
+ example: application/x-www-form-urlencoded
966
+ requestBody:
967
+ content:
968
+ application/x-www-form-urlencoded:
969
+ encoding: {}
970
+ schema:
971
+ required:
972
+ - credential_0
973
+ - credential_1
974
+ - destination
975
+ type: object
976
+ properties:
977
+ credential_0:
978
+ type: string
979
+ example: apiadmin
980
+ credential_1:
981
+ type: string
982
+ example: Aruba123!
983
+ destination:
984
+ type: string
985
+ example: /api
986
+ required: false
987
+ responses:
988
+ '200':
989
+ description: ''
990
+ headers: {}
991
+ content: {}
992
+ deprecated: false
993
+ components:
994
+ schemas:
995
+ amp_ap_update:
996
+ title: amp_ap_update
997
+ required:
998
+ - version
999
+ - ap
1000
+ type: object
1001
+ properties:
1002
+ version:
1003
+ type: integer
1004
+ format: int32
1005
+ xml:
1006
+ name: version
1007
+ attribute: true
1008
+ wrapped: false
1009
+ ap:
1010
+ type: array
1011
+ items:
1012
+ $ref: '#/components/schemas/ap'
1013
+ description: ''
1014
+ xml:
1015
+ namespace: ''
1016
+ attribute: false
1017
+ wrapped: false
1018
+ xml:
1019
+ name: amp_ap_update
1020
+ namespace: ''
1021
+ attribute: false
1022
+ wrapped: false
1023
+ ap:
1024
+ title: ap
1025
+ required:
1026
+ - name
1027
+ - radio
1028
+ type: object
1029
+ properties:
1030
+ id:
1031
+ type: integer
1032
+ format: int32
1033
+ xml:
1034
+ name: id
1035
+ attribute: true
1036
+ wrapped: false
1037
+ name:
1038
+ type: string
1039
+ xml:
1040
+ name: name
1041
+ namespace: ''
1042
+ attribute: false
1043
+ wrapped: false
1044
+ lan_ip:
1045
+ type: string
1046
+ xml:
1047
+ name: lan_ip
1048
+ namespace: ''
1049
+ attribute: false
1050
+ wrapped: false
1051
+ radio:
1052
+ type: array
1053
+ items:
1054
+ $ref: '#/components/schemas/radio'
1055
+ description: ''
1056
+ xml:
1057
+ namespace: ''
1058
+ attribute: false
1059
+ wrapped: false
1060
+ xml:
1061
+ name: ap
1062
+ namespace: ''
1063
+ attribute: false
1064
+ wrapped: false
1065
+ radio:
1066
+ title: radio
1067
+ required:
1068
+ - channel
1069
+ - transmit_power
1070
+ type: object
1071
+ properties:
1072
+ index:
1073
+ type: integer
1074
+ format: int32
1075
+ xml:
1076
+ name: index
1077
+ attribute: true
1078
+ wrapped: false
1079
+ channel:
1080
+ type: integer
1081
+ format: int32
1082
+ xml:
1083
+ name: channel
1084
+ namespace: ''
1085
+ attribute: false
1086
+ wrapped: false
1087
+ transmit_power:
1088
+ type: string
1089
+ xml:
1090
+ name: transmit_power
1091
+ namespace: ''
1092
+ attribute: false
1093
+ wrapped: false
1094
+ antenna:
1095
+ type: string
1096
+ xml:
1097
+ name: antenna
1098
+ namespace: ''
1099
+ attribute: false
1100
+ wrapped: false
1101
+ xml:
1102
+ name: radio
1103
+ namespace: ''
1104
+ attribute: false
1105
+ wrapped: false
1106
+ amp_template_variable_update:
1107
+ title: amp_template_variable_update
1108
+ required:
1109
+ - version
1110
+ - ap
1111
+ type: object
1112
+ properties:
1113
+ version:
1114
+ type: integer
1115
+ format: int32
1116
+ xml:
1117
+ name: version
1118
+ attribute: true
1119
+ wrapped: false
1120
+ ap:
1121
+ type: array
1122
+ items:
1123
+ $ref: '#/components/schemas/ap1'
1124
+ description: ''
1125
+ xml:
1126
+ namespace: ''
1127
+ attribute: false
1128
+ wrapped: false
1129
+ xml:
1130
+ name: amp_template_variable_update
1131
+ namespace: ''
1132
+ attribute: false
1133
+ wrapped: false
1134
+ ap1:
1135
+ title: ap1
1136
+ required:
1137
+ - custom_variable_9
1138
+ - swarm_radius_servers
1139
+ - prefer_master
1140
+ - custom_variable_1
1141
+ - pppoe_username
1142
+ - instant_networking_mode
1143
+ - zone_name
1144
+ type: object
1145
+ properties:
1146
+ id:
1147
+ type: integer
1148
+ format: int32
1149
+ xml:
1150
+ name: id
1151
+ attribute: true
1152
+ wrapped: false
1153
+ custom_variable_9:
1154
+ type: string
1155
+ xml:
1156
+ name: custom_variable_9
1157
+ namespace: ''
1158
+ attribute: false
1159
+ wrapped: false
1160
+ swarm_radius_servers:
1161
+ type: string
1162
+ xml:
1163
+ name: swarm_radius_servers
1164
+ namespace: ''
1165
+ attribute: false
1166
+ wrapped: false
1167
+ prefer_master:
1168
+ type: integer
1169
+ format: int32
1170
+ xml:
1171
+ name: prefer_master
1172
+ namespace: ''
1173
+ attribute: false
1174
+ wrapped: false
1175
+ custom_variable_1:
1176
+ type: string
1177
+ xml:
1178
+ name: custom_variable_1
1179
+ namespace: ''
1180
+ attribute: false
1181
+ wrapped: false
1182
+ pppoe_username:
1183
+ type: string
1184
+ xml:
1185
+ name: pppoe_username
1186
+ namespace: ''
1187
+ attribute: false
1188
+ wrapped: false
1189
+ instant_networking_mode:
1190
+ type: integer
1191
+ format: int32
1192
+ xml:
1193
+ name: instant_networking_mode
1194
+ namespace: ''
1195
+ attribute: false
1196
+ wrapped: false
1197
+ zone_name:
1198
+ type: string
1199
+ xml:
1200
+ name: zone_name
1201
+ namespace: ''
1202
+ attribute: false
1203
+ wrapped: false
1204
+ xml:
1205
+ name: ap
1206
+ namespace: ''
1207
+ attribute: false
1208
+ wrapped: false
1209
+ amp_batch_command_execute:
1210
+ title: amp_batch_command_execute
1211
+ required:
1212
+ - version
1213
+ - cmds
1214
+ - cmd_type
1215
+ - ap
1216
+ type: object
1217
+ properties:
1218
+ version:
1219
+ type: integer
1220
+ format: int32
1221
+ xml:
1222
+ name: version
1223
+ attribute: true
1224
+ wrapped: false
1225
+ cmds:
1226
+ type: string
1227
+ xml:
1228
+ name: cmds
1229
+ attribute: true
1230
+ wrapped: false
1231
+ cmd_type:
1232
+ type: string
1233
+ xml:
1234
+ name: cmd_type
1235
+ attribute: true
1236
+ wrapped: false
1237
+ ap:
1238
+ type: array
1239
+ items:
1240
+ $ref: '#/components/schemas/ap2'
1241
+ description: ''
1242
+ xml:
1243
+ namespace: ''
1244
+ attribute: false
1245
+ wrapped: false
1246
+ xml:
1247
+ name: amp_batch_command_execute
1248
+ namespace: ''
1249
+ attribute: false
1250
+ wrapped: false
1251
+ ap2:
1252
+ title: ap2
1253
+ required:
1254
+ - id
1255
+ type: object
1256
+ properties:
1257
+ id:
1258
+ type: integer
1259
+ format: int32
1260
+ xml:
1261
+ name: id
1262
+ attribute: true
1263
+ wrapped: false
1264
+ controller_id:
1265
+ type: integer
1266
+ format: int32
1267
+ xml:
1268
+ name: controller_id
1269
+ attribute: true
1270
+ wrapped: false
1271
+ ap_group_id:
1272
+ type: integer
1273
+ format: int32
1274
+ xml:
1275
+ name: ap_group_id
1276
+ attribute: true
1277
+ wrapped: false
1278
+ ap_folder_id:
1279
+ type: integer
1280
+ format: int32
1281
+ xml:
1282
+ name: ap_folder_id
1283
+ attribute: true
1284
+ wrapped: false
1285
+ xml:
1286
+ name: ap
1287
+ namespace: ''
1288
+ attribute: false
1289
+ wrapped: false
1290
+ tags:
1291
+ - name: Query API's
1292
+ description: ''
1293
+ - name: Configuration API's
1294
+ description: ''
1295
+ - name: Search API's
1296
+ description: ''
1297
+ - name: Report API's
1298
+ description: ''
1299
+ - name: Batch Execute AP Commands API's
1300
+ description: ''