@itentialopensource/adapter-dna_center 0.6.0 → 0.6.1

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 0.6.1 [04-12-2023]
+
+* Cisco DNA Center Limit and Offset
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-dna_center!12
+
+---
+
 ## 0.6.0 [05-21-2022]
 
 * Migration to the latest Adapter Foundation

package/adapter.js

@@ -8123,7 +8123,51 @@ class DnaCenter extends AdapterBaseCl {
    */
   /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
   getDnaintentapiv1networkDevice(hostname, managementIpAddress, macAddress, locationName, serialNumber, location, family, type, series, collectionStatus, collectionInterval, notSyncedForMinutes, errorCode, errorDescription, softwareVersion, softwareType, platformId, role, reachabilityStatus, upTime, associatedWlcIp, licensename, licensetype, licensestatus, modulename, moduleequpimenttype, moduleservicestate, modulevendorequipmenttype, modulepartnumber, moduleoperationstatecode, id, callback) {
-    const meth = 'adapter-getDnaintentapiv1networkDevice';
+    this.getDnaintentapiv1networkDeviceWithOptions(hostname, managementIpAddress, macAddress, locationName, serialNumber, location, family, type, series, collectionStatus, collectionInterval, notSyncedForMinutes, errorCode, errorDescription, softwareVersion, softwareType, platformId, role, reachabilityStatus, upTime, associatedWlcIp, licensename, licensetype, licensestatus, modulename, moduleequpimenttype, moduleservicestate, modulevendorequipmenttype, modulepartnumber, moduleoperationstatecode, id, null, null, callback);
+  }
+
+  /**
+   * @summary Get Device list
+   *
+   * @function getDnaintentapiv1networkDeviceWithOptions
+   * @param {array} hostname - hostname
+   * @param {array} managementIpAddress - managementIpAddress
+   * @param {array} macAddress - macAddress
+   * @param {array} locationName - locationName
+   * @param {array} serialNumber - serialNumber
+   * @param {array} location - location
+   * @param {array} family - family
+   * @param {array} type - type
+   * @param {array} series - series
+   * @param {array} collectionStatus - collectionStatus
+   * @param {array} collectionInterval - collectionInterval
+   * @param {array} notSyncedForMinutes - notSyncedForMinutes
+   * @param {array} errorCode - errorCode
+   * @param {array} errorDescription - errorDescription
+   * @param {array} softwareVersion - softwareVersion
+   * @param {array} softwareType - softwareType
+   * @param {array} platformId - platformId
+   * @param {array} role - role
+   * @param {array} reachabilityStatus - reachabilityStatus
+   * @param {array} upTime - upTime
+   * @param {array} associatedWlcIp - associatedWlcIp
+   * @param {array} licensename - licenseName
+   * @param {array} licensetype - licenseType
+   * @param {array} licensestatus - licenseStatus
+   * @param {array} modulename - moduleName
+   * @param {array} moduleequpimenttype - moduleEqupimentType
+   * @param {array} moduleservicestate - moduleServiceState
+   * @param {array} modulevendorequipmenttype - moduleVendorEquipmentType
+   * @param {array} modulepartnumber - modulePartNumber
+   * @param {array} moduleoperationstatecode - moduleOperationStateCode
+   * @param {string} id - Accepts comma separated id's and return list of network-devices for the given id's. If invalid or not-found id's are provided, null entry will be returned in the list.
+   * @param {number} offset - offset. Greater than or equal to 1
+   * @param {number} limit - limit. max. no. of devices to be returned. 1 <= limit <= 500
+   * @param {getCallback} callback - a callback function to return the result
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  getDnaintentapiv1networkDeviceWithOptions(hostname, managementIpAddress, macAddress, locationName, serialNumber, location, family, type, series, collectionStatus, collectionInterval, notSyncedForMinutes, errorCode, errorDescription, softwareVersion, softwareType, platformId, role, reachabilityStatus, upTime, associatedWlcIp, licensename, licensetype, licensestatus, modulename, moduleequpimenttype, moduleservicestate, modulevendorequipmenttype, modulepartnumber, moduleoperationstatecode, id, offset, limit, callback) {
+    const meth = 'adapter-getDnaintentapiv1networkDeviceWithOptions';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
@@ -8136,7 +8180,7 @@ class DnaCenter extends AdapterBaseCl {
     /* HERE IS WHERE YOU VALIDATE DATA */
 
     /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
-    const queryParamsAvailable = { hostname, managementIpAddress, macAddress, locationName, serialNumber, location, family, type, series, collectionStatus, collectionInterval, notSyncedForMinutes, errorCode, errorDescription, softwareVersion, softwareType, platformId, role, reachabilityStatus, upTime, associatedWlcIp, licensename, licensetype, licensestatus, modulename, moduleequpimenttype, moduleservicestate, modulevendorequipmenttype, modulepartnumber, moduleoperationstatecode, id };
+    const queryParamsAvailable = { hostname, managementIpAddress, macAddress, locationName, serialNumber, location, family, type, series, collectionStatus, collectionInterval, notSyncedForMinutes, errorCode, errorDescription, softwareVersion, softwareType, platformId, role, reachabilityStatus, upTime, associatedWlcIp, licensename, licensetype, licensestatus, modulename, moduleequpimenttype, moduleservicestate, modulevendorequipmenttype, modulepartnumber, moduleoperationstatecode, id, offset, limit };
     const queryParams = {};
     const pathVars = [];
     const bodyVars = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-dna_center",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "This adapter integrates with system Dna_center",
   "main": "adapter.js",
   "systemName": "Cisco DNA Center",
@@ -54,7 +54,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/controller-orchestrator/adapter-dna_center#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^4.45.6",
+    "@itentialopensource/adapter-utils": "^4.48.13",
     "ajv": "^6.12.0",
     "axios": "^0.21.0",
     "commander": "^2.20.0",

package/pronghorn.json

@@ -5834,6 +5834,360 @@
       },
       "task": true
     },
+    {
+      "name": "getDnaintentapiv1networkDeviceWithOptions",
+      "summary": "Get Device list",
+      "description": "Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, location name and a wide variety of additional criteria. You can also use the asterisk in any value to conduct a wildcard search. For example, to find all hostnames beginning with myhost in the IP address range 192.25.18.n, issue the following request:\nGET  fqdnoripofdnacenterplatform/dna/intent/api/v1/network-device? hostname=myhost* & managementIpAddress=192.25.18.*\nFor a complete list of parameter names that you can use for filtering this request, see the DNA Center API Reference documentation.\n\nNote: If id parameter is provided, it will return the list of network-devices for the given ids and ignores the other request parameters.",
+      "input": [
+        {
+          "name": "hostname",
+          "type": "array",
+          "info": "hostname",
+          "required": false,
+          "schema": {
+            "title": "hostname",
+            "type": "array"
+          }
+        },
+        {
+          "name": "managementIpAddress",
+          "type": "array",
+          "info": "managementIpAddress",
+          "required": false,
+          "schema": {
+            "title": "managementIpAddress",
+            "type": "array"
+          }
+        },
+        {
+          "name": "macAddress",
+          "type": "array",
+          "info": "macAddress",
+          "required": false,
+          "schema": {
+            "title": "macAddress",
+            "type": "array"
+          }
+        },
+        {
+          "name": "locationName",
+          "type": "array",
+          "info": "locationName",
+          "required": false,
+          "schema": {
+            "title": "locationName",
+            "type": "array"
+          }
+        },
+        {
+          "name": "serialNumber",
+          "type": "array",
+          "info": "serialNumber",
+          "required": false,
+          "schema": {
+            "title": "serialNumber",
+            "type": "array"
+          }
+        },
+        {
+          "name": "location",
+          "type": "array",
+          "info": "location",
+          "required": false,
+          "schema": {
+            "title": "location",
+            "type": "array"
+          }
+        },
+        {
+          "name": "family",
+          "type": "array",
+          "info": "family",
+          "required": false,
+          "schema": {
+            "title": "family",
+            "type": "array"
+          }
+        },
+        {
+          "name": "type",
+          "type": "array",
+          "info": "type",
+          "required": false,
+          "schema": {
+            "title": "type",
+            "type": "array"
+          }
+        },
+        {
+          "name": "series",
+          "type": "array",
+          "info": "series",
+          "required": false,
+          "schema": {
+            "title": "series",
+            "type": "array"
+          }
+        },
+        {
+          "name": "collectionStatus",
+          "type": "array",
+          "info": "collectionStatus",
+          "required": false,
+          "schema": {
+            "title": "collectionStatus",
+            "type": "array"
+          }
+        },
+        {
+          "name": "collectionInterval",
+          "type": "array",
+          "info": "collectionInterval",
+          "required": false,
+          "schema": {
+            "title": "collectionInterval",
+            "type": "array"
+          }
+        },
+        {
+          "name": "notSyncedForMinutes",
+          "type": "array",
+          "info": "notSyncedForMinutes",
+          "required": false,
+          "schema": {
+            "title": "notSyncedForMinutes",
+            "type": "array"
+          }
+        },
+        {
+          "name": "errorCode",
+          "type": "array",
+          "info": "errorCode",
+          "required": false,
+          "schema": {
+            "title": "errorCode",
+            "type": "array"
+          }
+        },
+        {
+          "name": "errorDescription",
+          "type": "array",
+          "info": "errorDescription",
+          "required": false,
+          "schema": {
+            "title": "errorDescription",
+            "type": "array"
+          }
+        },
+        {
+          "name": "softwareVersion",
+          "type": "array",
+          "info": "softwareVersion",
+          "required": false,
+          "schema": {
+            "title": "softwareVersion",
+            "type": "array"
+          }
+        },
+        {
+          "name": "softwareType",
+          "type": "array",
+          "info": "softwareType",
+          "required": false,
+          "schema": {
+            "title": "softwareType",
+            "type": "array"
+          }
+        },
+        {
+          "name": "platformId",
+          "type": "array",
+          "info": "platformId",
+          "required": false,
+          "schema": {
+            "title": "platformId",
+            "type": "array"
+          }
+        },
+        {
+          "name": "role",
+          "type": "array",
+          "info": "role",
+          "required": false,
+          "schema": {
+            "title": "role",
+            "type": "array"
+          }
+        },
+        {
+          "name": "reachabilityStatus",
+          "type": "array",
+          "info": "reachabilityStatus",
+          "required": false,
+          "schema": {
+            "title": "reachabilityStatus",
+            "type": "array"
+          }
+        },
+        {
+          "name": "upTime",
+          "type": "array",
+          "info": "upTime",
+          "required": false,
+          "schema": {
+            "title": "upTime",
+            "type": "array"
+          }
+        },
+        {
+          "name": "associatedWlcIp",
+          "type": "array",
+          "info": "associatedWlcIp",
+          "required": false,
+          "schema": {
+            "title": "associatedWlcIp",
+            "type": "array"
+          }
+        },
+        {
+          "name": "licensename",
+          "type": "array",
+          "info": "licenseName",
+          "required": false,
+          "schema": {
+            "title": "licensename",
+            "type": "array"
+          }
+        },
+        {
+          "name": "licensetype",
+          "type": "array",
+          "info": "licenseType",
+          "required": false,
+          "schema": {
+            "title": "licensetype",
+            "type": "array"
+          }
+        },
+        {
+          "name": "licensestatus",
+          "type": "array",
+          "info": "licenseStatus",
+          "required": false,
+          "schema": {
+            "title": "licensestatus",
+            "type": "array"
+          }
+        },
+        {
+          "name": "modulename",
+          "type": "array",
+          "info": "moduleName",
+          "required": false,
+          "schema": {
+            "title": "modulename",
+            "type": "array"
+          }
+        },
+        {
+          "name": "moduleequpimenttype",
+          "type": "array",
+          "info": "moduleEqupimentType",
+          "required": false,
+          "schema": {
+            "title": "moduleequpimenttype",
+            "type": "array"
+          }
+        },
+        {
+          "name": "moduleservicestate",
+          "type": "array",
+          "info": "moduleServiceState",
+          "required": false,
+          "schema": {
+            "title": "moduleservicestate",
+            "type": "array"
+          }
+        },
+        {
+          "name": "modulevendorequipmenttype",
+          "type": "array",
+          "info": "moduleVendorEquipmentType",
+          "required": false,
+          "schema": {
+            "title": "modulevendorequipmenttype",
+            "type": "array"
+          }
+        },
+        {
+          "name": "modulepartnumber",
+          "type": "array",
+          "info": "modulePartNumber",
+          "required": false,
+          "schema": {
+            "title": "modulepartnumber",
+            "type": "array"
+          }
+        },
+        {
+          "name": "moduleoperationstatecode",
+          "type": "array",
+          "info": "moduleOperationStateCode",
+          "required": false,
+          "schema": {
+            "title": "moduleoperationstatecode",
+            "type": "array"
+          }
+        },
+        {
+          "name": "id",
+          "type": "string",
+          "info": "Accepts comma separated id's and return list of network-devices for the given id's. If invalid or not-found id's are provided, null entry will be returned in the list.",
+          "required": false,
+          "schema": {
+            "title": "id",
+            "type": "string"
+          }
+        },
+        {
+          "name": "offset",
+          "type": "number",
+          "info": "offset. offset >= 1",
+          "required": false,
+          "schema": {
+            "title": "offset",
+            "type": "number"
+          }
+        },
+        {
+          "name": "limit",
+          "type": "number",
+          "info": "max. no. of devices to be returned. 1 <= limit <= 500",
+          "required": false,
+          "schema": {
+            "title": "limit",
+            "type": "number"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getDnaintentapiv1networkDevice"
+      },
+      "task": true
+    },
     {
       "name": "postDnaintentapiv1networkDevice",
       "summary": "Add Device",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.5.7",
-  "configLines": 10857,
+  "version": "0.6.0",
+  "configLines": 11211,
   "scriptLines": 1707,
-  "codeLines": 15490,
-  "testLines": 13672,
-  "testCases": 688,
-  "totalCodeLines": 30869,
-  "wfTasks": 187
+  "codeLines": 15534,
+  "testLines": 13711,
+  "testCases": 690,
+  "totalCodeLines": 30952,
+  "wfTasks": 188
 }

package/test/integration/adapterTestIntegration.js

@@ -3284,6 +3284,33 @@ describe('[integration] Dna_center Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#getDnaintentapiv1networkDeviceWithOptions - errors', () => {
+      it('should work if integrated or standalone with mockdata', (done) => {
+        try {
+          a.getDnaintentapiv1networkDeviceWithOptions(null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, (data, error) => {
+            try {
+              runCommonAsserts(data, error);
+
+              if (stub) {
+                assert.equal(true, Array.isArray(data.response.response));
+                assert.equal('string', data.response.version);
+              } else {
+                runCommonAsserts(data, error);
+              }
+
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     // describe('#postDnaintentapiv1networkDevice - errors', () => {
     //   it('should work if integrated or standalone with mockdata', (done) => {
     //     try {

package/test/unit/adapterTestUnit.js

@@ -4765,6 +4765,18 @@ describe('[unit] Dna_center Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    describe('#getDnaintentapiv1networkDeviceWithOptions - errors', () => {
+      it('should have a getDnaintentapiv1networkDeviceWithOptions function', (done) => {
+        try {
+          assert.equal(true, typeof a.getDnaintentapiv1networkDeviceWithOptions === 'function');
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
     describe('#postDnaintentapiv1networkDevice - errors', () => {
       it('should have a postDnaintentapiv1networkDevice function', (done) => {
         try {