@itentialopensource/adapter-apic 0.12.2 → 0.14.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 (28) hide show
  1. package/CALLS.md +138 -0
  2. package/PROPERTIES.md +16 -1
  3. package/adapter.js +2078 -0
  4. package/adapterBase.js +38 -0
  5. package/entities/ApplicationProfileOperations/action.json +25 -0
  6. package/entities/ApplicationProfileOperations/schema.json +19 -0
  7. package/entities/BridgeDomainOperations/action.json +65 -0
  8. package/entities/BridgeDomainOperations/schema.json +21 -0
  9. package/entities/EPGOperations/action.json +86 -0
  10. package/entities/EPGOperations/schema.json +33 -0
  11. package/entities/TenantOperations/action.json +87 -0
  12. package/entities/TenantOperations/schema.json +22 -0
  13. package/entities/VLANPoolOperations/action.json +147 -0
  14. package/entities/VLANPoolOperations/schema.json +25 -0
  15. package/entities/VMMDomainOperations/action.json +46 -0
  16. package/entities/VMMDomainOperations/schema.json +31 -0
  17. package/entities/VRFOperations/action.json +45 -0
  18. package/entities/VRFOperations/schema.json +20 -0
  19. package/package.json +4 -4
  20. package/pronghorn.json +1104 -2
  21. package/propertiesSchema.json +41 -3
  22. package/report/adapterInfo.json +7 -7
  23. package/report/cisco-aci-apic-openapi.json +801 -0
  24. package/report/updateReport1764798882161.json +120 -0
  25. package/sampleProperties.json +4 -1
  26. package/test/integration/adapterTestIntegration.js +585 -0
  27. package/test/unit/adapterBaseTestUnit.js +1 -1
  28. package/test/unit/adapterTestUnit.js +826 -0
package/CALLS.md CHANGED
@@ -238,5 +238,143 @@ Specific adapter calls are built based on the API of the Apic. The Adapter Build
238
238
  <td style="padding:15px">{base_path}/{version}/mo/uni/{pathv1}?{query}</td>
239
239
  <td style="padding:15px">Yes</td>
240
240
  </tr>
241
+ <tr>
242
+ <td style="padding:15px">getAllTenants(iapMetadata, callback)</td>
243
+ <td style="padding:15px">Get All Tenants</td>
244
+ <td style="padding:15px">{base_path}/{version}/class/fvTenant.json?{query}</td>
245
+ <td style="padding:15px">Yes</td>
246
+ </tr>
247
+ <tr>
248
+ <td style="padding:15px">getTenant(tenantName, iapMetadata, callback)</td>
249
+ <td style="padding:15px">Get Specific Tenant</td>
250
+ <td style="padding:15px">{base_path}/{version}/mo/uni/tn-{pathv1}.json?{query}</td>
251
+ <td style="padding:15px">Yes</td>
252
+ </tr>
253
+ <tr>
254
+ <td style="padding:15px">getTenantWithFullSubtree(tenantName, iapMetadata, callback)</td>
255
+ <td style="padding:15px">Get Tenant with Full Subtree</td>
256
+ <td style="padding:15px">{base_path}/{version}/mo/uni/tn-{pathv1}.json?{query}</td>
257
+ <td style="padding:15px">Yes</td>
258
+ </tr>
259
+ <tr>
260
+ <td style="padding:15px">createTenantOrEnvironment(body, iapMetadata, callback)</td>
261
+ <td style="padding:15px">Create Tenant or Complete Environment</td>
262
+ <td style="padding:15px">{base_path}/{version}/mo/uni.json?{query}</td>
263
+ <td style="padding:15px">Yes</td>
264
+ </tr>
265
+ <tr>
266
+ <td style="padding:15px">createTenantResource(tenantName, body, iapMetadata, callback)</td>
267
+ <td style="padding:15px">Create Resources in Tenant</td>
268
+ <td style="padding:15px">{base_path}/{version}/mo/uni/tn-{pathv1}.json?{query}</td>
269
+ <td style="padding:15px">Yes</td>
270
+ </tr>
271
+ <tr>
272
+ <td style="padding:15px">getAllVRFs(iapMetadata, callback)</td>
273
+ <td style="padding:15px">Get All VRFs</td>
274
+ <td style="padding:15px">{base_path}/{version}/class/fvCtx.json?{query}</td>
275
+ <td style="padding:15px">Yes</td>
276
+ </tr>
277
+ <tr>
278
+ <td style="padding:15px">getAllBridgeDomains(iapMetadata, callback)</td>
279
+ <td style="padding:15px">Get All Bridge Domains</td>
280
+ <td style="padding:15px">{base_path}/{version}/class/fvBD.json?{query}</td>
281
+ <td style="padding:15px">Yes</td>
282
+ </tr>
283
+ <tr>
284
+ <td style="padding:15px">createDHCPRelayPolicy(tenantName, dhcpRelayPolicyName, body, iapMetadata, callback)</td>
285
+ <td style="padding:15px">Configure DHCP Relay Policy</td>
286
+ <td style="padding:15px">{base_path}/{version}/mo/uni/tn-{pathv1}/relayp-{pathv2}.json?{query}</td>
287
+ <td style="padding:15px">Yes</td>
288
+ </tr>
289
+ <tr>
290
+ <td style="padding:15px">associateDHCPRelayToBD(tenantName, bdName, body, iapMetadata, callback)</td>
291
+ <td style="padding:15px">Associate DHCP Relay Policy to BD</td>
292
+ <td style="padding:15px">{base_path}/{version}/mo/uni/tn-{pathv1}/BD-{pathv2}.json?{query}</td>
293
+ <td style="padding:15px">Yes</td>
294
+ </tr>
295
+ <tr>
296
+ <td style="padding:15px">getAllApplicationProfiles(iapMetadata, callback)</td>
297
+ <td style="padding:15px">Get All Application Profiles</td>
298
+ <td style="padding:15px">{base_path}/{version}/class/fvAp.json?{query}</td>
299
+ <td style="padding:15px">Yes</td>
300
+ </tr>
301
+ <tr>
302
+ <td style="padding:15px">getAllEPGs(iapMetadata, callback)</td>
303
+ <td style="padding:15px">Get All EPGs</td>
304
+ <td style="padding:15px">{base_path}/{version}/class/fvAEPg.json?{query}</td>
305
+ <td style="padding:15px">Yes</td>
306
+ </tr>
307
+ <tr>
308
+ <td style="padding:15px">getEPGsInTenant(queryTargetFilter, iapMetadata, callback)</td>
309
+ <td style="padding:15px">Get EPGs in Tenant</td>
310
+ <td style="padding:15px">{base_path}/{version}/node/class/fvAEPg.json?{query}</td>
311
+ <td style="padding:15px">Yes</td>
312
+ </tr>
313
+ <tr>
314
+ <td style="padding:15px">createEPGWithVMM(tenantName, appProfileName, body, iapMetadata, callback)</td>
315
+ <td style="padding:15px">Create EPG with BD and VMM Association</td>
316
+ <td style="padding:15px">{base_path}/{version}/mo/uni/tn-{pathv1}/ap-{pathv2}.json?{query}</td>
317
+ <td style="padding:15px">Yes</td>
318
+ </tr>
319
+ <tr>
320
+ <td style="padding:15px">associateEPGWithVMM(tenantName, appProfileName, epgName, body, iapMetadata, callback)</td>
321
+ <td style="padding:15px">Associate EPG with VMM Domain</td>
322
+ <td style="padding:15px">{base_path}/{version}/mo/uni/tn-{pathv1}/ap-{pathv2}/epg-{pathv3}.json?{query}</td>
323
+ <td style="padding:15px">Yes</td>
324
+ </tr>
325
+ <tr>
326
+ <td style="padding:15px">getAllVMMDomains(iapMetadata, callback)</td>
327
+ <td style="padding:15px">Get All VMM Domains</td>
328
+ <td style="padding:15px">{base_path}/{version}/class/vmmDomP.json?{query}</td>
329
+ <td style="padding:15px">Yes</td>
330
+ </tr>
331
+ <tr>
332
+ <td style="padding:15px">getVMwareVMMDomains(queryTargetFilter, iapMetadata, callback)</td>
333
+ <td style="padding:15px">Get VMware VMM Domains</td>
334
+ <td style="padding:15px">{base_path}/{version}/node/class/vmmDomP.json?{query}</td>
335
+ <td style="padding:15px">Yes</td>
336
+ </tr>
337
+ <tr>
338
+ <td style="padding:15px">getAllVLANPools(iapMetadata, callback)</td>
339
+ <td style="padding:15px">Get All VLAN Pools</td>
340
+ <td style="padding:15px">{base_path}/{version}/class/fvnsVlanInstP.json?{query}</td>
341
+ <td style="padding:15px">Yes</td>
342
+ </tr>
343
+ <tr>
344
+ <td style="padding:15px">createDynamicVLANPool(vlanPoolName, body, iapMetadata, callback)</td>
345
+ <td style="padding:15px">Create Dynamic VLAN Pool</td>
346
+ <td style="padding:15px">{base_path}/{version}/mo/uni/infra/vlanns-[{pathv1}]-dynamic.json?{query}</td>
347
+ <td style="padding:15px">Yes</td>
348
+ </tr>
349
+ <tr>
350
+ <td style="padding:15px">getVLANPoolDetails(vlanPoolName, iapMetadata, callback)</td>
351
+ <td style="padding:15px">Get VLAN Pool Details</td>
352
+ <td style="padding:15px">{base_path}/{version}/mo/uni/infra/vlanns-[{pathv1}]-dynamic.json?{query}</td>
353
+ <td style="padding:15px">Yes</td>
354
+ </tr>
355
+ <tr>
356
+ <td style="padding:15px">createStaticVLANPool(vlanPoolName, body, iapMetadata, callback)</td>
357
+ <td style="padding:15px">Create Static VLAN Pool</td>
358
+ <td style="padding:15px">{base_path}/{version}/mo/uni/infra/vlanns-[{pathv1}]-static.json?{query}</td>
359
+ <td style="padding:15px">Yes</td>
360
+ </tr>
361
+ <tr>
362
+ <td style="padding:15px">associateVLANPoolWithVMM(vmmDomainName, body, iapMetadata, callback)</td>
363
+ <td style="padding:15px">Associate VLAN Pool with VMM Domain</td>
364
+ <td style="padding:15px">{base_path}/{version}/mo/uni/vmmp-VMware/dom-{pathv1}.json?{query}</td>
365
+ <td style="padding:15px">Yes</td>
366
+ </tr>
367
+ <tr>
368
+ <td style="padding:15px">getVMMDomainVLANPoolAssociation(vmmDomainName, iapMetadata, callback)</td>
369
+ <td style="padding:15px">Get VMM Domain VLAN Pool Association</td>
370
+ <td style="padding:15px">{base_path}/{version}/mo/uni/vmmp-VMware/dom-{pathv1}.json?{query}</td>
371
+ <td style="padding:15px">Yes</td>
372
+ </tr>
373
+ <tr>
374
+ <td style="padding:15px">addVLANRangeToPool(vlanPoolName, vlanStart, vlanEnd, body, iapMetadata, callback)</td>
375
+ <td style="padding:15px">Add VLAN Range to Existing Pool</td>
376
+ <td style="padding:15px">{base_path}/{version}/mo/uni/infra/vlanns-[{pathv1}]-dynamic/from-[vlan-{pathv2}]-to-[vlan-{pathv3}].json?{query}</td>
377
+ <td style="padding:15px">Yes</td>
378
+ </tr>
241
379
  </table>
242
380
  <br>
package/PROPERTIES.md CHANGED
@@ -29,7 +29,10 @@ This section defines **all** the properties that are available for the adapter,
29
29
  "auth_logging": false,
30
30
  "client_id": "",
31
31
  "client_secret": "",
32
- "grant_type": ""
32
+ "grant_type": "",
33
+ "auth_request_datatype": "",
34
+ "auth_response_datatype": "",
35
+ "token_response_placement": ""
33
36
  },
34
37
  "healthcheck": {
35
38
  "type": "startup",
@@ -283,6 +286,18 @@ The following properties are used to define the authentication process to Apic.
283
286
  <td style="padding:15px">grant_type</td>
284
287
  <td style="padding:15px">Provide a grant type when needed, this is common on some types of OAuth.</td>
285
288
  </tr>
289
+ <tr>
290
+ <td style="padding:15px">auth_request_datatype</td>
291
+ <td style="padding:15px">Override the request data type for token authentication requests. When set, this overrides the schema's requestDatatype (JSON, JSON2XML, PLAIN, XML, URLENCODE, URLQUERY, FORM).</td>
292
+ </tr>
293
+ <tr>
294
+ <td style="padding:15px">auth_response_datatype</td>
295
+ <td style="padding:15px">Override the response data type for token authentication requests. When set, this overrides the schema's responseDatatype (JSON, XML2JSON, PLAIN, XML, URLENCODE).</td>
296
+ </tr>
297
+ <tr>
298
+ <td style="padding:15px">token_response_placement</td>
299
+ <td style="padding:15px">Override where to extract the token from the authentication response (HEADER or BODY). When set, this overrides the schema's token placement setting.</td>
300
+ </tr>
286
301
  </table>
287
302
  <br>
288
303