@itentialopensource/adapter-aruba_central 0.1.1 → 0.1.2
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.
- package/CALLS.md +2112 -0
- package/CHANGELOG.md +8 -1
- package/package.json +1 -1
- package/refs?service=git-upload-pack +0 -0
- package/report/adapterInfo.json +10 -0
- package/adapter_modifications/README.md +0 -59
- package/adapter_modifications/specificCallScript.js +0 -97
- package/adapter_modifications/update.js +0 -532
- package/adapter_modifications/updateFiles/components/adapter.js +0 -164
- package/adapter_modifications/updateFiles/components/entities/Installers/action.json +0 -22
- package/adapter_modifications/updateFiles/components/entities/Installers/mockdatafiles/mockdata.json +0 -1
- package/adapter_modifications/updateFiles/components/entities/Installers/schema.json +0 -20
- package/adapter_modifications/updateFiles/components/entities/Sites/action.json +0 -22
- package/adapter_modifications/updateFiles/components/entities/Sites/mockdatafiles/mockdata.json +0 -1
- package/adapter_modifications/updateFiles/components/entities/Sites/schema.json +0 -20
- package/adapter_modifications/updateFiles/components/methods.json +0 -204
- package/adapter_modifications/updateFiles/components/pronghorn.json +0 -77
- package/adapter_modifications/updateFiles/components/test/integration/adapterTestIntegration.js +0 -76
- package/adapter_modifications/updateFiles/components/test/unit/adapterTestUnit.js +0 -58
- package/updatePackage.zip +0 -0
- package/versions.json +0 -257
package/CALLS.md
CHANGED
|
@@ -166,5 +166,2117 @@ Specific adapter calls are built based on the API of the Aruba_central. The Adap
|
|
|
166
166
|
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
|
|
167
167
|
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
|
|
168
168
|
</tr>
|
|
169
|
+
<tr>
|
|
170
|
+
<td style="padding:15px">apiExternalControllerGetNetworksV2(group, swarmId, label, site, calculateClientCount, sort, callback)</td>
|
|
171
|
+
<td style="padding:15px">Get a list of networks. You can only specify one of group, swarm_id, label, site parameters.
|
|
172
|
+
Possible error_codes for the error responses are
|
|
173
|
+
1. 0001 - General Error.
|
|
174
|
+
2. 0003 - Validation Error. Unsupported query combination
|
|
175
|
+
3. 0004 - Validation Error. Invalid value for a query parameter</td>
|
|
176
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v2/networks?{query}</td>
|
|
177
|
+
<td style="padding:15px">Yes</td>
|
|
178
|
+
</tr>
|
|
179
|
+
<tr>
|
|
180
|
+
<td style="padding:15px">apiExternalControllerGetNetworkV2(networkName, group, swarmId, label, site, callback)</td>
|
|
181
|
+
<td style="padding:15px">Get Network details
|
|
182
|
+
Possible error_codes for the error responses are
|
|
183
|
+
1. 0003 - Validation Error. Unsupported query combination</td>
|
|
184
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v2/networks/{pathv1}?{query}</td>
|
|
185
|
+
<td style="padding:15px">Yes</td>
|
|
186
|
+
</tr>
|
|
187
|
+
<tr>
|
|
188
|
+
<td style="padding:15px">apiExternalControllerGetNetworksBandwidthUsageV2(network, group, swarmId, label, fromTimestamp, toTimestamp, site, callback)</td>
|
|
189
|
+
<td style="padding:15px">Get WLAN network bandwidth usage over a time period. You can only specify one of group, swarm_id, label, site parameters.
|
|
190
|
+
Possible error_codes for the error responses are
|
|
191
|
+
1. 0001 - General Error.
|
|
192
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
193
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
194
|
+
4. 0005 - Validation Error. Missing required parameter.</td>
|
|
195
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v2/networks/bandwidth_usage?{query}</td>
|
|
196
|
+
<td style="padding:15px">Yes</td>
|
|
197
|
+
</tr>
|
|
198
|
+
<tr>
|
|
199
|
+
<td style="padding:15px">apiExternalControllerGetApsV2(group, swarmId, label, site, status, serial, macaddr, model, clusterId, fields, calculateTotal, calculateClientCount, calculateSsidCount, showResourceDetails, offset, limit, sort, callback)</td>
|
|
200
|
+
<td style="padding:15px">Get access points. You can only specify one of group, swarm_id, label, site parameters.
|
|
201
|
+
Possible error_codes for the error responses are
|
|
202
|
+
1. 0001 - General Error.
|
|
203
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
204
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
205
|
+
4. 0004 - Validation Error. Invalid value for a query parameter</td>
|
|
206
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v2/aps?{query}</td>
|
|
207
|
+
<td style="padding:15px">Yes</td>
|
|
208
|
+
</tr>
|
|
209
|
+
<tr>
|
|
210
|
+
<td style="padding:15px">apiExternalControllerGetBssidsV2(group, swarmId, label, site, serial, macaddr, clusterId, calculateTotal, offset, limit, sort, callback)</td>
|
|
211
|
+
<td style="padding:15px">Get a list of BSSIDs. You can only specify one of group, swarm_id, label, serial, macaddr, site parameters
|
|
212
|
+
Possible error_codes for the error responses are
|
|
213
|
+
1. 0001 - General Error.
|
|
214
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
215
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
216
|
+
4. 0004 - Validation Error. Invalid value for a query parameter
|
|
217
|
+
5. 0006 - Internal data Error.</td>
|
|
218
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v2/bssids?{query}</td>
|
|
219
|
+
<td style="padding:15px">Yes</td>
|
|
220
|
+
</tr>
|
|
221
|
+
<tr>
|
|
222
|
+
<td style="padding:15px">apiExternalControllerGetAp(serial, callback)</td>
|
|
223
|
+
<td style="padding:15px">Get AP details</td>
|
|
224
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/aps/{pathv1}?{query}</td>
|
|
225
|
+
<td style="padding:15px">Yes</td>
|
|
226
|
+
</tr>
|
|
227
|
+
<tr>
|
|
228
|
+
<td style="padding:15px">apiExternalControllerDeleteAp(serial, callback)</td>
|
|
229
|
+
<td style="padding:15px">Delete AP</td>
|
|
230
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/aps/{pathv1}?{query}</td>
|
|
231
|
+
<td style="padding:15px">Yes</td>
|
|
232
|
+
</tr>
|
|
233
|
+
<tr>
|
|
234
|
+
<td style="padding:15px">apiExternalControllerGetApRfSummaryV3(serial, band, radioNumber, fromTimestamp, toTimestamp, callback)</td>
|
|
235
|
+
<td style="padding:15px">Get AP RF summary of channel utilization, noise floor in negative, errors, drops and
|
|
236
|
+
retries over a time period.
|
|
237
|
+
Possible error_codes for the error responses are
|
|
238
|
+
1. 0001 - General Error.
|
|
239
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
240
|
+
3. 0004 - Validation Error. Invalid value for a query parameter
|
|
241
|
+
4. 0005 - Validation Error. Missing required query parameter</td>
|
|
242
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v3/aps/{pathv1}/rf_summary?{query}</td>
|
|
243
|
+
<td style="padding:15px">Yes</td>
|
|
244
|
+
</tr>
|
|
245
|
+
<tr>
|
|
246
|
+
<td style="padding:15px">apiExternalControllerGetApsBandwidthUsageV3(group, swarmId, label, site, serial, clusterId, interval, band, radioNumber, ethernetInterfaceIndex, network, fromTimestamp, toTimestamp, callback)</td>
|
|
247
|
+
<td style="padding:15px">Get access points bandwidth usage over a time period. You can only specify one of group, swarm_id, label,
|
|
248
|
+
serial, cluster_id, site parameters.
|
|
249
|
+
Possible error_codes for the error responses are
|
|
250
|
+
1. 0001 - General Error.
|
|
251
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
252
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
253
|
+
4. 0004 - Validation Error. Invalid value for a query parameter
|
|
254
|
+
5. 0005 - Validation Error. Missing required parameter.</td>
|
|
255
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v3/aps/bandwidth_usage?{query}</td>
|
|
256
|
+
<td style="padding:15px">Yes</td>
|
|
257
|
+
</tr>
|
|
258
|
+
<tr>
|
|
259
|
+
<td style="padding:15px">apiExternalControllerGetApsBandwidthUsageTopnV2(group, swarmId, label, site, clusterId, count, fromTimestamp, toTimestamp, callback)</td>
|
|
260
|
+
<td style="padding:15px">Get top N AP details over a time period. You can only specify one of group, swarm_id, label, cluster_id, site parameters.
|
|
261
|
+
Possible error_codes for the error responses are
|
|
262
|
+
1. 0001 - General Error.
|
|
263
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
264
|
+
3. 0003 - Validation Error. Unsupported query combination</td>
|
|
265
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v2/aps/bandwidth_usage/topn?{query}</td>
|
|
266
|
+
<td style="padding:15px">Yes</td>
|
|
267
|
+
</tr>
|
|
268
|
+
<tr>
|
|
269
|
+
<td style="padding:15px">apiExternalControllerGetSwarmsBandwidthUsageTopn(group, count, fromTimestamp, toTimestamp, callback)</td>
|
|
270
|
+
<td style="padding:15px">Get top N Swarm by bandwidth usage over a time period.
|
|
271
|
+
parameters.
|
|
272
|
+
Possible error_codes for the error responses are
|
|
273
|
+
1. 0001 - General Error.
|
|
274
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.</td>
|
|
275
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/swarms/bandwidth_usage/topn?{query}</td>
|
|
276
|
+
<td style="padding:15px">Yes</td>
|
|
277
|
+
</tr>
|
|
278
|
+
<tr>
|
|
279
|
+
<td style="padding:15px">apiExternalControllerGetSwarmsClientsCountTopn(group, count, fromTimestamp, toTimestamp, sort, callback)</td>
|
|
280
|
+
<td style="padding:15px">Get top N Swarm by clients count over a time period.
|
|
281
|
+
Possible error_codes for the error responses are
|
|
282
|
+
1. 0001 - General Error.
|
|
283
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.</td>
|
|
284
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/swarms/clients_count/topn?{query}</td>
|
|
285
|
+
<td style="padding:15px">Yes</td>
|
|
286
|
+
</tr>
|
|
287
|
+
<tr>
|
|
288
|
+
<td style="padding:15px">apiExternalControllerGetSwarms(group, status, publicIpAddress, fields, calculateTotal, offset, limit, sort, swarmName, callback)</td>
|
|
289
|
+
<td style="padding:15px">Get list of swarms. You can optionally specify a group to filter on groups.
|
|
290
|
+
Possible error_codes for the error responses are
|
|
291
|
+
1. 0001 - General Error.
|
|
292
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
293
|
+
3. 0004 - Validation Error. Invalid value for a query parameter</td>
|
|
294
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/swarms?{query}</td>
|
|
295
|
+
<td style="padding:15px">Yes</td>
|
|
296
|
+
</tr>
|
|
297
|
+
<tr>
|
|
298
|
+
<td style="padding:15px">apiExternalControllerGetSwarm(swarmId, callback)</td>
|
|
299
|
+
<td style="padding:15px">Get Swarm details</td>
|
|
300
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/swarms/{pathv1}?{query}</td>
|
|
301
|
+
<td style="padding:15px">Yes</td>
|
|
302
|
+
</tr>
|
|
303
|
+
<tr>
|
|
304
|
+
<td style="padding:15px">apiExternalControllerGetWirelessClients(group, swarmId, label, site, network, serial, osType, clusterId, band, fields, calculateTotal, offset, limit, sort, lastClientMac, callback)</td>
|
|
305
|
+
<td style="padding:15px">Get a list of wireless clients. You can only specify one of group, swarm_id, label parameters.
|
|
306
|
+
Possible error_codes for the error responses are
|
|
307
|
+
1. 0001 - General Error.
|
|
308
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
309
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
310
|
+
4. 0004 - Validation Error. Invalid value for a query parameter</td>
|
|
311
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/clients/wireless?{query}</td>
|
|
312
|
+
<td style="padding:15px">Yes</td>
|
|
313
|
+
</tr>
|
|
314
|
+
<tr>
|
|
315
|
+
<td style="padding:15px">apiExternalControllerGetWiredClients(group, swarmId, label, site, serial, clusterId, stackId, fields, calculateTotal, offset, limit, sort, lastClientMac, callback)</td>
|
|
316
|
+
<td style="padding:15px">Get a list of wired clients. You can only specify one of group, swarm_id, cluster_id, stack_id and
|
|
317
|
+
label parameters.
|
|
318
|
+
Possible error_codes for the error responses are
|
|
319
|
+
1. 0001 - General Error.
|
|
320
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
321
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
322
|
+
4. 0004 - Validation Error. Invalid value for a query parameter</td>
|
|
323
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/clients/wired?{query}</td>
|
|
324
|
+
<td style="padding:15px">Yes</td>
|
|
325
|
+
</tr>
|
|
326
|
+
<tr>
|
|
327
|
+
<td style="padding:15px">apiExternalControllerGetV2UnifiedClients(group, swarmId, label, site, network, serial, clusterId, band, stackId, osType, fields, calculateTotal, offset, limit, sort, lastClientMac, timerange = 3H, clientType = WIRELESS, clientStatus = CONNECTED, showUsage, showManufacturer, showSignalDb, callback)</td>
|
|
328
|
+
<td style="padding:15px">This is a unified form of List APIs /monitoring/v1/clients/wired and /monitoring/v1/clients/wireless and it is backward compatible with these v1 apis.
|
|
329
|
+
|
|
330
|
+
Get a list of unified clients. You can only specify one of group, swarm_id, cluster_id, network, site and
|
|
331
|
+
label parameters.
|
|
332
|
+
Possible error_codes for the error responses are
|
|
333
|
+
1. 0001 - General Error.
|
|
334
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
335
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
336
|
+
4. 0004 - Validation E...(description truncated)</td>
|
|
337
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v2/clients?{query}</td>
|
|
338
|
+
<td style="padding:15px">Yes</td>
|
|
339
|
+
</tr>
|
|
340
|
+
<tr>
|
|
341
|
+
<td style="padding:15px">apiExternalControllerGetV2UnifiedClientDetail(macaddr, callback)</td>
|
|
342
|
+
<td style="padding:15px">This is a unified form of Details APIs /monitoring/v1/clients/wired/{macaddr} and /monitoring/v1/clients/wireless/{macaddr} and it is backward compatible with these v1 apis.
|
|
343
|
+
|
|
344
|
+
Get wireless/wired client details</td>
|
|
345
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v2/clients/{pathv1}?{query}</td>
|
|
346
|
+
<td style="padding:15px">Yes</td>
|
|
347
|
+
</tr>
|
|
348
|
+
<tr>
|
|
349
|
+
<td style="padding:15px">apiExternalControllerGetWirelessClient(macaddr, callback)</td>
|
|
350
|
+
<td style="padding:15px">Get wireless client details</td>
|
|
351
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/clients/wireless/{pathv1}?{query}</td>
|
|
352
|
+
<td style="padding:15px">Yes</td>
|
|
353
|
+
</tr>
|
|
354
|
+
<tr>
|
|
355
|
+
<td style="padding:15px">apiExternalControllerGetWirelessClientMobility(macaddr, calculateTotal, offset, limit, fromTimestamp, toTimestamp, callback)</td>
|
|
356
|
+
<td style="padding:15px">Get wireless client mobility details
|
|
357
|
+
Possible error_code for the error response is
|
|
358
|
+
1. 0002 - Validation Error. Out of Range value for a query parameter.</td>
|
|
359
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/clients/wireless/{pathv1}/mobility_trail?{query}</td>
|
|
360
|
+
<td style="padding:15px">Yes</td>
|
|
361
|
+
</tr>
|
|
362
|
+
<tr>
|
|
363
|
+
<td style="padding:15px">apiExternalControllerGetWiredClient(macaddr, callback)</td>
|
|
364
|
+
<td style="padding:15px">Get wired client details</td>
|
|
365
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/clients/wired/{pathv1}?{query}</td>
|
|
366
|
+
<td style="padding:15px">Yes</td>
|
|
367
|
+
</tr>
|
|
368
|
+
<tr>
|
|
369
|
+
<td style="padding:15px">apiExternalControllerGetClientsBandwidthUsage(group, swarmId, label, clusterId, stackId, serial, macaddr, fromTimestamp, toTimestamp, callback)</td>
|
|
370
|
+
<td style="padding:15px">Get clients bandwidth usage over a time period. You can only specify one of group, swarm_id, label, cluster_id
|
|
371
|
+
and stack_id parameters.
|
|
372
|
+
Possible error_codes for the error responses are
|
|
373
|
+
1. 0001 - General Error.
|
|
374
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
375
|
+
3. 0003 - Validation Error. Unsupported query combination</td>
|
|
376
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/clients/bandwidth_usage?{query}</td>
|
|
377
|
+
<td style="padding:15px">Yes</td>
|
|
378
|
+
</tr>
|
|
379
|
+
<tr>
|
|
380
|
+
<td style="padding:15px">apiExternalControllerGetClientsBandwidthUsageTopn(group, swarmId, label, network, clusterId, stackId, count, fromTimestamp, toTimestamp, callback)</td>
|
|
381
|
+
<td style="padding:15px">Get top N client details over a time period. You can only specify one of group, swarm_id, label, cluster_id
|
|
382
|
+
and stack_id parameters.
|
|
383
|
+
Possible error_codes for the error responses are
|
|
384
|
+
1. 0001 - General Error.
|
|
385
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
386
|
+
3. 0003 - Validation Error. Unsupported query combination</td>
|
|
387
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/clients/bandwidth_usage/topn?{query}</td>
|
|
388
|
+
<td style="padding:15px">Yes</td>
|
|
389
|
+
</tr>
|
|
390
|
+
<tr>
|
|
391
|
+
<td style="padding:15px">apiExternalControllerGetClientsCount(group, swarmId, label, network, clusterId, stackId, deviceType, serial, band, radioNumber, fromTimestamp, toTimestamp, callback)</td>
|
|
392
|
+
<td style="padding:15px">Get the total clients connected
|
|
393
|
+
Possible error_codes for the error responses are
|
|
394
|
+
1. 0001 - General Error.
|
|
395
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
396
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
397
|
+
4. 0004 - Validation Error. Invalid value for a query parameter
|
|
398
|
+
5. 0005 - Validation Error. Missing required query parameter</td>
|
|
399
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/clients/count?{query}</td>
|
|
400
|
+
<td style="padding:15px">Yes</td>
|
|
401
|
+
</tr>
|
|
402
|
+
<tr>
|
|
403
|
+
<td style="padding:15px">apiExternalControllerGetVpnInfo(swarmId, callback)</td>
|
|
404
|
+
<td style="padding:15px">Get VPN details</td>
|
|
405
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/vpn/info?{query}</td>
|
|
406
|
+
<td style="padding:15px">Yes</td>
|
|
407
|
+
</tr>
|
|
408
|
+
<tr>
|
|
409
|
+
<td style="padding:15px">apiExternalControllerGetVpnUsageV3(body, callback)</td>
|
|
410
|
+
<td style="padding:15px">Get VPN usages per tunnel over a time period.
|
|
411
|
+
Possible error_codes for the error responses are
|
|
412
|
+
1. 0001 - General Error.
|
|
413
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
414
|
+
3. 0004 - Validation Error. Invalid value for a query parameter</td>
|
|
415
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v3/vpn/usage?{query}</td>
|
|
416
|
+
<td style="padding:15px">Yes</td>
|
|
417
|
+
</tr>
|
|
418
|
+
<tr>
|
|
419
|
+
<td style="padding:15px">apiExternalControllerGetMcs(group, label, site, status, macaddr, model, fields, calculateTotal, offset, limit, sort, callback)</td>
|
|
420
|
+
<td style="padding:15px">Get mobility controllers.
|
|
421
|
+
This API is deprecated and will be removed on 2022-06-30T00:00:00Z.
|
|
422
|
+
For cloud deployment, use /monitoring/v1/gateways.
|
|
423
|
+
For controller on-prem deployment, use /monitoring/v2/mobility_controllers.
|
|
424
|
+
You can only specify one of group, label parameters.
|
|
425
|
+
Possible error_codes for the error responses are
|
|
426
|
+
1. 0001 - General Error.
|
|
427
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
428
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
429
|
+
4. 0004 - Validation Err...(description truncated)</td>
|
|
430
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/mobility_controllers?{query}</td>
|
|
431
|
+
<td style="padding:15px">Yes</td>
|
|
432
|
+
</tr>
|
|
433
|
+
<tr>
|
|
434
|
+
<td style="padding:15px">apiExternalControllerGetMc(serial, statsMetric, callback)</td>
|
|
435
|
+
<td style="padding:15px">Get mobility controller details.
|
|
436
|
+
This API is deprecated and will be removed on 2022-06-30T00:00:00Z.
|
|
437
|
+
For cloud deployment, use /monitoring/v1/gateways/{serial}.
|
|
438
|
+
For controller on-prem deployment, use /monitoring/v2/mobility_controllers/{serial}.</td>
|
|
439
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/mobility_controllers/{pathv1}?{query}</td>
|
|
440
|
+
<td style="padding:15px">Yes</td>
|
|
441
|
+
</tr>
|
|
442
|
+
<tr>
|
|
443
|
+
<td style="padding:15px">apiExternalControllerDeleteMc(serial, callback)</td>
|
|
444
|
+
<td style="padding:15px">Delete mobility controller.
|
|
445
|
+
This API is deprecated and will be removed on 2022-06-30T00:00:00Z.
|
|
446
|
+
For cloud deployment, use /monitoring/v1/gateways/{serial}.
|
|
447
|
+
For controller on-prem deployment, use /monitoring/v2/mobility_controllers/{serial}.</td>
|
|
448
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/mobility_controllers/{pathv1}?{query}</td>
|
|
449
|
+
<td style="padding:15px">Yes</td>
|
|
450
|
+
</tr>
|
|
451
|
+
<tr>
|
|
452
|
+
<td style="padding:15px">apiExternalControllerGetMcPortsBandwidthUsage(serial, fromTimestamp, toTimestamp, port, callback)</td>
|
|
453
|
+
<td style="padding:15px">Get Mobility Controller ports bandwidth usage over a time period.
|
|
454
|
+
Possible error_codes for the error responses are
|
|
455
|
+
1. 0001 - General Error.
|
|
456
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.</td>
|
|
457
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/mobility_controllers/{pathv1}/ports/bandwidth_usage?{query}</td>
|
|
458
|
+
<td style="padding:15px">Yes</td>
|
|
459
|
+
</tr>
|
|
460
|
+
<tr>
|
|
461
|
+
<td style="padding:15px">apiExternalControllerGetMcPorts(serial, callback)</td>
|
|
462
|
+
<td style="padding:15px">Get mobility controllers ports details.
|
|
463
|
+
Possible error_codes for the error responses are
|
|
464
|
+
1. 0001 - General Error.</td>
|
|
465
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/mobility_controllers/{pathv1}/ports?{query}</td>
|
|
466
|
+
<td style="padding:15px">Yes</td>
|
|
467
|
+
</tr>
|
|
468
|
+
<tr>
|
|
469
|
+
<td style="padding:15px">apiExternalControllerGetVlanInfo(serial, callback)</td>
|
|
470
|
+
<td style="padding:15px">Get mobility controller's VLAN information.
|
|
471
|
+
Possible error_codes for the error responses are
|
|
472
|
+
1. 0001 - General Error.</td>
|
|
473
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/mobility_controllers/{pathv1}/vlan?{query}</td>
|
|
474
|
+
<td style="padding:15px">Yes</td>
|
|
475
|
+
</tr>
|
|
476
|
+
<tr>
|
|
477
|
+
<td style="padding:15px">apiExternalControllerGetMcsV2(group, label, site, status, macaddr, model, fields, calculateTotal, offset, limit, sort, callback)</td>
|
|
478
|
+
<td style="padding:15px">Get mobility controllers.
|
|
479
|
+
For cloud deployment, use /monitoring/v1/gateways/{serial}.
|
|
480
|
+
You can only specify one of group, label parameters.
|
|
481
|
+
Possible error_codes for the error responses are
|
|
482
|
+
1. 0001 - General Error.
|
|
483
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
484
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
485
|
+
4. 0004 - Validation Error. Invalid value for a query parameter</td>
|
|
486
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v2/mobility_controllers?{query}</td>
|
|
487
|
+
<td style="padding:15px">Yes</td>
|
|
488
|
+
</tr>
|
|
489
|
+
<tr>
|
|
490
|
+
<td style="padding:15px">apiExternalControllerGetMcV2(serial, statsMetric, callback)</td>
|
|
491
|
+
<td style="padding:15px">Get mobility controller details.
|
|
492
|
+
For cloud deployment, use /monitoring/v1/gateways/{serial}.</td>
|
|
493
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v2/mobility_controllers/{pathv1}?{query}</td>
|
|
494
|
+
<td style="padding:15px">Yes</td>
|
|
495
|
+
</tr>
|
|
496
|
+
<tr>
|
|
497
|
+
<td style="padding:15px">apiExternalControllerDeleteMcV2(serial, callback)</td>
|
|
498
|
+
<td style="padding:15px">Delete mobility controller.
|
|
499
|
+
For cloud deployment, use /monitoring/v1/gateways/{serial}.</td>
|
|
500
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v2/mobility_controllers/{pathv1}?{query}</td>
|
|
501
|
+
<td style="padding:15px">Yes</td>
|
|
502
|
+
</tr>
|
|
503
|
+
<tr>
|
|
504
|
+
<td style="padding:15px">apiExternalControllerGetGateways(group, label, site, status, macaddr, model, fields, calculateTotal, offset, limit, sort, callback)</td>
|
|
505
|
+
<td style="padding:15px">Get gateways. You can only specify one of group, label parameters.
|
|
506
|
+
Possible error_codes for the error responses are
|
|
507
|
+
1. 0001 - General Error.
|
|
508
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
509
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
510
|
+
4. 0004 - Validation Error. Invalid value for a query parameter</td>
|
|
511
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/gateways?{query}</td>
|
|
512
|
+
<td style="padding:15px">Yes</td>
|
|
513
|
+
</tr>
|
|
514
|
+
<tr>
|
|
515
|
+
<td style="padding:15px">apiExternalControllerGetGateway(serial, statsMetric, callback)</td>
|
|
516
|
+
<td style="padding:15px">Get gateway details</td>
|
|
517
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/gateways/{pathv1}?{query}</td>
|
|
518
|
+
<td style="padding:15px">Yes</td>
|
|
519
|
+
</tr>
|
|
520
|
+
<tr>
|
|
521
|
+
<td style="padding:15px">apiExternalControllerDeleteGateway(serial, callback)</td>
|
|
522
|
+
<td style="padding:15px">Delete gateway</td>
|
|
523
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/gateways/{pathv1}?{query}</td>
|
|
524
|
+
<td style="padding:15px">Yes</td>
|
|
525
|
+
</tr>
|
|
526
|
+
<tr>
|
|
527
|
+
<td style="padding:15px">apiExternalControllerGetGatewayUplinksDetail(serial, timerange = 3H, callback)</td>
|
|
528
|
+
<td style="padding:15px">Get gateway uplink details.</td>
|
|
529
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/gateways/{pathv1}/uplinks?{query}</td>
|
|
530
|
+
<td style="padding:15px">Yes</td>
|
|
531
|
+
</tr>
|
|
532
|
+
<tr>
|
|
533
|
+
<td style="padding:15px">apiExternalControllerGetGatewayUplinksBandwidthUsage(serial, uplinkId, interval, fromTimestamp, toTimestamp, callback)</td>
|
|
534
|
+
<td style="padding:15px">Get gateway uplink bandwidth usage over a time period.</td>
|
|
535
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/gateways/{pathv1}/uplinks/bandwidth_usage?{query}</td>
|
|
536
|
+
<td style="padding:15px">Yes</td>
|
|
537
|
+
</tr>
|
|
538
|
+
<tr>
|
|
539
|
+
<td style="padding:15px">apiExternalControllerGetGatewayUplinksTunnelStats(serial, uplinkId, mapName, interval, fromTimestamp, toTimestamp, callback)</td>
|
|
540
|
+
<td style="padding:15px">Get gateway uplink tunnel stats over a time period for a particular gateway.
|
|
541
|
+
Possible error_codes for the error responses are
|
|
542
|
+
1. 0001 - General Error.
|
|
543
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
544
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
545
|
+
4. 0004 - Validation Error. Invalid value for a query parameter
|
|
546
|
+
5. 0005 - Validation Error. Missing required parameter.</td>
|
|
547
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/gateways/{pathv1}/tunnels/stats?{query}</td>
|
|
548
|
+
<td style="padding:15px">Yes</td>
|
|
549
|
+
</tr>
|
|
550
|
+
<tr>
|
|
551
|
+
<td style="padding:15px">apiExternalControllerGetGatewayUplinksWanCompressionUsage(serial, uplinkId, interval, fromTimestamp, toTimestamp, callback)</td>
|
|
552
|
+
<td style="padding:15px">Get Gateway WAN compression stats over a time period.</td>
|
|
553
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/gateways/{pathv1}/uplinks/wan_compression_stats?{query}</td>
|
|
554
|
+
<td style="padding:15px">Yes</td>
|
|
555
|
+
</tr>
|
|
556
|
+
<tr>
|
|
557
|
+
<td style="padding:15px">apiExternalControllerGetGatewayUplinksDistribution(serial, callback)</td>
|
|
558
|
+
<td style="padding:15px">Get gateway uplinks distribution.</td>
|
|
559
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/gateways/{pathv1}/uplinks/distribution?{query}</td>
|
|
560
|
+
<td style="padding:15px">Yes</td>
|
|
561
|
+
</tr>
|
|
562
|
+
<tr>
|
|
563
|
+
<td style="padding:15px">apiExternalControllerGetGatewayPortsBandwidthUsage(serial, fromTimestamp, toTimestamp, port, callback)</td>
|
|
564
|
+
<td style="padding:15px">Get Gateway ports bandwidth usage over a time period.
|
|
565
|
+
Possible error_codes for the error responses are
|
|
566
|
+
1. 0001 - General Error.
|
|
567
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.</td>
|
|
568
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/gateways/{pathv1}/ports/bandwidth_usage?{query}</td>
|
|
569
|
+
<td style="padding:15px">Yes</td>
|
|
570
|
+
</tr>
|
|
571
|
+
<tr>
|
|
572
|
+
<td style="padding:15px">apiExternalControllerGetGatewayPorts(serial, callback)</td>
|
|
573
|
+
<td style="padding:15px">Get gateways ports details.
|
|
574
|
+
Possible error_codes for the error responses are
|
|
575
|
+
1. 0001 - General Error.</td>
|
|
576
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/gateways/{pathv1}/ports?{query}</td>
|
|
577
|
+
<td style="padding:15px">Yes</td>
|
|
578
|
+
</tr>
|
|
579
|
+
<tr>
|
|
580
|
+
<td style="padding:15px">apiExternalControllerGetGatewayPortErrors(serial, port, interval = 5minutes, fromTimestamp, toTimestamp, callback)</td>
|
|
581
|
+
<td style="padding:15px">Get gateway port errors over a time period.</td>
|
|
582
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/gateways/{pathv1}/ports/errors?{query}</td>
|
|
583
|
+
<td style="padding:15px">Yes</td>
|
|
584
|
+
</tr>
|
|
585
|
+
<tr>
|
|
586
|
+
<td style="padding:15px">apiExternalControllerGetGatewayTunnels(serial, timerange = 3H, offset, limit, callback)</td>
|
|
587
|
+
<td style="padding:15px">Get gateway Uplink tunnel details.
|
|
588
|
+
Possible error_codes for the error responses are
|
|
589
|
+
1. 0001 - General Error.</td>
|
|
590
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/gateways/{pathv1}/tunnels?{query}</td>
|
|
591
|
+
<td style="padding:15px">Yes</td>
|
|
592
|
+
</tr>
|
|
593
|
+
<tr>
|
|
594
|
+
<td style="padding:15px">apiExternalControllerGetGatewayDhcpClients(serial, reservation, offset, limit, callback)</td>
|
|
595
|
+
<td style="padding:15px">Get gateway DHCP Clients information.</td>
|
|
596
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/gateways/{pathv1}/dhcp_clients?{query}</td>
|
|
597
|
+
<td style="padding:15px">Yes</td>
|
|
598
|
+
</tr>
|
|
599
|
+
<tr>
|
|
600
|
+
<td style="padding:15px">apiExternalControllerGetGatewayDhcpPools(serial, callback)</td>
|
|
601
|
+
<td style="padding:15px">Get gateway DHCP Pools information.
|
|
602
|
+
Possible error_codes for the error responses are
|
|
603
|
+
1. 0001 - General Error.</td>
|
|
604
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/gateways/{pathv1}/dhcp_pools?{query}</td>
|
|
605
|
+
<td style="padding:15px">Yes</td>
|
|
606
|
+
</tr>
|
|
607
|
+
<tr>
|
|
608
|
+
<td style="padding:15px">apiExternalControllerGetGatewayVlanInfo(serial, callback)</td>
|
|
609
|
+
<td style="padding:15px">Get gateway's VLAN information.
|
|
610
|
+
Possible error_codes for the error responses are
|
|
611
|
+
1. 0001 - General Error.</td>
|
|
612
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/gateways/{pathv1}/vlan?{query}</td>
|
|
613
|
+
<td style="padding:15px">Yes</td>
|
|
614
|
+
</tr>
|
|
615
|
+
<tr>
|
|
616
|
+
<td style="padding:15px">labelsExternalControllerGetLabels(calculateTotal, categoryId, offset, limit, sort, callback)</td>
|
|
617
|
+
<td style="padding:15px">Get list of Labels and Sites.
|
|
618
|
+
Possible error_codes for the error responses are
|
|
619
|
+
1. 0001 - General Error.
|
|
620
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
621
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
622
|
+
4. 0004 - Validation Error. Invalid value for a query parameter</td>
|
|
623
|
+
<td style="padding:15px">{base_path}/{version}/central/v1/labels?{query}</td>
|
|
624
|
+
<td style="padding:15px">Yes</td>
|
|
625
|
+
</tr>
|
|
626
|
+
<tr>
|
|
627
|
+
<td style="padding:15px">labelsExternalControllerCreateLabel(body, callback)</td>
|
|
628
|
+
<td style="padding:15px">Create a Label.</td>
|
|
629
|
+
<td style="padding:15px">{base_path}/{version}/central/v1/labels?{query}</td>
|
|
630
|
+
<td style="padding:15px">Yes</td>
|
|
631
|
+
</tr>
|
|
632
|
+
<tr>
|
|
633
|
+
<td style="padding:15px">labelsExternalControllerGetDefaultLabels(calculateTotal, offset, limit, sort, callback)</td>
|
|
634
|
+
<td style="padding:15px">Get list of default Labels.
|
|
635
|
+
Possible error_codes for the error responses are
|
|
636
|
+
1. 0001 - General Error.
|
|
637
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
638
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
639
|
+
4. 0004 - Validation Error. Invalid value for a query parameter</td>
|
|
640
|
+
<td style="padding:15px">{base_path}/{version}/central/v2/labels?{query}</td>
|
|
641
|
+
<td style="padding:15px">Yes</td>
|
|
642
|
+
</tr>
|
|
643
|
+
<tr>
|
|
644
|
+
<td style="padding:15px">labelsExternalControllerGetLabel(labelId, callback)</td>
|
|
645
|
+
<td style="padding:15px">Get Label details.</td>
|
|
646
|
+
<td style="padding:15px">{base_path}/{version}/central/v1/labels/{pathv1}?{query}</td>
|
|
647
|
+
<td style="padding:15px">Yes</td>
|
|
648
|
+
</tr>
|
|
649
|
+
<tr>
|
|
650
|
+
<td style="padding:15px">labelsExternalControllerUpdateLabel(labelId, body, callback)</td>
|
|
651
|
+
<td style="padding:15px">Update Label name.</td>
|
|
652
|
+
<td style="padding:15px">{base_path}/{version}/central/v1/labels/{pathv1}?{query}</td>
|
|
653
|
+
<td style="padding:15px">Yes</td>
|
|
654
|
+
</tr>
|
|
655
|
+
<tr>
|
|
656
|
+
<td style="padding:15px">labelsExternalControllerDeleteLabel(labelId, callback)</td>
|
|
657
|
+
<td style="padding:15px">Delete a Label.</td>
|
|
658
|
+
<td style="padding:15px">{base_path}/{version}/central/v1/labels/{pathv1}?{query}</td>
|
|
659
|
+
<td style="padding:15px">Yes</td>
|
|
660
|
+
</tr>
|
|
661
|
+
<tr>
|
|
662
|
+
<td style="padding:15px">labelsExternalControllerAssignLabel(body, callback)</td>
|
|
663
|
+
<td style="padding:15px">Add a Label to a device.</td>
|
|
664
|
+
<td style="padding:15px">{base_path}/{version}/central/v1/labels/associations?{query}</td>
|
|
665
|
+
<td style="padding:15px">Yes</td>
|
|
666
|
+
</tr>
|
|
667
|
+
<tr>
|
|
668
|
+
<td style="padding:15px">labelsExternalControllerUnassignLabel(body, callback)</td>
|
|
669
|
+
<td style="padding:15px">Remove a Label from a device.</td>
|
|
670
|
+
<td style="padding:15px">{base_path}/{version}/central/v1/labels/associations?{query}</td>
|
|
671
|
+
<td style="padding:15px">Yes</td>
|
|
672
|
+
</tr>
|
|
673
|
+
<tr>
|
|
674
|
+
<td style="padding:15px">labelsExternalControllerAssignLabelToDevices(body, callback)</td>
|
|
675
|
+
<td style="padding:15px">Add a Label to devices.</td>
|
|
676
|
+
<td style="padding:15px">{base_path}/{version}/central/v2/labels/associations?{query}</td>
|
|
677
|
+
<td style="padding:15px">Yes</td>
|
|
678
|
+
</tr>
|
|
679
|
+
<tr>
|
|
680
|
+
<td style="padding:15px">labelsExternalControllerUnassignLabelFromDevices(body, callback)</td>
|
|
681
|
+
<td style="padding:15px">Remove a Label from devices.</td>
|
|
682
|
+
<td style="padding:15px">{base_path}/{version}/central/v2/labels/associations?{query}</td>
|
|
683
|
+
<td style="padding:15px">Yes</td>
|
|
684
|
+
</tr>
|
|
685
|
+
<tr>
|
|
686
|
+
<td style="padding:15px">labelsExternalControllerGetLabelCategories(calculateTotal, limit, offset, callback)</td>
|
|
687
|
+
<td style="padding:15px">Get list of Label categories.</td>
|
|
688
|
+
<td style="padding:15px">{base_path}/{version}/central/v1/labels/categories?{query}</td>
|
|
689
|
+
<td style="padding:15px">Yes</td>
|
|
690
|
+
</tr>
|
|
691
|
+
<tr>
|
|
692
|
+
<td style="padding:15px">sitesExternalControllerGetSites(calculateTotal, offset, limit, sort, callback)</td>
|
|
693
|
+
<td style="padding:15px">Get list of Sites.
|
|
694
|
+
Possible error_codes for the error responses are
|
|
695
|
+
1. 0001 - General Error.
|
|
696
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
697
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
698
|
+
4. 0004 - Validation Error. Invalid value for a query parameter</td>
|
|
699
|
+
<td style="padding:15px">{base_path}/{version}/central/v2/sites?{query}</td>
|
|
700
|
+
<td style="padding:15px">Yes</td>
|
|
701
|
+
</tr>
|
|
702
|
+
<tr>
|
|
703
|
+
<td style="padding:15px">sitesExternalControllerCreateSite(body, callback)</td>
|
|
704
|
+
<td style="padding:15px">Create a Site.
|
|
705
|
+
Site can be created using either address or geolocation.
|
|
706
|
+
All fields within geolocation are mandatory.</td>
|
|
707
|
+
<td style="padding:15px">{base_path}/{version}/central/v2/sites?{query}</td>
|
|
708
|
+
<td style="padding:15px">Yes</td>
|
|
709
|
+
</tr>
|
|
710
|
+
<tr>
|
|
711
|
+
<td style="padding:15px">sitesExternalControllerGetSite(siteId, callback)</td>
|
|
712
|
+
<td style="padding:15px">Get Site details.</td>
|
|
713
|
+
<td style="padding:15px">{base_path}/{version}/central/v2/sites/{pathv1}?{query}</td>
|
|
714
|
+
<td style="padding:15px">Yes</td>
|
|
715
|
+
</tr>
|
|
716
|
+
<tr>
|
|
717
|
+
<td style="padding:15px">sitesExternalControllerUpdateSite(siteId, body, callback)</td>
|
|
718
|
+
<td style="padding:15px">Update a Site.
|
|
719
|
+
Site name is a mandatory parameter. Site can be updated with either address or geolocation.
|
|
720
|
+
All fields within geolocation are mandatory.</td>
|
|
721
|
+
<td style="padding:15px">{base_path}/{version}/central/v2/sites/{pathv1}?{query}</td>
|
|
722
|
+
<td style="padding:15px">Yes</td>
|
|
723
|
+
</tr>
|
|
724
|
+
<tr>
|
|
725
|
+
<td style="padding:15px">sitesExternalControllerDeleteSite(siteId, callback)</td>
|
|
726
|
+
<td style="padding:15px">Delete a Site.</td>
|
|
727
|
+
<td style="padding:15px">{base_path}/{version}/central/v2/sites/{pathv1}?{query}</td>
|
|
728
|
+
<td style="padding:15px">Yes</td>
|
|
729
|
+
</tr>
|
|
730
|
+
<tr>
|
|
731
|
+
<td style="padding:15px">sitesExternalControllerAssignSite(body, callback)</td>
|
|
732
|
+
<td style="padding:15px">Add device to a Site.</td>
|
|
733
|
+
<td style="padding:15px">{base_path}/{version}/central/v2/sites/associate?{query}</td>
|
|
734
|
+
<td style="padding:15px">Yes</td>
|
|
735
|
+
</tr>
|
|
736
|
+
<tr>
|
|
737
|
+
<td style="padding:15px">sitesExternalControllerUnassignSite(body, callback)</td>
|
|
738
|
+
<td style="padding:15px">Remove device from a Site.</td>
|
|
739
|
+
<td style="padding:15px">{base_path}/{version}/central/v2/sites/associate?{query}</td>
|
|
740
|
+
<td style="padding:15px">Yes</td>
|
|
741
|
+
</tr>
|
|
742
|
+
<tr>
|
|
743
|
+
<td style="padding:15px">sitesExternalControllerAssignSiteToDevices(body, callback)</td>
|
|
744
|
+
<td style="padding:15px">Add devices to a Site.</td>
|
|
745
|
+
<td style="padding:15px">{base_path}/{version}/central/v2/sites/associations?{query}</td>
|
|
746
|
+
<td style="padding:15px">Yes</td>
|
|
747
|
+
</tr>
|
|
748
|
+
<tr>
|
|
749
|
+
<td style="padding:15px">sitesExternalControllerUnassignSiteFromDevices(body, callback)</td>
|
|
750
|
+
<td style="padding:15px">Remove devices from a Site.</td>
|
|
751
|
+
<td style="padding:15px">{base_path}/{version}/central/v2/sites/associations?{query}</td>
|
|
752
|
+
<td style="padding:15px">Yes</td>
|
|
753
|
+
</tr>
|
|
754
|
+
<tr>
|
|
755
|
+
<td style="padding:15px">apiExternalControllerGetSwitches(group, label, stackId, status, fields, calculateTotal, showResourceDetails, calculateClientCount, publicIpAddress, site, offset, limit, sort, callback)</td>
|
|
756
|
+
<td style="padding:15px">Get switches You can only specify one of group, label and stack_id parameters.
|
|
757
|
+
Possible error_codes for the error responses are
|
|
758
|
+
1. 0001 - General Error.
|
|
759
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
760
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
761
|
+
4. 0004 - Validation Error. Invalid value for a query parameter</td>
|
|
762
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switches?{query}</td>
|
|
763
|
+
<td style="padding:15px">Yes</td>
|
|
764
|
+
</tr>
|
|
765
|
+
<tr>
|
|
766
|
+
<td style="padding:15px">apiExternalControllerGetSwitchVlan(serial, name, id, taggedPort, untaggedPort, isJumboEnabled, isVoiceEnabled, isIgmpEnabled, type, primaryVlanId, status, offset, limit, sort, calculateTotal, callback)</td>
|
|
767
|
+
<td style="padding:15px">Get switch vlan info</td>
|
|
768
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switches/{pathv1}/vlan?{query}</td>
|
|
769
|
+
<td style="padding:15px">Yes</td>
|
|
770
|
+
</tr>
|
|
771
|
+
<tr>
|
|
772
|
+
<td style="padding:15px">apiExternalControllerGetCxSwitchVlan(serial, name, id, taggedPort, untaggedPort, isJumboEnabled, isVoiceEnabled, isIgmpEnabled, type, primaryVlanId, status, offset, limit, sort, calculateTotal, callback)</td>
|
|
773
|
+
<td style="padding:15px">Get vlan info for CX switch</td>
|
|
774
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/cx_switches/{pathv1}/vlan?{query}</td>
|
|
775
|
+
<td style="padding:15px">Yes</td>
|
|
776
|
+
</tr>
|
|
777
|
+
<tr>
|
|
778
|
+
<td style="padding:15px">apiExternalControllerGetSwitchStackVlan(stackId, name, id, taggedPort, untaggedPort, isJumboEnabled, isVoiceEnabled, isIgmpEnabled, type, primaryVlanId, status, offset, limit, sort, calculateTotal, callback)</td>
|
|
779
|
+
<td style="padding:15px">Get switch stack vlan info</td>
|
|
780
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switch_stacks/{pathv1}/vlan?{query}</td>
|
|
781
|
+
<td style="padding:15px">Yes</td>
|
|
782
|
+
</tr>
|
|
783
|
+
<tr>
|
|
784
|
+
<td style="padding:15px">apiExternalControllerGetCxSwitchStackVlan(stackId, name, id, taggedPort, untaggedPort, isJumboEnabled, isVoiceEnabled, isIgmpEnabled, type, primaryVlanId, status, offset, limit, sort, calculateTotal, callback)</td>
|
|
785
|
+
<td style="padding:15px">Get switch stack vlan info for CX</td>
|
|
786
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/cx_switch_stacks/{pathv1}/vlan?{query}</td>
|
|
787
|
+
<td style="padding:15px">Yes</td>
|
|
788
|
+
</tr>
|
|
789
|
+
<tr>
|
|
790
|
+
<td style="padding:15px">apiExternalControllerGetSwitchPoeDetail(serial, port, callback)</td>
|
|
791
|
+
<td style="padding:15px">Get switch port poe info</td>
|
|
792
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switches/{pathv1}/poe_detail?{query}</td>
|
|
793
|
+
<td style="padding:15px">Yes</td>
|
|
794
|
+
</tr>
|
|
795
|
+
<tr>
|
|
796
|
+
<td style="padding:15px">apiExternalControllerGetCxSwitchPoeDetail(serial, port, callback)</td>
|
|
797
|
+
<td style="padding:15px">Get switch port poe info for CX switch</td>
|
|
798
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/cx_switches/{pathv1}/poe_detail?{query}</td>
|
|
799
|
+
<td style="padding:15px">Yes</td>
|
|
800
|
+
</tr>
|
|
801
|
+
<tr>
|
|
802
|
+
<td style="padding:15px">apiExternalControllerGetSwitchPoeDetailsForAllPorts(serial, port, callback)</td>
|
|
803
|
+
<td style="padding:15px">Get switch poe info</td>
|
|
804
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switches/{pathv1}/poe_details?{query}</td>
|
|
805
|
+
<td style="padding:15px">Yes</td>
|
|
806
|
+
</tr>
|
|
807
|
+
<tr>
|
|
808
|
+
<td style="padding:15px">apiExternalControllerGetCxSwitchPoeDetailsForAllPorts(serial, port, callback)</td>
|
|
809
|
+
<td style="padding:15px">Get switch poe info for CX switch</td>
|
|
810
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/cx_switches/{pathv1}/poe_details?{query}</td>
|
|
811
|
+
<td style="padding:15px">Yes</td>
|
|
812
|
+
</tr>
|
|
813
|
+
<tr>
|
|
814
|
+
<td style="padding:15px">apiExternalControllerGetSwitchVsxDetail(serial, callback)</td>
|
|
815
|
+
<td style="padding:15px">Get switch vsx info for CX switch</td>
|
|
816
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/cx_switches/{pathv1}/vsx?{query}</td>
|
|
817
|
+
<td style="padding:15px">Yes</td>
|
|
818
|
+
</tr>
|
|
819
|
+
<tr>
|
|
820
|
+
<td style="padding:15px">apiExternalControllerGetBandwidthUsage(group, label, serial, stackId, fromTimestamp, toTimestamp, callback)</td>
|
|
821
|
+
<td style="padding:15px">Get switches bandwidth usage over a time period. You can only specify one of group, label, serial and stack_id
|
|
822
|
+
parameters.
|
|
823
|
+
Possible error_codes for the error responses are
|
|
824
|
+
1. 0001 - General Error.
|
|
825
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
826
|
+
3. 0003 - Validation Error. Unsupported query combination</td>
|
|
827
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switches/bandwidth_usage?{query}</td>
|
|
828
|
+
<td style="padding:15px">Yes</td>
|
|
829
|
+
</tr>
|
|
830
|
+
<tr>
|
|
831
|
+
<td style="padding:15px">apiExternalControllerGetBandwidthUsageTopn(group, label, stackId, count, fromTimestamp, toTimestamp, callback)</td>
|
|
832
|
+
<td style="padding:15px">Get top N Switches details over a time period. You can only specify one of group, label and stack_id parameters.
|
|
833
|
+
Possible error_codes for the error responses are
|
|
834
|
+
1. 0001 - General Error.
|
|
835
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
836
|
+
3. 0003 - Validation Error. Unsupported query combination</td>
|
|
837
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switches/bandwidth_usage/topn?{query}</td>
|
|
838
|
+
<td style="padding:15px">Yes</td>
|
|
839
|
+
</tr>
|
|
840
|
+
<tr>
|
|
841
|
+
<td style="padding:15px">apiExternalControllerGetSwitch(serial, callback)</td>
|
|
842
|
+
<td style="padding:15px">Get Switch details</td>
|
|
843
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switches/{pathv1}?{query}</td>
|
|
844
|
+
<td style="padding:15px">Yes</td>
|
|
845
|
+
</tr>
|
|
846
|
+
<tr>
|
|
847
|
+
<td style="padding:15px">apiExternalControllerDeleteSwitch(serial, callback)</td>
|
|
848
|
+
<td style="padding:15px">Delete Switch</td>
|
|
849
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switches/{pathv1}?{query}</td>
|
|
850
|
+
<td style="padding:15px">Yes</td>
|
|
851
|
+
</tr>
|
|
852
|
+
<tr>
|
|
853
|
+
<td style="padding:15px">apiExternalControllerGetSwitchPorts(serial, slot, callback)</td>
|
|
854
|
+
<td style="padding:15px">Get switch ports details.
|
|
855
|
+
Possible error_codes for the error responses are
|
|
856
|
+
1. 0001 - General Error.</td>
|
|
857
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switches/{pathv1}/ports?{query}</td>
|
|
858
|
+
<td style="padding:15px">Yes</td>
|
|
859
|
+
</tr>
|
|
860
|
+
<tr>
|
|
861
|
+
<td style="padding:15px">apiExternalControllerGetCxSwitchPorts(serial, slot, callback)</td>
|
|
862
|
+
<td style="padding:15px">Get ports details for CX switch
|
|
863
|
+
Possible error_codes for the error responses are
|
|
864
|
+
1. 0001 - General Error.</td>
|
|
865
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/cx_switches/{pathv1}/ports?{query}</td>
|
|
866
|
+
<td style="padding:15px">Yes</td>
|
|
867
|
+
</tr>
|
|
868
|
+
<tr>
|
|
869
|
+
<td style="padding:15px">apiExternalControllerGetChassisInfo(serial, callback)</td>
|
|
870
|
+
<td style="padding:15px">Get switch chassis details for chassis type switches.
|
|
871
|
+
Possible error_codes for the error responses are
|
|
872
|
+
1. 0001 - General Error.</td>
|
|
873
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switches/{pathv1}/chassis_info?{query}</td>
|
|
874
|
+
<td style="padding:15px">Yes</td>
|
|
875
|
+
</tr>
|
|
876
|
+
<tr>
|
|
877
|
+
<td style="padding:15px">apiExternalControllerGetSwitchPortsBandwidthUsage(serial, fromTimestamp, toTimestamp, port, showUplink, callback)</td>
|
|
878
|
+
<td style="padding:15px">Get switch ports bandwidth usage over a time period.
|
|
879
|
+
Possible error_codes for the error responses are
|
|
880
|
+
1. 0001 - General Error.
|
|
881
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.</td>
|
|
882
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switches/{pathv1}/ports/bandwidth_usage?{query}</td>
|
|
883
|
+
<td style="padding:15px">Yes</td>
|
|
884
|
+
</tr>
|
|
885
|
+
<tr>
|
|
886
|
+
<td style="padding:15px">apiExternalControllerGetCxSwitchPortsBandwidthUsage(serial, fromTimestamp, toTimestamp, port, showUplink, callback)</td>
|
|
887
|
+
<td style="padding:15px">Get switch ports bandwidth usage over a time period for CX switch
|
|
888
|
+
Possible error_codes for the error responses are
|
|
889
|
+
1. 0001 - General Error.
|
|
890
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.</td>
|
|
891
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/cx_switches/{pathv1}/ports/bandwidth_usage?{query}</td>
|
|
892
|
+
<td style="padding:15px">Yes</td>
|
|
893
|
+
</tr>
|
|
894
|
+
<tr>
|
|
895
|
+
<td style="padding:15px">apiExternalControllerGetPortsErrors(serial, fromTimestamp, toTimestamp, port, error, callback)</td>
|
|
896
|
+
<td style="padding:15px">Get switch ports in and out errors over a time period.
|
|
897
|
+
Possible error_codes for the error responses are
|
|
898
|
+
1. 0001 - General Error.
|
|
899
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.</td>
|
|
900
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switches/{pathv1}/ports/errors?{query}</td>
|
|
901
|
+
<td style="padding:15px">Yes</td>
|
|
902
|
+
</tr>
|
|
903
|
+
<tr>
|
|
904
|
+
<td style="padding:15px">apiExternalControllerGetCxPortsErrors(serial, fromTimestamp, toTimestamp, port, error, callback)</td>
|
|
905
|
+
<td style="padding:15px">Get switch ports in and out errors over a time period for CX switch
|
|
906
|
+
Possible error_codes for the error responses are
|
|
907
|
+
1. 0001 - General Error.
|
|
908
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.</td>
|
|
909
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/cx_switches/{pathv1}/ports/errors?{query}</td>
|
|
910
|
+
<td style="padding:15px">Yes</td>
|
|
911
|
+
</tr>
|
|
912
|
+
<tr>
|
|
913
|
+
<td style="padding:15px">apiExternalControllerGetStackPorts(stackId, callback)</td>
|
|
914
|
+
<td style="padding:15px">Get the Port details for a given stack_id</td>
|
|
915
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switch_stacks/{pathv1}/ports?{query}</td>
|
|
916
|
+
<td style="padding:15px">Yes</td>
|
|
917
|
+
</tr>
|
|
918
|
+
<tr>
|
|
919
|
+
<td style="padding:15px">apiExternalControllerGetCxStackPorts(stackId, callback)</td>
|
|
920
|
+
<td style="padding:15px">Get the Port details for a given stack_id for CX Switch</td>
|
|
921
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/cx_switch_stacks/{pathv1}/ports?{query}</td>
|
|
922
|
+
<td style="padding:15px">Yes</td>
|
|
923
|
+
</tr>
|
|
924
|
+
<tr>
|
|
925
|
+
<td style="padding:15px">apiExternalControllerGetSwitchStacks(hostname, group, offset, limit, callback)</td>
|
|
926
|
+
<td style="padding:15px">List Switch Stacks</td>
|
|
927
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switch_stacks?{query}</td>
|
|
928
|
+
<td style="padding:15px">Yes</td>
|
|
929
|
+
</tr>
|
|
930
|
+
<tr>
|
|
931
|
+
<td style="padding:15px">apiExternalControllerGetSwitchStack(stackId, callback)</td>
|
|
932
|
+
<td style="padding:15px">Get Switch Stack details</td>
|
|
933
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switch_stacks/{pathv1}?{query}</td>
|
|
934
|
+
<td style="padding:15px">Yes</td>
|
|
935
|
+
</tr>
|
|
936
|
+
<tr>
|
|
937
|
+
<td style="padding:15px">apiExternalControllerDeleteSwitchStack(stackId, callback)</td>
|
|
938
|
+
<td style="padding:15px">Delete the stack and associated switches
|
|
939
|
+
1. 0001 - General Error.
|
|
940
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.</td>
|
|
941
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/switch_stacks/{pathv1}?{query}</td>
|
|
942
|
+
<td style="padding:15px">Yes</td>
|
|
943
|
+
</tr>
|
|
944
|
+
<tr>
|
|
945
|
+
<td style="padding:15px">apiExternalControllerGetEvents(group, swarmId, label, fromTimestamp, toTimestamp, offset, limit, serial, eventType, eventNumber, level, eventDescription, eventCategory, macaddr, fields, calculateTotal, callback)</td>
|
|
946
|
+
<td style="padding:15px">Get a list of events. You can only specify one of group, swarm_id, label, serial, macaddr parameters.
|
|
947
|
+
Possible error_codes for the error responses are
|
|
948
|
+
1. 0001 - General Error.
|
|
949
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
950
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
951
|
+
4. 0004 - Validation Error. Invalid value for a query parameter</td>
|
|
952
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v1/events?{query}</td>
|
|
953
|
+
<td style="padding:15px">Yes</td>
|
|
954
|
+
</tr>
|
|
955
|
+
<tr>
|
|
956
|
+
<td style="padding:15px">apiExternalControllerGetEventsV2(group, swarmId, label, fromTimestamp, toTimestamp, offset, limit, macaddr, bssid, deviceMac, hostname, deviceType = ACCESS POINT, sort = -timestamp, site, serial, level, eventDescription, eventType, fields, calculateTotal, callback)</td>
|
|
957
|
+
<td style="padding:15px">Get a list of events.Possible error_codes for the error responses are
|
|
958
|
+
|
|
959
|
+
1. 0001 - General Error.
|
|
960
|
+
2. 0002 - Validation Error. Out of Range value for a query parameter.
|
|
961
|
+
3. 0003 - Validation Error. Unsupported query combination
|
|
962
|
+
4. 0004 - Validation Error. Invalid value for a query parameter</td>
|
|
963
|
+
<td style="padding:15px">{base_path}/{version}/monitoring/v2/events?{query}</td>
|
|
964
|
+
<td style="padding:15px">Yes</td>
|
|
965
|
+
</tr>
|
|
966
|
+
<tr>
|
|
967
|
+
<td style="padding:15px">apiGroupsGetGroupsV2(limit, offset, callback)</td>
|
|
968
|
+
<td style="padding:15px">Get all group names which exist for a customer. Response is sorted by group name.
|
|
969
|
+
|
|
970
|
+
/configuration/v2/groups/template_info API can be used to get the configuration
|
|
971
|
+
mode(UI or template mode of configuration) set per device type for a group.
|
|
972
|
+
</td>
|
|
973
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/groups?{query}</td>
|
|
974
|
+
<td style="padding:15px">Yes</td>
|
|
975
|
+
</tr>
|
|
976
|
+
<tr>
|
|
977
|
+
<td style="padding:15px">apiGroupsCreateGroupV2(group, callback)</td>
|
|
978
|
+
<td style="padding:15px">Create new group given a group name and configuration
|
|
979
|
+
mode(UI or template mode of configuration) to be set per device type.
|
|
980
|
+
|
|
981
|
+
The password provided would not be saved.
|
|
982
|
+
Please use respective device configuration UI feature page or api's (if exists) to set the device admin password at group level
|
|
983
|
+
|
|
984
|
+
Configuration mode can be set for Access points and Gateways under the 'Wireless' field and for
|
|
985
|
+
switches under the 'Wired' field. The configuration mode is specified as a boolean value indicating
|
|
986
|
+
if the d...(description truncated)</td>
|
|
987
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/groups?{query}</td>
|
|
988
|
+
<td style="padding:15px">Yes</td>
|
|
989
|
+
</tr>
|
|
990
|
+
<tr>
|
|
991
|
+
<td style="padding:15px">apiGroupsCreateGroupV3(group, callback)</td>
|
|
992
|
+
<td style="padding:15px">Create new group given a group name, configuration
|
|
993
|
+
mode(UI or template mode of configuration) to be set per device type and
|
|
994
|
+
the user can also specify the following properties for the group
|
|
995
|
+
- Device types(AccessPoints, Gateways, Switches) to be allowed in the group
|
|
996
|
+
|
|
997
|
+
- Architecture(Instant / AOS10) for the access points and gateways in the group.
|
|
998
|
+
|
|
999
|
+
- Network role(Standard / Microbranch) for access points in the group.
|
|
1000
|
+
Standard network role is applicable for both AOS10 and Instant architec...(description truncated)</td>
|
|
1001
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v3/groups?{query}</td>
|
|
1002
|
+
<td style="padding:15px">Yes</td>
|
|
1003
|
+
</tr>
|
|
1004
|
+
<tr>
|
|
1005
|
+
<td style="padding:15px">apiGroupsCloneGroup(groupAttributes, callback)</td>
|
|
1006
|
+
<td style="padding:15px">Clone and create new group from a given group with the given name. The configuration of the new group will be inherited from the given group.
|
|
1007
|
+
For example:
|
|
1008
|
+
Sample request body to create a group is as follows:
|
|
1009
|
+
{
|
|
1010
|
+
"group": "Lorem",
|
|
1011
|
+
"clone_group": "Ipsum"
|
|
1012
|
+
}
|
|
1013
|
+
With the above body, a group named Lorem will be created with the attributes such as template-type & configurations cloned from Ipsum group.
|
|
1014
|
+
</td>
|
|
1015
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/groups/clone?{query}</td>
|
|
1016
|
+
<td style="padding:15px">Yes</td>
|
|
1017
|
+
</tr>
|
|
1018
|
+
<tr>
|
|
1019
|
+
<td style="padding:15px">apiGroupsGetGroupsTemplateData(groups, callback)</td>
|
|
1020
|
+
<td style="padding:15px">Get configuration mode(UI or template mode of configuration) set per device type for the given list of groups.
|
|
1021
|
+
|
|
1022
|
+
For each group in the provided list, the configuration mode for Instant APs and Gateways
|
|
1023
|
+
is specified under the 'Wireless' field and for switches under the 'Wired' field.
|
|
1024
|
+
The configuration mode is specified as a boolean value indicating
|
|
1025
|
+
if the device type is managed using the template mode of configuration or not.
|
|
1026
|
+
|
|
1027
|
+
Example:
|
|
1028
|
+
{"data": [{"group": "group1", "template_info": {"Wired": tru...(description truncated)</td>
|
|
1029
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/groups/template_info?{query}</td>
|
|
1030
|
+
<td style="padding:15px">Yes</td>
|
|
1031
|
+
</tr>
|
|
1032
|
+
<tr>
|
|
1033
|
+
<td style="padding:15px">apiGroupsGetGroupsProperties(groups, callback)</td>
|
|
1034
|
+
<td style="padding:15px">For each group in the provided list, the following properties for the group are returned
|
|
1035
|
+
- Device types(AccessPoints, Gateways, Switches) to be allowed in the group
|
|
1036
|
+
|
|
1037
|
+
- Architecture(Instant / AOS10) for the access points and gateways in the group.
|
|
1038
|
+
|
|
1039
|
+
- Network role(Standard / Microbranch) for access points in the group.
|
|
1040
|
+
Standard network role is applicable for both AOS10 and Instant architecture.
|
|
1041
|
+
Microbranch network role for access points is applicable only for AOS10 architecture.
|
|
1042
|
+
|
|
1043
|
+
-...(description truncated)</td>
|
|
1044
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/properties?{query}</td>
|
|
1045
|
+
<td style="padding:15px">Yes</td>
|
|
1046
|
+
</tr>
|
|
1047
|
+
<tr>
|
|
1048
|
+
<td style="padding:15px">apiGroupsUpdateGroupPropertiesV2(group, updateAttributes, callback)</td>
|
|
1049
|
+
<td style="padding:15px">Update properties for the given group.
|
|
1050
|
+
|
|
1051
|
+
For a given group, new devices can be added as part of allowed device types.
|
|
1052
|
+
|
|
1053
|
+
The corresponding persona and configuration mode(UI or template mode of configuration) can
|
|
1054
|
+
be updated for the added device types.
|
|
1055
|
+
- If AccessPoints is added to allowed device types, the network role for access points,
|
|
1056
|
+
architecture (if gateways not present in existing allowed device type list) and configuration mode for wireless device types
|
|
1057
|
+
(if gateways not present in e...(description truncated)</td>
|
|
1058
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/groups/{pathv1}/properties?{query}</td>
|
|
1059
|
+
<td style="padding:15px">Yes</td>
|
|
1060
|
+
</tr>
|
|
1061
|
+
<tr>
|
|
1062
|
+
<td style="padding:15px">apiGroupsUpdateGroupName(group, newGroupName, callback)</td>
|
|
1063
|
+
<td style="padding:15px">Update group name for the given group.
|
|
1064
|
+
Names for System created groups cannot be edited.
|
|
1065
|
+
</td>
|
|
1066
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/{pathv1}/name?{query}</td>
|
|
1067
|
+
<td style="padding:15px">Yes</td>
|
|
1068
|
+
</tr>
|
|
1069
|
+
<tr>
|
|
1070
|
+
<td style="padding:15px">apiGroupsGetCustDefaultGroup(callback)</td>
|
|
1071
|
+
<td style="padding:15px">Get default group.</td>
|
|
1072
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/default_group?{query}</td>
|
|
1073
|
+
<td style="padding:15px">Yes</td>
|
|
1074
|
+
</tr>
|
|
1075
|
+
<tr>
|
|
1076
|
+
<td style="padding:15px">apiGroupsSetCustDefaultGroup(groupAttributes, callback)</td>
|
|
1077
|
+
<td style="padding:15px">Set a group to default group.</td>
|
|
1078
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/default_group?{query}</td>
|
|
1079
|
+
<td style="padding:15px">Yes</td>
|
|
1080
|
+
</tr>
|
|
1081
|
+
<tr>
|
|
1082
|
+
<td style="padding:15px">apiGroupsDeleteGroup(group, callback)</td>
|
|
1083
|
+
<td style="padding:15px">Delete existing group.</td>
|
|
1084
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/{pathv1}?{query}</td>
|
|
1085
|
+
<td style="padding:15px">Yes</td>
|
|
1086
|
+
</tr>
|
|
1087
|
+
<tr>
|
|
1088
|
+
<td style="padding:15px">apiGroupsGetGroup(group, callback)</td>
|
|
1089
|
+
<td style="padding:15px">(Deprecated) Get group.
|
|
1090
|
+
|
|
1091
|
+
The value of template_group for a group would be None if it is a group which
|
|
1092
|
+
has different configuration modes (template or UI) set per device type.
|
|
1093
|
+
|
|
1094
|
+
/configuration/v2/groups/template_info API can be used to get the configuration
|
|
1095
|
+
mode(UI or template mode of configuration) set per device type for a group.
|
|
1096
|
+
</td>
|
|
1097
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/{pathv1}?{query}</td>
|
|
1098
|
+
<td style="padding:15px">Yes</td>
|
|
1099
|
+
</tr>
|
|
1100
|
+
<tr>
|
|
1101
|
+
<td style="padding:15px">apiGroupsGetGroups(limit, offset, q, callback)</td>
|
|
1102
|
+
<td style="padding:15px">(Deprecated) Get all groups, Response is sorted by group name.
|
|
1103
|
+
|
|
1104
|
+
The value of template_group for a group would be None if it is a group which
|
|
1105
|
+
has different configuration modes (UI or template mode of configuration) set per device type.
|
|
1106
|
+
|
|
1107
|
+
/configuration/v2/groups/template_info API can be used to get the configuration
|
|
1108
|
+
mode(UI or template mode of configuration) set per device type for a group.
|
|
1109
|
+
</td>
|
|
1110
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups?{query}</td>
|
|
1111
|
+
<td style="padding:15px">Yes</td>
|
|
1112
|
+
</tr>
|
|
1113
|
+
<tr>
|
|
1114
|
+
<td style="padding:15px">apiGroupsCreateGroup(group, callback)</td>
|
|
1115
|
+
<td style="padding:15px">(Deprecated) Create new group.
|
|
1116
|
+
Groups are now allowed to have different configuration modes (template or UI mode of configuration)
|
|
1117
|
+
set per device type. Please use the new create group api /configuration/v2/groups to
|
|
1118
|
+
create a group with configuration modes specified per device type.
|
|
1119
|
+
</td>
|
|
1120
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups?{query}</td>
|
|
1121
|
+
<td style="padding:15px">Yes</td>
|
|
1122
|
+
</tr>
|
|
1123
|
+
<tr>
|
|
1124
|
+
<td style="padding:15px">apiGroupsPreProvisionGroup(data, callback)</td>
|
|
1125
|
+
<td style="padding:15px">Pre Provision a group to the device</td>
|
|
1126
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/preassign?{query}</td>
|
|
1127
|
+
<td style="padding:15px">Yes</td>
|
|
1128
|
+
</tr>
|
|
1129
|
+
<tr>
|
|
1130
|
+
<td style="padding:15px">apiGroupsPreProvisionGroupDm(params, callback)</td>
|
|
1131
|
+
<td style="padding:15px">(Deprecated: This API would be supported till November 2022) Assign pre provisioned group to list of devices. If device is already managed by Central then you can not assign pre provisioned group to it.
|
|
1132
|
+
|
|
1133
|
+
Possible error_codes for the error responses are:
|
|
1134
|
+
1. 0001 - General Error.
|
|
1135
|
+
2. 0007 - Validation Error. Invalid value for a parameter.
|
|
1136
|
+
</td>
|
|
1137
|
+
<td style="padding:15px">{base_path}/{version}/device_management/v1/group/assign?{query}</td>
|
|
1138
|
+
<td style="padding:15px">Yes</td>
|
|
1139
|
+
</tr>
|
|
1140
|
+
<tr>
|
|
1141
|
+
<td style="padding:15px">apiTemplatesGetTemplates(group, limit, offset, template, deviceType = IAP, version, model, q, callback)</td>
|
|
1142
|
+
<td style="padding:15px">Get all templates in group.
|
|
1143
|
+
|
|
1144
|
+
Query can be filtered by name, device_type, version, model or J number (for ArubaSwitch).
|
|
1145
|
+
|
|
1146
|
+
Response is sorted by template name.
|
|
1147
|
+
</td>
|
|
1148
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/{pathv1}/templates?{query}</td>
|
|
1149
|
+
<td style="padding:15px">Yes</td>
|
|
1150
|
+
</tr>
|
|
1151
|
+
<tr>
|
|
1152
|
+
<td style="padding:15px">apiTemplatesCreateTemplate(group, name, deviceType = IAP, version, model, template, callback)</td>
|
|
1153
|
+
<td style="padding:15px">Create new template.</td>
|
|
1154
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/{pathv1}/templates?{query}</td>
|
|
1155
|
+
<td style="padding:15px">Yes</td>
|
|
1156
|
+
</tr>
|
|
1157
|
+
<tr>
|
|
1158
|
+
<td style="padding:15px">apiTemplatesUpdateTemplate(group, name, deviceType = IAP, version, model, template, callback)</td>
|
|
1159
|
+
<td style="padding:15px">Update existing template.</td>
|
|
1160
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/{pathv1}/templates?{query}</td>
|
|
1161
|
+
<td style="padding:15px">Yes</td>
|
|
1162
|
+
</tr>
|
|
1163
|
+
<tr>
|
|
1164
|
+
<td style="padding:15px">apiTemplatesGetTemplate(group, template, callback)</td>
|
|
1165
|
+
<td style="padding:15px">Get template text for a template in group.</td>
|
|
1166
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/{pathv1}/templates/{pathv2}?{query}</td>
|
|
1167
|
+
<td style="padding:15px">Yes</td>
|
|
1168
|
+
</tr>
|
|
1169
|
+
<tr>
|
|
1170
|
+
<td style="padding:15px">apiTemplatesDeleteTemplate(group, template, callback)</td>
|
|
1171
|
+
<td style="padding:15px">Delete existing template.</td>
|
|
1172
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/{pathv1}/templates/{pathv2}?{query}</td>
|
|
1173
|
+
<td style="padding:15px">Yes</td>
|
|
1174
|
+
</tr>
|
|
1175
|
+
<tr>
|
|
1176
|
+
<td style="padding:15px">apiGroupsCreateSnapshotForGroup(group, groupAttributes, callback)</td>
|
|
1177
|
+
<td style="padding:15px">Create new configuration backup for group.</td>
|
|
1178
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/snapshot/{pathv1}?{query}</td>
|
|
1179
|
+
<td style="padding:15px">Yes</td>
|
|
1180
|
+
</tr>
|
|
1181
|
+
<tr>
|
|
1182
|
+
<td style="padding:15px">apiGroupsCreateSnapshotsForMultipleGroups(groupAttributes, callback)</td>
|
|
1183
|
+
<td style="padding:15px">Create new configuration backup for multiple groups.</td>
|
|
1184
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/snapshot/backups?{query}</td>
|
|
1185
|
+
<td style="padding:15px">Yes</td>
|
|
1186
|
+
</tr>
|
|
1187
|
+
<tr>
|
|
1188
|
+
<td style="padding:15px">apiGroupsGetSnapshotsForGroup(group, callback)</td>
|
|
1189
|
+
<td style="padding:15px">List all the configuration backups for the given group.</td>
|
|
1190
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/{pathv1}/snapshots?{query}</td>
|
|
1191
|
+
<td style="padding:15px">Yes</td>
|
|
1192
|
+
</tr>
|
|
1193
|
+
<tr>
|
|
1194
|
+
<td style="padding:15px">apiGroupsUpdateDoNotDelete(group, snapshotAttributes, callback)</td>
|
|
1195
|
+
<td style="padding:15px">Update do-not-delete flag for list of configuration backups for the given group.</td>
|
|
1196
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/{pathv1}/snapshots?{query}</td>
|
|
1197
|
+
<td style="padding:15px">Yes</td>
|
|
1198
|
+
</tr>
|
|
1199
|
+
<tr>
|
|
1200
|
+
<td style="padding:15px">apiGroupsGetLastRestoreLogsForGroup(group, callback)</td>
|
|
1201
|
+
<td style="padding:15px">Get last restore logs for the given group.</td>
|
|
1202
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/{pathv1}/last_restore_log?{query}</td>
|
|
1203
|
+
<td style="padding:15px">Yes</td>
|
|
1204
|
+
</tr>
|
|
1205
|
+
<tr>
|
|
1206
|
+
<td style="padding:15px">apiGroupsGetBackupLogForSnapshot(group, snapshot, callback)</td>
|
|
1207
|
+
<td style="padding:15px">Get backup-log for the given configuration backup for the given group.</td>
|
|
1208
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/{pathv1}/snapshots/{pathv2}/backup_log?{query}</td>
|
|
1209
|
+
<td style="padding:15px">Yes</td>
|
|
1210
|
+
</tr>
|
|
1211
|
+
<tr>
|
|
1212
|
+
<td style="padding:15px">apiGroupsGetBackupStatusForSnapshot(group, snapshot, callback)</td>
|
|
1213
|
+
<td style="padding:15px">Get status of configuration backup for the given group.</td>
|
|
1214
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/{pathv1}/snapshots/{pathv2}/backup_status?{query}</td>
|
|
1215
|
+
<td style="padding:15px">Yes</td>
|
|
1216
|
+
</tr>
|
|
1217
|
+
<tr>
|
|
1218
|
+
<td style="padding:15px">apiGroupsGetRestoreStatusForSnapshot(group, snapshot, callback)</td>
|
|
1219
|
+
<td style="padding:15px">Get status of configuration restore for the given group.</td>
|
|
1220
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/{pathv1}/snapshots/{pathv2}/restore_status?{query}</td>
|
|
1221
|
+
<td style="padding:15px">Yes</td>
|
|
1222
|
+
</tr>
|
|
1223
|
+
<tr>
|
|
1224
|
+
<td style="padding:15px">apiGroupsRestoreSnapshotForGroup(group, snapshot, deviceType = IAP, callback)</td>
|
|
1225
|
+
<td style="padding:15px">Restore configuration backup of a group.</td>
|
|
1226
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/groups/{pathv1}/snapshots/{pathv2}/restore?{query}</td>
|
|
1227
|
+
<td style="padding:15px">Yes</td>
|
|
1228
|
+
</tr>
|
|
1229
|
+
<tr>
|
|
1230
|
+
<td style="padding:15px">apiGroupsMoveDevices(data, callback)</td>
|
|
1231
|
+
<td style="padding:15px">List of given device serials will be moved to the specified group.
|
|
1232
|
+
|
|
1233
|
+
1) If the device is already part of any group: Move device to group and assign specified group in device management page.
|
|
1234
|
+
Note: if given device is part of a swarm, stack or controller, all associated devices will be moved to the target group.
|
|
1235
|
+
|
|
1236
|
+
2) If device is not part of any group: Assign specified group in device management page.
|
|
1237
|
+
|
|
1238
|
+
The 'preserve_config_overrides' parameter can be used to retain device configuration overrides w...(description truncated)</td>
|
|
1239
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/move?{query}</td>
|
|
1240
|
+
<td style="padding:15px">Yes</td>
|
|
1241
|
+
</tr>
|
|
1242
|
+
<tr>
|
|
1243
|
+
<td style="padding:15px">apiDevicesGetDeviceGroup(deviceSerial, callback)</td>
|
|
1244
|
+
<td style="padding:15px">Get group for a device.</td>
|
|
1245
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/{pathv1}/group?{query}</td>
|
|
1246
|
+
<td style="padding:15px">Yes</td>
|
|
1247
|
+
</tr>
|
|
1248
|
+
<tr>
|
|
1249
|
+
<td style="padding:15px">apiDevicesGetDeviceConfiguration(deviceSerial, callback)</td>
|
|
1250
|
+
<td style="padding:15px">Get last known running configuration for a device.</td>
|
|
1251
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/{pathv1}/configuration?{query}</td>
|
|
1252
|
+
<td style="padding:15px">Yes</td>
|
|
1253
|
+
</tr>
|
|
1254
|
+
<tr>
|
|
1255
|
+
<td style="padding:15px">apiDevicesGetDeviceConfigurationDetails(deviceSerial, details, callback)</td>
|
|
1256
|
+
<td style="padding:15px">Get
|
|
1257
|
+
1) central side configuration.
|
|
1258
|
+
|
|
1259
|
+
2) Device running configuration.
|
|
1260
|
+
|
|
1261
|
+
3) Configuration error details.
|
|
1262
|
+
|
|
1263
|
+
4) Template error details and status of a device belonging to a template group.
|
|
1264
|
+
</td>
|
|
1265
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/{pathv1}/config_details?{query}</td>
|
|
1266
|
+
<td style="padding:15px">Yes</td>
|
|
1267
|
+
</tr>
|
|
1268
|
+
<tr>
|
|
1269
|
+
<td style="padding:15px">apiDevicesGetDevicesTemplateDetails(deviceSerials, callback)</td>
|
|
1270
|
+
<td style="padding:15px">Get templates for a list of devices.</td>
|
|
1271
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/template?{query}</td>
|
|
1272
|
+
<td style="padding:15px">Yes</td>
|
|
1273
|
+
</tr>
|
|
1274
|
+
<tr>
|
|
1275
|
+
<td style="padding:15px">apiDevicesGetGroupsTemplateDetails(limit, offset, includeGroups, excludeGroups, allGroups, deviceType = IAP, callback)</td>
|
|
1276
|
+
<td style="padding:15px">Get templates of devices present in the given list of groups.</td>
|
|
1277
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/groups/template?{query}</td>
|
|
1278
|
+
<td style="padding:15px">Yes</td>
|
|
1279
|
+
</tr>
|
|
1280
|
+
<tr>
|
|
1281
|
+
<td style="padding:15px">apiDevicesGetHashTemplateDetails(templateHash, limit, offset, excludeHash, deviceType = IAP, callback)</td>
|
|
1282
|
+
<td style="padding:15px">Get templates of devices for given template hash (Only allowed for user having all_groups access or admin).</td>
|
|
1283
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/{pathv1}/template?{query}</td>
|
|
1284
|
+
<td style="padding:15px">Yes</td>
|
|
1285
|
+
</tr>
|
|
1286
|
+
<tr>
|
|
1287
|
+
<td style="padding:15px">apiDevicesGetDeviceVariabilisedTemplate(deviceSerial, callback)</td>
|
|
1288
|
+
<td style="padding:15px">Response information.
|
|
1289
|
+
- -----BEGIN TEMPLATE-----
|
|
1290
|
+
- template body
|
|
1291
|
+
- -----END TEMPLATE-----
|
|
1292
|
+
|
|
1293
|
+
- -----BEGIN VARIABLES-----
|
|
1294
|
+
- variables information
|
|
1295
|
+
- -----END VARIABLES-----</td>
|
|
1296
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/{pathv1}/variablised_template?{query}</td>
|
|
1297
|
+
<td style="padding:15px">Yes</td>
|
|
1298
|
+
</tr>
|
|
1299
|
+
<tr>
|
|
1300
|
+
<td style="padding:15px">apiDevicesUpdateSshConnectionInfo(deviceSerial, params, callback)</td>
|
|
1301
|
+
<td style="padding:15px">Set Username, password required for establishing SSH connection to switch.</td>
|
|
1302
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/{pathv1}/ssh_connection?{query}</td>
|
|
1303
|
+
<td style="padding:15px">Yes</td>
|
|
1304
|
+
</tr>
|
|
1305
|
+
<tr>
|
|
1306
|
+
<td style="padding:15px">apiDevicesGetDeviceTemplateVariables(deviceSerial, callback)</td>
|
|
1307
|
+
<td style="padding:15px">Get template variables for a device.</td>
|
|
1308
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/{pathv1}/template_variables?{query}</td>
|
|
1309
|
+
<td style="padding:15px">Yes</td>
|
|
1310
|
+
</tr>
|
|
1311
|
+
<tr>
|
|
1312
|
+
<td style="padding:15px">apiDevicesCreateDeviceTemplateVariables(deviceSerial, variables, callback)</td>
|
|
1313
|
+
<td style="padding:15px">Create template variables for a device for the first time.
|
|
1314
|
+
|
|
1315
|
+
Example:
|
|
1316
|
+
|
|
1317
|
+
Existing variables:
|
|
1318
|
+
None
|
|
1319
|
+
|
|
1320
|
+
Variables provided in this request body:
|
|
1321
|
+
{"_sys_serial": "AB0011111", "_sys_lan_mac": "11:12:AA:13:14:BB", "SSID_A": "Z-Employee"}
|
|
1322
|
+
|
|
1323
|
+
Final output variables:
|
|
1324
|
+
{"_sys_serial": "AB0011111", "_sys_lan_mac": "11:12:AA:13:14:BB", "SSID_A": "Z-Employee"}
|
|
1325
|
+
</td>
|
|
1326
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/{pathv1}/template_variables?{query}</td>
|
|
1327
|
+
<td style="padding:15px">Yes</td>
|
|
1328
|
+
</tr>
|
|
1329
|
+
<tr>
|
|
1330
|
+
<td style="padding:15px">apiDevicesUpdateDeviceTemplateVariables(deviceSerial, variables, callback)</td>
|
|
1331
|
+
<td style="padding:15px">Update values of existing template variables and add new variabels to the existing set of variables for a device.
|
|
1332
|
+
|
|
1333
|
+
Example:
|
|
1334
|
+
|
|
1335
|
+
Existing variables:
|
|
1336
|
+
{"_sys_serial": "AB0011111", "_sys_lan_mac": "11:12:AA:13:14:BB", "SSID_A": "Z-Employee"}
|
|
1337
|
+
|
|
1338
|
+
Variables provided in this request body:
|
|
1339
|
+
{"SSID_A": "X-Employee", "vc_name": "Instant-13:14:BB"}
|
|
1340
|
+
|
|
1341
|
+
Final output variables:
|
|
1342
|
+
{"_sys_serial": "AB0011111", "_sys_lan_mac": "11:12:AA:13:14:BB", "SSID_A": "X-Employee", "vc_name": "Instant-13:14:BB"}
|
|
1343
|
+
|
|
1344
|
+
In Final output ...(description truncated)</td>
|
|
1345
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/{pathv1}/template_variables?{query}</td>
|
|
1346
|
+
<td style="padding:15px">Yes</td>
|
|
1347
|
+
</tr>
|
|
1348
|
+
<tr>
|
|
1349
|
+
<td style="padding:15px">apiDevicesReplaceDeviceTemplateVariables(deviceSerial, variables, callback)</td>
|
|
1350
|
+
<td style="padding:15px">Delete all existing template variables and create requested template variables for a device.
|
|
1351
|
+
This API can be used for deleting some variables out of all for a device.
|
|
1352
|
+
|
|
1353
|
+
Example:
|
|
1354
|
+
|
|
1355
|
+
Existing variables:
|
|
1356
|
+
{"_sys_serial": "AB0011111", "_sys_lan_mac": "11:12:AA:13:14:BB", "SSID_A": "Z-Employee"}
|
|
1357
|
+
|
|
1358
|
+
Variables provided in this request body:
|
|
1359
|
+
{"_sys_serial": "AB0011111", "_sys_lan_mac": "11:12:AA:13:14:BB", "vc_name": "Instant-13:14:BB"}
|
|
1360
|
+
|
|
1361
|
+
Final output variables:
|
|
1362
|
+
{"_sys_serial": "AB0011111", "_sys_lan_mac": ...(description truncated)</td>
|
|
1363
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/{pathv1}/template_variables?{query}</td>
|
|
1364
|
+
<td style="padding:15px">Yes</td>
|
|
1365
|
+
</tr>
|
|
1366
|
+
<tr>
|
|
1367
|
+
<td style="padding:15px">apiDevicesDeleteDeviceTemplateVariables(deviceSerial, callback)</td>
|
|
1368
|
+
<td style="padding:15px">Delete all of the template variables for a device.</td>
|
|
1369
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/{pathv1}/template_variables?{query}</td>
|
|
1370
|
+
<td style="padding:15px">Yes</td>
|
|
1371
|
+
</tr>
|
|
1372
|
+
<tr>
|
|
1373
|
+
<td style="padding:15px">apiDevicesGetAllDevicesTemplateVariables(limit, offset, format = JSON, callback)</td>
|
|
1374
|
+
<td style="padding:15px">Get template variables for all devices, Response is sorted by device serial.</td>
|
|
1375
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/template_variables?{query}</td>
|
|
1376
|
+
<td style="padding:15px">Yes</td>
|
|
1377
|
+
</tr>
|
|
1378
|
+
<tr>
|
|
1379
|
+
<td style="padding:15px">apiDevicesCreateAllDevicesTemplateVariables(format = JSON, variables, callback)</td>
|
|
1380
|
+
<td style="padding:15px">Create template variables for all devices for the first time.
|
|
1381
|
+
|
|
1382
|
+
Example:
|
|
1383
|
+
|
|
1384
|
+
Existing variables:
|
|
1385
|
+
None
|
|
1386
|
+
|
|
1387
|
+
Variables provided in this request body:
|
|
1388
|
+
{"AB0011111": {"_sys_serial": "AB0011111", "_sys_lan_mac": "11:12:AA:13:14:BB", "SSID_A": "Z-Employee"},
|
|
1389
|
+
"AB0022222": {"_sys_serial": "AB0022222", "_sys_lan_mac": "21:22:AA:23:24:BB", "vc_name": "Instant-23:24:BB"}}
|
|
1390
|
+
|
|
1391
|
+
Final output variables:
|
|
1392
|
+
{"AB0011111": {"_sys_serial": "AB0011111", "_sys_lan_mac": "11:12:AA:13:14:BB", "SSID_A": "Z-Employee"},
|
|
1393
|
+
"AB0022...(description truncated)</td>
|
|
1394
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/template_variables?{query}</td>
|
|
1395
|
+
<td style="padding:15px">Yes</td>
|
|
1396
|
+
</tr>
|
|
1397
|
+
<tr>
|
|
1398
|
+
<td style="padding:15px">apiDevicesReplaceAllDevicesTemplateVariables(format = JSON, variables, callback)</td>
|
|
1399
|
+
<td style="padding:15px">Delete all existing template variables and create requested template variables for all devices.
|
|
1400
|
+
This API can be used for deleting some variables out of all for all devices.
|
|
1401
|
+
|
|
1402
|
+
Example:
|
|
1403
|
+
|
|
1404
|
+
Existing variables:
|
|
1405
|
+
{"AB0011111": {"_sys_serial": "AB0011111", "_sys_lan_mac": "11:12:AA:13:14:BB", "SSID_A": "Z-Employee"},
|
|
1406
|
+
"AB0022222": {"_sys_serial": "AB0022222", "_sys_lan_mac": "21:22:AA:23:24:BB", "vc_name": "Instant-23:24:BB"}}
|
|
1407
|
+
|
|
1408
|
+
Variables provided in this request body:
|
|
1409
|
+
{"AB0011111": {"_sys_serial": "AB0...(description truncated)</td>
|
|
1410
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/template_variables?{query}</td>
|
|
1411
|
+
<td style="padding:15px">Yes</td>
|
|
1412
|
+
</tr>
|
|
1413
|
+
<tr>
|
|
1414
|
+
<td style="padding:15px">apiDevicesUpdateAllDevicesTemplateVariables(variables, callback)</td>
|
|
1415
|
+
<td style="padding:15px">Update values of existing template variables and add new variabels to the existing set of variables for all devices.
|
|
1416
|
+
|
|
1417
|
+
Example:
|
|
1418
|
+
|
|
1419
|
+
Existing variables:
|
|
1420
|
+
{"AB0011111": {"_sys_serial": "AB0011111", "_sys_lan_mac": "11:12:AA:13:14:BB", "SSID_A": "Z-Employee"},
|
|
1421
|
+
"AB0022222": {"_sys_serial": "AB0022222", "_sys_lan_mac": "21:22:AA:23:24:BB", "vc_name": "Instant-23:24:BB"}}
|
|
1422
|
+
|
|
1423
|
+
Variables provided in this request body:
|
|
1424
|
+
{"AB0011111": {"_sys_serial": "AB0011111", "_sys_lan_mac": "11:12:AA:13:14:BB", "SSID_A": ...(description truncated)</td>
|
|
1425
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/template_variables?{query}</td>
|
|
1426
|
+
<td style="padding:15px">Yes</td>
|
|
1427
|
+
</tr>
|
|
1428
|
+
<tr>
|
|
1429
|
+
<td style="padding:15px">apiDevicesRecoverMdDevice(deviceSerial, callback)</td>
|
|
1430
|
+
<td style="padding:15px">Trigger Mobility Device recovery.</td>
|
|
1431
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/devices/{pathv1}/recover_device?{query}</td>
|
|
1432
|
+
<td style="padding:15px">Yes</td>
|
|
1433
|
+
</tr>
|
|
1434
|
+
<tr>
|
|
1435
|
+
<td style="padding:15px">apiCertificatesGetCertificates(limit, offset, q, callback)</td>
|
|
1436
|
+
<td style="padding:15px">Get Certificates details uploaded.</td>
|
|
1437
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/certificates?{query}</td>
|
|
1438
|
+
<td style="padding:15px">Yes</td>
|
|
1439
|
+
</tr>
|
|
1440
|
+
<tr>
|
|
1441
|
+
<td style="padding:15px">apiCertificatesUploadCertificate(certificate, callback)</td>
|
|
1442
|
+
<td style="padding:15px">Upload a certificate.</td>
|
|
1443
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/certificates?{query}</td>
|
|
1444
|
+
<td style="padding:15px">Yes</td>
|
|
1445
|
+
</tr>
|
|
1446
|
+
<tr>
|
|
1447
|
+
<td style="padding:15px">apiCertificatesDeleteCertificate(certificate, callback)</td>
|
|
1448
|
+
<td style="padding:15px">Delete existing certificate.</td>
|
|
1449
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/certificates/{pathv1}?{query}</td>
|
|
1450
|
+
<td style="padding:15px">Yes</td>
|
|
1451
|
+
</tr>
|
|
1452
|
+
<tr>
|
|
1453
|
+
<td style="padding:15px">apiCertificatesMspUpdateCertificate(certificate, callback)</td>
|
|
1454
|
+
<td style="padding:15px">Update a certificate.</td>
|
|
1455
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/msp/certificate?{query}</td>
|
|
1456
|
+
<td style="padding:15px">Yes</td>
|
|
1457
|
+
</tr>
|
|
1458
|
+
<tr>
|
|
1459
|
+
<td style="padding:15px">apiCpLogoGetCpLogos(limit, offset, callback)</td>
|
|
1460
|
+
<td style="padding:15px">Get Captive Portal Logos uploaded.</td>
|
|
1461
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/cplogo?{query}</td>
|
|
1462
|
+
<td style="padding:15px">Yes</td>
|
|
1463
|
+
</tr>
|
|
1464
|
+
<tr>
|
|
1465
|
+
<td style="padding:15px">apiCpLogoUploadCpLogo(cplogo, callback)</td>
|
|
1466
|
+
<td style="padding:15px">API to upload captive portal logo.
|
|
1467
|
+
|
|
1468
|
+
Validations for the uploaded logo:
|
|
1469
|
+
|
|
1470
|
+
1) Filename should be of the format: name.extension.
|
|
1471
|
+
|
|
1472
|
+
2) Image types supported: jpg, jpeg, png, gif.
|
|
1473
|
+
|
|
1474
|
+
3) Logo size should not exceed 16kB.
|
|
1475
|
+
|
|
1476
|
+
4) Logo data should be in base64 format.
|
|
1477
|
+
</td>
|
|
1478
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/cplogo?{query}</td>
|
|
1479
|
+
<td style="padding:15px">Yes</td>
|
|
1480
|
+
</tr>
|
|
1481
|
+
<tr>
|
|
1482
|
+
<td style="padding:15px">apiCpLogoDeleteCpLogo(checksum, callback)</td>
|
|
1483
|
+
<td style="padding:15px">Delete existing captive portal logo.</td>
|
|
1484
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/cplogo/{pathv1}?{query}</td>
|
|
1485
|
+
<td style="padding:15px">Yes</td>
|
|
1486
|
+
</tr>
|
|
1487
|
+
<tr>
|
|
1488
|
+
<td style="padding:15px">apiTemplatesGetMspCustomerTemplates(limit, offset, deviceType = IAP, version, model, callback)</td>
|
|
1489
|
+
<td style="padding:15px">Get all MSP customer level templates details.
|
|
1490
|
+
|
|
1491
|
+
Query can be filtered by device_type, version, model.
|
|
1492
|
+
</td>
|
|
1493
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/msp/templates?{query}</td>
|
|
1494
|
+
<td style="padding:15px">Yes</td>
|
|
1495
|
+
</tr>
|
|
1496
|
+
<tr>
|
|
1497
|
+
<td style="padding:15px">apiTemplatesGetMspCustomerTemplateText(deviceType = IAP, version, model, callback)</td>
|
|
1498
|
+
<td style="padding:15px">Get MSP level template text.</td>
|
|
1499
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/msp/templates/{pathv1}/{pathv2}/{pathv3}?{query}</td>
|
|
1500
|
+
<td style="padding:15px">Yes</td>
|
|
1501
|
+
</tr>
|
|
1502
|
+
<tr>
|
|
1503
|
+
<td style="padding:15px">apiTemplatesDeleteMspCustomerTemplate(deviceType = IAP, version, model, callback)</td>
|
|
1504
|
+
<td style="padding:15px">Delete existing MSP customer template.</td>
|
|
1505
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/msp/templates/{pathv1}/{pathv2}/{pathv3}?{query}</td>
|
|
1506
|
+
<td style="padding:15px">Yes</td>
|
|
1507
|
+
</tr>
|
|
1508
|
+
<tr>
|
|
1509
|
+
<td style="padding:15px">apiTemplatesSetMspCustomerTemplate(deviceType = IAP, version, model, template, callback)</td>
|
|
1510
|
+
<td style="padding:15px">Update MSP customer level template to matching model and version.
|
|
1511
|
+
|
|
1512
|
+
This would not apply MSP template to end customers and template groups for end customers.
|
|
1513
|
+
</td>
|
|
1514
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/msp/templates?{query}</td>
|
|
1515
|
+
<td style="padding:15px">Yes</td>
|
|
1516
|
+
</tr>
|
|
1517
|
+
<tr>
|
|
1518
|
+
<td style="padding:15px">apiTemplatesGetEndCustomerTemplates(cid, limit, offset, deviceType = IAP, version, model, callback)</td>
|
|
1519
|
+
<td style="padding:15px">Get all end customer level templates details.
|
|
1520
|
+
|
|
1521
|
+
Query can be filtered by device_type, version, model.
|
|
1522
|
+
</td>
|
|
1523
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/msp/templates/customer/{pathv1}?{query}</td>
|
|
1524
|
+
<td style="padding:15px">Yes</td>
|
|
1525
|
+
</tr>
|
|
1526
|
+
<tr>
|
|
1527
|
+
<td style="padding:15px">apiTemplatesGetEndCustomerTemplateText(cid, deviceType = IAP, version, model, callback)</td>
|
|
1528
|
+
<td style="padding:15px">Get end-customer level template text.</td>
|
|
1529
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/msp/templates/customer/{pathv1}/{pathv2}/{pathv3}/{pathv4}?{query}</td>
|
|
1530
|
+
<td style="padding:15px">Yes</td>
|
|
1531
|
+
</tr>
|
|
1532
|
+
<tr>
|
|
1533
|
+
<td style="padding:15px">apiTemplatesDeleteEndCustomerTemplate(cid, deviceType = IAP, version, model, callback)</td>
|
|
1534
|
+
<td style="padding:15px">Delete existing end customer template.</td>
|
|
1535
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/msp/templates/customer/{pathv1}/{pathv2}/{pathv3}/{pathv4}?{query}</td>
|
|
1536
|
+
<td style="padding:15px">Yes</td>
|
|
1537
|
+
</tr>
|
|
1538
|
+
<tr>
|
|
1539
|
+
<td style="padding:15px">apiTemplatesSetEndCustomerTemplate(cid, deviceType = IAP, version, model, template, callback)</td>
|
|
1540
|
+
<td style="padding:15px">Update end customer level template to matching model and version.
|
|
1541
|
+
|
|
1542
|
+
This would not apply template to any template groups at end customer.
|
|
1543
|
+
</td>
|
|
1544
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/msp/templates/customer/{pathv1}?{query}</td>
|
|
1545
|
+
<td style="padding:15px">Yes</td>
|
|
1546
|
+
</tr>
|
|
1547
|
+
<tr>
|
|
1548
|
+
<td style="padding:15px">apiTemplatesGetMspTmplDifferCustsGroups(deviceType = IAP, version, model, limit, offset, callback)</td>
|
|
1549
|
+
<td style="padding:15px">Get customers and groups where given MSP level template is not applied. It will take only MSP token as input.
|
|
1550
|
+
|
|
1551
|
+
Note: If the limit and the offset are not provided, records for first 100 customers will be returned.
|
|
1552
|
+
</td>
|
|
1553
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/msp/templates/differences/{pathv1}/{pathv2}/{pathv3}?{query}</td>
|
|
1554
|
+
<td style="padding:15px">Yes</td>
|
|
1555
|
+
</tr>
|
|
1556
|
+
<tr>
|
|
1557
|
+
<td style="padding:15px">apiTemplatesGetMspTmplEndCustDifferGroups(cid, deviceType = IAP, version, model, callback)</td>
|
|
1558
|
+
<td style="padding:15px">Get groups for given end customer where MSP Level template is not applied. It will take only MSP token as input.</td>
|
|
1559
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/msp/templates/differences/customer/{pathv1}/{pathv2}/{pathv3}/{pathv4}?{query}</td>
|
|
1560
|
+
<td style="padding:15px">Yes</td>
|
|
1561
|
+
</tr>
|
|
1562
|
+
<tr>
|
|
1563
|
+
<td style="padding:15px">apiTemplatesApplyMspCustomerTemplate(applyCustomers, deviceType = IAP, version, model, callback)</td>
|
|
1564
|
+
<td style="padding:15px">Apply MSP customer level template to matching model and version to end customers.
|
|
1565
|
+
|
|
1566
|
+
This would not apply template to template groups at end customers.
|
|
1567
|
+
</td>
|
|
1568
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/msp/templates/end_customers/{pathv1}/{pathv2}/{pathv3}?{query}</td>
|
|
1569
|
+
<td style="padding:15px">Yes</td>
|
|
1570
|
+
</tr>
|
|
1571
|
+
<tr>
|
|
1572
|
+
<td style="padding:15px">apiTemplatesApplyEndCustomerTemplate(cid, applyGroups, deviceType = IAP, version, model, callback)</td>
|
|
1573
|
+
<td style="padding:15px">Apply end customer level template to end customer groups.</td>
|
|
1574
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/msp/templates/end_customers/{pathv1}/{pathv2}/{pathv3}/{pathv4}/groups?{query}</td>
|
|
1575
|
+
<td style="padding:15px">Yes</td>
|
|
1576
|
+
</tr>
|
|
1577
|
+
<tr>
|
|
1578
|
+
<td style="padding:15px">apiConfigModeGetCustConfigMode(callback)</td>
|
|
1579
|
+
<td style="padding:15px">Get configuration mode as either Monitor or Managed mode at customer level. Configuration mode (Monitor-Manage) APIs are available for private cloud only.
|
|
1580
|
+
Use Save Commit APIs for public cloud.</td>
|
|
1581
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/mode?{query}</td>
|
|
1582
|
+
<td style="padding:15px">Yes</td>
|
|
1583
|
+
</tr>
|
|
1584
|
+
<tr>
|
|
1585
|
+
<td style="padding:15px">apiConfigModeSetCustConfigMode(configMode, callback)</td>
|
|
1586
|
+
<td style="padding:15px">Set configuration mode as either Monitor or Manage at customer level. Configuration mode (Monitor-Manage) APIs are available for private cloud only.
|
|
1587
|
+
Use Save Commit APIs for public cloud.</td>
|
|
1588
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/mode?{query}</td>
|
|
1589
|
+
<td style="padding:15px">Yes</td>
|
|
1590
|
+
</tr>
|
|
1591
|
+
<tr>
|
|
1592
|
+
<td style="padding:15px">apiConfigModeGetGroupConfigMode(limit, offset, q, callback)</td>
|
|
1593
|
+
<td style="padding:15px">Get configuration mode as either Monitor or Managed mode at group level. Configuration mode (Monitor-Manage) APIs are available for private cloud only.
|
|
1594
|
+
Use Save Commit APIs for public cloud.</td>
|
|
1595
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/mode/group?{query}</td>
|
|
1596
|
+
<td style="padding:15px">Yes</td>
|
|
1597
|
+
</tr>
|
|
1598
|
+
<tr>
|
|
1599
|
+
<td style="padding:15px">apiConfigModeSetGroupConfigMode(configMode, callback)</td>
|
|
1600
|
+
<td style="padding:15px">Set configuration mode as either Monitor or Manage at group level. Configuration mode (Monitor-Manage) APIs are available for private cloud only.
|
|
1601
|
+
Use Save Commit APIs for public cloud.</td>
|
|
1602
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/mode/group?{query}</td>
|
|
1603
|
+
<td style="padding:15px">Yes</td>
|
|
1604
|
+
</tr>
|
|
1605
|
+
<tr>
|
|
1606
|
+
<td style="padding:15px">apiConfigModeGetDeviceConfigMode(limit, offset, group, callback)</td>
|
|
1607
|
+
<td style="padding:15px">Get configuration mode as either Monitor or Managed mode at device level in given group. Configuration mode (Monitor-Manage) APIs are available for private cloud only.
|
|
1608
|
+
Use Save Commit APIs for public cloud.</td>
|
|
1609
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/mode/device?{query}</td>
|
|
1610
|
+
<td style="padding:15px">Yes</td>
|
|
1611
|
+
</tr>
|
|
1612
|
+
<tr>
|
|
1613
|
+
<td style="padding:15px">apiConfigModeSetDeviceConfigMode(configMode, callback)</td>
|
|
1614
|
+
<td style="padding:15px">Set configuration mode as either Monitor or Manage for given devices. Configuration mode (Monitor-Manage) APIs are available for private cloud only.
|
|
1615
|
+
Use Save Commit APIs for public cloud.</td>
|
|
1616
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/mode/device?{query}</td>
|
|
1617
|
+
<td style="padding:15px">Yes</td>
|
|
1618
|
+
</tr>
|
|
1619
|
+
<tr>
|
|
1620
|
+
<td style="padding:15px">apiConfigModeGetDeviceSerialsConfigMode(deviceSerials, callback)</td>
|
|
1621
|
+
<td style="padding:15px">Get configuration mode as either Monitor or Managed mode for device serials. Configuration mode (Monitor-Manage) APIs are available for private cloud only.
|
|
1622
|
+
Use Save Commit APIs for public cloud.</td>
|
|
1623
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/mode/devices?{query}</td>
|
|
1624
|
+
<td style="padding:15px">Yes</td>
|
|
1625
|
+
</tr>
|
|
1626
|
+
<tr>
|
|
1627
|
+
<td style="padding:15px">apiVariablesFirewallGetVfwGroups(callback)</td>
|
|
1628
|
+
<td style="padding:15px">Get whitelisted groups in Variables Firewall.
|
|
1629
|
+
|
|
1630
|
+
NOTE: Variables Firewall APIs are available for private cloud only.
|
|
1631
|
+
</td>
|
|
1632
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/variables_firewall/groups?{query}</td>
|
|
1633
|
+
<td style="padding:15px">Yes</td>
|
|
1634
|
+
</tr>
|
|
1635
|
+
<tr>
|
|
1636
|
+
<td style="padding:15px">apiVariablesFirewallUpdateVfwGroups(groups, callback)</td>
|
|
1637
|
+
<td style="padding:15px">Add groups to Variables Firewall whitelist.
|
|
1638
|
+
|
|
1639
|
+
NOTE: Variables Firewall APIs are available for private cloud only.
|
|
1640
|
+
</td>
|
|
1641
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/variables_firewall/groups?{query}</td>
|
|
1642
|
+
<td style="padding:15px">Yes</td>
|
|
1643
|
+
</tr>
|
|
1644
|
+
<tr>
|
|
1645
|
+
<td style="padding:15px">apiVariablesFirewallDeleteVfwGroup(group, callback)</td>
|
|
1646
|
+
<td style="padding:15px">Delete group from Variables Firewall whitelist.
|
|
1647
|
+
|
|
1648
|
+
NOTE: Variables Firewall APIs are available for private cloud only.
|
|
1649
|
+
</td>
|
|
1650
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/variables_firewall/groups/{pathv1}?{query}</td>
|
|
1651
|
+
<td style="padding:15px">Yes</td>
|
|
1652
|
+
</tr>
|
|
1653
|
+
<tr>
|
|
1654
|
+
<td style="padding:15px">apiVariablesFirewallGetVfwVariables(callback)</td>
|
|
1655
|
+
<td style="padding:15px">Get whitelisted variables in Variables Firewall.
|
|
1656
|
+
|
|
1657
|
+
NOTE: Variables Firewall APIs are available for private cloud only.
|
|
1658
|
+
</td>
|
|
1659
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/variables_firewall/variables?{query}</td>
|
|
1660
|
+
<td style="padding:15px">Yes</td>
|
|
1661
|
+
</tr>
|
|
1662
|
+
<tr>
|
|
1663
|
+
<td style="padding:15px">apiVariablesFirewallUpdateVfwVariables(variables, callback)</td>
|
|
1664
|
+
<td style="padding:15px">Add variables to Variables Firewall whitelist.
|
|
1665
|
+
|
|
1666
|
+
NOTE: Variables Firewall APIs are available for private cloud only.
|
|
1667
|
+
</td>
|
|
1668
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/variables_firewall/variables?{query}</td>
|
|
1669
|
+
<td style="padding:15px">Yes</td>
|
|
1670
|
+
</tr>
|
|
1671
|
+
<tr>
|
|
1672
|
+
<td style="padding:15px">apiVariablesFirewallDeleteVfwVariable(variable, callback)</td>
|
|
1673
|
+
<td style="padding:15px">Delete variable from Variables Firewall whitelist.
|
|
1674
|
+
|
|
1675
|
+
NOTE: Variables Firewall APIs are available for private cloud only.
|
|
1676
|
+
</td>
|
|
1677
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/variables_firewall/variables/{pathv1}?{query}</td>
|
|
1678
|
+
<td style="padding:15px">Yes</td>
|
|
1679
|
+
</tr>
|
|
1680
|
+
<tr>
|
|
1681
|
+
<td style="padding:15px">apiNbUiGroupConfigSetGroupConfigCountryCode(setGroupConfigCountryCode, callback)</td>
|
|
1682
|
+
<td style="padding:15px">Set country code at group level.
|
|
1683
|
+
|
|
1684
|
+
|
|
1685
|
+
Note: This API is for UI groups only. Not supported for template groups.
|
|
1686
|
+
|
|
1687
|
+
Note: IAP's need to be rebooted for changes to take effect.
|
|
1688
|
+
</td>
|
|
1689
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/country?{query}</td>
|
|
1690
|
+
<td style="padding:15px">Yes</td>
|
|
1691
|
+
</tr>
|
|
1692
|
+
<tr>
|
|
1693
|
+
<td style="padding:15px">apiNbUiGroupConfigGetGroupCountry(group, callback)</td>
|
|
1694
|
+
<td style="padding:15px">Get country code set for group.
|
|
1695
|
+
|
|
1696
|
+
Note: This API is for UI groups only. Not supported for template groups.
|
|
1697
|
+
</td>
|
|
1698
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/{pathv1}/country?{query}</td>
|
|
1699
|
+
<td style="padding:15px">Yes</td>
|
|
1700
|
+
</tr>
|
|
1701
|
+
<tr>
|
|
1702
|
+
<td style="padding:15px">apiSaveCommitGetGroupsAutoCommitState(limit, offset, q, callback)</td>
|
|
1703
|
+
<td style="padding:15px">Get auto commit state as either On or Off at group level.</td>
|
|
1704
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/auto_commit_state/groups?{query}</td>
|
|
1705
|
+
<td style="padding:15px">Yes</td>
|
|
1706
|
+
</tr>
|
|
1707
|
+
<tr>
|
|
1708
|
+
<td style="padding:15px">apiSaveCommitSetGroupsAutoCommitState(autoCommitState, callback)</td>
|
|
1709
|
+
<td style="padding:15px">Set auto commit state as either On or Off at group level.</td>
|
|
1710
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/auto_commit_state/groups?{query}</td>
|
|
1711
|
+
<td style="padding:15px">Yes</td>
|
|
1712
|
+
</tr>
|
|
1713
|
+
<tr>
|
|
1714
|
+
<td style="padding:15px">apiSaveCommitGetDeviceSerialsAutoCommitState(deviceSerials, callback)</td>
|
|
1715
|
+
<td style="padding:15px">Get auto commit state as either On or Off for device serials.</td>
|
|
1716
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/auto_commit_state/devices?{query}</td>
|
|
1717
|
+
<td style="padding:15px">Yes</td>
|
|
1718
|
+
</tr>
|
|
1719
|
+
<tr>
|
|
1720
|
+
<td style="padding:15px">apiSaveCommitSetDeviceSerialsAutoCommitState(autoCommitState, callback)</td>
|
|
1721
|
+
<td style="padding:15px">Set auto commit state as either On or Off for given devices.
|
|
1722
|
+
Auto commit state for a device cannot be set to 'On' when the auto commit state of the group
|
|
1723
|
+
it belongs to is 'Off'
|
|
1724
|
+
</td>
|
|
1725
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/auto_commit_state/devices?{query}</td>
|
|
1726
|
+
<td style="padding:15px">Yes</td>
|
|
1727
|
+
</tr>
|
|
1728
|
+
<tr>
|
|
1729
|
+
<td style="padding:15px">apiSaveCommitCommitGroupConfig(commitMode, callback)</td>
|
|
1730
|
+
<td style="padding:15px">Commit configurations for given groups.</td>
|
|
1731
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/commit/groups?{query}</td>
|
|
1732
|
+
<td style="padding:15px">Yes</td>
|
|
1733
|
+
</tr>
|
|
1734
|
+
<tr>
|
|
1735
|
+
<td style="padding:15px">apiSaveCommitCommitDeviceConfig(commitMode, callback)</td>
|
|
1736
|
+
<td style="padding:15px">Commit configurations for given devices.</td>
|
|
1737
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/commit/devices?{query}</td>
|
|
1738
|
+
<td style="padding:15px">Yes</td>
|
|
1739
|
+
</tr>
|
|
1740
|
+
<tr>
|
|
1741
|
+
<td style="padding:15px">apiBlacklistClientGetBlacklistClients(deviceId, callback)</td>
|
|
1742
|
+
<td style="padding:15px">Get all denylist client mac addresses in device.</td>
|
|
1743
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/swarm/{pathv1}/blacklisting?{query}</td>
|
|
1744
|
+
<td style="padding:15px">Yes</td>
|
|
1745
|
+
</tr>
|
|
1746
|
+
<tr>
|
|
1747
|
+
<td style="padding:15px">apiBlacklistClientAddBlacklistClients(deviceId, blacklist, callback)</td>
|
|
1748
|
+
<td style="padding:15px">Add denylist clients.</td>
|
|
1749
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/swarm/{pathv1}/blacklisting?{query}</td>
|
|
1750
|
+
<td style="padding:15px">Yes</td>
|
|
1751
|
+
</tr>
|
|
1752
|
+
<tr>
|
|
1753
|
+
<td style="padding:15px">apiBlacklistClientDeleteBlacklistClients(deviceId, blacklist, callback)</td>
|
|
1754
|
+
<td style="padding:15px">Delete denylist clients.</td>
|
|
1755
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/swarm/{pathv1}/blacklisting?{query}</td>
|
|
1756
|
+
<td style="padding:15px">Yes</td>
|
|
1757
|
+
</tr>
|
|
1758
|
+
<tr>
|
|
1759
|
+
<td style="padding:15px">apiWlanGetWlanList(groupNameOrGuid, callback)</td>
|
|
1760
|
+
<td style="padding:15px">Get WLAN list of an UI group.</td>
|
|
1761
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/wlan/{pathv1}?{query}</td>
|
|
1762
|
+
<td style="padding:15px">Yes</td>
|
|
1763
|
+
</tr>
|
|
1764
|
+
<tr>
|
|
1765
|
+
<td style="padding:15px">apiWlanGetWlanTemplate(groupNameOrGuid, callback)</td>
|
|
1766
|
+
<td style="padding:15px">Get WLAN default configuration.</td>
|
|
1767
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/wlan/{pathv1}/template?{query}</td>
|
|
1768
|
+
<td style="padding:15px">Yes</td>
|
|
1769
|
+
</tr>
|
|
1770
|
+
<tr>
|
|
1771
|
+
<td style="padding:15px">apiWlanGetProtocolMap(groupNameOrGuid, callback)</td>
|
|
1772
|
+
<td style="padding:15px">Get WLAN access rule protocol map.</td>
|
|
1773
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/wlan/{pathv1}/protocol_map?{query}</td>
|
|
1774
|
+
<td style="padding:15px">Yes</td>
|
|
1775
|
+
</tr>
|
|
1776
|
+
<tr>
|
|
1777
|
+
<td style="padding:15px">apiWlanGetAccessRuleServices(groupNameOrGuid, callback)</td>
|
|
1778
|
+
<td style="padding:15px">Get WLAN access rule services.</td>
|
|
1779
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/wlan/{pathv1}/access_rule_services?{query}</td>
|
|
1780
|
+
<td style="padding:15px">Yes</td>
|
|
1781
|
+
</tr>
|
|
1782
|
+
<tr>
|
|
1783
|
+
<td style="padding:15px">apiWlanGetWlan(groupNameOrGuid, wlanName, callback)</td>
|
|
1784
|
+
<td style="padding:15px">(Deprecated) Get the information of an existing WLAN.</td>
|
|
1785
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/wlan/{pathv1}/{pathv2}?{query}</td>
|
|
1786
|
+
<td style="padding:15px">Yes</td>
|
|
1787
|
+
</tr>
|
|
1788
|
+
<tr>
|
|
1789
|
+
<td style="padding:15px">apiWlanCreateWlan(groupNameOrGuid, wlanName, wlanData, callback)</td>
|
|
1790
|
+
<td style="padding:15px">(Deprecated) Create a new WLAN.</td>
|
|
1791
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/wlan/{pathv1}/{pathv2}?{query}</td>
|
|
1792
|
+
<td style="padding:15px">Yes</td>
|
|
1793
|
+
</tr>
|
|
1794
|
+
<tr>
|
|
1795
|
+
<td style="padding:15px">apiWlanCleanUpAndUpdateWlan(groupNameOrGuid, wlanName, wlanData, callback)</td>
|
|
1796
|
+
<td style="padding:15px">(Deprecated) Update an existing WLAN and clean up unsupported fields.</td>
|
|
1797
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/wlan/{pathv1}/{pathv2}?{query}</td>
|
|
1798
|
+
<td style="padding:15px">Yes</td>
|
|
1799
|
+
</tr>
|
|
1800
|
+
<tr>
|
|
1801
|
+
<td style="padding:15px">apiWlanUpdateWlan(groupNameOrGuid, wlanName, wlanData, callback)</td>
|
|
1802
|
+
<td style="padding:15px">(Deprecated) Update an existing WLAN.</td>
|
|
1803
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/wlan/{pathv1}/{pathv2}?{query}</td>
|
|
1804
|
+
<td style="padding:15px">Yes</td>
|
|
1805
|
+
</tr>
|
|
1806
|
+
<tr>
|
|
1807
|
+
<td style="padding:15px">apiWlanDeleteWlan(groupNameOrGuid, wlanName, callback)</td>
|
|
1808
|
+
<td style="padding:15px">Delete an existing WLAN.</td>
|
|
1809
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/wlan/{pathv1}/{pathv2}?{query}</td>
|
|
1810
|
+
<td style="padding:15px">Yes</td>
|
|
1811
|
+
</tr>
|
|
1812
|
+
<tr>
|
|
1813
|
+
<td style="padding:15px">apiWlanGetWlanV2(groupNameOrGuid, wlanName, callback)</td>
|
|
1814
|
+
<td style="padding:15px">Get the information of an existing WLAN.</td>
|
|
1815
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/wlan/{pathv1}/{pathv2}?{query}</td>
|
|
1816
|
+
<td style="padding:15px">Yes</td>
|
|
1817
|
+
</tr>
|
|
1818
|
+
<tr>
|
|
1819
|
+
<td style="padding:15px">apiWlanCreateWlanV2(groupNameOrGuid, wlanName, wlanData, callback)</td>
|
|
1820
|
+
<td style="padding:15px">Create a new WLAN.</td>
|
|
1821
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/wlan/{pathv1}/{pathv2}?{query}</td>
|
|
1822
|
+
<td style="padding:15px">Yes</td>
|
|
1823
|
+
</tr>
|
|
1824
|
+
<tr>
|
|
1825
|
+
<td style="padding:15px">apiWlanCleanUpAndUpdateWlanV2(groupNameOrGuid, wlanName, wlanData, callback)</td>
|
|
1826
|
+
<td style="padding:15px">Update an existing WLAN and clean up unsupported fields.</td>
|
|
1827
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/wlan/{pathv1}/{pathv2}?{query}</td>
|
|
1828
|
+
<td style="padding:15px">Yes</td>
|
|
1829
|
+
</tr>
|
|
1830
|
+
<tr>
|
|
1831
|
+
<td style="padding:15px">apiWlanUpdateWlanV2(groupNameOrGuid, wlanName, wlanData, callback)</td>
|
|
1832
|
+
<td style="padding:15px">Update an existing WLAN.</td>
|
|
1833
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/wlan/{pathv1}/{pathv2}?{query}</td>
|
|
1834
|
+
<td style="padding:15px">Yes</td>
|
|
1835
|
+
</tr>
|
|
1836
|
+
<tr>
|
|
1837
|
+
<td style="padding:15px">apiFullWlanGetWlanList(groupNameOrGuid, callback)</td>
|
|
1838
|
+
<td style="padding:15px">Get WLAN list of an UI group.</td>
|
|
1839
|
+
<td style="padding:15px">{base_path}/{version}/configuration/full_wlan/{pathv1}?{query}</td>
|
|
1840
|
+
<td style="padding:15px">Yes</td>
|
|
1841
|
+
</tr>
|
|
1842
|
+
<tr>
|
|
1843
|
+
<td style="padding:15px">apiFullWlanGetWlanTemplate(groupNameOrGuid, callback)</td>
|
|
1844
|
+
<td style="padding:15px">Get WLAN default configuration.</td>
|
|
1845
|
+
<td style="padding:15px">{base_path}/{version}/configuration/full_wlan/{pathv1}/template?{query}</td>
|
|
1846
|
+
<td style="padding:15px">Yes</td>
|
|
1847
|
+
</tr>
|
|
1848
|
+
<tr>
|
|
1849
|
+
<td style="padding:15px">apiFullWlanGetProtocolMap(groupNameOrGuid, callback)</td>
|
|
1850
|
+
<td style="padding:15px">Get WLAN access rule protocol map.</td>
|
|
1851
|
+
<td style="padding:15px">{base_path}/{version}/configuration/full_wlan/{pathv1}/protocol_map?{query}</td>
|
|
1852
|
+
<td style="padding:15px">Yes</td>
|
|
1853
|
+
</tr>
|
|
1854
|
+
<tr>
|
|
1855
|
+
<td style="padding:15px">apiFullWlanGetAccessRuleServices(groupNameOrGuid, callback)</td>
|
|
1856
|
+
<td style="padding:15px">Get WLAN access rule services.</td>
|
|
1857
|
+
<td style="padding:15px">{base_path}/{version}/configuration/full_wlan/{pathv1}/access_rule_services?{query}</td>
|
|
1858
|
+
<td style="padding:15px">Yes</td>
|
|
1859
|
+
</tr>
|
|
1860
|
+
<tr>
|
|
1861
|
+
<td style="padding:15px">apiFullWlanGetWlan(groupNameOrGuid, wlanName, callback)</td>
|
|
1862
|
+
<td style="padding:15px">Get the information of an existing WLAN.</td>
|
|
1863
|
+
<td style="padding:15px">{base_path}/{version}/configuration/full_wlan/{pathv1}/{pathv2}?{query}</td>
|
|
1864
|
+
<td style="padding:15px">Yes</td>
|
|
1865
|
+
</tr>
|
|
1866
|
+
<tr>
|
|
1867
|
+
<td style="padding:15px">apiFullWlanCreateWlan(groupNameOrGuid, wlanName, wlanData, callback)</td>
|
|
1868
|
+
<td style="padding:15px">Create a new WLAN.</td>
|
|
1869
|
+
<td style="padding:15px">{base_path}/{version}/configuration/full_wlan/{pathv1}/{pathv2}?{query}</td>
|
|
1870
|
+
<td style="padding:15px">Yes</td>
|
|
1871
|
+
</tr>
|
|
1872
|
+
<tr>
|
|
1873
|
+
<td style="padding:15px">apiFullWlanUpdateWlan(groupNameOrGuid, wlanName, wlanData, callback)</td>
|
|
1874
|
+
<td style="padding:15px">Update an existing WLAN.</td>
|
|
1875
|
+
<td style="padding:15px">{base_path}/{version}/configuration/full_wlan/{pathv1}/{pathv2}?{query}</td>
|
|
1876
|
+
<td style="padding:15px">Yes</td>
|
|
1877
|
+
</tr>
|
|
1878
|
+
<tr>
|
|
1879
|
+
<td style="padding:15px">apiFullWlanDeleteWlan(groupNameOrGuid, wlanName, callback)</td>
|
|
1880
|
+
<td style="padding:15px">Delete an existing WLAN.</td>
|
|
1881
|
+
<td style="padding:15px">{base_path}/{version}/configuration/full_wlan/{pathv1}/{pathv2}?{query}</td>
|
|
1882
|
+
<td style="padding:15px">Yes</td>
|
|
1883
|
+
</tr>
|
|
1884
|
+
<tr>
|
|
1885
|
+
<td style="padding:15px">apiFullHotspotGetHotspotList(groupNameOrGuid, callback)</td>
|
|
1886
|
+
<td style="padding:15px">Get hotspot list of an UI group or swarm.</td>
|
|
1887
|
+
<td style="padding:15px">{base_path}/{version}/configuration/full_hotspot/{pathv1}?{query}</td>
|
|
1888
|
+
<td style="padding:15px">Yes</td>
|
|
1889
|
+
</tr>
|
|
1890
|
+
<tr>
|
|
1891
|
+
<td style="padding:15px">apiFullHotspotGetHotspotListByModeName(groupNameOrGuid, modeName, callback)</td>
|
|
1892
|
+
<td style="padding:15px">Get hotspot list of an UI group or swarm with mode name.</td>
|
|
1893
|
+
<td style="padding:15px">{base_path}/{version}/configuration/full_hotspot/{pathv1}/{pathv2}?{query}</td>
|
|
1894
|
+
<td style="padding:15px">Yes</td>
|
|
1895
|
+
</tr>
|
|
1896
|
+
<tr>
|
|
1897
|
+
<td style="padding:15px">apiFullHotspotGetHotspotTemplates(groupNameOrGuid, callback)</td>
|
|
1898
|
+
<td style="padding:15px">Get hotspot default configuration.</td>
|
|
1899
|
+
<td style="padding:15px">{base_path}/{version}/configuration/full_hotspot/{pathv1}/template?{query}</td>
|
|
1900
|
+
<td style="padding:15px">Yes</td>
|
|
1901
|
+
</tr>
|
|
1902
|
+
<tr>
|
|
1903
|
+
<td style="padding:15px">apiFullHotspotGetHotspot(groupNameOrGuid, hotspotName, modeName, callback)</td>
|
|
1904
|
+
<td style="padding:15px">Get the information of an existing hotspot.</td>
|
|
1905
|
+
<td style="padding:15px">{base_path}/{version}/configuration/full_hotspot/{pathv1}/{pathv2}/{pathv3}?{query}</td>
|
|
1906
|
+
<td style="padding:15px">Yes</td>
|
|
1907
|
+
</tr>
|
|
1908
|
+
<tr>
|
|
1909
|
+
<td style="padding:15px">apiFullHotspotCreateHotspot(groupNameOrGuid, hotspotName, modeName, hotspotData, callback)</td>
|
|
1910
|
+
<td style="padding:15px">Create a new hotspot.</td>
|
|
1911
|
+
<td style="padding:15px">{base_path}/{version}/configuration/full_hotspot/{pathv1}/{pathv2}/{pathv3}?{query}</td>
|
|
1912
|
+
<td style="padding:15px">Yes</td>
|
|
1913
|
+
</tr>
|
|
1914
|
+
<tr>
|
|
1915
|
+
<td style="padding:15px">apiFullHotspotUpdateHotspot(groupNameOrGuid, hotspotName, modeName, hotspotData, callback)</td>
|
|
1916
|
+
<td style="padding:15px">Update an existing hotspot.</td>
|
|
1917
|
+
<td style="padding:15px">{base_path}/{version}/configuration/full_hotspot/{pathv1}/{pathv2}/{pathv3}?{query}</td>
|
|
1918
|
+
<td style="padding:15px">Yes</td>
|
|
1919
|
+
</tr>
|
|
1920
|
+
<tr>
|
|
1921
|
+
<td style="padding:15px">apiFullHotspotDeleteHotspot(groupNameOrGuid, hotspotName, modeName, callback)</td>
|
|
1922
|
+
<td style="padding:15px">Delete an existing hotspot.</td>
|
|
1923
|
+
<td style="padding:15px">{base_path}/{version}/configuration/full_hotspot/{pathv1}/{pathv2}/{pathv3}?{query}</td>
|
|
1924
|
+
<td style="padding:15px">Yes</td>
|
|
1925
|
+
</tr>
|
|
1926
|
+
<tr>
|
|
1927
|
+
<td style="padding:15px">apiApSettingsGetApSettings(serialNumber, callback)</td>
|
|
1928
|
+
<td style="padding:15px">(Deprecated) Get an existing ap settings.</td>
|
|
1929
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/ap_settings/{pathv1}?{query}</td>
|
|
1930
|
+
<td style="padding:15px">Yes</td>
|
|
1931
|
+
</tr>
|
|
1932
|
+
<tr>
|
|
1933
|
+
<td style="padding:15px">apiApSettingsUpdateApSettings(serialNumber, apSettingsData, callback)</td>
|
|
1934
|
+
<td style="padding:15px">(Deprecated) Update an existing ap settings.</td>
|
|
1935
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/ap_settings/{pathv1}?{query}</td>
|
|
1936
|
+
<td style="padding:15px">Yes</td>
|
|
1937
|
+
</tr>
|
|
1938
|
+
<tr>
|
|
1939
|
+
<td style="padding:15px">apiApSettingsGetApSettingsV2(serialNumber, callback)</td>
|
|
1940
|
+
<td style="padding:15px">Get an existing ap settings.</td>
|
|
1941
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/ap_settings/{pathv1}?{query}</td>
|
|
1942
|
+
<td style="padding:15px">Yes</td>
|
|
1943
|
+
</tr>
|
|
1944
|
+
<tr>
|
|
1945
|
+
<td style="padding:15px">apiApSettingsUpdateApSettingsV2(serialNumber, apSettingsData, callback)</td>
|
|
1946
|
+
<td style="padding:15px">Update an existing ap settings.</td>
|
|
1947
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/ap_settings/{pathv1}?{query}</td>
|
|
1948
|
+
<td style="padding:15px">Yes</td>
|
|
1949
|
+
</tr>
|
|
1950
|
+
<tr>
|
|
1951
|
+
<td style="padding:15px">apiApClisGetConfigurationClis(groupNameOrGuid, version, callback)</td>
|
|
1952
|
+
<td style="padding:15px">Get whole configuration in CLI format of an UI group or a swarm in the group.</td>
|
|
1953
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/ap_cli/{pathv1}?{query}</td>
|
|
1954
|
+
<td style="padding:15px">Yes</td>
|
|
1955
|
+
</tr>
|
|
1956
|
+
<tr>
|
|
1957
|
+
<td style="padding:15px">apiApClisUpdateConfigurationClis(groupNameOrGuid, clis, callback)</td>
|
|
1958
|
+
<td style="padding:15px">Replace whole configuration of an UI group or a swarm in the group. The posted data should be modified from the get result. Otherwise, it may corrupt the configuration. Should use with caution!</td>
|
|
1959
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/ap_cli/{pathv1}?{query}</td>
|
|
1960
|
+
<td style="padding:15px">Yes</td>
|
|
1961
|
+
</tr>
|
|
1962
|
+
<tr>
|
|
1963
|
+
<td style="padding:15px">apiApClisGetApSettingsClis(serialNumber, callback)</td>
|
|
1964
|
+
<td style="padding:15px">Get whole per AP setting in CLI format of an AP in UI group.</td>
|
|
1965
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/ap_settings_cli/{pathv1}?{query}</td>
|
|
1966
|
+
<td style="padding:15px">Yes</td>
|
|
1967
|
+
</tr>
|
|
1968
|
+
<tr>
|
|
1969
|
+
<td style="padding:15px">apiApClisUpdateApSettingsClis(serialNumber, clis, callback)</td>
|
|
1970
|
+
<td style="padding:15px">Replace whole per AP setting of an AP in UI group. The posted data should be modified from the get result. Otherwise, it may corrupt the configuration. Should use with caution!</td>
|
|
1971
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/ap_settings_cli/{pathv1}?{query}</td>
|
|
1972
|
+
<td style="padding:15px">Yes</td>
|
|
1973
|
+
</tr>
|
|
1974
|
+
<tr>
|
|
1975
|
+
<td style="padding:15px">apiApClisGetSwarmVariables(groupNameOrGuid, callback)</td>
|
|
1976
|
+
<td style="padding:15px">Get whole variables of an UI group or a swarm in the group.</td>
|
|
1977
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/iap_variables/{pathv1}?{query}</td>
|
|
1978
|
+
<td style="padding:15px">Yes</td>
|
|
1979
|
+
</tr>
|
|
1980
|
+
<tr>
|
|
1981
|
+
<td style="padding:15px">apiApClisUpdateSwarmVariables(groupNameOrGuid, variables, callback)</td>
|
|
1982
|
+
<td style="padding:15px">Replace whole variables of an UI group or a swarm in the group.. The posted data should be modified from the get result. Otherwise, it may corrupt the configuration. Should use with caution!</td>
|
|
1983
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/iap_variables/{pathv1}?{query}</td>
|
|
1984
|
+
<td style="padding:15px">Yes</td>
|
|
1985
|
+
</tr>
|
|
1986
|
+
<tr>
|
|
1987
|
+
<td style="padding:15px">apiApClisGetDirtyDiff(groupNameOrGuid, limit, offset, callback)</td>
|
|
1988
|
+
<td style="padding:15px">Get dirty diff of an UI group or a swarm.</td>
|
|
1989
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/dirty_diff/{pathv1}?{query}</td>
|
|
1990
|
+
<td style="padding:15px">Yes</td>
|
|
1991
|
+
</tr>
|
|
1992
|
+
<tr>
|
|
1993
|
+
<td style="padding:15px">apiSystemConfigGetSystemConfig(groupNameOrGuid, callback)</td>
|
|
1994
|
+
<td style="padding:15px">Get an existing System Config.</td>
|
|
1995
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/system_config/{pathv1}?{query}</td>
|
|
1996
|
+
<td style="padding:15px">Yes</td>
|
|
1997
|
+
</tr>
|
|
1998
|
+
<tr>
|
|
1999
|
+
<td style="padding:15px">apiSystemConfigUpdateSystemConfig(groupNameOrGuid, systemConfigInfo, callback)</td>
|
|
2000
|
+
<td style="padding:15px">Update system config would contain NTP server, DNS server, username and PAssword.</td>
|
|
2001
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/system_config/{pathv1}?{query}</td>
|
|
2002
|
+
<td style="padding:15px">Yes</td>
|
|
2003
|
+
</tr>
|
|
2004
|
+
<tr>
|
|
2005
|
+
<td style="padding:15px">apiRfConfigGetArmConfig(groupNameOrGuid, callback)</td>
|
|
2006
|
+
<td style="padding:15px">Get an existing ARM configuration.</td>
|
|
2007
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/arm/{pathv1}?{query}</td>
|
|
2008
|
+
<td style="padding:15px">Yes</td>
|
|
2009
|
+
</tr>
|
|
2010
|
+
<tr>
|
|
2011
|
+
<td style="padding:15px">apiRfConfigUpdateArmConfig(groupNameOrGuid, armInfo, callback)</td>
|
|
2012
|
+
<td style="padding:15px">Update an existing ARM configuration.</td>
|
|
2013
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/arm/{pathv1}?{query}</td>
|
|
2014
|
+
<td style="padding:15px">Yes</td>
|
|
2015
|
+
</tr>
|
|
2016
|
+
<tr>
|
|
2017
|
+
<td style="padding:15px">apiRfConfigGetAllDot11gRadioProfile(groupNameOrGuid, callback)</td>
|
|
2018
|
+
<td style="padding:15px">Get an existing Dot11g radio profiles List.</td>
|
|
2019
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/dot11g_radio_profiles/{pathv1}?{query}</td>
|
|
2020
|
+
<td style="padding:15px">Yes</td>
|
|
2021
|
+
</tr>
|
|
2022
|
+
<tr>
|
|
2023
|
+
<td style="padding:15px">apiRfConfigGetDot11gRadioConfigByName(groupNameOrGuid, name, callback)</td>
|
|
2024
|
+
<td style="padding:15px">Get an existing Dot11g radio profile configuration.</td>
|
|
2025
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/dot11g_radio_profile/{pathv1}/{pathv2}?{query}</td>
|
|
2026
|
+
<td style="padding:15px">Yes</td>
|
|
2027
|
+
</tr>
|
|
2028
|
+
<tr>
|
|
2029
|
+
<td style="padding:15px">apiRfConfigUpdateDot11gRadioProfile(groupNameOrGuid, name, dot11gRadioProfile, callback)</td>
|
|
2030
|
+
<td style="padding:15px">Update an existing Dot11g radio profile or create a new Dot11g radio profile.</td>
|
|
2031
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/dot11g_radio_profile/{pathv1}/{pathv2}?{query}</td>
|
|
2032
|
+
<td style="padding:15px">Yes</td>
|
|
2033
|
+
</tr>
|
|
2034
|
+
<tr>
|
|
2035
|
+
<td style="padding:15px">apiRfConfigDeleteDot11gRadioProfile(groupNameOrGuid, name, callback)</td>
|
|
2036
|
+
<td style="padding:15px">Delete an existing Dot11g radio profile.</td>
|
|
2037
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/dot11g_radio_profile/{pathv1}/{pathv2}?{query}</td>
|
|
2038
|
+
<td style="padding:15px">Yes</td>
|
|
2039
|
+
</tr>
|
|
2040
|
+
<tr>
|
|
2041
|
+
<td style="padding:15px">apiRfConfigGetAllDot11aRadioProfile(groupNameOrGuid, callback)</td>
|
|
2042
|
+
<td style="padding:15px">Get an existing Dot11a radio profiles List.</td>
|
|
2043
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/dot11a_radio_profiles/{pathv1}?{query}</td>
|
|
2044
|
+
<td style="padding:15px">Yes</td>
|
|
2045
|
+
</tr>
|
|
2046
|
+
<tr>
|
|
2047
|
+
<td style="padding:15px">apiRfConfigGetDot11aRadioConfigByName(groupNameOrGuid, name, callback)</td>
|
|
2048
|
+
<td style="padding:15px">Get an existing Dot11a radio profile configuration.</td>
|
|
2049
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/dot11a_radio_profile/{pathv1}/{pathv2}?{query}</td>
|
|
2050
|
+
<td style="padding:15px">Yes</td>
|
|
2051
|
+
</tr>
|
|
2052
|
+
<tr>
|
|
2053
|
+
<td style="padding:15px">apiRfConfigUpdateDot11aRadioProfile(groupNameOrGuid, name, dot11aRadioProfile, callback)</td>
|
|
2054
|
+
<td style="padding:15px">Update an existing Dot11a radio profile or create a new Dot11a radio profile.</td>
|
|
2055
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/dot11a_radio_profile/{pathv1}/{pathv2}?{query}</td>
|
|
2056
|
+
<td style="padding:15px">Yes</td>
|
|
2057
|
+
</tr>
|
|
2058
|
+
<tr>
|
|
2059
|
+
<td style="padding:15px">apiRfConfigDeleteDot11aRadioProfile(groupNameOrGuid, name, callback)</td>
|
|
2060
|
+
<td style="padding:15px">Delete an existing Dot11a radio profile.</td>
|
|
2061
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/dot11a_radio_profile/{pathv1}/{pathv2}?{query}</td>
|
|
2062
|
+
<td style="padding:15px">Yes</td>
|
|
2063
|
+
</tr>
|
|
2064
|
+
<tr>
|
|
2065
|
+
<td style="padding:15px">apiSwarmConfigGetSwarmConfig(guid, callback)</td>
|
|
2066
|
+
<td style="padding:15px">(Deprecated) Get an existing swarm config.</td>
|
|
2067
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/swarm_config/{pathv1}?{query}</td>
|
|
2068
|
+
<td style="padding:15px">Yes</td>
|
|
2069
|
+
</tr>
|
|
2070
|
+
<tr>
|
|
2071
|
+
<td style="padding:15px">apiSwarmConfigUpdateSwarmConfig(guid, swarmConfigData, callback)</td>
|
|
2072
|
+
<td style="padding:15px">(Deprecated) Update an existing swarm config.</td>
|
|
2073
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/swarm_config/{pathv1}?{query}</td>
|
|
2074
|
+
<td style="padding:15px">Yes</td>
|
|
2075
|
+
</tr>
|
|
2076
|
+
<tr>
|
|
2077
|
+
<td style="padding:15px">apiSwarmConfigGetSwarmConfigV2(guid, callback)</td>
|
|
2078
|
+
<td style="padding:15px">Get an existing swarm config.</td>
|
|
2079
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/swarm_config/{pathv1}?{query}</td>
|
|
2080
|
+
<td style="padding:15px">Yes</td>
|
|
2081
|
+
</tr>
|
|
2082
|
+
<tr>
|
|
2083
|
+
<td style="padding:15px">apiSwarmConfigUpdateSwarmConfigV2(guid, swarmConfigData, callback)</td>
|
|
2084
|
+
<td style="padding:15px">Update an existing swarm config.</td>
|
|
2085
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v2/swarm_config/{pathv1}?{query}</td>
|
|
2086
|
+
<td style="padding:15px">Yes</td>
|
|
2087
|
+
</tr>
|
|
2088
|
+
<tr>
|
|
2089
|
+
<td style="padding:15px">apiCxConfigGetInterfaces(deviceSerial, groupName, callback)</td>
|
|
2090
|
+
<td style="padding:15px">Get interfaces configuration from device/group of CX switch.
|
|
2091
|
+
</td>
|
|
2092
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/switch/cx/interfaces?{query}</td>
|
|
2093
|
+
<td style="padding:15px">Yes</td>
|
|
2094
|
+
</tr>
|
|
2095
|
+
<tr>
|
|
2096
|
+
<td style="padding:15px">apiCxConfigUpdateInterfaces(deviceSerial, groupName, body, callback)</td>
|
|
2097
|
+
<td style="padding:15px">Update interfaces in device/group of CX switch.
|
|
2098
|
+
Recommended way to use POST:
|
|
2099
|
+
* Execute GET interfaces
|
|
2100
|
+
* Copy response body and edit appropriate fields
|
|
2101
|
+
* Paste into POST body in (update) structure.
|
|
2102
|
+
---
|
|
2103
|
+
**Overrides**:
|
|
2104
|
+
|
|
2105
|
+
* Only group supported configs are sent to all devices (things such as IP, not group supported, are not sent to the whole group)
|
|
2106
|
+
* Calling a device level API will configure a specific device in the group. If you modify any of the group level configurations from a device level API an...(description truncated)</td>
|
|
2107
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/switch/cx/interfaces?{query}</td>
|
|
2108
|
+
<td style="padding:15px">Yes</td>
|
|
2109
|
+
</tr>
|
|
2110
|
+
<tr>
|
|
2111
|
+
<td style="padding:15px">apiCxConfigGetLag(deviceSerial, groupName, callback)</td>
|
|
2112
|
+
<td style="padding:15px">Get LAGs configuration from device/group of CX switch.
|
|
2113
|
+
</td>
|
|
2114
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/switch/cx/lags?{query}</td>
|
|
2115
|
+
<td style="padding:15px">Yes</td>
|
|
2116
|
+
</tr>
|
|
2117
|
+
<tr>
|
|
2118
|
+
<td style="padding:15px">apiCxConfigCrudLag(deviceSerial, groupName, body, callback)</td>
|
|
2119
|
+
<td style="padding:15px">Create/Update/Delete LAGs in device/group of CX switch.
|
|
2120
|
+
Recommended way to use POST:
|
|
2121
|
+
* Execute GET LAGs
|
|
2122
|
+
* Copy response body and edit appropriate fields
|
|
2123
|
+
* Paste into POST body in (create/update/delete) structure.
|
|
2124
|
+
---
|
|
2125
|
+
**Overrides**:
|
|
2126
|
+
|
|
2127
|
+
* Only group supported configs are sent to all devices (things such as IP, not group supported, are not sent to the whole group)
|
|
2128
|
+
* Calling a device level API will configure a specific device in the group. If you modify any of the group level configurations from a dev...(description truncated)</td>
|
|
2129
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/switch/cx/lags?{query}</td>
|
|
2130
|
+
<td style="padding:15px">Yes</td>
|
|
2131
|
+
</tr>
|
|
2132
|
+
<tr>
|
|
2133
|
+
<td style="padding:15px">apiCxConfigGetLoopPrevention(deviceSerial, groupName, callback)</td>
|
|
2134
|
+
<td style="padding:15px">Get loop prevention configuration from device/group of CX switch.
|
|
2135
|
+
</td>
|
|
2136
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/switch/cx/loop-prevention?{query}</td>
|
|
2137
|
+
<td style="padding:15px">Yes</td>
|
|
2138
|
+
</tr>
|
|
2139
|
+
<tr>
|
|
2140
|
+
<td style="padding:15px">apiCxConfigUpdateLoopPrevention(deviceSerial, groupName, body, callback)</td>
|
|
2141
|
+
<td style="padding:15px">Update loop prevention in device/group of CX switch.
|
|
2142
|
+
Recommended way to use POST:
|
|
2143
|
+
* Execute GET loop prevention
|
|
2144
|
+
* Copy response body and edit appropriate fields
|
|
2145
|
+
* Paste into POST body in (update) structure.
|
|
2146
|
+
---
|
|
2147
|
+
**Overrides**:
|
|
2148
|
+
|
|
2149
|
+
* Only group supported configs are sent to all devices (things such as IP, not group supported, are not sent to the whole group)
|
|
2150
|
+
* Calling a device level API will configure a specific device in the group. If you modify any of the group level configurations from a device le...(description truncated)</td>
|
|
2151
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/switch/cx/loop-prevention?{query}</td>
|
|
2152
|
+
<td style="padding:15px">Yes</td>
|
|
2153
|
+
</tr>
|
|
2154
|
+
<tr>
|
|
2155
|
+
<td style="padding:15px">apiCxConfigGetProperties(deviceSerial, groupName, callback)</td>
|
|
2156
|
+
<td style="padding:15px">Get properties configuration from device/group of CX switch.
|
|
2157
|
+
</td>
|
|
2158
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/switch/cx/properties?{query}</td>
|
|
2159
|
+
<td style="padding:15px">Yes</td>
|
|
2160
|
+
</tr>
|
|
2161
|
+
<tr>
|
|
2162
|
+
<td style="padding:15px">apiCxConfigUpdateProperties(deviceSerial, groupName, body, callback)</td>
|
|
2163
|
+
<td style="padding:15px">Update properties in device/group of CX switch.
|
|
2164
|
+
Recommended way to use POST:
|
|
2165
|
+
* Execute GET properties
|
|
2166
|
+
* Copy response body and edit appropriate fields
|
|
2167
|
+
* Paste into POST body in (update) structure.
|
|
2168
|
+
---
|
|
2169
|
+
**Overrides**:
|
|
2170
|
+
|
|
2171
|
+
* Only group supported configs are sent to all devices (things such as IP, not group supported, are not sent to the whole group)
|
|
2172
|
+
* Calling a device level API will configure a specific device in the group. If you modify any of the group level configurations from a device level API an...(description truncated)</td>
|
|
2173
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/switch/cx/properties?{query}</td>
|
|
2174
|
+
<td style="padding:15px">Yes</td>
|
|
2175
|
+
</tr>
|
|
2176
|
+
<tr>
|
|
2177
|
+
<td style="padding:15px">apiCxConfigGetSyslog(deviceSerial, groupName, callback)</td>
|
|
2178
|
+
<td style="padding:15px">Get syslog configuration from device/group of CX switch.
|
|
2179
|
+
</td>
|
|
2180
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/switch/cx/syslog?{query}</td>
|
|
2181
|
+
<td style="padding:15px">Yes</td>
|
|
2182
|
+
</tr>
|
|
2183
|
+
<tr>
|
|
2184
|
+
<td style="padding:15px">postConfigurationV1SwitchCxSyslog(deviceSerial, groupName, body, callback)</td>
|
|
2185
|
+
<td style="padding:15px">Create/Update/Delete syslog in device/group of CX switch.
|
|
2186
|
+
Recommended way to use POST:
|
|
2187
|
+
* Execute GET syslog
|
|
2188
|
+
* Copy response body and edit appropriate fields
|
|
2189
|
+
* Paste into POST body in (create/update/delete) structure.
|
|
2190
|
+
---
|
|
2191
|
+
**Overrides**:
|
|
2192
|
+
|
|
2193
|
+
* Only group supported configs are sent to all devices (things such as IP, not group supported, are not sent to the whole group)
|
|
2194
|
+
* Calling a device level API will configure a specific device in the group. If you modify any of the group level configurations from a...(description truncated)</td>
|
|
2195
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/switch/cx/syslog?{query}</td>
|
|
2196
|
+
<td style="padding:15px">Yes</td>
|
|
2197
|
+
</tr>
|
|
2198
|
+
<tr>
|
|
2199
|
+
<td style="padding:15px">apiCxConfigGetVlans(deviceSerial, groupName, callback)</td>
|
|
2200
|
+
<td style="padding:15px">Get VLANs configuration from device/group of CX switch.
|
|
2201
|
+
</td>
|
|
2202
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/switch/cx/vlans?{query}</td>
|
|
2203
|
+
<td style="padding:15px">Yes</td>
|
|
2204
|
+
</tr>
|
|
2205
|
+
<tr>
|
|
2206
|
+
<td style="padding:15px">apiCxConfigCrudVlans(deviceSerial, groupName, body, callback)</td>
|
|
2207
|
+
<td style="padding:15px">Create/Update/Delete VLANs in device/group of CX switch.
|
|
2208
|
+
Recommended way to use POST:
|
|
2209
|
+
* Execute GET VLANs
|
|
2210
|
+
* Copy response body and edit appropriate fields
|
|
2211
|
+
* For VLANs update case, remove `vlan_id` key-value pair before pasting it into POST body
|
|
2212
|
+
* Paste into POST body in (create/update/delete) structure.
|
|
2213
|
+
---
|
|
2214
|
+
**Overrides**:
|
|
2215
|
+
|
|
2216
|
+
* Only group supported configs are sent to all devices (things such as IP, not group supported, are not sent to the whole group)
|
|
2217
|
+
* Calling a device level API will configure a ...(description truncated)</td>
|
|
2218
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/switch/cx/vlans?{query}</td>
|
|
2219
|
+
<td style="padding:15px">Yes</td>
|
|
2220
|
+
</tr>
|
|
2221
|
+
<tr>
|
|
2222
|
+
<td style="padding:15px">apiHppcSwitchGetGroupPorts(groupName, callback)</td>
|
|
2223
|
+
<td style="padding:15px">Get ports name for a group.</td>
|
|
2224
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/aos_switch/ports/groups/{pathv1}?{query}</td>
|
|
2225
|
+
<td style="padding:15px">Yes</td>
|
|
2226
|
+
</tr>
|
|
2227
|
+
<tr>
|
|
2228
|
+
<td style="padding:15px">apiHppcSwitchSetGroupPorts(groupName, ports, callback)</td>
|
|
2229
|
+
<td style="padding:15px">Update ports name for a group.</td>
|
|
2230
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/aos_switch/ports/groups/{pathv1}?{query}</td>
|
|
2231
|
+
<td style="padding:15px">Yes</td>
|
|
2232
|
+
</tr>
|
|
2233
|
+
<tr>
|
|
2234
|
+
<td style="padding:15px">apiHppcSwitchGetDevicePorts(deviceSerial, callback)</td>
|
|
2235
|
+
<td style="padding:15px">Get ports name for a device.</td>
|
|
2236
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/aos_switch/ports/devices/{pathv1}?{query}</td>
|
|
2237
|
+
<td style="padding:15px">Yes</td>
|
|
2238
|
+
</tr>
|
|
2239
|
+
<tr>
|
|
2240
|
+
<td style="padding:15px">apiHppcSwitchSetDevicePorts(deviceSerial, ports, callback)</td>
|
|
2241
|
+
<td style="padding:15px">Update ports name for a device.</td>
|
|
2242
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/aos_switch/ports/devices/{pathv1}?{query}</td>
|
|
2243
|
+
<td style="padding:15px">Yes</td>
|
|
2244
|
+
</tr>
|
|
2245
|
+
<tr>
|
|
2246
|
+
<td style="padding:15px">apiHppcSwitchGetGroupVlans(groupName, callback)</td>
|
|
2247
|
+
<td style="padding:15px">Get vlans with tagged, untagged and isolated ports for a group.</td>
|
|
2248
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/aos_switch/vlans/groups/{pathv1}?{query}</td>
|
|
2249
|
+
<td style="padding:15px">Yes</td>
|
|
2250
|
+
</tr>
|
|
2251
|
+
<tr>
|
|
2252
|
+
<td style="padding:15px">apiHppcSwitchSetGroupVlans(groupName, vlans, callback)</td>
|
|
2253
|
+
<td style="padding:15px">Update vlans with tagged, untagged and isolated ports for a group.</td>
|
|
2254
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/aos_switch/vlans/groups/{pathv1}?{query}</td>
|
|
2255
|
+
<td style="padding:15px">Yes</td>
|
|
2256
|
+
</tr>
|
|
2257
|
+
<tr>
|
|
2258
|
+
<td style="padding:15px">apiHppcSwitchGetDeviceVlans(deviceSerial, callback)</td>
|
|
2259
|
+
<td style="padding:15px">Get vlans with tagged, untagged and isolated ports for a device.</td>
|
|
2260
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/aos_switch/vlans/devices/{pathv1}?{query}</td>
|
|
2261
|
+
<td style="padding:15px">Yes</td>
|
|
2262
|
+
</tr>
|
|
2263
|
+
<tr>
|
|
2264
|
+
<td style="padding:15px">apiHppcSwitchSetDeviceVlans(deviceSerial, ports, callback)</td>
|
|
2265
|
+
<td style="padding:15px">Update vlans with tagged, untagged and isolated ports for a device.</td>
|
|
2266
|
+
<td style="padding:15px">{base_path}/{version}/configuration/v1/aos_switch/vlans/devices/{pathv1}?{query}</td>
|
|
2267
|
+
<td style="padding:15px">Yes</td>
|
|
2268
|
+
</tr>
|
|
2269
|
+
<tr>
|
|
2270
|
+
<td style="padding:15px">apiInstallManagerExternalApiInviteInstaller(body, callback)</td>
|
|
2271
|
+
<td style="padding:15px">Invite a new installer using First Name, Last Name, Country Code, Mobile Number</td>
|
|
2272
|
+
<td style="padding:15px">{base_path}/{version}/v1/invite_installer?{query}</td>
|
|
2273
|
+
<td style="padding:15px">Yes</td>
|
|
2274
|
+
</tr>
|
|
2275
|
+
<tr>
|
|
2276
|
+
<td style="padding:15px">apiInstallManagerExternalApiAssignGroupToDeviceTypesInSites(body, callback)</td>
|
|
2277
|
+
<td style="padding:15px">Site Name, Device Type, Group Name mapping</td>
|
|
2278
|
+
<td style="padding:15px">{base_path}/{version}/v1/assign_group_to_device_types_in_sites?{query}</td>
|
|
2279
|
+
<td style="padding:15px">Yes</td>
|
|
2280
|
+
</tr>
|
|
169
2281
|
</table>
|
|
170
2282
|
<br>
|