@itentialopensource/adapter-netbox_v33 2.1.7 → 2.1.8

package/TAB2.md

@@ -1,4 +1,4 @@
-# Netbox_v33
+# NetBox
 
 ## Table of Contents 
 
@@ -11,42 +11,38 @@
 ## Specific Adapter Information
 ### Authentication
 
-This document will go through the steps for authenticating the Netbox_v33 adapter with Basic Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/authentication/" target="_blank">HERE</a>. 
+This document will go through the steps for authenticating the NetBox adapter with authentication methods we have worked with in the past. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>. 
 
-#### Basic Authentication
-The Netbox_v33 adapter requires Basic Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
+Companies periodically change authentication methods to provide better security. As this happens this section should be updated and contributed/merge back into the adapter repository.
+
+#### Static Token (APIKEY) Authentication
+The NetBox adapter requires Static Token (APIKEY) Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
 
 STEPS  
-1. Ensure you have access to a Netbox_v33 server and that it is running
+1. Ensure you have access to a NetBox server and that it is running
 2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
 3. Use the properties below for the ```properties.authentication``` field
 ```json
 "authentication": {
-  "auth_method": "basic user_password",
-  "username": "<username>",
-  "password": "<password>",
-  "token": "",
-  "token_timeout": 1800000,
-  "token_cache": "local",
-  "invalid_token_error": 401,
+  "auth_method": "static_token",
+  "token": "<token>",
   "auth_field": "header.headers.Authorization",
-  "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
-  "auth_logging": false,
-  "client_id": "",
-  "client_secret": "",
-  "grant_type": ""
+  "auth_field_format": "Token {token}",
+  "auth_logging": false
 }
 ```
+you can leave all of the other properties in the authentication section, they will not be used when the auth_method is static_token.<br>
 4. Restart the adapter. If your properties were set correctly, the adapter should go online. 
 
 #### Troubleshooting
-- Make sure you copied over the correct username and password.
+- Make sure you copied over the correct token.
 - Turn on debug level logs for the adapter in IAP Admin Essentials.
 - Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
 - Investigate the logs - in particular:
   - The FULL REQUEST log to make sure the proper headers are being sent with the request.
   - The FULL BODY log to make sure the payload is accurate.
   - The CALL RETURN log to see what the other system is telling us.
+- Credentials should be ** masked ** by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
 - Remember when you are done to turn auth_logging off as you do not want to log credentials.
 
 ### Sample Properties
@@ -67,7 +63,7 @@ Sample Properties can be used to help you configure the adapter in the Itential
     "stub": true,
     "protocol": "https",
     "authentication": {
-      "auth_method": "no_authentication",
+      "auth_method": "static_token",
       "username": "username",
       "password": "password",
       "token": "token",
@@ -75,7 +71,7 @@ Sample Properties can be used to help you configure the adapter in the Itential
       "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": "",
@@ -169,30 +165,32 @@ Sample Properties can be used to help you configure the adapter in the Itential
       }
     },
     "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": "",
@@ -207,42 +205,44 @@ Sample Properties can be used to help you configure the adapter in the Itential
           "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": {}
@@ -250,7 +250,7 @@ Sample Properties can be used to help you configure the adapter in the Itential
       ],
       "getCount": [
         {
-          "path": "/get/devices",
+          "path": "/not/mapped",
           "method": "GET",
           "query": {},
           "body": {},
@@ -266,15 +266,15 @@ Sample Properties can be used to help you configure the adapter in the Itential
       "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": "",
@@ -288,7 +288,15 @@ Sample Properties can be used to help you configure the adapter in the Itential
               "handleFailure": "ignore",
               "requestFields": {},
               "responseDatakey": "",
-              "responseFields": {}
+              "responseFields": {
+                "name": "{this}{||}{that}",
+                "ostype": "{osfield}",
+                "ostypePrefix": "meraki-",
+                "port": "{port}",
+                "ipaddress": "{ip_addr}",
+                "serial": "{serial}",
+                "id": "{myid}"
+              }
             }
           ],
           "cachedTasks": [

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.7",
+  "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/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.1.6",
-  "configLines": 185571,
+  "version": "2.1.7",
+  "configLines": 185576,
   "scriptLines": 1783,
   "codeLines": 79704,
-  "testLines": 52921,
+  "testLines": 52920,
   "testCases": 2758,
-  "totalCodeLines": 134408,
+  "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": [