@itentialopensource/adapter-netbox_v33 2.1.6 → 2.1.8

package/adapter.js

@@ -49071,6 +49071,7 @@ via a protocol such as LLDP. Two query parameters must be included in the reques
    * @name deleteIpamIpAddresses
    * @summary ipam_ip-addresses_bulk_delete
    *
+   * @param {Array} data - data param
    * @param {getCallback} callback - a callback function to return the result
    * @return {object} results - An object containing the response of the action
    *
@@ -49079,7 +49080,7 @@ via a protocol such as LLDP. Two query parameters must be included in the reques
    * @task true
    */
   /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
-  deleteIpamIpAddresses(callback) {
+  deleteIpamIpAddresses(data, callback) {
     const meth = 'adapter-deleteIpamIpAddresses';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
@@ -49091,12 +49092,17 @@ via a protocol such as LLDP. Two query parameters must be included in the reques
     }
 
     /* HERE IS WHERE YOU VALIDATE DATA */
+    if (data === undefined || data === null || data === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['data'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
 
     /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
     const queryParamsAvailable = {};
     const queryParams = {};
     const pathVars = [];
-    const bodyVars = {};
+    const bodyVars = data;
 
     // loop in template. long callback arg name to avoid identifier conflicts
     Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {

package/metadata.json

@@ -37,27 +37,75 @@
     "isDeprecated": false
   },
   "brokerSince": "",
+  "authMethods": [
+    {
+      "type": "API Key",
+      "primary": true
+    }
+  ],
   "documentation": {
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-netbox_v33",
-    "repoLink": "https://gitlab.com/itentialopensource/adapters/inventory/adapter-netbox_v33",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-netbox_v33",
     "docLink": "https://docs.itential.com/opensource/docs/netbox-v33",
-    "demoLinks": [],
-    "trainingLinks": [],
+    "demoLinks": [
+      {
+        "title": "Itential & NetBox: Evolving from a Source of Truth to Automation & Orchestration (ONUG)",
+        "link": "https://www.itential.com/resource/demo/evolving-from-a-source-of-truth-to-automation-orchestration-with-netbox-onug/"
+      },
+      {
+        "title": "Integrating NetBox as a Source of Truth for Network Automation",
+        "link": "https://www.itential.com/resource/demo/integrating-netbox-as-a-source-of-truth-for-network-automation/"
+      },
+      {
+        "title": "Itential’s No-Code Integration with NetBox",
+        "link": "https://www.itential.com/solutions/integrations/netbox-network-automation/"
+      }
+    ],
+    "trainingLinks": [
+      {
+        "title": "Itential Academy",
+        "link": "https://www.itential.com/itential-academy/"
+      }
+    ],
     "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
     "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
     "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
     "webLink": "",
-    "vendorLink": "",
-    "productLink": "",
-    "apiLinks": []
+    "vendorLink": "https://netbox.dev/",
+    "productLink": "https://netbox.dev/",
+    "apiLinks": [
+      {
+        "title": "NetBox REST API",
+        "link": "https://demo.netbox.dev/api/schema/swagger-ui/",
+        "public": true
+      },
+      {
+        "title": "NetBox Sandbox",
+        "link": "https://demo.netbox.dev/",
+        "public": true
+      }
+    ]
   },
   "assets": [],
   "relatedItems": {
     "adapters": [],
     "integrations": [],
     "ecosystemApplications": [],
-    "workflowProjects": [],
+    "workflowProjects": [
+      {
+        "name": "NetBox - REST",
+        "webName": "NetBox IP Address Management",
+        "overview": "Project with workflows for NetBox using REST protocol for managing IP Address and Prefix",
+        "isDependency": false,
+        "versions": [
+          "^1.0.6"
+        ],
+        "repoLink": "https://gitlab.com/itentialopensource/pre-built-automations/netbox-rest",
+        "docLink": "",
+        "webLink": "https://www.itential.com/automations/netbox-ip-address-management/"
+      }
+    ],
     "transformationProjects": [],
     "exampleProjects": []
   }

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@itentialopensource/adapter-netbox_v33",
-  "version": "2.1.6",
+  "version": "2.1.8",
   "description": "This adapter integrates with system described as: Netbox v3.3",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.14",
+  "engineVersion": "1.67.19",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -15,7 +15,6 @@
     "test:baseunit": "mocha test/unit/adapterBaseTestUnit.js --LOG=error",
     "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
     "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
-    "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
     "test": "npm run test:baseunit && npm run test:unit && npm run test:integration",
     "adapter:install": "npm i && node utils/tbScript.js install",
     "adapter:checkMigrate": "node utils/checkMigrate.js",
@@ -43,15 +42,15 @@
   ],
   "license": "Apache-2.0",
   "engines": {
-    "node": ">= 8.0.0",
+    "node": ">= 14.0.0",
     "npm": ">= 6.0.0"
   },
   "repository": {
     "type": "git",
-    "url": "git@gitlab.com:itentialopensource/adapters/inventory/adapter-netbox_v33.git"
+    "url": "git@gitlab.com:itentialopensource/adapters/adapter-netbox_v33.git"
   },
   "author": "Itential",
-  "homepage": "https://gitlab.com/itentialopensource/adapters/inventory/adapter-netbox_v33#readme",
+  "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-netbox_v33#readme",
   "dependencies": {
     "@itentialopensource/adapter-utils": "^5.3.10",
     "acorn": "^8.10.0",
@@ -64,7 +63,6 @@
     "mocha": "^10.3.0",
     "mocha-param": "^2.0.1",
     "mongodb": "^4.16.0",
-    "nyc": "^15.1.0",
     "ping": "^0.4.4",
     "prompts": "^2.4.2",
     "readline-sync": "^1.4.10",

package/pronghorn.json

@@ -121709,7 +121709,19 @@
       "name": "deleteIpamIpAddresses",
       "summary": "ipam_ip-addresses_bulk_delete",
       "description": "ipam_ip-addresses_bulk_delete",
-      "input": [],
+      "input": [
+        {
+          "name": "data",
+          "type": "array",
+          "info": "List of IP Objects",
+          "required": true,
+          "schema": {
+            "required": [
+            ],
+            "type": "object"
+          }
+        }
+      ],
       "output": {
         "name": "result",
         "type": "object",

package/propertiesSchema.json

@@ -945,6 +945,11 @@
     "devicebroker": {
       "type": "object",
       "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether or not the device broker calls have been mapped",
+          "default": false
+        },
         "getDevice": {
           "type": "array",
           "description": "Broker call(s) to getDevice",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "2.0.0",
-  "configLines": 185559,
+  "version": "2.1.7",
+  "configLines": 185576,
   "scriptLines": 1783,
-  "codeLines": 79698,
-  "testLines": 52921,
+  "codeLines": 79704,
+  "testLines": 52920,
   "testCases": 2758,
-  "totalCodeLines": 134402,
+  "totalCodeLines": 134407,
   "wfTasks": 896
 }

package/report/updateReport1715186697583.json

@@ -0,0 +1,120 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors no longer available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors that have been updated (e.g. recommendation changes)",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 16
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 21
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.3.10"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 78
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 344
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 647
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the BROKER.md",
+      "value": 70
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 26732
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 1808
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 24936
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 880
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1453
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 53121
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 2688
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -14,7 +14,7 @@
     "stub": true,
     "protocol": "https",
     "authentication": {
-      "auth_method": "no_authentication",
+      "auth_method": "static_token",
       "username": "username",
       "password": "password",
       "token": "token",
@@ -22,7 +22,7 @@
       "token_cache": "local",
       "invalid_token_error": 401,
       "auth_field": "header.headers.Authorization",
-      "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
+      "auth_field_format": "Token {token}",
       "auth_logging": false,
       "client_id": "",
       "client_secret": "",
@@ -116,30 +116,32 @@
       }
     },
     "devicebroker": {
+      "enabled": false,
       "getDevice": [
         {
-          "path": "/get/devices/{id}",
+          "path": "/not/mapped",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "insample": "{port}"
           },
           "responseDatakey": "",
           "responseFields": {
-            "name": "host",
-            "ostype": "os",
-            "ostypePrefix": "system-",
-            "ipaddress": "attributes.ipaddr",
-            "port": "443"
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial" : "{serial}"
           }
         }
       ],
       "getDevicesFiltered": [
         {
-          "path": "/get/devices",
+          "path": "/not/mapped",
           "method": "GET",
           "pagination": {
             "offsetVar": "",
@@ -154,42 +156,44 @@
           "requestFields": {},
           "responseDatakey": "",
           "responseFields": {
-            "name": "host",
-            "ostype": "os",
-            "ostypePrefix": "system-",
-            "ipaddress": "attributes.ipaddr",
-            "port": "443"
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial" : "{serial}",
+            "id": "{myid}"
           }
         }
       ],
       "isAlive": [
         {
-          "path": "/get/devices/{id}/status",
+          "path": "/not/mapped/{devID}",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "devID": "{id}"
           },
           "responseDatakey": "",
           "responseFields": {
-            "status": "status",
-            "statusValue": "online"
+            "status": "return2xx",
+            "statusValue": "AD.200"
           }
         }
       ],
       "getConfig": [
         {
-          "path": "/get/devices/{id}/configPart1",
+          "path": "/not/mapped/{devID}",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "devID": "{id}"
           },
           "responseDatakey": "",
           "responseFields": {}
@@ -197,7 +201,7 @@
       ],
       "getCount": [
         {
-          "path": "/get/devices",
+          "path": "/not/mapped",
           "method": "GET",
           "query": {},
           "body": {},
@@ -213,15 +217,15 @@
       "enabled": false,
       "entities": [
         {
-          "entityType": "",
-          "frequency": 1440,
+          "entityType": "device",
+          "frequency": 3600,
           "flushOnFail": false,
-          "limit": 1000,
+          "limit": 10000,
           "retryAttempts": 5,
           "sort": true,
           "populate": [
             {
-              "path": "",
+              "path": "/not/mapped",
               "method": "GET",
               "pagination": {
                 "offsetVar": "",
@@ -235,7 +239,15 @@
               "handleFailure": "ignore",
               "requestFields": {},
               "responseDatakey": "",
-              "responseFields": {}
+              "responseFields": {
+                "name": "{this}{||}{that}",
+                "ostype": "{osfield}",
+                "ostypePrefix": "meraki-",
+                "port": "{port}",
+                "ipaddress": "{ip_addr}",
+                "serial" : "{serial}",
+                "id": "{myid}"
+              }
             }
           ],
           "cachedTasks": [

package/test/integration/adapterTestIntegration.js

@@ -46,6 +46,7 @@ samProps.ssl.accept_invalid_cert = false;
 if (samProps.request.attempt_timeout < 30000) {
   samProps.request.attempt_timeout = 30000;
 }
+samProps.devicebroker.enabled = true;
 const attemptTimeout = samProps.request.attempt_timeout;
 const { stub } = samProps;
 
@@ -22109,7 +22110,7 @@ describe('[integration] Netbox_v33 Adapter Test', () => {
     describe('#deleteIpamIpAddresses - errors', () => {
       it('should work if integrated but since no mockdata should error when run standalone', (done) => {
         try {
-          a.deleteIpamIpAddresses((data, error) => {
+          a.deleteIpamIpAddresses([], (data, error) => {
             try {
               if (stub) {
                 const displayE = 'Error 400 received on request';

package/test/unit/adapterTestUnit.js

@@ -284,7 +284,6 @@ describe('[unit] Netbox_v33 Adapter Test', () => {
           assert.equal('mocha test/unit/adapterBaseTestUnit.js --LOG=error', packageDotJson.scripts['test:baseunit']);
           assert.equal('mocha test/unit/adapterTestUnit.js --LOG=error', packageDotJson.scripts['test:unit']);
           assert.equal('mocha test/integration/adapterTestIntegration.js --LOG=error', packageDotJson.scripts['test:integration']);
-          assert.equal('nyc --reporter html --reporter text mocha --reporter dot test/*', packageDotJson.scripts['test:cover']);
           assert.equal('npm run test:baseunit && npm run test:unit && npm run test:integration', packageDotJson.scripts.test);
           assert.equal('npm publish --registry=https://registry.npmjs.org --access=public', packageDotJson.scripts.deploy);
           assert.equal('npm run deploy', packageDotJson.scripts.build);
@@ -321,7 +320,6 @@ describe('[unit] Netbox_v33 Adapter Test', () => {
           assert.equal('^11.1.1', packageDotJson.dependencies['fs-extra']);
           assert.equal('^10.3.0', packageDotJson.dependencies.mocha);
           assert.equal('^2.0.1', packageDotJson.dependencies['mocha-param']);
-          assert.equal('^15.1.0', packageDotJson.dependencies.nyc);
           assert.equal('^0.4.4', packageDotJson.dependencies.ping);
           assert.equal('^1.4.10', packageDotJson.dependencies['readline-sync']);
           assert.equal('^7.5.3', packageDotJson.dependencies.semver);