@itentialopensource/adapter-viptela 0.12.0 → 0.12.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.
Files changed (14) hide show
  1. package/CALLS.md +193 -144
  2. package/CHANGELOG.md +16 -0
  3. package/README.md +10 -6
  4. package/adapterBase.js +103 -0
  5. package/metadata.json +18 -7
  6. package/package.json +4 -4
  7. package/propertiesSchema.json +64 -0
  8. package/refs?service=git-upload-pack +0 -0
  9. package/report/adapterInfo.json +5 -5
  10. package/report/updateReport1694453336318.json +120 -0
  11. package/sampleProperties.json +12 -0
  12. package/test/unit/adapterBaseTestUnit.js +6 -6
  13. package/test/unit/adapterTestUnit.js +9 -3
  14. package/utils/methodDocumentor.js +57 -22
package/CALLS.md CHANGED
@@ -19,7 +19,7 @@ These are adapter methods that IAP or you might use. There are some other method
19
19
  </tr>
20
20
  <tr>
21
21
  <td style="padding:15px">healthCheck(callback)</td>
22
- <td style="padding:15px">This call ensures that the adapter can communicate with Viptela. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
22
+ <td style="padding:15px">This call ensures that the adapter can communicate with Adapter for Viptela. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
23
23
  <td style="padding:15px">No</td>
24
24
  </tr>
25
25
  <tr>
@@ -29,7 +29,7 @@ These are adapter methods that IAP or you might use. There are some other method
29
29
  </tr>
30
30
  <tr>
31
31
  <td style="padding:15px">encryptProperty(property, technique, callback)</td>
32
- <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Viptela.</td>
32
+ <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for Viptela.</td>
33
33
  <td style="padding:15px">No</td>
34
34
  </tr>
35
35
  <tr>
@@ -37,11 +37,6 @@ These are adapter methods that IAP or you might use. There are some other method
37
37
  <td style="padding:15px">This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.</td>
38
38
  <td style="padding:15px">Yes</td>
39
39
  </tr>
40
- <tr>
41
- <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
42
- <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
43
- <td style="padding:15px">Yes</td>
44
- </tr>
45
40
  <tr>
46
41
  <td style="padding:15px">iapSuspendAdapter(mode, callback)</td>
47
42
  <td style="padding:15px">This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.</td>
@@ -57,12 +52,16 @@ These are adapter methods that IAP or you might use. There are some other method
57
52
  <td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td>
58
53
  <td style="padding:15px">Yes</td>
59
54
  </tr>
55
+ <tr>
56
+ <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
57
+ <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
58
+ <td style="padding:15px">Yes</td>
59
+ </tr>
60
60
  <tr>
61
61
  <td style="padding:15px">iapTroubleshootAdapter(props, persistFlag, adapter, callback)</td>
62
62
  <td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td>
63
63
  <td style="padding:15px">Yes</td>
64
64
  </tr>
65
-
66
65
  <tr>
67
66
  <td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td>
68
67
  <td style="padding:15px">This call will return the results of a healthcheck.</td>
@@ -83,6 +82,21 @@ These are adapter methods that IAP or you might use. There are some other method
83
82
  <td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.</td>
84
83
  <td style="padding:15px">Yes</td>
85
84
  </tr>
85
+ <tr>
86
+ <td style="padding:15px">iapDeactivateTasks(tasks, callback)</td>
87
+ <td style="padding:15px">This call provides the ability to remove tasks from the adapter.</td>
88
+ <td style="padding:15px">Yes</td>
89
+ </tr>
90
+ <tr>
91
+ <td style="padding:15px">iapActivateTasks(tasks, callback)</td>
92
+ <td style="padding:15px">This call provides the ability to add deactivated tasks back into the adapter.</td>
93
+ <td style="padding:15px">Yes</td>
94
+ </tr>
95
+ <tr>
96
+ <td style="padding:15px">iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)</td>
97
+ <td style="padding:15px">This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.</td>
98
+ <td style="padding:15px">Yes</td>
99
+ </tr>
86
100
  <tr>
87
101
  <td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
88
102
  <td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td>
@@ -94,19 +108,42 @@ These are adapter methods that IAP or you might use. There are some other method
94
108
  <td style="padding:15px">Yes</td>
95
109
  </tr>
96
110
  <tr>
97
- <td style="padding:15px">iapHasAdapterEntity(entityType, entityId, callback)</td>
98
- <td style="padding:15px">This call verifies the adapter has the specific entity.</td>
99
- <td style="padding:15px">No</td>
111
+ <td style="padding:15px">iapRunAdapterLint(callback)</td>
112
+ <td style="padding:15px">Runs lint on the addapter and provides the information back.</td>
113
+ <td style="padding:15px">Yes</td>
100
114
  </tr>
101
115
  <tr>
102
- <td style="padding:15px">iapVerifyAdapterCapability(entityType, actionType, entityId, callback)</td>
103
- <td style="padding:15px">This call verifies the adapter can perform the provided action on the specific entity.</td>
104
- <td style="padding:15px">No</td>
116
+ <td style="padding:15px">iapRunAdapterTests(callback)</td>
117
+ <td style="padding:15px">Runs baseunit and unit tests on the adapter and provides the information back.</td>
118
+ <td style="padding:15px">Yes</td>
105
119
  </tr>
106
120
  <tr>
107
- <td style="padding:15px">iapUpdateAdapterEntityCache()</td>
108
- <td style="padding:15px">This call will update the entity cache.</td>
109
- <td style="padding:15px">No</td>
121
+ <td style="padding:15px">iapGetAdapterInventory(callback)</td>
122
+ <td style="padding:15px">This call provides some inventory related information about the adapter.</td>
123
+ <td style="padding:15px">Yes</td>
124
+ </tr>
125
+ </table>
126
+ <br>
127
+
128
+ ### Adapter Cache Calls
129
+
130
+ These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.
131
+
132
+ <table border="1" class="bordered-table">
133
+ <tr>
134
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
135
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
136
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
137
+ </tr>
138
+ <tr>
139
+ <td style="padding:15px">iapPopulateEntityCache(entityTypes, callback)</td>
140
+ <td style="padding:15px">This call populates the adapter cache.</td>
141
+ <td style="padding:15px">Yes</td>
142
+ </tr>
143
+ <tr>
144
+ <td style="padding:15px">iapRetrieveEntitiesCache(entityType, options, callback)</td>
145
+ <td style="padding:15px">This call retrieves the specific items from the adapter cache.</td>
146
+ <td style="padding:15px">Yes</td>
110
147
  </tr>
111
148
  </table>
112
149
  <br>
@@ -129,27 +166,27 @@ These are adapter methods that are used to integrate to IAP Brokers. This adapte
129
166
  <tr>
130
167
  <td style="padding:15px">getDevice(deviceName, callback)</td>
131
168
  <td style="padding:15px">This call returns the details of the requested device.</td>
132
- <td style="padding:15px">Yes</td>
169
+ <td style="padding:15px">No</td>
133
170
  </tr>
134
171
  <tr>
135
172
  <td style="padding:15px">getDevicesFiltered(options, callback)</td>
136
173
  <td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td>
137
- <td style="padding:15px">Yes</td>
174
+ <td style="padding:15px">No</td>
138
175
  </tr>
139
176
  <tr>
140
177
  <td style="padding:15px">isAlive(deviceName, callback)</td>
141
178
  <td style="padding:15px">This call returns whether the device status is active</td>
142
- <td style="padding:15px">Yes</td>
179
+ <td style="padding:15px">No</td>
143
180
  </tr>
144
181
  <tr>
145
182
  <td style="padding:15px">getConfig(deviceName, format, callback)</td>
146
183
  <td style="padding:15px">This call returns the configuration for the selected device.</td>
147
- <td style="padding:15px">Yes</td>
184
+ <td style="padding:15px">No</td>
148
185
  </tr>
149
186
  <tr>
150
187
  <td style="padding:15px">iapGetDeviceCount(callback)</td>
151
188
  <td style="padding:15px">This call returns the count of devices.</td>
152
- <td style="padding:15px">Yes</td>
189
+ <td style="padding:15px">No</td>
153
190
  </tr>
154
191
  </table>
155
192
  <br>
@@ -167,31 +204,31 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
167
204
  </tr>
168
205
  <tr>
169
206
  <td style="padding:15px">getStatisticsinterface(query, callback)</td>
170
- <td style="padding:15px">Get with optional query</td>
207
+ <td style="padding:15px">Get raw data</td>
171
208
  <td style="padding:15px">{base_path}/{version}/statistics/interface?{query}</td>
172
209
  <td style="padding:15px">Yes</td>
173
210
  </tr>
174
211
  <tr>
175
212
  <td style="padding:15px">postStatisticsinterface(body, callback)</td>
176
- <td style="padding:15px">Get with optional query</td>
213
+ <td style="padding:15px">Get raw data</td>
177
214
  <td style="padding:15px">{base_path}/{version}/statistics/interface?{query}</td>
178
215
  <td style="padding:15px">Yes</td>
179
216
  </tr>
180
217
  <tr>
181
218
  <td style="padding:15px">getStatisticsinterfaceaggregation(query, callback)</td>
182
- <td style="padding:15px">Get with optional query</td>
219
+ <td style="padding:15px">Get raw data</td>
183
220
  <td style="padding:15px">{base_path}/{version}/statistics/interface/aggregation?{query}</td>
184
221
  <td style="padding:15px">Yes</td>
185
222
  </tr>
186
223
  <tr>
187
224
  <td style="padding:15px">postStatisticsinterfaceaggregation(body, callback)</td>
188
- <td style="padding:15px">Get with optional query</td>
225
+ <td style="padding:15px">Get raw data</td>
189
226
  <td style="padding:15px">{base_path}/{version}/statistics/interface/aggregation?{query}</td>
190
227
  <td style="padding:15px">Yes</td>
191
228
  </tr>
192
229
  <tr>
193
230
  <td style="padding:15px">getStatisticsinterfacecsv(query, callback)</td>
194
- <td style="padding:15px">Get raw data with optional query as CSV</td>
231
+ <td style="padding:15px">Get raw data as CSV</td>
195
232
  <td style="padding:15px">{base_path}/{version}/statistics/interface/csv?{query}</td>
196
233
  <td style="padding:15px">Yes</td>
197
234
  </tr>
@@ -215,19 +252,19 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
215
252
  </tr>
216
253
  <tr>
217
254
  <td style="padding:15px">getStatisticsinterfacepage(query, scrollId, count, callback)</td>
218
- <td style="padding:15px">Get with optional query</td>
255
+ <td style="padding:15px">Get raw data</td>
219
256
  <td style="padding:15px">{base_path}/{version}/statistics/interface/page?{query}</td>
220
257
  <td style="padding:15px">Yes</td>
221
258
  </tr>
222
259
  <tr>
223
260
  <td style="padding:15px">postStatisticsinterfacepage(body, scrollId, count, callback)</td>
224
- <td style="padding:15px">Get with optional query</td>
261
+ <td style="padding:15px">Get raw data</td>
225
262
  <td style="padding:15px">{base_path}/{version}/statistics/interface/page?{query}</td>
226
263
  <td style="padding:15px">Yes</td>
227
264
  </tr>
228
265
  <tr>
229
266
  <td style="padding:15px">getStatisticsinterfacequeryfields(callback)</td>
230
- <td style="padding:15px">Get query field</td>
267
+ <td style="padding:15px">Get query fields</td>
231
268
  <td style="padding:15px">{base_path}/{version}/statistics/interface/query/fields?{query}</td>
232
269
  <td style="padding:15px">Yes</td>
233
270
  </tr>
@@ -239,16 +276,22 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
239
276
  </tr>
240
277
  <tr>
241
278
  <td style="padding:15px">getDatadevicestatestateDataTypefields(stateDataType, callback)</td>
242
- <td style="padding:15px">Retrieve device state data fields</td>
279
+ <td style="padding:15px">Retrieve device state data fileds</td>
243
280
  <td style="padding:15px">{base_path}/{version}/data/device/state/{pathv1}/fields?{query}</td>
244
281
  <td style="padding:15px">Yes</td>
245
282
  </tr>
246
283
  <tr>
247
284
  <td style="padding:15px">getDatadevicestatestateDataTypequery(stateDataType, callback)</td>
248
- <td style="padding:15px">Retrieve device state data fields</td>
285
+ <td style="padding:15px">Retrieve device state data fileds</td>
249
286
  <td style="padding:15px">{base_path}/{version}/data/device/state/{pathv1}/query?{query}</td>
250
287
  <td style="padding:15px">Yes</td>
251
288
  </tr>
289
+ <tr>
290
+ <td style="padding:15px">getDevices(callback)</td>
291
+ <td style="padding:15px">Retrieve list of all devices</td>
292
+ <td style="padding:15px">{base_path}/{version}/device?{query}</td>
293
+ <td style="padding:15px">Yes</td>
294
+ </tr>
252
295
  <tr>
253
296
  <td style="padding:15px">getDeviceconfig(deviceId, callback)</td>
254
297
  <td style="padding:15px">Retrieve device running configuration</td>
@@ -557,457 +600,457 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
557
600
  </tr>
558
601
  <tr>
559
602
  <td style="padding:15px">generateDeviceTemplateInput(body, callback)</td>
560
- <td style="padding:15px">Get with optional query</td>
603
+ <td style="padding:15px">Get raw data</td>
561
604
  <td style="padding:15px">{base_path}/{version}/template/device/config/input?{query}</td>
562
605
  <td style="padding:15px">Yes</td>
563
606
  </tr>
564
607
  <tr>
565
608
  <td style="padding:15px">previewDeviceTemplateConfiguration(body, callback)</td>
566
- <td style="padding:15px">Get with optional query</td>
609
+ <td style="padding:15px">Get raw data</td>
567
610
  <td style="padding:15px">{base_path}/{version}/template/device/config/config?{query}</td>
568
611
  <td style="padding:15px">Yes</td>
569
612
  </tr>
570
613
  <tr>
571
614
  <td style="padding:15px">attachDeviceTemplateCli(body, callback)</td>
572
- <td style="padding:15px">Get with optional query</td>
615
+ <td style="padding:15px">Get raw data</td>
573
616
  <td style="padding:15px">{base_path}/{version}/template/device/config/attachcli?{query}</td>
574
617
  <td style="padding:15px">Yes</td>
575
618
  </tr>
576
619
  <tr>
577
620
  <td style="padding:15px">attachDeviceTemplateFeature(body, callback)</td>
578
- <td style="padding:15px">Get with optional query</td>
621
+ <td style="padding:15px">Get raw data</td>
579
622
  <td style="padding:15px">{base_path}/{version}/template/device/config/attachfeature?{query}</td>
580
623
  <td style="padding:15px">Yes</td>
581
624
  </tr>
582
625
  <tr>
583
626
  <td style="padding:15px">detachDeviceTemplateCli(body, callback)</td>
584
- <td style="padding:15px">Get with optional query</td>
627
+ <td style="padding:15px">Get raw data</td>
585
628
  <td style="padding:15px">{base_path}/{version}/template/config/device/mode/cli?{query}</td>
586
629
  <td style="padding:15px">Yes</td>
587
630
  </tr>
588
631
  <tr>
589
632
  <td style="padding:15px">getDeviceList(masterTemplateId, callback)</td>
590
- <td style="padding:15px">Get device list</td>
633
+ <td style="padding:15px">getDeviceList</td>
591
634
  <td style="padding:15px">{base_path}/{version}/template/device/config/available/{pathv1}?{query}</td>
592
635
  <td style="padding:15px">Yes</td>
593
636
  </tr>
594
637
  <tr>
595
638
  <td style="padding:15px">pushMixTemplate(body, callback)</td>
596
- <td style="padding:15px">Attach device template</td>
639
+ <td style="padding:15px">pushMixTemplate</td>
597
640
  <td style="padding:15px">{base_path}/{version}/template/device/config/attachment?{query}</td>
598
641
  <td style="padding:15px">Yes</td>
599
642
  </tr>
600
643
  <tr>
601
644
  <td style="padding:15px">getAttachedConfigToDevice(deviceId, callback)</td>
602
- <td style="padding:15px">Get attached device list</td>
645
+ <td style="padding:15px">getAttachedConfigToDevice</td>
603
646
  <td style="padding:15px">{base_path}/{version}/template/device/config/attachedconfig?{query}</td>
604
647
  <td style="padding:15px">Yes</td>
605
648
  </tr>
606
649
  <tr>
607
650
  <td style="padding:15px">pushMasterTemplate(body, callback)</td>
608
- <td style="padding:15px">Attach device template</td>
651
+ <td style="padding:15px">pushMasterTemplate</td>
609
652
  <td style="padding:15px">{base_path}/{version}/template/device/config/attachfeature?{query}</td>
610
653
  <td style="padding:15px">Yes</td>
611
654
  </tr>
612
655
  <tr>
613
656
  <td style="padding:15px">getAttachedDeviceList(masterTemplateId, callback)</td>
614
- <td style="padding:15px">Get attached device list</td>
657
+ <td style="padding:15px">getAttachedDeviceList</td>
615
658
  <td style="padding:15px">{base_path}/{version}/template/device/config/attached/{pathv1}?{query}</td>
616
659
  <td style="padding:15px">Yes</td>
617
660
  </tr>
618
661
  <tr>
619
662
  <td style="padding:15px">createInputWithoutDevice(body, callback)</td>
620
- <td style="padding:15px">Create device input</td>
663
+ <td style="padding:15px">createInputWithoutDevice</td>
621
664
  <td style="padding:15px">{base_path}/{version}/template/device/config/exportcsv?{query}</td>
622
665
  <td style="padding:15px">Yes</td>
623
666
  </tr>
624
667
  <tr>
625
668
  <td style="padding:15px">getDeviceConfigurationPreview(body, callback)</td>
626
- <td style="padding:15px">Get device configuration</td>
669
+ <td style="padding:15px">getDeviceConfigurationPreview</td>
627
670
  <td style="padding:15px">{base_path}/{version}/template/device/config/config?{query}</td>
628
671
  <td style="padding:15px">Yes</td>
629
672
  </tr>
630
673
  <tr>
631
674
  <td style="padding:15px">processInputCommaSepFile(callback)</td>
632
- <td style="padding:15px">Process input comma seperate file</td>
675
+ <td style="padding:15px">processInputCommaSepFile</td>
633
676
  <td style="padding:15px">{base_path}/{version}/template/device/config/process/input/file?{query}</td>
634
677
  <td style="padding:15px">Yes</td>
635
678
  </tr>
636
679
  <tr>
637
680
  <td style="padding:15px">validateTemplate(body, callback)</td>
638
- <td style="padding:15px">Validate template</td>
681
+ <td style="padding:15px">validateTemplate</td>
639
682
  <td style="padding:15px">{base_path}/{version}/template/device/config/verify?{query}</td>
640
683
  <td style="padding:15px">Yes</td>
641
684
  </tr>
642
685
  <tr>
643
686
  <td style="padding:15px">pushCloudxConfig(body, callback)</td>
644
- <td style="padding:15px">Enable Gateways, clients, dias</td>
687
+ <td style="padding:15px">pushCloudxConfig</td>
645
688
  <td style="padding:15px">{base_path}/{version}/template/device/config/attachcloudx?{query}</td>
646
689
  <td style="padding:15px">Yes</td>
647
690
  </tr>
648
691
  <tr>
649
692
  <td style="padding:15px">editCloudxConfig(body, callback)</td>
650
- <td style="padding:15px">Edit already enabled Gateways, clients, dias</td>
693
+ <td style="padding:15px">editCloudxConfig</td>
651
694
  <td style="padding:15px">{base_path}/{version}/template/device/config/attachcloudx?{query}</td>
652
695
  <td style="padding:15px">Yes</td>
653
696
  </tr>
654
697
  <tr>
655
698
  <td style="padding:15px">detachSites(body, callback)</td>
656
- <td style="padding:15px">Disable Gateways, clients, dias</td>
699
+ <td style="padding:15px">detachSites</td>
657
700
  <td style="padding:15px">{base_path}/{version}/template/device/config/detachcloudx?{query}</td>
658
701
  <td style="padding:15px">Yes</td>
659
702
  </tr>
660
703
  <tr>
661
704
  <td style="padding:15px">getDevicesWithDuplicateIP(body, callback)</td>
662
- <td style="padding:15px">Get devices having the system ips</td>
705
+ <td style="padding:15px">getDevicesWithDuplicateIP</td>
663
706
  <td style="padding:15px">{base_path}/{version}/template/device/config/duplicateip?{query}</td>
664
707
  <td style="padding:15px">Yes</td>
665
708
  </tr>
666
709
  <tr>
667
710
  <td style="padding:15px">pushCLITemplate(body, callback)</td>
668
- <td style="padding:15px">Create device template</td>
711
+ <td style="padding:15px">pushCLITemplate</td>
669
712
  <td style="padding:15px">{base_path}/{version}/template/device/config/attachcli?{query}</td>
670
713
  <td style="padding:15px">Yes</td>
671
714
  </tr>
672
715
  <tr>
673
716
  <td style="padding:15px">detachDeviceTemplate(body, callback)</td>
674
- <td style="padding:15px">Detach device template</td>
717
+ <td style="padding:15px">detachDeviceTemplate</td>
675
718
  <td style="padding:15px">{base_path}/{version}/template/device/config/detach?{query}</td>
676
719
  <td style="padding:15px">Yes</td>
677
720
  </tr>
678
721
  <tr>
679
722
  <td style="padding:15px">createDeviceInput(body, callback)</td>
680
- <td style="padding:15px">Create device input</td>
723
+ <td style="padding:15px">createDeviceInput</td>
681
724
  <td style="padding:15px">{base_path}/{version}/template/device/config/input?{query}</td>
682
725
  <td style="padding:15px">Yes</td>
683
726
  </tr>
684
727
  <tr>
685
728
  <td style="padding:15px">checkVbond(callback)</td>
686
- <td style="padding:15px">Check vBond</td>
729
+ <td style="padding:15px">checkVbond</td>
687
730
  <td style="padding:15px">{base_path}/{version}/template/device/config/vbond?{query}</td>
688
731
  <td style="padding:15px">Yes</td>
689
732
  </tr>
690
733
  <tr>
691
734
  <td style="padding:15px">generateTemplateList(summary, callback)</td>
692
- <td style="padding:15px">Generate template list</td>
735
+ <td style="padding:15px">generateTemplateList</td>
693
736
  <td style="padding:15px">{base_path}/{version}/template/feature?{query}</td>
694
737
  <td style="padding:15px">Yes</td>
695
738
  </tr>
696
739
  <tr>
697
740
  <td style="padding:15px">createTemplate(body, callback)</td>
698
- <td style="padding:15px">Create feature template</td>
741
+ <td style="padding:15px">createTemplate</td>
699
742
  <td style="padding:15px">{base_path}/{version}/template/feature?{query}</td>
700
743
  <td style="padding:15px">Yes</td>
701
744
  </tr>
702
745
  <tr>
703
746
  <td style="padding:15px">getTemplate(templateId, callback)</td>
704
- <td style="padding:15px">Get template</td>
747
+ <td style="padding:15px">getTemplate</td>
705
748
  <td style="padding:15px">{base_path}/{version}/template/feature/object/{pathv1}?{query}</td>
706
749
  <td style="padding:15px">Yes</td>
707
750
  </tr>
708
751
  <tr>
709
752
  <td style="padding:15px">editTemplate(templateId, body, callback)</td>
710
- <td style="padding:15px">Edit template</td>
753
+ <td style="padding:15px">editTemplate</td>
711
754
  <td style="padding:15px">{base_path}/{version}/template/feature/{pathv1}?{query}</td>
712
755
  <td style="padding:15px">Yes</td>
713
756
  </tr>
714
757
  <tr>
715
758
  <td style="padding:15px">deleteTemplate(templateId, callback)</td>
716
- <td style="padding:15px">Delete template</td>
759
+ <td style="padding:15px">deleteTemplate</td>
717
760
  <td style="padding:15px">{base_path}/{version}/template/feature/{pathv1}?{query}</td>
718
761
  <td style="padding:15px">Yes</td>
719
762
  </tr>
720
763
  <tr>
721
764
  <td style="padding:15px">editLITemplate(templateId, body, callback)</td>
722
- <td style="padding:15px">Update feature template</td>
765
+ <td style="padding:15px">editLITemplate</td>
723
766
  <td style="padding:15px">{base_path}/{version}/template/feature/li/{pathv1}?{query}</td>
724
767
  <td style="padding:15px">Yes</td>
725
768
  </tr>
726
769
  <tr>
727
770
  <td style="padding:15px">createLITemplate(body, callback)</td>
728
- <td style="padding:15px">Create feature template</td>
771
+ <td style="padding:15px">createLITemplate</td>
729
772
  <td style="padding:15px">{base_path}/{version}/template/feature/li?{query}</td>
730
773
  <td style="padding:15px">Yes</td>
731
774
  </tr>
732
775
  <tr>
733
776
  <td style="padding:15px">listLITemplate(callback)</td>
734
- <td style="padding:15px">Get LI feature template</td>
777
+ <td style="padding:15px">listLITemplate</td>
735
778
  <td style="padding:15px">{base_path}/{version}/template/feature/li?{query}</td>
736
779
  <td style="padding:15px">Yes</td>
737
780
  </tr>
738
781
  <tr>
739
782
  <td style="padding:15px">generateTemplateByDeviceType(deviceType, callback)</td>
740
- <td style="padding:15px">Generate template based on device</td>
783
+ <td style="padding:15px">generateTemplateByDeviceType</td>
741
784
  <td style="padding:15px">{base_path}/{version}/template/feature/{pathv1}?{query}</td>
742
785
  <td style="padding:15px">Yes</td>
743
786
  </tr>
744
787
  <tr>
745
788
  <td style="padding:15px">getTemplateDefinition(templateId, callback)</td>
746
- <td style="padding:15px">Get template</td>
789
+ <td style="padding:15px">getTemplateDefinition</td>
747
790
  <td style="padding:15px">{base_path}/{version}/template/feature/definition/{pathv1}?{query}</td>
748
791
  <td style="padding:15px">Yes</td>
749
792
  </tr>
750
793
  <tr>
751
794
  <td style="padding:15px">generateTemplateTypes(callback)</td>
752
- <td style="padding:15px">Generate template types</td>
795
+ <td style="padding:15px">generateTemplateTypes</td>
753
796
  <td style="padding:15px">{base_path}/{version}/template/feature/types?{query}</td>
754
797
  <td style="padding:15px">Yes</td>
755
798
  </tr>
756
799
  <tr>
757
800
  <td style="padding:15px">generateTemplateTypeDefinition(typeName, version, callback)</td>
758
- <td style="padding:15px">Generate template type definition</td>
801
+ <td style="padding:15px">generateTemplateTypeDefinition</td>
759
802
  <td style="padding:15px">{base_path}/{version}/template/feature/types/definition/{pathv1}/{pathv2}?{query}</td>
760
803
  <td style="padding:15px">Yes</td>
761
804
  </tr>
762
805
  <tr>
763
806
  <td style="padding:15px">generateMasterTemplateDefinition(typeName, callback)</td>
764
- <td style="padding:15px">Generate template type definition</td>
807
+ <td style="padding:15px">generateMasterTemplateDefinition</td>
765
808
  <td style="padding:15px">{base_path}/{version}/template/feature/master/{pathv1}?{query}</td>
766
809
  <td style="padding:15px">Yes</td>
767
810
  </tr>
768
811
  <tr>
769
812
  <td style="padding:15px">getDeviceTemplatesAttachedToFeature(templateId, callback)</td>
770
- <td style="padding:15px">Get all device templates for this feature template</td>
813
+ <td style="padding:15px">getDeviceTemplatesAttachedToFeature</td>
771
814
  <td style="padding:15px">{base_path}/{version}/template/feature/devicetemplates/{pathv1}?{query}</td>
772
815
  <td style="padding:15px">Yes</td>
773
816
  </tr>
774
817
  <tr>
775
818
  <td style="padding:15px">generateMasterTemplateList(feature, callback)</td>
776
- <td style="padding:15px">Generate template list Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
819
+ <td style="padding:15px">generateMasterTemplateList</td>
777
820
  <td style="padding:15px">{base_path}/{version}/template/device?{query}</td>
778
821
  <td style="padding:15px">Yes</td>
779
822
  </tr>
780
823
  <tr>
781
824
  <td style="padding:15px">editMasterTemplate(templateId, body, callback)</td>
782
- <td style="padding:15px">Edit template Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
825
+ <td style="padding:15px">editMasterTemplate</td>
783
826
  <td style="padding:15px">{base_path}/{version}/template/device/{pathv1}?{query}</td>
784
827
  <td style="padding:15px">Yes</td>
785
828
  </tr>
786
829
  <tr>
787
830
  <td style="padding:15px">createVSmartTemplate(body, callback)</td>
788
- <td style="padding:15px">Create template for given policy</td>
831
+ <td style="padding:15px">createVSmartTemplate</td>
789
832
  <td style="padding:15px">{base_path}/{version}/template/policy/vsmart?{query}</td>
790
833
  <td style="padding:15px">Yes</td>
791
834
  </tr>
792
835
  <tr>
793
836
  <td style="padding:15px">getTemplateByPolicyId(policyId, callback)</td>
794
- <td style="padding:15px">Get template policy definition by policy id</td>
837
+ <td style="padding:15px">getTemplateByPolicyId</td>
795
838
  <td style="padding:15px">{base_path}/{version}/template/policy/vsmart/definition/{pathv1}?{query}</td>
796
839
  <td style="padding:15px">Yes</td>
797
840
  </tr>
798
841
  <tr>
799
842
  <td style="padding:15px">editVSmartTemplate(policyId, body, callback)</td>
800
- <td style="padding:15px">Edit template for given policy id</td>
843
+ <td style="padding:15px">editVSmartTemplate</td>
801
844
  <td style="padding:15px">{base_path}/{version}/template/policy/vsmart/{pathv1}?{query}</td>
802
845
  <td style="padding:15px">Yes</td>
803
846
  </tr>
804
847
  <tr>
805
848
  <td style="padding:15px">deleteVSmartTemplate(policyId, callback)</td>
806
- <td style="padding:15px">Delete template for a given policy id</td>
849
+ <td style="padding:15px">deleteVSmartTemplate</td>
807
850
  <td style="padding:15px">{base_path}/{version}/template/policy/vsmart/{pathv1}?{query}</td>
808
851
  <td style="padding:15px">Yes</td>
809
852
  </tr>
810
853
  <tr>
811
854
  <td style="padding:15px">resetVedgeCloud(uuid, callback)</td>
812
- <td style="padding:15px">Decommission software vEdge</td>
855
+ <td style="padding:15px">resetVedgeCloud</td>
813
856
  <td style="padding:15px">{base_path}/{version}/system/device/reset/{pathv1}?{query}</td>
814
857
  <td style="padding:15px">Yes</td>
815
858
  </tr>
816
859
  <tr>
817
860
  <td style="padding:15px">generateBootstrapConfigForVedges(body, callback)</td>
818
- <td style="padding:15px">Get bootstrap config for software vEdges</td>
861
+ <td style="padding:15px">generateBootstrapConfigForVedges</td>
819
862
  <td style="padding:15px">{base_path}/{version}/system/device/bootstrap/devices?{query}</td>
820
863
  <td style="padding:15px">Yes</td>
821
864
  </tr>
822
865
  <tr>
823
866
  <td style="padding:15px">decommissionVedgeCloud(uuid, callback)</td>
824
- <td style="padding:15px">Decommission software vEdge</td>
867
+ <td style="padding:15px">decommissionVedgeCloud</td>
825
868
  <td style="padding:15px">{base_path}/{version}/system/device/decommission/{pathv1}?{query}</td>
826
869
  <td style="padding:15px">Yes</td>
827
870
  </tr>
828
871
  <tr>
829
872
  <td style="padding:15px">generateBootstrapConfigForVedge(uuid, configtype = cloudinit, callback)</td>
830
- <td style="padding:15px">Get bootstrap config for software vEdge</td>
873
+ <td style="padding:15px">generateBootstrapConfigForVedge</td>
831
874
  <td style="padding:15px">{base_path}/{version}/system/device/bootstrap/device/{pathv1}?{query}</td>
832
875
  <td style="padding:15px">Yes</td>
833
876
  </tr>
834
877
  <tr>
835
878
  <td style="padding:15px">getBootstrapConfigZip(id, callback)</td>
836
- <td style="padding:15px">Get bootstrap config for software vEdges</td>
879
+ <td style="padding:15px">getBootstrapConfigZip</td>
837
880
  <td style="padding:15px">{base_path}/{version}/system/device/bootstrap/download/{pathv1}?{query}</td>
838
881
  <td style="padding:15px">Yes</td>
839
882
  </tr>
840
883
  <tr>
841
884
  <td style="padding:15px">formPost(callback)</td>
842
- <td style="padding:15px">Post form</td>
885
+ <td style="padding:15px">formPost</td>
843
886
  <td style="padding:15px">{base_path}/{version}/system/device/fileupload?{query}</td>
844
887
  <td style="padding:15px">Yes</td>
845
888
  </tr>
846
889
  <tr>
847
890
  <td style="padding:15px">getDevicesDetails(deviceCategory = vedges, model, state = tokengenerated, uuid, deviceIP, validity = valid, callback)</td>
848
- <td style="padding:15px">Get devices details</td>
891
+ <td style="padding:15px">getDevicesDetails</td>
849
892
  <td style="padding:15px">{base_path}/{version}/system/device/{pathv1}?{query}</td>
850
893
  <td style="padding:15px">Yes</td>
851
894
  </tr>
852
895
  <tr>
853
896
  <td style="padding:15px">createDevice(body, callback)</td>
854
- <td style="padding:15px">Create device</td>
897
+ <td style="padding:15px">createDevice</td>
855
898
  <td style="padding:15px">{base_path}/{version}/system/device?{query}</td>
856
899
  <td style="padding:15px">Yes</td>
857
900
  </tr>
858
901
  <tr>
859
902
  <td style="padding:15px">getManagementSystemIPInfo(callback)</td>
860
- <td style="padding:15px">Get Management system ip mapping</td>
903
+ <td style="padding:15px">getManagementSystemIPInfo</td>
861
904
  <td style="padding:15px">{base_path}/{version}/system/device/management/systemip?{query}</td>
862
905
  <td style="padding:15px">Yes</td>
863
906
  </tr>
864
907
  <tr>
865
908
  <td style="padding:15px">deleteDevice(uuid, callback)</td>
866
- <td style="padding:15px">Delete vedges</td>
909
+ <td style="padding:15px">deleteDevice</td>
867
910
  <td style="padding:15px">{base_path}/{version}/system/device/{pathv1}?{query}</td>
868
911
  <td style="padding:15px">Yes</td>
869
912
  </tr>
870
913
  <tr>
871
914
  <td style="padding:15px">editDevice(uuid, body, callback)</td>
872
- <td style="padding:15px">Edit device</td>
915
+ <td style="padding:15px">editDevice</td>
873
916
  <td style="padding:15px">{base_path}/{version}/system/device/{pathv1}?{query}</td>
874
917
  <td style="padding:15px">Yes</td>
875
918
  </tr>
876
919
  <tr>
877
920
  <td style="padding:15px">getControllerVEdgeSyncStatus(callback)</td>
878
- <td style="padding:15px">Get controllers vedge sync status</td>
921
+ <td style="padding:15px">getControllerVEdgeSyncStatus</td>
879
922
  <td style="padding:15px">{base_path}/{version}/system/device/controllers/vedge/status?{query}</td>
880
923
  <td style="padding:15px">Yes</td>
881
924
  </tr>
882
925
  <tr>
883
926
  <td style="padding:15px">getRootCertStatusAll(state = pending, callback)</td>
884
- <td style="padding:15px">Get controllers vedge sync status</td>
927
+ <td style="padding:15px">getRootCertStatusAll</td>
885
928
  <td style="padding:15px">{base_path}/{version}/system/device/rootcertchain/status?{query}</td>
886
929
  <td style="padding:15px">Yes</td>
887
930
  </tr>
888
931
  <tr>
889
932
  <td style="padding:15px">syncDevices(body, callback)</td>
890
- <td style="padding:15px">Sync devices from Smart-Account</td>
933
+ <td style="padding:15px">syncDevices</td>
891
934
  <td style="padding:15px">{base_path}/{version}/system/device/smartaccount/sync?{query}</td>
892
935
  <td style="padding:15px">Yes</td>
893
936
  </tr>
894
937
  <tr>
895
938
  <td style="padding:15px">getCloudDockDataBasedOnDeviceType(deviceCategory = vedges, callback)</td>
896
- <td style="padding:15px">Get devices details</td>
939
+ <td style="padding:15px">getCloudDockDataBasedOnDeviceType</td>
897
940
  <td style="padding:15px">{base_path}/{version}/system/device/type/{pathv1}?{query}</td>
898
941
  <td style="padding:15px">Yes</td>
899
942
  </tr>
900
943
  <tr>
901
944
  <td style="padding:15px">getOutOfSyncTemplates(callback)</td>
902
- <td style="padding:15px">Get template sync status</td>
945
+ <td style="padding:15px">getOutOfSyncTemplates</td>
903
946
  <td style="padding:15px">{base_path}/{version}/template/device/syncstatus?{query}</td>
904
947
  <td style="padding:15px">Yes</td>
905
948
  </tr>
906
949
  <tr>
907
950
  <td style="padding:15px">getOutOfSyncDevices(templateId, callback)</td>
908
- <td style="padding:15px">Get out of sync devices</td>
951
+ <td style="padding:15px">getOutOfSyncDevices</td>
909
952
  <td style="padding:15px">{base_path}/{version}/template/device/syncstatus/{pathv1}?{query}</td>
910
953
  <td style="padding:15px">Yes</td>
911
954
  </tr>
912
955
  <tr>
913
956
  <td style="padding:15px">createMasterTemplate(body, callback)</td>
914
- <td style="padding:15px">Create template</td>
957
+ <td style="padding:15px">createMasterTemplate</td>
915
958
  <td style="padding:15px">{base_path}/{version}/template/device/feature?{query}</td>
916
959
  <td style="padding:15px">Yes</td>
917
960
  </tr>
918
961
  <tr>
919
962
  <td style="padding:15px">createCLITemplate(body, callback)</td>
920
- <td style="padding:15px">Create template</td>
963
+ <td style="padding:15px">createCLITemplate</td>
921
964
  <td style="padding:15px">{base_path}/{version}/template/device/cli?{query}</td>
922
965
  <td style="padding:15px">Yes</td>
923
966
  </tr>
924
967
  <tr>
925
968
  <td style="padding:15px">getMasterTemplateDefinition(templateId, callback)</td>
926
- <td style="padding:15px">Get template object</td>
969
+ <td style="padding:15px">getMasterTemplateDefinition</td>
927
970
  <td style="padding:15px">{base_path}/{version}/template/device/object/{pathv1}?{query}</td>
928
971
  <td style="padding:15px">Yes</td>
929
972
  </tr>
930
973
  <tr>
931
974
  <td style="padding:15px">getRunningConfig(deviceUUID, callback)</td>
932
- <td style="padding:15px">Get running config</td>
975
+ <td style="padding:15px">getRunningConfig</td>
933
976
  <td style="padding:15px">{base_path}/{version}/template/config/running/{pathv1}?{query}</td>
934
977
  <td style="padding:15px">Yes</td>
935
978
  </tr>
936
979
  <tr>
937
980
  <td style="padding:15px">uploadConfig(deviceUUID, body, callback)</td>
938
- <td style="padding:15px">Upload config</td>
981
+ <td style="padding:15px">uploadConfig</td>
939
982
  <td style="padding:15px">{base_path}/{version}/template/config/attach/{pathv1}?{query}</td>
940
983
  <td style="padding:15px">Yes</td>
941
984
  </tr>
942
985
  <tr>
943
986
  <td style="padding:15px">getAttachedConfig(deviceUUID, type, callback)</td>
944
- <td style="padding:15px">Get attached config</td>
987
+ <td style="padding:15px">getAttachedConfig</td>
945
988
  <td style="padding:15px">{base_path}/{version}/template/config/attached/{pathv1}?{query}</td>
946
989
  <td style="padding:15px">Yes</td>
947
990
  </tr>
948
991
  <tr>
949
992
  <td style="padding:15px">getConfigDiff(deviceUUID, callback)</td>
950
- <td style="padding:15px">Get config diff</td>
993
+ <td style="padding:15px">getConfigDiff</td>
951
994
  <td style="padding:15px">{base_path}/{version}/template/config/diff/{pathv1}?{query}</td>
952
995
  <td style="padding:15px">Yes</td>
953
996
  </tr>
954
997
  <tr>
955
998
  <td style="padding:15px">generateCLIModeDevices(type = vedge, callback)</td>
956
- <td style="padding:15px">Generate CLI mode devices</td>
999
+ <td style="padding:15px">generateCLIModeDevices</td>
957
1000
  <td style="padding:15px">{base_path}/{version}/template/config/device/mode/cli?{query}</td>
958
1001
  <td style="padding:15px">Yes</td>
959
1002
  </tr>
960
1003
  <tr>
961
1004
  <td style="padding:15px">updateDeviceToCLIMode(body, callback)</td>
962
- <td style="padding:15px">Update device to CLI Mode</td>
1005
+ <td style="padding:15px">updateDeviceToCLIMode</td>
963
1006
  <td style="padding:15px">{base_path}/{version}/template/config/device/mode/cli?{query}</td>
964
1007
  <td style="padding:15px">Yes</td>
965
1008
  </tr>
966
1009
  <tr>
967
1010
  <td style="padding:15px">generatevManageModeDevices(type = vedge, callback)</td>
968
- <td style="padding:15px">Generate vManage mode devices</td>
1011
+ <td style="padding:15px">generatevManageModeDevices</td>
969
1012
  <td style="padding:15px">{base_path}/{version}/template/config/device/mode/vmanage?{query}</td>
970
1013
  <td style="padding:15px">Yes</td>
971
1014
  </tr>
972
1015
  <tr>
973
1016
  <td style="padding:15px">getCompatibleDevices(oldDeviceUUID, callback)</td>
974
- <td style="padding:15px">Get compatible devices</td>
1017
+ <td style="padding:15px">getCompatibleDevices</td>
975
1018
  <td style="padding:15px">{base_path}/{version}/template/config/rmalist/{pathv1}?{query}</td>
976
1019
  <td style="padding:15px">Yes</td>
977
1020
  </tr>
978
1021
  <tr>
979
1022
  <td style="padding:15px">getVpnForDevice(uuid, callback)</td>
980
- <td style="padding:15px">Get configured vpn for the device</td>
1023
+ <td style="padding:15px">getVpnForDevice</td>
981
1024
  <td style="padding:15px">{base_path}/{version}/template/config/vpn/{pathv1}?{query}</td>
982
1025
  <td style="padding:15px">Yes</td>
983
1026
  </tr>
984
1027
  <tr>
985
1028
  <td style="padding:15px">rmaUpdate(body, callback)</td>
986
- <td style="padding:15px">Update New Device</td>
1029
+ <td style="padding:15px">rmaUpdate</td>
987
1030
  <td style="padding:15px">{base_path}/{version}/template/config/rmaupdate?{query}</td>
988
1031
  <td style="padding:15px">Yes</td>
989
1032
  </tr>
990
1033
  <tr>
991
1034
  <td style="padding:15px">deActivatePolicy(policyId, callback)</td>
992
- <td style="padding:15px">Deactivate vsmart policy</td>
1035
+ <td style="padding:15px">deActivatePolicy</td>
993
1036
  <td style="padding:15px">{base_path}/{version}/template/policy/vsmart/deactivate/{pathv1}?{query}</td>
994
1037
  <td style="padding:15px">Yes</td>
995
1038
  </tr>
996
1039
  <tr>
997
1040
  <td style="padding:15px">activatePolicy(policyId, body, callback)</td>
998
- <td style="padding:15px">Activate vsmart policy</td>
1041
+ <td style="padding:15px">activatePolicy</td>
999
1042
  <td style="padding:15px">{base_path}/{version}/template/policy/vsmart/activate/{pathv1}?{query}</td>
1000
1043
  <td style="padding:15px">Yes</td>
1001
1044
  </tr>
1002
1045
  <tr>
1003
1046
  <td style="padding:15px">checkVSmartConnectivityStatus(callback)</td>
1004
- <td style="padding:15px">Check VSmart Connectivity Status</td>
1047
+ <td style="padding:15px">checkVSmartConnectivityStatus</td>
1005
1048
  <td style="padding:15px">{base_path}/{version}/template/policy/vsmart/connectivity/status?{query}</td>
1006
1049
  <td style="padding:15px">Yes</td>
1007
1050
  </tr>
1008
1051
  <tr>
1009
1052
  <td style="padding:15px">applicationAwareRoutingStatistics(body, callback)</td>
1010
- <td style="padding:15px">Getting statistics for application aware routing</td>
1053
+ <td style="padding:15px">applicationAwareRoutingStatistics</td>
1011
1054
  <td style="padding:15px">{base_path}/{version}/statistics/approute/fec/aggregation?{query}</td>
1012
1055
  <td style="padding:15px">Yes</td>
1013
1056
  </tr>
@@ -1523,25 +1566,25 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
1523
1566
  </tr>
1524
1567
  <tr>
1525
1568
  <td style="padding:15px">forceSyncRootCert(body, callback)</td>
1526
- <td style="padding:15px">Force sync root certificate Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.</td>
1569
+ <td style="padding:15px">Force sync root certificate Note: In a multitenant vManage system, this API is only available in</td>
1527
1570
  <td style="padding:15px">{base_path}/{version}/certificate/forcesync/rootCert?{query}</td>
1528
1571
  <td style="padding:15px">Yes</td>
1529
1572
  </tr>
1530
1573
  <tr>
1531
1574
  <td style="padding:15px">generateCSR(body, callback)</td>
1532
- <td style="padding:15px">Generate CSR Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.</td>
1575
+ <td style="padding:15px">Generate CSR Note: In a multitenant vManage system, this API is only available in the Provider an</td>
1533
1576
  <td style="padding:15px">{base_path}/{version}/certificate/generate/csr?{query}</td>
1534
1577
  <td style="padding:15px">Yes</td>
1535
1578
  </tr>
1536
1579
  <tr>
1537
1580
  <td style="padding:15px">generateEnterpriseCSR(body, callback)</td>
1538
- <td style="padding:15px">Generate CSR Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.</td>
1581
+ <td style="padding:15px">Generate CSR Note: In a multitenant vManage system, this API is only available in the Provider an</td>
1539
1582
  <td style="padding:15px">{base_path}/{version}/certificate/generate/enterprise/csr/vedge?{query}</td>
1540
1583
  <td style="padding:15px">Yes</td>
1541
1584
  </tr>
1542
1585
  <tr>
1543
1586
  <td style="padding:15px">installCertificate(body, callback)</td>
1544
- <td style="padding:15px">Install singed certificate Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.</td>
1587
+ <td style="padding:15px">Install singed certificate Note: In a multitenant vManage system, this API is only available in t</td>
1545
1588
  <td style="padding:15px">{base_path}/{version}/certificate/install/signedCert?{query}</td>
1546
1589
  <td style="padding:15px">Yes</td>
1547
1590
  </tr>
@@ -1559,13 +1602,13 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
1559
1602
  </tr>
1560
1603
  <tr>
1561
1604
  <td style="padding:15px">resetRSA(body, callback)</td>
1562
- <td style="padding:15px">Register CSR Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.</td>
1605
+ <td style="padding:15px">Register CSR Note: In a multitenant vManage system, this API is only available in the Provider an</td>
1563
1606
  <td style="padding:15px">{base_path}/{version}/certificate/reset/rsa?{query}</td>
1564
1607
  <td style="padding:15px">Yes</td>
1565
1608
  </tr>
1566
1609
  <tr>
1567
1610
  <td style="padding:15px">decommissionEnterpriseCSRForVedge(body, callback)</td>
1568
- <td style="padding:15px">Revoking enterprise CSR for hardware vEdge Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.</td>
1611
+ <td style="padding:15px">Revoking enterprise CSR for hardware vEdge Note: In a multitenant vManage system, this API is onl</td>
1569
1612
  <td style="padding:15px">{base_path}/{version}/certificate/revoke/enterprise/certificate?{query}</td>
1570
1613
  <td style="padding:15px">Yes</td>
1571
1614
  </tr>
@@ -1577,7 +1620,7 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
1577
1620
  </tr>
1578
1621
  <tr>
1579
1622
  <td style="padding:15px">saveRootCertChain(body, callback)</td>
1580
- <td style="padding:15px">Save root cert chain Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.</td>
1623
+ <td style="padding:15px">Save root cert chain Note: In a multitenant vManage system, this API is only available in the Pro</td>
1581
1624
  <td style="padding:15px">{base_path}/{version}/certificate/rootcertchains?{query}</td>
1582
1625
  <td style="padding:15px">Yes</td>
1583
1626
  </tr>
@@ -1631,7 +1674,7 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
1631
1674
  </tr>
1632
1675
  <tr>
1633
1676
  <td style="padding:15px">getvSmartList(callback)</td>
1634
- <td style="padding:15px">Get vSmart list Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.</td>
1677
+ <td style="padding:15px">Get vSmart list Note: In a multitenant vManage system, this API is only available in the Provider</td>
1635
1678
  <td style="padding:15px">{base_path}/{version}/certificate/vsmart/list?{query}</td>
1636
1679
  <td style="padding:15px">Yes</td>
1637
1680
  </tr>
@@ -1643,7 +1686,7 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
1643
1686
  </tr>
1644
1687
  <tr>
1645
1688
  <td style="padding:15px">deleteConfiguration(uuid, replaceController, deviceId, callback)</td>
1646
- <td style="padding:15px">Invalidate device Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.</td>
1689
+ <td style="padding:15px">Invalidate device Note: In a multitenant vManage system, this API is only available in the Provid</td>
1647
1690
  <td style="padding:15px">{base_path}/{version}/certificate/{pathv1}?{query}</td>
1648
1691
  <td style="padding:15px">Yes</td>
1649
1692
  </tr>
@@ -1803,6 +1846,12 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
1803
1846
  <td style="padding:15px">{base_path}/{version}/cloudservices/authtoken?{query}</td>
1804
1847
  <td style="padding:15px">Yes</td>
1805
1848
  </tr>
1849
+ <tr>
1850
+ <td style="padding:15px">systemconnect(callback)</td>
1851
+ <td style="padding:15px">Telemetry Opt In</td>
1852
+ <td style="padding:15px">{base_path}/{version}/cloudservices/connect?{query}</td>
1853
+ <td style="padding:15px">Yes</td>
1854
+ </tr>
1806
1855
  <tr>
1807
1856
  <td style="padding:15px">getCloudCredentials(callback)</td>
1808
1857
  <td style="padding:15px">Get cloud service credentials</td>
@@ -1877,91 +1926,91 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
1877
1926
  </tr>
1878
1927
  <tr>
1879
1928
  <td style="padding:15px">checkIfClusterLocked(callback)</td>
1880
- <td style="padding:15px">Check whether cluster is locked Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
1929
+ <td style="padding:15px">Check whether cluster is locked Note: In a multitenant vManage system, this API is only available</td>
1881
1930
  <td style="padding:15px">{base_path}/{version}/clusterManagement/clusterLocked?{query}</td>
1882
1931
  <td style="padding:15px">Yes</td>
1883
1932
  </tr>
1884
1933
  <tr>
1885
1934
  <td style="padding:15px">configureVmanage(body, callback)</td>
1886
- <td style="padding:15px">Configure vManage Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
1935
+ <td style="padding:15px">Configure vManage Note: In a multitenant vManage system, this API is only available in the Provid</td>
1887
1936
  <td style="padding:15px">{base_path}/{version}/clusterManagement/configure?{query}</td>
1888
1937
  <td style="padding:15px">Yes</td>
1889
1938
  </tr>
1890
1939
  <tr>
1891
1940
  <td style="padding:15px">getConnectedDevices(vmanageIP, callback)</td>
1892
- <td style="padding:15px">Get connected device for vManage Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
1941
+ <td style="padding:15px">Get connected device for vManage Note: In a multitenant vManage system, this API is only availabl</td>
1893
1942
  <td style="padding:15px">{base_path}/{version}/clusterManagement/connectedDevices/{pathv1}?{query}</td>
1894
1943
  <td style="padding:15px">Yes</td>
1895
1944
  </tr>
1896
1945
  <tr>
1897
1946
  <td style="padding:15px">enableSDAVC(callback)</td>
1898
- <td style="padding:15px">Enable SDAVC Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
1947
+ <td style="padding:15px">Enable SDAVC Note: In a multitenant vManage system, this API is only available in the Provider vi</td>
1899
1948
  <td style="padding:15px">{base_path}/{version}/clusterManagement/enableSDAVC?{query}</td>
1900
1949
  <td style="padding:15px">Yes</td>
1901
1950
  </tr>
1902
1951
  <tr>
1903
1952
  <td style="padding:15px">healthDetails(callback)</td>
1904
- <td style="padding:15px">Get cluster health check details Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
1953
+ <td style="padding:15px">Get cluster health check details Note: In a multitenant vManage system, this API is only availabl</td>
1905
1954
  <td style="padding:15px">{base_path}/{version}/clusterManagement/health/details?{query}</td>
1906
1955
  <td style="padding:15px">Yes</td>
1907
1956
  </tr>
1908
1957
  <tr>
1909
1958
  <td style="padding:15px">healthStatusInfo(callback)</td>
1910
- <td style="padding:15px">Get cluster health check details Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
1959
+ <td style="padding:15px">Get cluster health check details Note: In a multitenant vManage system, this API is only availabl</td>
1911
1960
  <td style="padding:15px">{base_path}/{version}/clusterManagement/health/status?{query}</td>
1912
1961
  <td style="padding:15px">Yes</td>
1913
1962
  </tr>
1914
1963
  <tr>
1915
1964
  <td style="padding:15px">healthSummary(isCached, callback)</td>
1916
- <td style="padding:15px">Get cluster health check summary Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
1965
+ <td style="padding:15px">Get cluster health check summary Note: In a multitenant vManage system, this API is only availabl</td>
1917
1966
  <td style="padding:15px">{base_path}/{version}/clusterManagement/health/summary?{query}</td>
1918
1967
  <td style="padding:15px">Yes</td>
1919
1968
  </tr>
1920
1969
  <tr>
1921
1970
  <td style="padding:15px">getConfiguredIPList(vmanageID, callback)</td>
1922
- <td style="padding:15px">Get configured IP addresses Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
1971
+ <td style="padding:15px">Get configured IP addresses Note: In a multitenant vManage system, this API is only available in</td>
1923
1972
  <td style="padding:15px">{base_path}/{version}/clusterManagement/iplist/{pathv1}?{query}</td>
1924
1973
  <td style="padding:15px">Yes</td>
1925
1974
  </tr>
1926
1975
  <tr>
1927
1976
  <td style="padding:15px">isClusterReady(callback)</td>
1928
- <td style="padding:15px">Is cluster ready Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
1977
+ <td style="padding:15px">Is cluster ready Note: In a multitenant vManage system, this API is only available in the Provide</td>
1929
1978
  <td style="padding:15px">{base_path}/{version}/clusterManagement/isready?{query}</td>
1930
1979
  <td style="padding:15px">Yes</td>
1931
1980
  </tr>
1932
1981
  <tr>
1933
1982
  <td style="padding:15px">listVmanages(callback)</td>
1934
- <td style="padding:15px">List vManages in the cluster Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
1983
+ <td style="padding:15px">List vManages in the cluster Note: In a multitenant vManage system, this API is only available in</td>
1935
1984
  <td style="padding:15px">{base_path}/{version}/clusterManagement/list?{query}</td>
1936
1985
  <td style="padding:15px">Yes</td>
1937
1986
  </tr>
1938
1987
  <tr>
1939
1988
  <td style="padding:15px">nodeProperties(callback)</td>
1940
- <td style="padding:15px">Get properties of vManage being added to cluster Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
1989
+ <td style="padding:15px">Get properties of vManage being added to cluster Note: In a multitenant vManage system, this API</td>
1941
1990
  <td style="padding:15px">{base_path}/{version}/clusterManagement/nodeProperties?{query}</td>
1942
1991
  <td style="padding:15px">Yes</td>
1943
1992
  </tr>
1944
1993
  <tr>
1945
1994
  <td style="padding:15px">removeVmanage(body, callback)</td>
1946
- <td style="padding:15px">Remove vManage from cluster Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
1995
+ <td style="padding:15px">Remove vManage from cluster Note: In a multitenant vManage system, this API is only available in</td>
1947
1996
  <td style="padding:15px">{base_path}/{version}/clusterManagement/remove?{query}</td>
1948
1997
  <td style="padding:15px">Yes</td>
1949
1998
  </tr>
1950
1999
  <tr>
1951
2000
  <td style="padding:15px">performReplicationAndRebalanceOfKafkaPartitions(callback)</td>
1952
- <td style="padding:15px">Initiate replication and rebalance of kafka topics Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
2001
+ <td style="padding:15px">Initiate replication and rebalance of kafka topics Note: In a multitenant vManage system, this AP</td>
1953
2002
  <td style="padding:15px">{base_path}/{version}/clusterManagement/replicateAndRebalance?{query}</td>
1954
2003
  <td style="padding:15px">Yes</td>
1955
2004
  </tr>
1956
2005
  <tr>
1957
2006
  <td style="padding:15px">resetSDAVCNode(body, callback)</td>
1958
- <td style="padding:15px">Reset SDAVC on the vManage node Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
2007
+ <td style="padding:15px">Reset SDAVC on the vManage node Note: In a multitenant vManage system, this API is only available</td>
1959
2008
  <td style="padding:15px">{base_path}/{version}/clusterManagement/resetSDAVC?{query}</td>
1960
2009
  <td style="padding:15px">Yes</td>
1961
2010
  </tr>
1962
2011
  <tr>
1963
2012
  <td style="padding:15px">editVmanage(body, callback)</td>
1964
- <td style="padding:15px">Update vManage cluster info Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
2013
+ <td style="padding:15px">Update vManage cluster info Note: In a multitenant vManage system, this API is only available in</td>
1965
2014
  <td style="padding:15px">{base_path}/{version}/clusterManagement/setup?{query}</td>
1966
2015
  <td style="padding:15px">Yes</td>
1967
2016
  </tr>
@@ -1973,7 +2022,7 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
1973
2022
  </tr>
1974
2023
  <tr>
1975
2024
  <td style="padding:15px">getTenancyMode(callback)</td>
1976
- <td style="padding:15px">Get vManage tenancy mode Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
2025
+ <td style="padding:15px">Get vManage tenancy mode Note: In a multitenant vManage system, this API is only available in the</td>
1977
2026
  <td style="padding:15px">{base_path}/{version}/clusterManagement/tenancy/mode?{query}</td>
1978
2027
  <td style="padding:15px">Yes</td>
1979
2028
  </tr>
@@ -1985,31 +2034,31 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
1985
2034
  </tr>
1986
2035
  <tr>
1987
2036
  <td style="padding:15px">getTenantsList(callback)</td>
1988
- <td style="padding:15px">Get tenant list Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
2037
+ <td style="padding:15px">Get tenant list Note: In a multitenant vManage system, this API is only available in the Provider</td>
1989
2038
  <td style="padding:15px">{base_path}/{version}/clusterManagement/tenantList?{query}</td>
1990
2039
  <td style="padding:15px">Yes</td>
1991
2040
  </tr>
1992
2041
  <tr>
1993
2042
  <td style="padding:15px">updateReplicationFactorForKafkaTopics(callback)</td>
1994
- <td style="padding:15px">Update replication factor for each kakfa topic Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
2043
+ <td style="padding:15px">Update replication factor for each kakfa topic Note: In a multitenant vManage system, this API is</td>
1995
2044
  <td style="padding:15px">{base_path}/{version}/clusterManagement/updateReplicationFactor?{query}</td>
1996
2045
  <td style="padding:15px">Yes</td>
1997
2046
  </tr>
1998
2047
  <tr>
1999
2048
  <td style="padding:15px">addOrUpdateUserCredentials(body, callback)</td>
2000
- <td style="padding:15px">Add or update user credentials for cluster operations Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
2049
+ <td style="padding:15px">Add or update user credentials for cluster operations Note: In a multitenant vManage system, this</td>
2001
2050
  <td style="padding:15px">{base_path}/{version}/clusterManagement/userCreds?{query}</td>
2002
2051
  <td style="padding:15px">Yes</td>
2003
2052
  </tr>
2004
2053
  <tr>
2005
2054
  <td style="padding:15px">getVManageDetails(vmanageIP, callback)</td>
2006
- <td style="padding:15px">Get vManage detail Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
2055
+ <td style="padding:15px">Get vManage detail Note: In a multitenant vManage system, this API is only available in the Provi</td>
2007
2056
  <td style="padding:15px">{base_path}/{version}/clusterManagement/vManage/details/{pathv1}?{query}</td>
2008
2057
  <td style="padding:15px">Yes</td>
2009
2058
  </tr>
2010
2059
  <tr>
2011
2060
  <td style="padding:15px">getConnectedDevicesPerTenant(tenantId, vmanageIP, callback)</td>
2012
- <td style="padding:15px">Get connected device for vManage for a tenant Note: In a multitenant vManage system, this API is only available in the Provider view.</td>
2061
+ <td style="padding:15px">Get connected device for vManage for a tenant Note: In a multitenant vManage system, this API is</td>
2013
2062
  <td style="padding:15px">{base_path}/{version}/clusterManagement/{pathv1}/connectedDevices/{pathv2}?{query}</td>
2014
2063
  <td style="padding:15px">Yes</td>
2015
2064
  </tr>
@@ -2759,13 +2808,13 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
2759
2808
  </tr>
2760
2809
  <tr>
2761
2810
  <td style="padding:15px">getAggregationDataByQuery16(query, callback)</td>
2762
- <td style="padding:15px">Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage</td>
2811
+ <td style="padding:15px">Get aggregated data based on input query and filters. The data can be filtered on time and other un</td>
2763
2812
  <td style="padding:15px">{base_path}/{version}/device/history/aggregation?{query}</td>
2764
2813
  <td style="padding:15px">Yes</td>
2765
2814
  </tr>
2766
2815
  <tr>
2767
2816
  <td style="padding:15px">getPostAggregationDataByQuery15(body, callback)</td>
2768
- <td style="padding:15px">Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage</td>
2817
+ <td style="padding:15px">Get aggregated data based on input query and filters. The data can be filtered on time and other un</td>
2769
2818
  <td style="padding:15px">{base_path}/{version}/device/history/aggregation?{query}</td>
2770
2819
  <td style="padding:15px">Yes</td>
2771
2820
  </tr>
@@ -2933,13 +2982,13 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
2933
2982
  </tr>
2934
2983
  <tr>
2935
2984
  <td style="padding:15px">getAggregationDataByQuery23(query, callback)</td>
2936
- <td style="padding:15px">Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage</td>
2985
+ <td style="padding:15px">Get aggregated data based on input query and filters. The data can be filtered on time and other un</td>
2937
2986
  <td style="padding:15px">{base_path}/{version}/statistics/speedtest/aggregation?{query}</td>
2938
2987
  <td style="padding:15px">Yes</td>
2939
2988
  </tr>
2940
2989
  <tr>
2941
2990
  <td style="padding:15px">getPostAggregationDataByQuery22(body, callback)</td>
2942
- <td style="padding:15px">Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage</td>
2991
+ <td style="padding:15px">Get aggregated data based on input query and filters. The data can be filtered on time and other un</td>
2943
2992
  <td style="padding:15px">{base_path}/{version}/statistics/speedtest/aggregation?{query}</td>
2944
2993
  <td style="padding:15px">Yes</td>
2945
2994
  </tr>
@@ -3407,13 +3456,13 @@ Specific adapter calls are built based on the API of the Viptela. The Adapter Bu
3407
3456
  </tr>
3408
3457
  <tr>
3409
3458
  <td style="padding:15px">getAggregationDataByQuery21(query, callback)</td>
3410
- <td style="padding:15px">Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage</td>
3459
+ <td style="padding:15px">Get aggregated data based on input query and filters. The data can be filtered on time and other un</td>
3411
3460
  <td style="padding:15px">{base_path}/{version}/event/aggregation?{query}</td>
3412
3461
  <td style="padding:15px">Yes</td>
3413
3462
  </tr>
3414
3463
  <tr>
3415
3464
  <td style="padding:15px">getPostAggregationDataByQuery20(body, callback)</td>
3416
- <td style="padding:15px">Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage</td>
3465
+ <td style="padding:15px">Get aggregated data based on input query and filters. The data can be filtered on time and other un</td>
3417
3466
  <td style="padding:15px">{base_path}/{version}/event/aggregation?{query}</td>
3418
3467
  <td style="padding:15px">Yes</td>
3419
3468
  </tr>