@itentialopensource/adapter-paragon_active_assurance 0.1.2 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/.eslintignore +0 -1
  2. package/.jshintrc +3 -0
  3. package/CALLS.md +175 -139
  4. package/CHANGELOG.md +8 -0
  5. package/CONTRIBUTING.md +1 -160
  6. package/ENHANCE.md +2 -2
  7. package/README.md +31 -22
  8. package/adapter.js +163 -334
  9. package/adapterBase.js +538 -873
  10. package/changelogs/CHANGELOG.md +16 -0
  11. package/metadata.json +51 -0
  12. package/package.json +24 -26
  13. package/pronghorn.json +474 -142
  14. package/propertiesSchema.json +452 -40
  15. package/refs?service=git-upload-pack +0 -0
  16. package/report/adapter-openapi.json +15052 -0
  17. package/report/adapter-openapi.yaml +10325 -0
  18. package/report/adapterInfo.json +8 -8
  19. package/report/updateReport1691508876405.json +120 -0
  20. package/report/updateReport1692202191653.json +120 -0
  21. package/report/updateReport1692203293320.json +120 -0
  22. package/report/updateReport1694469109205.json +120 -0
  23. package/report/updateReport1698422878147.json +120 -0
  24. package/sampleProperties.json +67 -14
  25. package/test/integration/adapterTestBasicGet.js +1 -1
  26. package/test/integration/adapterTestConnectivity.js +91 -42
  27. package/test/integration/adapterTestIntegration.js +130 -2
  28. package/test/unit/adapterBaseTestUnit.js +388 -315
  29. package/test/unit/adapterTestUnit.js +307 -110
  30. package/utils/adapterInfo.js +1 -1
  31. package/utils/addAuth.js +1 -1
  32. package/utils/artifactize.js +1 -1
  33. package/utils/checkMigrate.js +1 -1
  34. package/utils/entitiesToDB.js +1 -0
  35. package/utils/findPath.js +1 -1
  36. package/utils/methodDocumentor.js +71 -23
  37. package/utils/modify.js +13 -15
  38. package/utils/packModificationScript.js +1 -1
  39. package/utils/taskMover.js +309 -0
  40. package/utils/tbScript.js +3 -10
  41. package/utils/tbUtils.js +2 -3
  42. package/utils/testRunner.js +1 -1
  43. package/utils/troubleshootingAdapter.js +1 -3
  44. package/.gitlab/.gitkeep +0 -0
  45. package/.gitlab/issue_templates/.gitkeep +0 -0
  46. package/.gitlab/issue_templates/Default.md +0 -17
  47. package/.gitlab/issue_templates/bugReportTemplate.md +0 -76
  48. package/.gitlab/issue_templates/featureRequestTemplate.md +0 -14
  49. package/workflows/README.md +0 -3
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 Paragon_active_assurance. 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 Juniper Paragon Active Assurance. 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 Paragon_active_assurance.</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 Juniper Paragon Active Assurance.</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,23 +108,46 @@ 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>
110
124
  </tr>
111
125
  </table>
112
126
  <br>
127
+
128
+ ### Adapter Cache Calls
113
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>
147
+ </tr>
148
+ </table>
149
+ <br>
150
+
114
151
  ### Adapter Broker Calls
115
152
 
116
153
  These are adapter methods that are used to integrate to IAP Brokers. This adapter currently supports the following broker calls.
@@ -129,32 +166,31 @@ 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>
156
193
 
157
-
158
194
  ### Specific Adapter Calls
159
195
 
160
196
  Specific adapter calls are built based on the API of the Paragon_active_assurance. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls.
@@ -168,697 +204,697 @@ Specific adapter calls are built based on the API of the Paragon_active_assuranc
168
204
  </tr>
169
205
  <tr>
170
206
  <td style="padding:15px">listAlarmEmails(account, limit, offset, callback)</td>
171
- <td style="padding:15px">Retrieve a list of all alarm email lists.</td>
207
+ <td style="padding:15px">list_alarm_emails</td>
172
208
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/alarm_emails/?{query}</td>
173
209
  <td style="padding:15px">Yes</td>
174
210
  </tr>
175
211
  <tr>
176
212
  <td style="padding:15px">createAlarmEmails(account, body, callback)</td>
177
- <td style="padding:15px">Create a new alarm email list.</td>
213
+ <td style="padding:15px">create_alarm_emails</td>
178
214
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/alarm_emails/?{query}</td>
179
215
  <td style="padding:15px">Yes</td>
180
216
  </tr>
181
217
  <tr>
182
218
  <td style="padding:15px">deleteAlarmEmails(account, alarmEmailsId, callback)</td>
183
- <td style="padding:15px">Delete an alarm email list with a given ID.</td>
219
+ <td style="padding:15px">delete_alarm_emails</td>
184
220
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/alarm_emails/{pathv2}/?{query}</td>
185
221
  <td style="padding:15px">Yes</td>
186
222
  </tr>
187
223
  <tr>
188
224
  <td style="padding:15px">getAlarmEmails(account, alarmEmailsId, callback)</td>
189
- <td style="padding:15px">Retrieve an alarm email list with a given ID.</td>
225
+ <td style="padding:15px">get_alarm_emails</td>
190
226
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/alarm_emails/{pathv2}/?{query}</td>
191
227
  <td style="padding:15px">Yes</td>
192
228
  </tr>
193
229
  <tr>
194
230
  <td style="padding:15px">updateAlarmEmails(account, alarmEmailsId, body, callback)</td>
195
- <td style="padding:15px">Modify the configuration of an alarm email list with a given ID.</td>
231
+ <td style="padding:15px">update_alarm_emails</td>
196
232
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/alarm_emails/{pathv2}/?{query}</td>
197
233
  <td style="padding:15px">Yes</td>
198
234
  </tr>
199
235
  <tr>
200
236
  <td style="padding:15px">listAlarmTemplates(account, limit, offset, callback)</td>
201
- <td style="padding:15px">Retrieve a list of all alarm templates.</td>
237
+ <td style="padding:15px">list_alarm_templates</td>
202
238
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/alarm_templates/?{query}</td>
203
239
  <td style="padding:15px">Yes</td>
204
240
  </tr>
205
241
  <tr>
206
242
  <td style="padding:15px">createAlarmTemplates(account, body, callback)</td>
207
- <td style="padding:15px">Create a new alarm template.</td>
243
+ <td style="padding:15px">create_alarm_templates</td>
208
244
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/alarm_templates/?{query}</td>
209
245
  <td style="padding:15px">Yes</td>
210
246
  </tr>
211
247
  <tr>
212
248
  <td style="padding:15px">deleteAlarmTemplate(account, alarmTemplateId, callback)</td>
213
- <td style="padding:15px">Delete an alarm template with a given ID.</td>
249
+ <td style="padding:15px">delete_alarm_template</td>
214
250
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/alarm_templates/{pathv2}/?{query}</td>
215
251
  <td style="padding:15px">Yes</td>
216
252
  </tr>
217
253
  <tr>
218
254
  <td style="padding:15px">getAlarmTemplate(account, alarmTemplateId, callback)</td>
219
- <td style="padding:15px">Retrieve the full definition of an alarm template with a given ID.</td>
255
+ <td style="padding:15px">get_alarm_template</td>
220
256
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/alarm_templates/{pathv2}/?{query}</td>
221
257
  <td style="padding:15px">Yes</td>
222
258
  </tr>
223
259
  <tr>
224
260
  <td style="padding:15px">updateAlarmTemplate(account, alarmTemplateId, body, callback)</td>
225
- <td style="padding:15px">Modify the configuration of an alarm template with a given ID.</td>
261
+ <td style="padding:15px">update_alarm_template</td>
226
262
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/alarm_templates/{pathv2}/?{query}</td>
227
263
  <td style="padding:15px">Yes</td>
228
264
  </tr>
229
265
  <tr>
230
266
  <td style="padding:15px">listAlarms(account, limit, offset, createdTimespanStart, createdTimespanEnd, clearedTimespanStart, clearedTimespanEnd, suppressed, isSuppressed, isActive, isCleared, interfaceName, testAgent, task, callback)</td>
231
- <td style="padding:15px">Retrieve a list of all alarms with their full definitions. For each alarm, an active config is returned; this is what is used to actually trigger an alarm. It consists of parameters from an alarm template overridden by values from an alarm config.</td>
267
+ <td style="padding:15px">list_alarms</td>
232
268
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/alarms/?{query}</td>
233
269
  <td style="padding:15px">Yes</td>
234
270
  </tr>
235
271
  <tr>
236
272
  <td style="padding:15px">deleteAlarm(account, alarmId, callback)</td>
237
- <td style="padding:15px">Delete an alarm with a given ID.</td>
273
+ <td style="padding:15px">delete_alarm</td>
238
274
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/alarms/{pathv2}/?{query}</td>
239
275
  <td style="padding:15px">Yes</td>
240
276
  </tr>
241
277
  <tr>
242
278
  <td style="padding:15px">getAlarm(account, alarmId, callback)</td>
243
- <td style="padding:15px">Retrieve the full definition of an alarm with a given ID. An active config is returned for the alarm; this is what is used to actually trigger it. The config consists of parameters from an alarm template overridden by values from an alarm config.</td>
279
+ <td style="padding:15px">get_alarm</td>
244
280
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/alarms/{pathv2}/?{query}</td>
245
281
  <td style="padding:15px">Yes</td>
246
282
  </tr>
247
283
  <tr>
248
284
  <td style="padding:15px">updateAlarm(account, alarmId, body, callback)</td>
249
- <td style="padding:15px">Suppress an alarm with a given ID so that it will never trigger.</td>
285
+ <td style="padding:15px">update_alarm</td>
250
286
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/alarms/{pathv2}/?{query}</td>
251
287
  <td style="padding:15px">Yes</td>
252
288
  </tr>
253
289
  <tr>
254
290
  <td style="padding:15px">listExternalUrlShares(account, limit, offset, callback)</td>
255
- <td style="padding:15px">Retrieve a list of all external URL shares.</td>
291
+ <td style="padding:15px">list_external_url_shares</td>
256
292
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/external_url_shares/?{query}</td>
257
293
  <td style="padding:15px">Yes</td>
258
294
  </tr>
259
295
  <tr>
260
296
  <td style="padding:15px">createExternalUrlShare(account, body, callback)</td>
261
- <td style="padding:15px">Create a new external URL share.</td>
297
+ <td style="padding:15px">create_external_url_share</td>
262
298
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/external_url_shares/?{query}</td>
263
299
  <td style="padding:15px">Yes</td>
264
300
  </tr>
265
301
  <tr>
266
302
  <td style="padding:15px">deleteExternalUrlShare(account, shareId, callback)</td>
267
- <td style="padding:15px">Delete a external URL share with a given ID.</td>
303
+ <td style="padding:15px">delete_external_url_share</td>
268
304
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/external_url_shares/{pathv2}/?{query}</td>
269
305
  <td style="padding:15px">Yes</td>
270
306
  </tr>
271
307
  <tr>
272
308
  <td style="padding:15px">getExternalUrlShare(account, shareId, callback)</td>
273
- <td style="padding:15px">Retrieve a external URL share with a given ID.</td>
309
+ <td style="padding:15px">get_external_url_share</td>
274
310
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/external_url_shares/{pathv2}/?{query}</td>
275
311
  <td style="padding:15px">Yes</td>
276
312
  </tr>
277
313
  <tr>
278
314
  <td style="padding:15px">updateExternalUrlShare(account, shareId, body, callback)</td>
279
- <td style="padding:15px">Modify the configuration of a external URL share with a given ID. Note that changing password requires you to delete the existing and create a new URL share with the new password.</td>
315
+ <td style="padding:15px">update_external_url_share</td>
280
316
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/external_url_shares/{pathv2}/?{query}</td>
281
317
  <td style="padding:15px">Yes</td>
282
318
  </tr>
283
319
  <tr>
284
320
  <td style="padding:15px">listIpLookupTable(account, limit, offset, tag, tagName, callback)</td>
285
- <td style="padding:15px">Retrieve a list of all IP Lookup Table.</td>
321
+ <td style="padding:15px">list_ip_lookup_table</td>
286
322
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ip_lookup_table/?{query}</td>
287
323
  <td style="padding:15px">Yes</td>
288
324
  </tr>
289
325
  <tr>
290
326
  <td style="padding:15px">createIpLookupTable(account, body, callback)</td>
291
- <td style="padding:15px">Create a new IP Lookup Table.</td>
327
+ <td style="padding:15px">create_ip_lookup_table</td>
292
328
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ip_lookup_table/?{query}</td>
293
329
  <td style="padding:15px">Yes</td>
294
330
  </tr>
295
331
  <tr>
296
332
  <td style="padding:15px">deleteIpLookupTable(account, ipLookupTableId, callback)</td>
297
- <td style="padding:15px">Delete a IP Lookup Table with a given ID.</td>
333
+ <td style="padding:15px">delete_ip_lookup_table</td>
298
334
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ip_lookup_table/{pathv2}/?{query}</td>
299
335
  <td style="padding:15px">Yes</td>
300
336
  </tr>
301
337
  <tr>
302
338
  <td style="padding:15px">getIpLookupTable(account, ipLookupTableId, callback)</td>
303
- <td style="padding:15px">Retrieve the configuration of a IP Lookup Table with a given ID.</td>
339
+ <td style="padding:15px">get_ip_lookup_table</td>
304
340
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ip_lookup_table/{pathv2}/?{query}</td>
305
341
  <td style="padding:15px">Yes</td>
306
342
  </tr>
307
343
  <tr>
308
344
  <td style="padding:15px">updateIpLookupTable(account, ipLookupTableId, body, callback)</td>
309
- <td style="padding:15px">Modify the configuration of a IP Lookup Table with a given ID.</td>
345
+ <td style="padding:15px">update_ip_lookup_table</td>
310
346
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ip_lookup_table/{pathv2}/?{query}</td>
311
347
  <td style="padding:15px">Yes</td>
312
348
  </tr>
313
349
  <tr>
314
350
  <td style="padding:15px">listIptvChannels(account, limit, offset, tag, tagName, callback)</td>
315
- <td style="padding:15px">Retrieve a list of all IPTV channels.</td>
351
+ <td style="padding:15px">list_iptv_channels</td>
316
352
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/iptv_channels/?{query}</td>
317
353
  <td style="padding:15px">Yes</td>
318
354
  </tr>
319
355
  <tr>
320
356
  <td style="padding:15px">createIptvChannel(account, body, callback)</td>
321
- <td style="padding:15px">Create a new IPTV channel.</td>
357
+ <td style="padding:15px">create_iptv_channel</td>
322
358
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/iptv_channels/?{query}</td>
323
359
  <td style="padding:15px">Yes</td>
324
360
  </tr>
325
361
  <tr>
326
362
  <td style="padding:15px">deleteIptvChannel(account, iptvId, callback)</td>
327
- <td style="padding:15px">Delete an IPTV channel with a given ID.</td>
363
+ <td style="padding:15px">delete_iptv_channel</td>
328
364
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/iptv_channels/{pathv2}/?{query}</td>
329
365
  <td style="padding:15px">Yes</td>
330
366
  </tr>
331
367
  <tr>
332
368
  <td style="padding:15px">getIptvChannel(account, iptvId, callback)</td>
333
- <td style="padding:15px">Retrieve the configuration of an IPTV channel with a given ID.</td>
369
+ <td style="padding:15px">get_iptv_channel</td>
334
370
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/iptv_channels/{pathv2}/?{query}</td>
335
371
  <td style="padding:15px">Yes</td>
336
372
  </tr>
337
373
  <tr>
338
374
  <td style="padding:15px">updateIptvChannel(account, iptvId, body, callback)</td>
339
- <td style="padding:15px">Modify the configuration of an IPTV channel with a given ID.</td>
375
+ <td style="padding:15px">update_iptv_channel</td>
340
376
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/iptv_channels/{pathv2}/?{query}</td>
341
377
  <td style="padding:15px">Yes</td>
342
378
  </tr>
343
379
  <tr>
344
380
  <td style="padding:15px">listMonitorTemplates(account, limit, offset, tag, tagName, callback)</td>
345
- <td style="padding:15px">Retrieve a list of all monitor templates.</td>
381
+ <td style="padding:15px">list_monitor_templates</td>
346
382
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/monitor_templates/?{query}</td>
347
383
  <td style="padding:15px">Yes</td>
348
384
  </tr>
349
385
  <tr>
350
386
  <td style="padding:15px">exportMonitorTemplates(account, ids, callback)</td>
351
- <td style="padding:15px">Export all monitor templates.</td>
387
+ <td style="padding:15px">export_monitor_templates</td>
352
388
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/monitor_templates/export/?{query}</td>
353
389
  <td style="padding:15px">Yes</td>
354
390
  </tr>
355
391
  <tr>
356
392
  <td style="padding:15px">importMonitorTemplates(account, forceOverwrite, body, callback)</td>
357
- <td style="padding:15px">Import previously exported monitor templates.</td>
393
+ <td style="padding:15px">import_monitor_templates</td>
358
394
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/monitor_templates/import/?{query}</td>
359
395
  <td style="padding:15px">Yes</td>
360
396
  </tr>
361
397
  <tr>
362
398
  <td style="padding:15px">getMonitorTemplate(account, templateId, callback)</td>
363
- <td style="padding:15px">Retrieve the full definition of a monitor template with a given ID.</td>
399
+ <td style="padding:15px">get_monitor_template</td>
364
400
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/monitor_templates/{pathv2}?{query}</td>
365
401
  <td style="padding:15px">Yes</td>
366
402
  </tr>
367
403
  <tr>
368
404
  <td style="padding:15px">updateMonitorTemplate(account, templateId, body, callback)</td>
369
- <td style="padding:15px">Updates the tag list of a monitor template with a given ID.</td>
405
+ <td style="padding:15px">update_monitor_template</td>
370
406
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/monitor_templates/{pathv2}?{query}</td>
371
407
  <td style="padding:15px">Yes</td>
372
408
  </tr>
373
409
  <tr>
374
410
  <td style="padding:15px">listMonitors(account, limit, offset, start, end, basedOnTemplate, tag, tagName, callback)</td>
375
- <td style="padding:15px">Retrieve a list of all defined monitors as well as data on SLA fulfillment during their execution. SLA fulfillment is by default indicated for the last 15 minutes. Different time period can be specified with the query string parameters `start` and `end`.</td>
411
+ <td style="padding:15px">list_monitors</td>
376
412
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/monitors/?{query}</td>
377
413
  <td style="padding:15px">Yes</td>
378
414
  </tr>
379
415
  <tr>
380
416
  <td style="padding:15px">createMonitor(account, body, callback)</td>
381
- <td style="padding:15px">Create a new monitor based on a monitor template.</td>
417
+ <td style="padding:15px">create_monitor</td>
382
418
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/monitors/?{query}</td>
383
419
  <td style="padding:15px">Yes</td>
384
420
  </tr>
385
421
  <tr>
386
422
  <td style="padding:15px">deleteMonitor(account, monitorId, callback)</td>
387
- <td style="padding:15px">Delete a monitor with a given ID.</td>
423
+ <td style="padding:15px">delete_monitor</td>
388
424
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/monitors/{pathv2}/?{query}</td>
389
425
  <td style="padding:15px">Yes</td>
390
426
  </tr>
391
427
  <tr>
392
428
  <td style="padding:15px">getMonitor(account, monitorId, start, end, resolution, withDetailedMetrics, withMetricsAvg, withOtherResults, callback)</td>
393
- <td style="padding:15px">Retrieve the full definition of a monitor with a given ID, as well as data on SLA fulfillment during its execution and comprehensive data metrics for successive time intervals (the length of these intervals is governed by the resolution parameter). SLA fulfillment is by default indicated for the last 15 minutes. Different time period can be specified with the query string parameters "start" and "end". Periodic tests are run as part of a monitor. If a task has a "task_ty...(description truncated)</td>
429
+ <td style="padding:15px">get_monitor</td>
394
430
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/monitors/{pathv2}/?{query}</td>
395
431
  <td style="padding:15px">Yes</td>
396
432
  </tr>
397
433
  <tr>
398
434
  <td style="padding:15px">patchMonitor(account, monitorId, body, callback)</td>
399
- <td style="padding:15px">You can start or stop a monitor with a given ID. This is done by setting the `started` parameter to True or False. PATCH can also be used to change the monitor name, description or tags. **Note:** PATCH cannot be used to edit other monitor parameters; PUT needs to be used instead.</td>
435
+ <td style="padding:15px">patch_monitor</td>
400
436
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/monitors/{pathv2}/?{query}</td>
401
437
  <td style="padding:15px">Yes</td>
402
438
  </tr>
403
439
  <tr>
404
440
  <td style="padding:15px">updateMonitor(account, monitorId, body, callback)</td>
405
- <td style="padding:15px">Modify a monitor with a given ID. **Only monitors based on a templates are allowed to be modified**. Monitor fields possible to update: - name - started - description - input_values - alarm_configs - tags **Note that any other field in the request body will be ignored by the server**.</td>
441
+ <td style="padding:15px">update_monitor</td>
406
442
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/monitors/{pathv2}/?{query}</td>
407
443
  <td style="padding:15px">Yes</td>
408
444
  </tr>
409
445
  <tr>
410
446
  <td style="padding:15px">getMonitorPdfreport(account, monitorId, start, end, worstNum, graphs, callback)</td>
411
- <td style="padding:15px">Generate a PDF report on a monitor with a given ID.</td>
447
+ <td style="padding:15px">get_monitor_pdfreport</td>
412
448
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/monitors/{pathv2}/pdf_report?{query}</td>
413
449
  <td style="padding:15px">Yes</td>
414
450
  </tr>
415
451
  <tr>
416
452
  <td style="padding:15px">listNetworkDevices(account, limit, offset, tag, tagName, callback)</td>
417
- <td style="padding:15px">Retrieve a list of all network devices.</td>
453
+ <td style="padding:15px">list_network_devices</td>
418
454
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/network_devices/?{query}</td>
419
455
  <td style="padding:15px">Yes</td>
420
456
  </tr>
421
457
  <tr>
422
458
  <td style="padding:15px">createNetworkDevice(account, body, callback)</td>
423
- <td style="padding:15px">Create a new network device.</td>
459
+ <td style="padding:15px">create_network_device</td>
424
460
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/network_devices/?{query}</td>
425
461
  <td style="padding:15px">Yes</td>
426
462
  </tr>
427
463
  <tr>
428
464
  <td style="padding:15px">deleteNetworkDevice(account, networkDeviceId, callback)</td>
429
- <td style="padding:15px">Delete a network device with a given ID.</td>
465
+ <td style="padding:15px">delete_network_device</td>
430
466
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/network_devices/{pathv2}/?{query}</td>
431
467
  <td style="padding:15px">Yes</td>
432
468
  </tr>
433
469
  <tr>
434
470
  <td style="padding:15px">getNetworkDevice(account, networkDeviceId, callback)</td>
435
- <td style="padding:15px">Retrieve the configuration of a network device with a given ID.</td>
471
+ <td style="padding:15px">get_network_device</td>
436
472
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/network_devices/{pathv2}/?{query}</td>
437
473
  <td style="padding:15px">Yes</td>
438
474
  </tr>
439
475
  <tr>
440
476
  <td style="padding:15px">updateNetworkDevicePatch(account, networkDeviceId, body, callback)</td>
441
- <td style="padding:15px">Modify tag list of a network device with a given ID.</td>
477
+ <td style="padding:15px">update_network_device_patch</td>
442
478
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/network_devices/{pathv2}/?{query}</td>
443
479
  <td style="padding:15px">Yes</td>
444
480
  </tr>
445
481
  <tr>
446
482
  <td style="padding:15px">updateNetworkDevice(account, networkDeviceId, body, callback)</td>
447
- <td style="padding:15px">Modify the configuration of a network device with a given ID.</td>
483
+ <td style="padding:15px">update_network_device</td>
448
484
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/network_devices/{pathv2}/?{query}</td>
449
485
  <td style="padding:15px">Yes</td>
450
486
  </tr>
451
487
  <tr>
452
488
  <td style="padding:15px">listPingHosts(account, limit, offset, tag, tagName, callback)</td>
453
- <td style="padding:15px">Retrieve a list of all Ping hosts.</td>
489
+ <td style="padding:15px">list_ping_hosts</td>
454
490
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ping_hosts/?{query}</td>
455
491
  <td style="padding:15px">Yes</td>
456
492
  </tr>
457
493
  <tr>
458
494
  <td style="padding:15px">createPingHost(account, body, callback)</td>
459
- <td style="padding:15px">Create a new Ping host.</td>
495
+ <td style="padding:15px">create_ping_host</td>
460
496
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ping_hosts/?{query}</td>
461
497
  <td style="padding:15px">Yes</td>
462
498
  </tr>
463
499
  <tr>
464
500
  <td style="padding:15px">deletePingHost(account, pinghostId, callback)</td>
465
- <td style="padding:15px">Delete a Ping host with a given ID.</td>
501
+ <td style="padding:15px">delete_ping_host</td>
466
502
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ping_hosts/{pathv2}/?{query}</td>
467
503
  <td style="padding:15px">Yes</td>
468
504
  </tr>
469
505
  <tr>
470
506
  <td style="padding:15px">getPingHost(account, pinghostId, callback)</td>
471
- <td style="padding:15px">Retrieve a Ping host with a given ID.</td>
507
+ <td style="padding:15px">get_ping_host</td>
472
508
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ping_hosts/{pathv2}/?{query}</td>
473
509
  <td style="padding:15px">Yes</td>
474
510
  </tr>
475
511
  <tr>
476
512
  <td style="padding:15px">updatePingHostPatch(account, pinghostId, body, callback)</td>
477
- <td style="padding:15px">Modify the tag list of a Ping host with a given ID.</td>
513
+ <td style="padding:15px">update_ping_host_patch</td>
478
514
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ping_hosts/{pathv2}/?{query}</td>
479
515
  <td style="padding:15px">Yes</td>
480
516
  </tr>
481
517
  <tr>
482
518
  <td style="padding:15px">updatePingHost(account, pinghostId, body, callback)</td>
483
- <td style="padding:15px">Modify the configuration of a Ping host with a given ID.</td>
519
+ <td style="padding:15px">update_ping_host</td>
484
520
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ping_hosts/{pathv2}/?{query}</td>
485
521
  <td style="padding:15px">Yes</td>
486
522
  </tr>
487
523
  <tr>
488
524
  <td style="padding:15px">listSipAccounts(account, limit, offset, callback)</td>
489
- <td style="padding:15px">Retrieve a list of all SIP accounts.</td>
525
+ <td style="padding:15px">list_sip_accounts</td>
490
526
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/sip_accounts/?{query}</td>
491
527
  <td style="padding:15px">Yes</td>
492
528
  </tr>
493
529
  <tr>
494
530
  <td style="padding:15px">createSipAccount(account, body, callback)</td>
495
- <td style="padding:15px">Create a new SIP account.</td>
531
+ <td style="padding:15px">create_sip_account</td>
496
532
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/sip_accounts/?{query}</td>
497
533
  <td style="padding:15px">Yes</td>
498
534
  </tr>
499
535
  <tr>
500
536
  <td style="padding:15px">deleteSipAccount(account, sipId, callback)</td>
501
- <td style="padding:15px">Delete a SIP account with a given ID.</td>
537
+ <td style="padding:15px">delete_sip_account</td>
502
538
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/sip_accounts/{pathv2}/?{query}</td>
503
539
  <td style="padding:15px">Yes</td>
504
540
  </tr>
505
541
  <tr>
506
542
  <td style="padding:15px">getSipAccount(account, sipId, callback)</td>
507
- <td style="padding:15px">Retrieve the configuration of a SIP account with a given ID.</td>
543
+ <td style="padding:15px">get_sip_account</td>
508
544
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/sip_accounts/{pathv2}/?{query}</td>
509
545
  <td style="padding:15px">Yes</td>
510
546
  </tr>
511
547
  <tr>
512
548
  <td style="padding:15px">updateSipAccount(account, sipId, body, callback)</td>
513
- <td style="padding:15px">Modify the configuration of a SIP account with a given ID.</td>
549
+ <td style="padding:15px">update_sip_account</td>
514
550
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/sip_accounts/{pathv2}/?{query}</td>
515
551
  <td style="padding:15px">Yes</td>
516
552
  </tr>
517
553
  <tr>
518
554
  <td style="padding:15px">listSnmpManagers(account, limit, offset, callback)</td>
519
- <td style="padding:15px">Retrieve a list of all SNMP managers.</td>
555
+ <td style="padding:15px">list_snmp_managers</td>
520
556
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/snmp_managers/?{query}</td>
521
557
  <td style="padding:15px">Yes</td>
522
558
  </tr>
523
559
  <tr>
524
560
  <td style="padding:15px">createSnmpManager(account, body, callback)</td>
525
- <td style="padding:15px">Create a new SNMP manager.</td>
561
+ <td style="padding:15px">create_snmp_manager</td>
526
562
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/snmp_managers/?{query}</td>
527
563
  <td style="padding:15px">Yes</td>
528
564
  </tr>
529
565
  <tr>
530
566
  <td style="padding:15px">deleteSnmpManager(account, snmpManagerId, callback)</td>
531
- <td style="padding:15px">Delete an SNMP manager with a given ID.</td>
567
+ <td style="padding:15px">delete_snmp_manager</td>
532
568
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/snmp_managers/{pathv2}/?{query}</td>
533
569
  <td style="padding:15px">Yes</td>
534
570
  </tr>
535
571
  <tr>
536
572
  <td style="padding:15px">getSnmpManager(account, snmpManagerId, callback)</td>
537
- <td style="padding:15px">Retrieve an SNMP manager with a given ID.</td>
573
+ <td style="padding:15px">get_snmp_manager</td>
538
574
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/snmp_managers/{pathv2}/?{query}</td>
539
575
  <td style="padding:15px">Yes</td>
540
576
  </tr>
541
577
  <tr>
542
578
  <td style="padding:15px">updateSnmpManager(account, snmpManagerId, body, callback)</td>
543
- <td style="padding:15px">Modify the configuration of an SNMP manager with a given ID.</td>
579
+ <td style="padding:15px">update_snmp_manager</td>
544
580
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/snmp_managers/{pathv2}/?{query}</td>
545
581
  <td style="padding:15px">Yes</td>
546
582
  </tr>
547
583
  <tr>
548
584
  <td style="padding:15px">getSpeedtestResults(account, start, end, limit, offset, callback)</td>
549
- <td style="padding:15px">Retrieve a list of all Speedtest results.</td>
585
+ <td style="padding:15px">get_speedtest_results</td>
550
586
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/speedtest/results/?{query}</td>
551
587
  <td style="padding:15px">Yes</td>
552
588
  </tr>
553
589
  <tr>
554
590
  <td style="padding:15px">getSpeedtest(account, speedtestId, callback)</td>
555
- <td style="padding:15px">Returns a Speedtest result for a given instance ID.</td>
591
+ <td style="padding:15px">get_speedtest</td>
556
592
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/speedtest/results/{pathv2}?{query}</td>
557
593
  <td style="padding:15px">Yes</td>
558
594
  </tr>
559
595
  <tr>
560
596
  <td style="padding:15px">listPublicSpeedtestcategories(account, limit, offset, callback)</td>
561
- <td style="padding:15px">List all Speedtest categories.</td>
597
+ <td style="padding:15px">list_public_speedtestcategories</td>
562
598
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/speedtest_public/categories/?{query}</td>
563
599
  <td style="padding:15px">Yes</td>
564
600
  </tr>
565
601
  <tr>
566
602
  <td style="padding:15px">listPublicSpeedtestinterfaces(account, limit, offset, callback)</td>
567
- <td style="padding:15px">List all Speedtest-enabled Test Agent interfaces.</td>
603
+ <td style="padding:15px">list_public_speedtestinterfaces</td>
568
604
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/speedtest_public/interfaces/?{query}</td>
569
605
  <td style="padding:15px">Yes</td>
570
606
  </tr>
571
607
  <tr>
572
608
  <td style="padding:15px">uploadPublicSpeedtestResult(account, body, callback)</td>
573
- <td style="padding:15px">This resources uploads a **Speedtest result** that was collected when a speedtest ran on the **Speedtest Page**. Please note that this resource in no way can be used to initiate the **Speedtest**. The actual **Speedtest** is run over a **Websocket** in a session connecting from the **Web browser** of the end user to the **Test Agent** that was chosen.</td>
609
+ <td style="padding:15px">upload_public_speedtest_result</td>
574
610
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/speedtest_public/results/?{query}</td>
575
611
  <td style="padding:15px">Yes</td>
576
612
  </tr>
577
613
  <tr>
578
614
  <td style="padding:15px">getPublicSpeedtests(account, speedtestToken, callback)</td>
579
- <td style="padding:15px">Retrieve all Speedtest results.</td>
615
+ <td style="padding:15px">get_public_speedtests</td>
580
616
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/speedtest_public/results/{pathv2}/?{query}</td>
581
617
  <td style="padding:15px">Yes</td>
582
618
  </tr>
583
619
  <tr>
584
620
  <td style="padding:15px">listSshKeys(account, testAgentId, limit, offset, callback)</td>
585
- <td style="padding:15px">Retrieve a list of all SSH keys for give test agent and account.</td>
621
+ <td style="padding:15px">list_ssh_keys</td>
586
622
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ssh_keys/?{query}</td>
587
623
  <td style="padding:15px">Yes</td>
588
624
  </tr>
589
625
  <tr>
590
626
  <td style="padding:15px">createSshKey(account, testAgentId, body, callback)</td>
591
- <td style="padding:15px">Add a new SSH key for given Test Agent.</td>
627
+ <td style="padding:15px">create_ssh_key</td>
592
628
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ssh_keys/?{query}</td>
593
629
  <td style="padding:15px">Yes</td>
594
630
  </tr>
595
631
  <tr>
596
632
  <td style="padding:15px">deleteSshKey(account, sshKeyId, testAgentId, callback)</td>
597
- <td style="padding:15px">Delete a SSH key with a given ID.</td>
633
+ <td style="padding:15px">delete_ssh_key</td>
598
634
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ssh_keys/{pathv2}/?{query}</td>
599
635
  <td style="padding:15px">Yes</td>
600
636
  </tr>
601
637
  <tr>
602
638
  <td style="padding:15px">getSshKey(account, sshKeyId, testAgentId, callback)</td>
603
- <td style="padding:15px">Retrieve a SSH key for give Test Agent and id.</td>
639
+ <td style="padding:15px">get_ssh_key</td>
604
640
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ssh_keys/{pathv2}/?{query}</td>
605
641
  <td style="padding:15px">Yes</td>
606
642
  </tr>
607
643
  <tr>
608
644
  <td style="padding:15px">updateSshKey(account, sshKeyId, testAgentId, body, callback)</td>
609
- <td style="padding:15px">Modify the configuration of a SSH Key with a given ID and Test Agent ID.</td>
645
+ <td style="padding:15px">update_ssh_key</td>
610
646
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/ssh_keys/{pathv2}/?{query}</td>
611
647
  <td style="padding:15px">Yes</td>
612
648
  </tr>
613
649
  <tr>
614
650
  <td style="padding:15px">getAccountStatistics(account, callback)</td>
615
- <td style="padding:15px">Return statistics for the NCC account.</td>
651
+ <td style="padding:15px">get_account_statistics</td>
616
652
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/statistics/?{query}</td>
617
653
  <td style="padding:15px">Yes</td>
618
654
  </tr>
619
655
  <tr>
620
656
  <td style="padding:15px">getInstanceStatistics(callback)</td>
621
- <td style="padding:15px">Return statistics for the NCC instance.</td>
657
+ <td style="padding:15px">get_instance_statistics</td>
622
658
  <td style="padding:15px">{base_path}/{version}/statistics/?{query}</td>
623
659
  <td style="padding:15px">Yes</td>
624
660
  </tr>
625
661
  <tr>
626
662
  <td style="padding:15px">listTags(account, limit, offset, callback)</td>
627
- <td style="padding:15px">Retrieve a list of all tags.</td>
663
+ <td style="padding:15px">list_tags</td>
628
664
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/tags/?{query}</td>
629
665
  <td style="padding:15px">Yes</td>
630
666
  </tr>
631
667
  <tr>
632
668
  <td style="padding:15px">createTag(account, body, callback)</td>
633
- <td style="padding:15px">Create a new tag.</td>
669
+ <td style="padding:15px">create_tag</td>
634
670
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/tags/?{query}</td>
635
671
  <td style="padding:15px">Yes</td>
636
672
  </tr>
637
673
  <tr>
638
674
  <td style="padding:15px">deleteTag(account, tagId, callback)</td>
639
- <td style="padding:15px">Delete a tag with a given ID.</td>
675
+ <td style="padding:15px">delete_tag</td>
640
676
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/tags/{pathv2}/?{query}</td>
641
677
  <td style="padding:15px">Yes</td>
642
678
  </tr>
643
679
  <tr>
644
680
  <td style="padding:15px">getTag(account, tagId, callback)</td>
645
- <td style="padding:15px">Retrieve the tag.</td>
681
+ <td style="padding:15px">get_tag</td>
646
682
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/tags/{pathv2}/?{query}</td>
647
683
  <td style="padding:15px">Yes</td>
648
684
  </tr>
649
685
  <tr>
650
686
  <td style="padding:15px">updateTag(account, tagId, body, callback)</td>
651
- <td style="padding:15px">Modify a tag with a given ID.</td>
687
+ <td style="padding:15px">update_tag</td>
652
688
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/tags/{pathv2}/?{query}</td>
653
689
  <td style="padding:15px">Yes</td>
654
690
  </tr>
655
691
  <tr>
656
692
  <td style="padding:15px">listTestAgents(account, limit, offset, tag, tagName, callback)</td>
657
- <td style="padding:15px">Retrieve a list of all Test Agents.</td>
693
+ <td style="padding:15px">list_test_agents</td>
658
694
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_agents/?{query}</td>
659
695
  <td style="padding:15px">Yes</td>
660
696
  </tr>
661
697
  <tr>
662
698
  <td style="padding:15px">createTestAgent(account, body, callback)</td>
663
- <td style="padding:15px">Create a new virtual Test Agent.</td>
699
+ <td style="padding:15px">create_test_agent</td>
664
700
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_agents/?{query}</td>
665
701
  <td style="padding:15px">Yes</td>
666
702
  </tr>
667
703
  <tr>
668
704
  <td style="padding:15px">rebootTestAgent(account, all, body, callback)</td>
669
- <td style="padding:15px">Trigger a reboot on target Test Agents. The target Test Agents can be provided by either specifying their IDs in a list or using the "?all" query parameter.</td>
705
+ <td style="padding:15px">reboot_test_agent</td>
670
706
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_agents/reboot/?{query}</td>
671
707
  <td style="padding:15px">Yes</td>
672
708
  </tr>
673
709
  <tr>
674
710
  <td style="padding:15px">upgradeTestAgentSoftware(account, all, body, callback)</td>
675
- <td style="padding:15px">Reboot and update Test Agents. This action can be run in two ways: for all Test Agents, by appending the "?all" query string in the URL; or for specified Test Agents, listed by ID in the body as described in the schema.</td>
711
+ <td style="padding:15px">upgrade_test_agent_software</td>
676
712
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_agents/update/?{query}</td>
677
713
  <td style="padding:15px">Yes</td>
678
714
  </tr>
679
715
  <tr>
680
716
  <td style="padding:15px">deleteTestAgent(account, testAgentId, callback)</td>
681
- <td style="padding:15px">Delete a Test Agent with a given ID.</td>
717
+ <td style="padding:15px">delete_test_agent</td>
682
718
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_agents/{pathv2}/?{query}</td>
683
719
  <td style="padding:15px">Yes</td>
684
720
  </tr>
685
721
  <tr>
686
722
  <td style="padding:15px">getTestAgent(account, testAgentId, refreshSystemInformation, callback)</td>
687
- <td style="padding:15px">Retrieve the configuration of a Test Agent with a given ID.</td>
723
+ <td style="padding:15px">get_test_agent</td>
688
724
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_agents/{pathv2}/?{query}</td>
689
725
  <td style="padding:15px">Yes</td>
690
726
  </tr>
691
727
  <tr>
692
728
  <td style="padding:15px">patchTestAgent(account, testAgentId, body, callback)</td>
693
- <td style="padding:15px">You can modify ONLY these fields using PATCH: `name`, `description`, `gps_lat`, `gps_long`, `interface_config_metadata`, `tags` **Note:** PATCH cannot be used to edit other Test Agent properties; PUT needs to be used instead.</td>
729
+ <td style="padding:15px">patch_test_agent</td>
694
730
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_agents/{pathv2}/?{query}</td>
695
731
  <td style="padding:15px">Yes</td>
696
732
  </tr>
697
733
  <tr>
698
734
  <td style="padding:15px">updateTestAgent(account, testAgentId, body, callback)</td>
699
- <td style="padding:15px">Modify the configuration of a Test Agent with a given ID. With the PUT method, you need to supply the configuration in its entirety.</td>
735
+ <td style="padding:15px">update_test_agent</td>
700
736
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_agents/{pathv2}/?{query}</td>
701
737
  <td style="padding:15px">Yes</td>
702
738
  </tr>
703
739
  <tr>
704
740
  <td style="padding:15px">testAgentMoveCancel(account, testAgentId, callback)</td>
705
- <td style="padding:15px">Cancel move of Test Agent instance to other Control Center.</td>
741
+ <td style="padding:15px">test_agent_move_cancel</td>
706
742
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_agents/{pathv2}/move/?{query}</td>
707
743
  <td style="padding:15px">Yes</td>
708
744
  </tr>
709
745
  <tr>
710
746
  <td style="padding:15px">testAgentMoveSchedule(account, testAgentId, body, callback)</td>
711
- <td style="padding:15px">Move Test Agent instance to other Control Center.</td>
747
+ <td style="padding:15px">test_agent_move_schedule</td>
712
748
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_agents/{pathv2}/move/?{query}</td>
713
749
  <td style="padding:15px">Yes</td>
714
750
  </tr>
715
751
  <tr>
716
752
  <td style="padding:15px">scanWifiNetworksStop(account, testAgentNumericId, testAgentInterfaceName, callback)</td>
717
- <td style="padding:15px">Stop the Wi-Fi scan on a named interface of a Test Agent with a given ID.</td>
753
+ <td style="padding:15px">scan_wifi_networks_stop</td>
718
754
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_agents/{pathv2}/wifiscan/{pathv3}/?{query}</td>
719
755
  <td style="padding:15px">Yes</td>
720
756
  </tr>
721
757
  <tr>
722
758
  <td style="padding:15px">scanWifiNetworksResults(account, testAgentNumericId, testAgentInterfaceName, callback)</td>
723
- <td style="padding:15px">Get results from a Wi-Fi scan on a named interface of a Test Agent with a given ID.</td>
759
+ <td style="padding:15px">scan_wifi_networks_results</td>
724
760
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_agents/{pathv2}/wifiscan/{pathv3}/?{query}</td>
725
761
  <td style="padding:15px">Yes</td>
726
762
  </tr>
727
763
  <tr>
728
764
  <td style="padding:15px">scanWifiNetworksStart(account, testAgentNumericId, testAgentInterfaceName, callback)</td>
729
- <td style="padding:15px">Start a Wi-Fi scan on a named interface of a Test Agent with a given ID.</td>
765
+ <td style="padding:15px">scan_wifi_networks_start</td>
730
766
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_agents/{pathv2}/wifiscan/{pathv3}/?{query}</td>
731
767
  <td style="padding:15px">Yes</td>
732
768
  </tr>
733
769
  <tr>
734
770
  <td style="padding:15px">listTestTemplates(account, limit, offset, tag, tagName, callback)</td>
735
- <td style="padding:15px">Retrieve a list of all test templates.</td>
771
+ <td style="padding:15px">list_test_templates</td>
736
772
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_templates/?{query}</td>
737
773
  <td style="padding:15px">Yes</td>
738
774
  </tr>
739
775
  <tr>
740
776
  <td style="padding:15px">exportTestTemplates(account, ids, callback)</td>
741
- <td style="padding:15px">Export all test templates.</td>
777
+ <td style="padding:15px">export_test_templates</td>
742
778
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_templates/export/?{query}</td>
743
779
  <td style="padding:15px">Yes</td>
744
780
  </tr>
745
781
  <tr>
746
782
  <td style="padding:15px">importTestTemplates(account, forceOverwrite, body, callback)</td>
747
- <td style="padding:15px">Import previously exported test templates.</td>
783
+ <td style="padding:15px">import_test_templates</td>
748
784
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_templates/import/?{query}</td>
749
785
  <td style="padding:15px">Yes</td>
750
786
  </tr>
751
787
  <tr>
752
788
  <td style="padding:15px">getTestTemplate(account, templateId, callback)</td>
753
- <td style="padding:15px">Retrieve the full definition of a test template with a given ID.</td>
789
+ <td style="padding:15px">get_test_template</td>
754
790
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_templates/{pathv2}/?{query}</td>
755
791
  <td style="padding:15px">Yes</td>
756
792
  </tr>
757
793
  <tr>
758
794
  <td style="padding:15px">updateTestTemplate(account, templateId, callback)</td>
759
- <td style="padding:15px">Update the tag list of a test template instance.</td>
795
+ <td style="padding:15px">update_test_template</td>
760
796
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/test_templates/{pathv2}/?{query}</td>
761
797
  <td style="padding:15px">Yes</td>
762
798
  </tr>
763
799
  <tr>
764
800
  <td style="padding:15px">listTests(account, limit, offset, tag, tagName, callback)</td>
765
- <td style="padding:15px">Retrieve a list of all defined tests.</td>
801
+ <td style="padding:15px">list_tests</td>
766
802
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/tests/?{query}</td>
767
803
  <td style="padding:15px">Yes</td>
768
804
  </tr>
769
805
  <tr>
770
806
  <td style="padding:15px">createTest(account, body, callback)</td>
771
- <td style="padding:15px">Create a test based on a test template, and run the test.</td>
807
+ <td style="padding:15px">create_test</td>
772
808
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/tests/?{query}</td>
773
809
  <td style="padding:15px">Yes</td>
774
810
  </tr>
775
811
  <tr>
776
812
  <td style="padding:15px">deleteTest(account, testId, callback)</td>
777
- <td style="padding:15px">Delete a test with a given ID.</td>
813
+ <td style="padding:15px">delete_test</td>
778
814
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/tests/{pathv2}/?{query}</td>
779
815
  <td style="padding:15px">Yes</td>
780
816
  </tr>
781
817
  <tr>
782
818
  <td style="padding:15px">getTest(account, testId, withDetailedMetrics, withMetricsAvg, withOtherResults, callback)</td>
783
- <td style="padding:15px">Retrieve results for a test with a given ID.</td>
819
+ <td style="padding:15px">get_test</td>
784
820
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/tests/{pathv2}/?{query}</td>
785
821
  <td style="padding:15px">Yes</td>
786
822
  </tr>
787
823
  <tr>
788
824
  <td style="padding:15px">updateTest(account, testId, body, callback)</td>
789
- <td style="padding:15px">Update the tag list for a test with a given ID.</td>
825
+ <td style="padding:15px">update_test</td>
790
826
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/tests/{pathv2}/?{query}</td>
791
827
  <td style="padding:15px">Yes</td>
792
828
  </tr>
793
829
  <tr>
794
830
  <td style="padding:15px">getTestPdfreport(account, testId, start, end, worstNum, graphs, callback)</td>
795
- <td style="padding:15px">Generate a PDF report on a test with a given ID.</td>
831
+ <td style="padding:15px">get_test_pdfreport</td>
796
832
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/tests/{pathv2}/pdf_report?{query}</td>
797
833
  <td style="padding:15px">Yes</td>
798
834
  </tr>
799
835
  <tr>
800
836
  <td style="padding:15px">listTwampReflectors(account, limit, offset, tag, tagName, callback)</td>
801
- <td style="padding:15px">Retrieve a list of all TWAMP reflectors.</td>
837
+ <td style="padding:15px">list_twamp_reflectors</td>
802
838
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/twamp_reflectors/?{query}</td>
803
839
  <td style="padding:15px">Yes</td>
804
840
  </tr>
805
841
  <tr>
806
842
  <td style="padding:15px">createTwampReflector(account, body, callback)</td>
807
- <td style="padding:15px">Create a new TWAMP reflector.</td>
843
+ <td style="padding:15px">create_twamp_reflector</td>
808
844
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/twamp_reflectors/?{query}</td>
809
845
  <td style="padding:15px">Yes</td>
810
846
  </tr>
811
847
  <tr>
812
848
  <td style="padding:15px">deleteTwampReflector(account, twampId, callback)</td>
813
- <td style="padding:15px">Delete a TWAMP reflector with a given ID.</td>
849
+ <td style="padding:15px">delete_twamp_reflector</td>
814
850
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/twamp_reflectors/{pathv2}/?{query}</td>
815
851
  <td style="padding:15px">Yes</td>
816
852
  </tr>
817
853
  <tr>
818
854
  <td style="padding:15px">getTwampReflector(account, twampId, callback)</td>
819
- <td style="padding:15px">Retrieve the configuration of a TWAMP reflector with a given ID.</td>
855
+ <td style="padding:15px">get_twamp_reflector</td>
820
856
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/twamp_reflectors/{pathv2}/?{query}</td>
821
857
  <td style="padding:15px">Yes</td>
822
858
  </tr>
823
859
  <tr>
824
860
  <td style="padding:15px">updateTwampReflectorPatch(account, twampId, body, callback)</td>
825
- <td style="padding:15px">Modify the tag list of a TWAMP reflector with a given ID.</td>
861
+ <td style="padding:15px">update_twamp_reflector_patch</td>
826
862
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/twamp_reflectors/{pathv2}/?{query}</td>
827
863
  <td style="padding:15px">Yes</td>
828
864
  </tr>
829
865
  <tr>
830
866
  <td style="padding:15px">updateTwampReflector(account, twampId, body, callback)</td>
831
- <td style="padding:15px">Modify the configuration of a TWAMP reflector with a given ID.</td>
867
+ <td style="padding:15px">update_twamp_reflector</td>
832
868
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/twamp_reflectors/{pathv2}/?{query}</td>
833
869
  <td style="padding:15px">Yes</td>
834
870
  </tr>
835
871
  <tr>
836
872
  <td style="padding:15px">listY1731Meps(account, limit, offset, tag, tagName, callback)</td>
837
- <td style="padding:15px">Retrieve a list of all Y.1731 MEPs.</td>
873
+ <td style="padding:15px">list_y1731_meps</td>
838
874
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/y1731_meps/?{query}</td>
839
875
  <td style="padding:15px">Yes</td>
840
876
  </tr>
841
877
  <tr>
842
878
  <td style="padding:15px">createY1731Mep(account, body, callback)</td>
843
- <td style="padding:15px">Create a new Y.1731 MEP.</td>
879
+ <td style="padding:15px">create_y1731_mep</td>
844
880
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/y1731_meps/?{query}</td>
845
881
  <td style="padding:15px">Yes</td>
846
882
  </tr>
847
883
  <tr>
848
884
  <td style="padding:15px">deleteY1731Mep(account, mepId, callback)</td>
849
- <td style="padding:15px">Delete a Y.1731 MEP with a given ID.</td>
885
+ <td style="padding:15px">delete_y1731_mep</td>
850
886
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/y1731_meps/{pathv2}/?{query}</td>
851
887
  <td style="padding:15px">Yes</td>
852
888
  </tr>
853
889
  <tr>
854
890
  <td style="padding:15px">getY1731Mep(account, mepId, callback)</td>
855
- <td style="padding:15px">Retrieve the configuration of a Y.1731 MEP with a given ID.</td>
891
+ <td style="padding:15px">get_y1731_mep</td>
856
892
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/y1731_meps/{pathv2}/?{query}</td>
857
893
  <td style="padding:15px">Yes</td>
858
894
  </tr>
859
895
  <tr>
860
896
  <td style="padding:15px">updateY1731Mep(account, mepId, body, callback)</td>
861
- <td style="padding:15px">Modify the configuration of a Y.1731 MEP with a given ID.</td>
897
+ <td style="padding:15px">update_y1731_mep</td>
862
898
  <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/y1731_meps/{pathv2}/?{query}</td>
863
899
  <td style="padding:15px">Yes</td>
864
900
  </tr>