@itentialopensource/adapter-phpipam 2.1.0 → 2.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 (42) hide show
  1. package/CALLS.md +588 -0
  2. package/CHANGELOG.md +8 -0
  3. package/CONTRIBUTING.md +1 -160
  4. package/ENHANCE.md +2 -2
  5. package/README.md +32 -23
  6. package/adapter.js +157 -329
  7. package/adapterBase.js +549 -879
  8. package/changelogs/changelog.md +102 -0
  9. package/metadata.json +49 -0
  10. package/package.json +24 -25
  11. package/pronghorn.json +981 -642
  12. package/propertiesSchema.json +431 -31
  13. package/refs?service=git-upload-pack +0 -0
  14. package/report/adapter-openapi.json +4152 -0
  15. package/report/adapter-openapi.yaml +3011 -0
  16. package/report/adapterInfo.json +8 -8
  17. package/report/updateReport1691508486949.json +120 -0
  18. package/report/updateReport1692202972871.json +120 -0
  19. package/report/updateReport1694466392520.json +120 -0
  20. package/report/updateReport1698421952447.json +120 -0
  21. package/sampleProperties.json +63 -2
  22. package/test/integration/adapterTestBasicGet.js +2 -4
  23. package/test/integration/adapterTestConnectivity.js +91 -42
  24. package/test/integration/adapterTestIntegration.js +130 -2
  25. package/test/unit/adapterBaseTestUnit.js +388 -313
  26. package/test/unit/adapterTestUnit.js +338 -112
  27. package/utils/adapterInfo.js +1 -1
  28. package/utils/addAuth.js +1 -1
  29. package/utils/artifactize.js +1 -1
  30. package/utils/checkMigrate.js +1 -1
  31. package/utils/entitiesToDB.js +2 -2
  32. package/utils/findPath.js +1 -1
  33. package/utils/methodDocumentor.js +273 -0
  34. package/utils/modify.js +13 -15
  35. package/utils/packModificationScript.js +1 -1
  36. package/utils/pre-commit.sh +2 -0
  37. package/utils/taskMover.js +309 -0
  38. package/utils/tbScript.js +89 -34
  39. package/utils/tbUtils.js +41 -21
  40. package/utils/testRunner.js +1 -1
  41. package/utils/troubleshootingAdapter.js +9 -6
  42. package/workflows/README.md +0 -3
package/CALLS.md CHANGED
@@ -165,5 +165,593 @@ Specific adapter calls are built based on the API of the {php}IPAM. The Adapter
165
165
  <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
166
166
  <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
167
167
  </tr>
168
+ <tr>
169
+ <td style="padding:15px">getSections(globals, callback)</td>
170
+ <td style="padding:15px">Returns all sections</td>
171
+ <td style="padding:15px">{base_path}/{version}/sections/?{query}</td>
172
+ <td style="padding:15px">Yes</td>
173
+ </tr>
174
+ <tr>
175
+ <td style="padding:15px">createSection(body, callback)</td>
176
+ <td style="padding:15px">Creates new section</td>
177
+ <td style="padding:15px">{base_path}/{version}/sections/?{query}</td>
178
+ <td style="padding:15px">Yes</td>
179
+ </tr>
180
+ <tr>
181
+ <td style="padding:15px">updateSection(body, callback)</td>
182
+ <td style="padding:15px">Updates section</td>
183
+ <td style="padding:15px">{base_path}/{version}/sections/?{query}</td>
184
+ <td style="padding:15px">Yes</td>
185
+ </tr>
186
+ <tr>
187
+ <td style="padding:15px">getSection(id, globals, callback)</td>
188
+ <td style="padding:15px">Returns specific section</td>
189
+ <td style="padding:15px">{base_path}/{version}/sections/{pathv1}/?{query}</td>
190
+ <td style="padding:15px">Yes</td>
191
+ </tr>
192
+ <tr>
193
+ <td style="padding:15px">deleteSection(id, callback)</td>
194
+ <td style="padding:15px">Deletes section with all belonging subnets and addresses</td>
195
+ <td style="padding:15px">{base_path}/{version}/sections/{pathv1}/?{query}</td>
196
+ <td style="padding:15px">Yes</td>
197
+ </tr>
198
+ <tr>
199
+ <td style="padding:15px">getSectionSubnets(id, globals, callback)</td>
200
+ <td style="padding:15px">Returns all subnets in section</td>
201
+ <td style="padding:15px">{base_path}/{version}/sections/{pathv1}/subnets/?{query}</td>
202
+ <td style="padding:15px">Yes</td>
203
+ </tr>
204
+ <tr>
205
+ <td style="padding:15px">getSectionByName(name, globals, callback)</td>
206
+ <td style="padding:15px">Returns specific section by name</td>
207
+ <td style="padding:15px">{base_path}/{version}/sections/{pathv1}/?{query}</td>
208
+ <td style="padding:15px">Yes</td>
209
+ </tr>
210
+ <tr>
211
+ <td style="padding:15px">getSectionsCustomFields(globals, callback)</td>
212
+ <td style="padding:15px">Returns custom section fields</td>
213
+ <td style="padding:15px">{base_path}/{version}/sections/custom_fields/?{query}</td>
214
+ <td style="padding:15px">Yes</td>
215
+ </tr>
216
+ <tr>
217
+ <td style="padding:15px">getSubnet(id, globals, callback)</td>
218
+ <td style="padding:15px">Returns specific subnet by id</td>
219
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/?{query}</td>
220
+ <td style="padding:15px">Yes</td>
221
+ </tr>
222
+ <tr>
223
+ <td style="padding:15px">deleteSubnet(id, callback)</td>
224
+ <td style="padding:15px">Deletes Subnet</td>
225
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/?{query}</td>
226
+ <td style="padding:15px">Yes</td>
227
+ </tr>
228
+ <tr>
229
+ <td style="padding:15px">getSubnetUsage(id, globals, callback)</td>
230
+ <td style="padding:15px">Returns subnet usage</td>
231
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/usage/?{query}</td>
232
+ <td style="padding:15px">Yes</td>
233
+ </tr>
234
+ <tr>
235
+ <td style="padding:15px">getSubnetFirstFree(id, globals, callback)</td>
236
+ <td style="padding:15px">Returns first available IP address in subnet</td>
237
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/first_free/?{query}</td>
238
+ <td style="padding:15px">Yes</td>
239
+ </tr>
240
+ <tr>
241
+ <td style="padding:15px">getSubnetSlaves(id, globals, callback)</td>
242
+ <td style="padding:15px">Returns all immediate slave subnets</td>
243
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/slaves/?{query}</td>
244
+ <td style="padding:15px">Yes</td>
245
+ </tr>
246
+ <tr>
247
+ <td style="padding:15px">getSubnetSlavesRecursive(id, globals, callback)</td>
248
+ <td style="padding:15px">Returns all slave subnets recursive</td>
249
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/slaves_recursive/?{query}</td>
250
+ <td style="padding:15px">Yes</td>
251
+ </tr>
252
+ <tr>
253
+ <td style="padding:15px">getSubnetAddresses(id, globals, callback)</td>
254
+ <td style="padding:15px">Returns all addresses in subnet</td>
255
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/addresses/?{query}</td>
256
+ <td style="padding:15px">Yes</td>
257
+ </tr>
258
+ <tr>
259
+ <td style="padding:15px">getSubnetIPAddress(id, ip, globals, callback)</td>
260
+ <td style="padding:15px">Returns IP address from subnet</td>
261
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/addresses/{pathv2}/?{query}</td>
262
+ <td style="padding:15px">Yes</td>
263
+ </tr>
264
+ <tr>
265
+ <td style="padding:15px">getSubnetFirstAvailable(id, mask, globals, callback)</td>
266
+ <td style="padding:15px">Returns first available subnet within selected for mask</td>
267
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/first_subnet/{pathv2}/?{query}</td>
268
+ <td style="padding:15px">Yes</td>
269
+ </tr>
270
+ <tr>
271
+ <td style="padding:15px">createSubnetInsideSubnet(id, mask, body, callback)</td>
272
+ <td style="padding:15px">Creates new child subnet inside subnet with specified mask</td>
273
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/first_subnet/{pathv2}/?{query}</td>
274
+ <td style="padding:15px">Yes</td>
275
+ </tr>
276
+ <tr>
277
+ <td style="padding:15px">getSubnetAllAvailable(id, mask, globals, callback)</td>
278
+ <td style="padding:15px">Returns all available subnets within selected for mask</td>
279
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/all_subnets/{pathv2}/?{query}</td>
280
+ <td style="padding:15px">Yes</td>
281
+ </tr>
282
+ <tr>
283
+ <td style="padding:15px">getSubnetCustomFields(globals, callback)</td>
284
+ <td style="padding:15px">Returns all subnet custom fields</td>
285
+ <td style="padding:15px">{base_path}/{version}/subnets/custom_fields/?{query}</td>
286
+ <td style="padding:15px">Yes</td>
287
+ </tr>
288
+ <tr>
289
+ <td style="padding:15px">getSubnetCIDR(subnet, globals, callback)</td>
290
+ <td style="padding:15px">Searches for subnet in CIDR format</td>
291
+ <td style="padding:15px">{base_path}/{version}/subnets/cidr/{pathv1}/?{query}</td>
292
+ <td style="padding:15px">Yes</td>
293
+ </tr>
294
+ <tr>
295
+ <td style="padding:15px">getSubnetCIDRSearch(subnet, globals, callback)</td>
296
+ <td style="padding:15px">Searches for subnet in CIDR format</td>
297
+ <td style="padding:15px">{base_path}/{version}/subnets/search/{pathv1}/?{query}</td>
298
+ <td style="padding:15px">Yes</td>
299
+ </tr>
300
+ <tr>
301
+ <td style="padding:15px">createSubnet(body, callback)</td>
302
+ <td style="padding:15px">Creates new subnet</td>
303
+ <td style="padding:15px">{base_path}/{version}/subnets/?{query}</td>
304
+ <td style="padding:15px">Yes</td>
305
+ </tr>
306
+ <tr>
307
+ <td style="padding:15px">updateSubnet(body, callback)</td>
308
+ <td style="padding:15px">Updates Subnet</td>
309
+ <td style="padding:15px">{base_path}/{version}/subnets/?{query}</td>
310
+ <td style="padding:15px">Yes</td>
311
+ </tr>
312
+ <tr>
313
+ <td style="padding:15px">updateSubnetMaskSize(id, body, callback)</td>
314
+ <td style="padding:15px">Resizes subnet to new mask</td>
315
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/resize/?{query}</td>
316
+ <td style="padding:15px">Yes</td>
317
+ </tr>
318
+ <tr>
319
+ <td style="padding:15px">updateSubnetSplit(id, body, callback)</td>
320
+ <td style="padding:15px">Splits subnet to smaller subnets</td>
321
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/split/?{query}</td>
322
+ <td style="padding:15px">Yes</td>
323
+ </tr>
324
+ <tr>
325
+ <td style="padding:15px">udpateSubnetPermissions(id, body, callback)</td>
326
+ <td style="padding:15px">Sets subnet permissions</td>
327
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/permissions/?{query}</td>
328
+ <td style="padding:15px">Yes</td>
329
+ </tr>
330
+ <tr>
331
+ <td style="padding:15px">deleteSubnetPermissions(id, callback)</td>
332
+ <td style="padding:15px">Removes all permissions</td>
333
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/permissions/?{query}</td>
334
+ <td style="padding:15px">Yes</td>
335
+ </tr>
336
+ <tr>
337
+ <td style="padding:15px">deleteSubnetAddresses(id, callback)</td>
338
+ <td style="padding:15px">Removes all addresses from subnet</td>
339
+ <td style="padding:15px">{base_path}/{version}/subnets/{pathv1}/truncate/?{query}</td>
340
+ <td style="padding:15px">Yes</td>
341
+ </tr>
342
+ <tr>
343
+ <td style="padding:15px">getAddress(id, globals, callback)</td>
344
+ <td style="padding:15px">Returns specific address</td>
345
+ <td style="padding:15px">{base_path}/{version}/addresses/{pathv1}/?{query}</td>
346
+ <td style="padding:15px">Yes</td>
347
+ </tr>
348
+ <tr>
349
+ <td style="padding:15px">updateAddress(id, body, callback)</td>
350
+ <td style="padding:15px">Updates address</td>
351
+ <td style="padding:15px">{base_path}/{version}/addresses/{pathv1}/?{query}</td>
352
+ <td style="padding:15px">Yes</td>
353
+ </tr>
354
+ <tr>
355
+ <td style="padding:15px">deleteAddress(id, callback)</td>
356
+ <td style="padding:15px">Deletes address</td>
357
+ <td style="padding:15px">{base_path}/{version}/addresses/{pathv1}/?{query}</td>
358
+ <td style="padding:15px">Yes</td>
359
+ </tr>
360
+ <tr>
361
+ <td style="padding:15px">getAddressStatus(id, globals, callback)</td>
362
+ <td style="padding:15px">Checks address status</td>
363
+ <td style="padding:15px">{base_path}/{version}/addresses/{pathv1}/ping/?{query}</td>
364
+ <td style="padding:15px">Yes</td>
365
+ </tr>
366
+ <tr>
367
+ <td style="padding:15px">getAddressFromSubnet(ip, subnetId, globals, callback)</td>
368
+ <td style="padding:15px">Returns address from subnet by ip address</td>
369
+ <td style="padding:15px">{base_path}/{version}/addresses/{pathv1}/{pathv2}/?{query}</td>
370
+ <td style="padding:15px">Yes</td>
371
+ </tr>
372
+ <tr>
373
+ <td style="padding:15px">deleteAddressInSubnet(ip, subnetId, callback)</td>
374
+ <td style="padding:15px">Deletes address by IP in specific subnet</td>
375
+ <td style="padding:15px">{base_path}/{version}/addresses/{pathv1}/{pathv2}/?{query}</td>
376
+ <td style="padding:15px">Yes</td>
377
+ </tr>
378
+ <tr>
379
+ <td style="padding:15px">getAddressByIP(ip, globals, callback)</td>
380
+ <td style="padding:15px">searches for addresses in database, returns multiple if found</td>
381
+ <td style="padding:15px">{base_path}/{version}/addresses/search/{pathv1}/?{query}</td>
382
+ <td style="padding:15px">Yes</td>
383
+ </tr>
384
+ <tr>
385
+ <td style="padding:15px">getAddressByHostname(hostname, globals, callback)</td>
386
+ <td style="padding:15px">searches for addresses in database by hostname, returns multiple if found</td>
387
+ <td style="padding:15px">{base_path}/{version}/addresses/search_hostname/{pathv1}/?{query}</td>
388
+ <td style="padding:15px">Yes</td>
389
+ </tr>
390
+ <tr>
391
+ <td style="padding:15px">getAddressFirstFree(subnetId, globals, callback)</td>
392
+ <td style="padding:15px">Returns first available address</td>
393
+ <td style="padding:15px">{base_path}/{version}/addresses/first_free/{pathv1}/?{query}</td>
394
+ <td style="padding:15px">Yes</td>
395
+ </tr>
396
+ <tr>
397
+ <td style="padding:15px">createAddressFirstAvailable(subnetId, body, callback)</td>
398
+ <td style="padding:15px">Creates new address in subnets – first available</td>
399
+ <td style="padding:15px">{base_path}/{version}/addresses/first_free/{pathv1}/?{query}</td>
400
+ <td style="padding:15px">Yes</td>
401
+ </tr>
402
+ <tr>
403
+ <td style="padding:15px">getAddressCustomFields(globals, callback)</td>
404
+ <td style="padding:15px">Returns custom fields</td>
405
+ <td style="padding:15px">{base_path}/{version}/addresses/custom_fields/?{query}</td>
406
+ <td style="padding:15px">Yes</td>
407
+ </tr>
408
+ <tr>
409
+ <td style="padding:15px">getAddressTags(globals, callback)</td>
410
+ <td style="padding:15px">Returns all tags</td>
411
+ <td style="padding:15px">{base_path}/{version}/addresses/tags/?{query}</td>
412
+ <td style="padding:15px">Yes</td>
413
+ </tr>
414
+ <tr>
415
+ <td style="padding:15px">getSpecificTag(id, globals, callback)</td>
416
+ <td style="padding:15px">Returns specific tag</td>
417
+ <td style="padding:15px">{base_path}/{version}/addresses/tags/{pathv1}/?{query}</td>
418
+ <td style="padding:15px">Yes</td>
419
+ </tr>
420
+ <tr>
421
+ <td style="padding:15px">getAddressesByTag(id, globals, callback)</td>
422
+ <td style="padding:15px">Returns addresses for specific tag</td>
423
+ <td style="padding:15px">{base_path}/{version}/addresses/tags/{pathv1}/addresses/?{query}</td>
424
+ <td style="padding:15px">Yes</td>
425
+ </tr>
426
+ <tr>
427
+ <td style="padding:15px">createAddress(body, callback)</td>
428
+ <td style="padding:15px">Creates new address</td>
429
+ <td style="padding:15px">{base_path}/{version}/addresses/?{query}</td>
430
+ <td style="padding:15px">Yes</td>
431
+ </tr>
432
+ <tr>
433
+ <td style="padding:15px">getVlans(globals, callback)</td>
434
+ <td style="padding:15px">Returns all Vlans</td>
435
+ <td style="padding:15px">{base_path}/{version}/vlan/?{query}</td>
436
+ <td style="padding:15px">Yes</td>
437
+ </tr>
438
+ <tr>
439
+ <td style="padding:15px">createVlan(body, callback)</td>
440
+ <td style="padding:15px">Creates new VLAN</td>
441
+ <td style="padding:15px">{base_path}/{version}/vlan/?{query}</td>
442
+ <td style="padding:15px">Yes</td>
443
+ </tr>
444
+ <tr>
445
+ <td style="padding:15px">updateVlan(body, callback)</td>
446
+ <td style="padding:15px">Updates VLAN</td>
447
+ <td style="padding:15px">{base_path}/{version}/vlan/?{query}</td>
448
+ <td style="padding:15px">Yes</td>
449
+ </tr>
450
+ <tr>
451
+ <td style="padding:15px">getVlan(id, globals, callback)</td>
452
+ <td style="padding:15px">Returns specific vlan</td>
453
+ <td style="padding:15px">{base_path}/{version}/vlan/{pathv1}/?{query}</td>
454
+ <td style="padding:15px">Yes</td>
455
+ </tr>
456
+ <tr>
457
+ <td style="padding:15px">deleteVlan(id, body, callback)</td>
458
+ <td style="padding:15px">Deletes VLAN</td>
459
+ <td style="padding:15px">{base_path}/{version}/vlan/{pathv1}/?{query}</td>
460
+ <td style="padding:15px">Yes</td>
461
+ </tr>
462
+ <tr>
463
+ <td style="padding:15px">getVlanSubnets(id, globals, callback)</td>
464
+ <td style="padding:15px">Returns all subnets attached to vlan</td>
465
+ <td style="padding:15px">{base_path}/{version}/vlan/{pathv1}/subnets/?{query}</td>
466
+ <td style="padding:15px">Yes</td>
467
+ </tr>
468
+ <tr>
469
+ <td style="padding:15px">getVlanSubnetsBySection(id, sectionId, globals, callback)</td>
470
+ <td style="padding:15px">Returns all subnets attached to vlan in specific section</td>
471
+ <td style="padding:15px">{base_path}/{version}/vlan/{pathv1}/subnets/{pathv2}/?{query}</td>
472
+ <td style="padding:15px">Yes</td>
473
+ </tr>
474
+ <tr>
475
+ <td style="padding:15px">getVlanCustomFields(id, globals, callback)</td>
476
+ <td style="padding:15px">Returns custom VLAN fields</td>
477
+ <td style="padding:15px">{base_path}/{version}/vlan/{pathv1}/custom_fields/?{query}</td>
478
+ <td style="padding:15px">Yes</td>
479
+ </tr>
480
+ <tr>
481
+ <td style="padding:15px">getVlanByNumber(id, number, globals, callback)</td>
482
+ <td style="padding:15px">Searches for VLAN</td>
483
+ <td style="padding:15px">{base_path}/{version}/vlan/{pathv1}/search/{pathv2}/?{query}</td>
484
+ <td style="padding:15px">Yes</td>
485
+ </tr>
486
+ <tr>
487
+ <td style="padding:15px">getL2Domains(globals, callback)</td>
488
+ <td style="padding:15px">Returns all L2 domains</td>
489
+ <td style="padding:15px">{base_path}/{version}/l2domains/?{query}</td>
490
+ <td style="padding:15px">Yes</td>
491
+ </tr>
492
+ <tr>
493
+ <td style="padding:15px">createL2Domain(body, callback)</td>
494
+ <td style="padding:15px">Creates new L2 domain</td>
495
+ <td style="padding:15px">{base_path}/{version}/l2domains/?{query}</td>
496
+ <td style="padding:15px">Yes</td>
497
+ </tr>
498
+ <tr>
499
+ <td style="padding:15px">updateL2Domain(body, callback)</td>
500
+ <td style="padding:15px">Updates L2 domain</td>
501
+ <td style="padding:15px">{base_path}/{version}/l2domains/?{query}</td>
502
+ <td style="padding:15px">Yes</td>
503
+ </tr>
504
+ <tr>
505
+ <td style="padding:15px">getL2Domain(id, globals, callback)</td>
506
+ <td style="padding:15px">Returns specific L2 domain</td>
507
+ <td style="padding:15px">{base_path}/{version}/l2domains/{pathv1}/?{query}</td>
508
+ <td style="padding:15px">Yes</td>
509
+ </tr>
510
+ <tr>
511
+ <td style="padding:15px">getL2DomainVlans(id, globals, callback)</td>
512
+ <td style="padding:15px">Returns all VLANs within L2 domain</td>
513
+ <td style="padding:15px">{base_path}/{version}/l2domains/{pathv1}/vlans/?{query}</td>
514
+ <td style="padding:15px">Yes</td>
515
+ </tr>
516
+ <tr>
517
+ <td style="padding:15px">getL2DomainCustomFields(globals, callback)</td>
518
+ <td style="padding:15px">Returns all custom fields</td>
519
+ <td style="padding:15px">{base_path}/{version}/l2domains/custom_fields/?{query}</td>
520
+ <td style="padding:15px">Yes</td>
521
+ </tr>
522
+ <tr>
523
+ <td style="padding:15px">deleteL2Domain(id, callback)</td>
524
+ <td style="padding:15px">Deletes L2 domain</td>
525
+ <td style="padding:15px">{base_path}/{version}/l2domains/{pathv1}/?{query}</td>
526
+ <td style="padding:15px">Yes</td>
527
+ </tr>
528
+ <tr>
529
+ <td style="padding:15px">getVRFs(globals, callback)</td>
530
+ <td style="padding:15px">Returns all VRFs</td>
531
+ <td style="padding:15px">{base_path}/{version}/vrf/?{query}</td>
532
+ <td style="padding:15px">Yes</td>
533
+ </tr>
534
+ <tr>
535
+ <td style="padding:15px">createVRF(body, callback)</td>
536
+ <td style="padding:15px">Creates new VRF</td>
537
+ <td style="padding:15px">{base_path}/{version}/vrf/?{query}</td>
538
+ <td style="padding:15px">Yes</td>
539
+ </tr>
540
+ <tr>
541
+ <td style="padding:15px">updateVRF(body, callback)</td>
542
+ <td style="padding:15px">Updates VRF</td>
543
+ <td style="padding:15px">{base_path}/{version}/vrf/?{query}</td>
544
+ <td style="padding:15px">Yes</td>
545
+ </tr>
546
+ <tr>
547
+ <td style="padding:15px">getVRF(id, globals, callback)</td>
548
+ <td style="padding:15px">Returns specific VRF</td>
549
+ <td style="padding:15px">{base_path}/{version}/vrf/{pathv1}/?{query}</td>
550
+ <td style="padding:15px">Yes</td>
551
+ </tr>
552
+ <tr>
553
+ <td style="padding:15px">deleteVRF(id, callback)</td>
554
+ <td style="padding:15px">Deletes VRF</td>
555
+ <td style="padding:15px">{base_path}/{version}/vrf/{pathv1}/?{query}</td>
556
+ <td style="padding:15px">Yes</td>
557
+ </tr>
558
+ <tr>
559
+ <td style="padding:15px">getVRFSubnets(id, globals, callback)</td>
560
+ <td style="padding:15px">Returns all subnets within VRF</td>
561
+ <td style="padding:15px">{base_path}/{version}/vrf/{pathv1}/subnets/?{query}</td>
562
+ <td style="padding:15px">Yes</td>
563
+ </tr>
564
+ <tr>
565
+ <td style="padding:15px">getVRFCustomFields(globals, callback)</td>
566
+ <td style="padding:15px">Returns all custom fields</td>
567
+ <td style="padding:15px">{base_path}/{version}/vrf/custom_fields/?{query}</td>
568
+ <td style="padding:15px">Yes</td>
569
+ </tr>
570
+ <tr>
571
+ <td style="padding:15px">getPhpDevices(globals, callback)</td>
572
+ <td style="padding:15px">Returns all devices</td>
573
+ <td style="padding:15px">{base_path}/{version}/devices/?{query}</td>
574
+ <td style="padding:15px">Yes</td>
575
+ </tr>
576
+ <tr>
577
+ <td style="padding:15px">createDevice(body, callback)</td>
578
+ <td style="padding:15px">Creates new device</td>
579
+ <td style="padding:15px">{base_path}/{version}/devices/?{query}</td>
580
+ <td style="padding:15px">Yes</td>
581
+ </tr>
582
+ <tr>
583
+ <td style="padding:15px">updateDevice(body, callback)</td>
584
+ <td style="padding:15px">Updates device</td>
585
+ <td style="padding:15px">{base_path}/{version}/devices/?{query}</td>
586
+ <td style="padding:15px">Yes</td>
587
+ </tr>
588
+ <tr>
589
+ <td style="padding:15px">getPhpDevice(id, globals, callback)</td>
590
+ <td style="padding:15px">Returns specific device</td>
591
+ <td style="padding:15px">{base_path}/{version}/devices/{pathv1}/?{query}</td>
592
+ <td style="padding:15px">Yes</td>
593
+ </tr>
594
+ <tr>
595
+ <td style="padding:15px">deleteDevice(id, callback)</td>
596
+ <td style="padding:15px">Deletes device</td>
597
+ <td style="padding:15px">{base_path}/{version}/devices/{pathv1}/?{query}</td>
598
+ <td style="padding:15px">Yes</td>
599
+ </tr>
600
+ <tr>
601
+ <td style="padding:15px">getDeviceSubnets(id, globals, callback)</td>
602
+ <td style="padding:15px">Returns all subnets within device</td>
603
+ <td style="padding:15px">{base_path}/{version}/devices/{pathv1}/subnets/?{query}</td>
604
+ <td style="padding:15px">Yes</td>
605
+ </tr>
606
+ <tr>
607
+ <td style="padding:15px">getDeviceAddresses(id, globals, callback)</td>
608
+ <td style="padding:15px">Returns all addresses within device</td>
609
+ <td style="padding:15px">{base_path}/{version}/devices/{pathv1}/addresses/?{query}</td>
610
+ <td style="padding:15px">Yes</td>
611
+ </tr>
612
+ <tr>
613
+ <td style="padding:15px">getDevicesBySearchString(searchString, globals, callback)</td>
614
+ <td style="padding:15px">Searches for devices</td>
615
+ <td style="padding:15px">{base_path}/{version}/devices/search/{pathv1}/?{query}</td>
616
+ <td style="padding:15px">Yes</td>
617
+ </tr>
618
+ <tr>
619
+ <td style="padding:15px">getToolsSubcontroller(subcontroller, globals, callback)</td>
620
+ <td style="padding:15px">Returns all subcontroller objects</td>
621
+ <td style="padding:15px">{base_path}/{version}/tools/{pathv1}/?{query}</td>
622
+ <td style="padding:15px">Yes</td>
623
+ </tr>
624
+ <tr>
625
+ <td style="padding:15px">postToolsSubcontroller(subcontroller, body, callback)</td>
626
+ <td style="padding:15px">Creates new subcontroller object</td>
627
+ <td style="padding:15px">{base_path}/{version}/tools/{pathv1}/?{query}</td>
628
+ <td style="padding:15px">Yes</td>
629
+ </tr>
630
+ <tr>
631
+ <td style="padding:15px">getToolsSubcontrollerIdentifier(subcontroller, identifier, globals, callback)</td>
632
+ <td style="padding:15px">Returns specific subcontroller object</td>
633
+ <td style="padding:15px">{base_path}/{version}/tools/{pathv1}/{pathv2}/?{query}</td>
634
+ <td style="padding:15px">Yes</td>
635
+ </tr>
636
+ <tr>
637
+ <td style="padding:15px">patchToolsSubcontrollerIdentifier(subcontroller, identifier, body, callback)</td>
638
+ <td style="padding:15px">Updates subcontroller object</td>
639
+ <td style="padding:15px">{base_path}/{version}/tools/{pathv1}/{pathv2}/?{query}</td>
640
+ <td style="padding:15px">Yes</td>
641
+ </tr>
642
+ <tr>
643
+ <td style="padding:15px">deleteToolsSubcontrollerIdentifier(subcontroller, identifier, callback)</td>
644
+ <td style="padding:15px">Deletes subcontroller object</td>
645
+ <td style="padding:15px">{base_path}/{version}/tools/{pathv1}/{pathv2}/?{query}</td>
646
+ <td style="padding:15px">Yes</td>
647
+ </tr>
648
+ <tr>
649
+ <td style="padding:15px">toolsGetDeviceTypeDetails(id, callback)</td>
650
+ <td style="padding:15px">Returns device type details</td>
651
+ <td style="padding:15px">{base_path}/{version}/tools/device_types/{pathv1}/?{query}</td>
652
+ <td style="padding:15px">Yes</td>
653
+ </tr>
654
+ <tr>
655
+ <td style="padding:15px">toolsGetDevicesByDeviceType(id, callback)</td>
656
+ <td style="padding:15px">Returns all devices with devicetype</td>
657
+ <td style="padding:15px">{base_path}/{version}/tools/device_types/{pathv1}/devices/?{query}</td>
658
+ <td style="padding:15px">Yes</td>
659
+ </tr>
660
+ <tr>
661
+ <td style="padding:15px">toolsGetSubnetsByVLAN(id, callback)</td>
662
+ <td style="padding:15px">Returns all subnets that belong to VLAN</td>
663
+ <td style="padding:15px">{base_path}/{version}/tools/vlans/{pathv1}/subnets/?{query}</td>
664
+ <td style="padding:15px">Yes</td>
665
+ </tr>
666
+ <tr>
667
+ <td style="padding:15px">toolsGetSubnetsByVRF(id, callback)</td>
668
+ <td style="padding:15px">Returns all subnets that belong to VRF</td>
669
+ <td style="padding:15px">{base_path}/{version}/tools/vrfs/{pathv1}/subnets/?{query}</td>
670
+ <td style="padding:15px">Yes</td>
671
+ </tr>
672
+ <tr>
673
+ <td style="padding:15px">toolsGetSubnetsByLocation(id, callback)</td>
674
+ <td style="padding:15px">Returns all subnets that belong to Location</td>
675
+ <td style="padding:15px">{base_path}/{version}/tools/locations/{pathv1}/subnets/?{query}</td>
676
+ <td style="padding:15px">Yes</td>
677
+ </tr>
678
+ <tr>
679
+ <td style="padding:15px">toolsGetDevicesByLocation(id, callback)</td>
680
+ <td style="padding:15px">Returns all devices that belong to Location</td>
681
+ <td style="padding:15px">{base_path}/{version}/tools/locations/{pathv1}/devices/?{query}</td>
682
+ <td style="padding:15px">Yes</td>
683
+ </tr>
684
+ <tr>
685
+ <td style="padding:15px">toolsGetRacksByLocation(id, callback)</td>
686
+ <td style="padding:15px">Returns all racks that belong to Location</td>
687
+ <td style="padding:15px">{base_path}/{version}/tools/locations/{pathv1}/racks/?{query}</td>
688
+ <td style="padding:15px">Yes</td>
689
+ </tr>
690
+ <tr>
691
+ <td style="padding:15px">toolsGetDevicesByRack(id, callback)</td>
692
+ <td style="padding:15px">Returns all devices that belong to rack</td>
693
+ <td style="padding:15px">{base_path}/{version}/tools/racks/{pathv1}/devices/?{query}</td>
694
+ <td style="padding:15px">Yes</td>
695
+ </tr>
696
+ <tr>
697
+ <td style="padding:15px">getNATDetailsAttachedObjects(id, globals, callback)</td>
698
+ <td style="padding:15px">Returns nat details and array of all attached objects</td>
699
+ <td style="padding:15px">{base_path}/{version}/tools/nat/{pathv1}/objects/?{query}</td>
700
+ <td style="padding:15px">Yes</td>
701
+ </tr>
702
+ <tr>
703
+ <td style="padding:15px">getNATDetailsAllObjects(id, globals, callback)</td>
704
+ <td style="padding:15px">Returns nat details and full array of all attached objects</td>
705
+ <td style="padding:15px">{base_path}/{version}/tools/nat/{pathv1}/objects_full/?{query}</td>
706
+ <td style="padding:15px">Yes</td>
707
+ </tr>
708
+ <tr>
709
+ <td style="padding:15px">getPrefixCustomerType(customerType, globals, callback)</td>
710
+ <td style="padding:15px">Returns all subnets used to deliver new subnets</td>
711
+ <td style="padding:15px">{base_path}/{version}/prefix/{pathv1}/?{query}</td>
712
+ <td style="padding:15px">Yes</td>
713
+ </tr>
714
+ <tr>
715
+ <td style="padding:15px">getPrefixCustomerTypeIpVersion(customerType, ipVersion, globals, callback)</td>
716
+ <td style="padding:15px">Returns all subnets used to deliver new subnets for specific IP version</td>
717
+ <td style="padding:15px">{base_path}/{version}/prefix/{pathv1}/{pathv2}/?{query}</td>
718
+ <td style="padding:15px">Yes</td>
719
+ </tr>
720
+ <tr>
721
+ <td style="padding:15px">getPrefixCustomerTypeAddress(customerType, globals, callback)</td>
722
+ <td style="padding:15px">Returns all subnets used to deliver new addresses</td>
723
+ <td style="padding:15px">{base_path}/{version}/prefix/{pathv1}/address/?{query}</td>
724
+ <td style="padding:15px">Yes</td>
725
+ </tr>
726
+ <tr>
727
+ <td style="padding:15px">getPrefixCustomerTypeAddressIpVersion(customerType, ipVersion, globals, callback)</td>
728
+ <td style="padding:15px">Returns all subnets used to deliver new addresses for specific IP version</td>
729
+ <td style="padding:15px">{base_path}/{version}/prefix/{pathv1}/address/{pathv2}/?{query}</td>
730
+ <td style="padding:15px">Yes</td>
731
+ </tr>
732
+ <tr>
733
+ <td style="padding:15px">getPrefixCustomerTypeIpVersionMask(customerType, ipVersion, mask, globals, callback)</td>
734
+ <td style="padding:15px">Returns first available subnet for ip version and requested mask</td>
735
+ <td style="padding:15px">{base_path}/{version}/prefix/{pathv1}/{pathv2}/{pathv3}/?{query}</td>
736
+ <td style="padding:15px">Yes</td>
737
+ </tr>
738
+ <tr>
739
+ <td style="padding:15px">postPrefixCustomerTypeIpVersionMask(customerType, ipVersion, mask, body, callback)</td>
740
+ <td style="padding:15px">Creates first available subnet for ip version and requested mask</td>
741
+ <td style="padding:15px">{base_path}/{version}/prefix/{pathv1}/{pathv2}/{pathv3}/?{query}</td>
742
+ <td style="padding:15px">Yes</td>
743
+ </tr>
744
+ <tr>
745
+ <td style="padding:15px">getPrefixCustomerTypeIpVersionAddress(customerType, ipVersion, globals, callback)</td>
746
+ <td style="padding:15px">Returns first available address for ip version</td>
747
+ <td style="padding:15px">{base_path}/{version}/prefix/{pathv1}/{pathv2}/address/?{query}</td>
748
+ <td style="padding:15px">Yes</td>
749
+ </tr>
750
+ <tr>
751
+ <td style="padding:15px">postPrefixCustomerTypeIpVersionAddress(customerType, ipVersion, body, callback)</td>
752
+ <td style="padding:15px">Creates first available address for ip version</td>
753
+ <td style="padding:15px">{base_path}/{version}/prefix/{pathv1}/{pathv2}/address/?{query}</td>
754
+ <td style="padding:15px">Yes</td>
755
+ </tr>
168
756
  </table>
169
757
  <br>
package/CHANGELOG.md CHANGED
@@ -1,4 +1,12 @@
1
1
 
2
+ ## 2.2.0 [12-30-2023]
3
+
4
+ * Adapter Engine has been updated and the changes are being migrated to the adapter
5
+
6
+ See merge request itentialopensource/adapters/inventory/adapter-phpipam!10
7
+
8
+ ---
9
+
2
10
  ## 2.1.0 [05-23-2022]
3
11
 
4
12
  * Migration to the latest Adapter Foundation