@itentialopensource/adapter-netbox_v33 2.1.5 → 2.1.7

package/CALLS.md

@@ -3407,7 +3407,7 @@ Specific adapter calls are built based on the API of the Netbox_v33. The Adapter
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">deleteIpamIpAddresses(callback)</td>
+    <td style="padding:15px">deleteIpamIpAddresses(data, callback)</td>
     <td style="padding:15px">ipam_ip-addresses_bulk_delete</td>
     <td style="padding:15px">{base_path}/{version}/ipam/ip-addresses/?{query}</td>
     <td style="padding:15px">Yes</td>

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 2.1.7 [05-01-2024]
+
+* Patch/adapt 3335
+
+See merge request itentialopensource/adapters/inventory/adapter-netbox_v33!11
+
+---
+
+## 2.1.6 [03-26-2024]
+
+* Changes made at 2024.03.26_14:41PM
+
+See merge request itentialopensource/adapters/inventory/adapter-netbox_v33!10
+
+---
+
 ## 2.1.5 [03-20-2024]
 
 * Fix field schemas

package/TAB1.md

@@ -0,0 +1,5 @@
+# Overview 
+
+This adapter is used to integrate the Itential Automation Platform (IAP) with the Netbox_v33 System. The API that was used to build the adapter for Netbox_v33 is usually available in the report directory of this adapter. The adapter utilizes the Netbox_v33 API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
+
+For further technical details on how to install and use this adapter, please click the Technical Documentation tab. 

package/TAB2.md

@@ -0,0 +1,309 @@
+# Netbox_v33
+
+## Table of Contents 
+
+  - [Specific Adapter Information](#specific-adapter-information) 
+    - [Authentication](#authentication) 
+    - [Sample Properties](#sample-properties) 
+    - [Swagger](#swagger) 
+  - [Generic Adapter Information](#generic-adapter-information) 
+
+## 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>. 
+
+#### 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.
+
+STEPS  
+1. Ensure you have access to a Netbox_v33 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_field": "header.headers.Authorization",
+  "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
+  "auth_logging": false,
+  "client_id": "",
+  "client_secret": "",
+  "grant_type": ""
+}
+```
+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.
+- 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.
+- Remember when you are done to turn auth_logging off as you do not want to log credentials.
+
+### Sample Properties
+
+Sample Properties can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
+
+```json
+  "properties": {
+    "host": "netbox.core-services.test.leaseplan.systems",
+    "port": 443,
+    "choosepath": "",
+    "base_path": "/api",
+    "version": "",
+    "cache_location": "none",
+    "encode_pathvars": true,
+    "encode_queryvars": true,
+    "save_metric": false,
+    "stub": true,
+    "protocol": "https",
+    "authentication": {
+      "auth_method": "no_authentication",
+      "username": "username",
+      "password": "password",
+      "token": "token",
+      "token_timeout": 600000,
+      "token_cache": "local",
+      "invalid_token_error": 401,
+      "auth_field": "header.headers.Authorization",
+      "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": "",
+      "sensitive": [],
+      "sso": {
+        "protocol": "",
+        "host": "",
+        "port": 0
+      },
+      "multiStepAuthCalls": [
+        {
+          "name": "",
+          "requestFields": {},
+          "responseFields": {},
+          "successfullResponseCode": 200
+        }
+      ]
+    },
+    "healthcheck": {
+      "type": "none",
+      "frequency": 60000,
+      "query_object": {},
+      "addlHeaders": {}
+    },
+    "throttle": {
+      "throttle_enabled": false,
+      "number_pronghorns": 1,
+      "sync_async": "sync",
+      "max_in_queue": 1000,
+      "concurrent_max": 1,
+      "expire_timeout": 0,
+      "avg_runtime": 200,
+      "priorities": [
+        {
+          "value": 0,
+          "percent": 100
+        }
+      ]
+    },
+    "request": {
+      "number_redirects": 0,
+      "number_retries": 3,
+      "limit_retry_error": [
+        0
+      ],
+      "failover_codes": [],
+      "attempt_timeout": 5000,
+      "global_request": {
+        "payload": {},
+        "uriOptions": {},
+        "addlHeaders": {},
+        "authData": {}
+      },
+      "healthcheck_on_timeout": true,
+      "return_raw": false,
+      "archiving": false,
+      "return_request": false
+    },
+    "proxy": {
+      "enabled": false,
+      "host": "",
+      "port": 1,
+      "protocol": "http",
+      "username": "",
+      "password": ""
+    },
+    "ssl": {
+      "ecdhCurve": "",
+      "enabled": false,
+      "accept_invalid_cert": false,
+      "ca_file": "",
+      "key_file": "",
+      "cert_file": "",
+      "secure_protocol": "",
+      "ciphers": ""
+    },
+    "mongo": {
+      "host": "",
+      "port": 0,
+      "database": "",
+      "username": "",
+      "password": "",
+      "replSet": "",
+      "db_ssl": {
+        "enabled": false,
+        "accept_invalid_cert": false,
+        "ca_file": "",
+        "key_file": "",
+        "cert_file": ""
+      }
+    },
+    "devicebroker": {
+      "getDevice": [
+        {
+          "path": "/get/devices/{id}",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "host",
+            "ostype": "os",
+            "ostypePrefix": "system-",
+            "ipaddress": "attributes.ipaddr",
+            "port": "443"
+          }
+        }
+      ],
+      "getDevicesFiltered": [
+        {
+          "path": "/get/devices",
+          "method": "GET",
+          "pagination": {
+            "offsetVar": "",
+            "limitVar": "",
+            "incrementBy": "limit",
+            "requestLocation": "query"
+          },
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "host",
+            "ostype": "os",
+            "ostypePrefix": "system-",
+            "ipaddress": "attributes.ipaddr",
+            "port": "443"
+          }
+        }
+      ],
+      "isAlive": [
+        {
+          "path": "/get/devices/{id}/status",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "status": "status",
+            "statusValue": "online"
+          }
+        }
+      ],
+      "getConfig": [
+        {
+          "path": "/get/devices/{id}/configPart1",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ],
+      "getCount": [
+        {
+          "path": "/get/devices",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ]
+    },
+    "cache": {
+      "enabled": false,
+      "entities": [
+        {
+          "entityType": "",
+          "frequency": 1440,
+          "flushOnFail": false,
+          "limit": 1000,
+          "retryAttempts": 5,
+          "sort": true,
+          "populate": [
+            {
+              "path": "",
+              "method": "GET",
+              "pagination": {
+                "offsetVar": "",
+                "limitVar": "",
+                "incrementBy": "limit",
+                "requestLocation": "query"
+              },
+              "query": {},
+              "body": {},
+              "headers": {},
+              "handleFailure": "ignore",
+              "requestFields": {},
+              "responseDatakey": "",
+              "responseFields": {}
+            }
+          ],
+          "cachedTasks": [
+            {
+              "name": "",
+              "filterField": "",
+              "filterLoc": ""
+            }
+          ]
+        }
+      ]
+    }
+  }
+```
+### [Swagger](https://gitlab.com/itentialopensource/adapters/inventory/adapter-netbox_v33/-/blob/master/report/adapter-openapi.json) 
+
+## [Generic Adapter Information](https://gitlab.com/itentialopensource/adapters/inventory/adapter-netbox_v33/-/blob/master/README.md) 
+

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-netbox_v33",
-  "version": "2.1.5",
+  "version": "2.1.7",
   "description": "This adapter integrates with system described as: Netbox v3.3",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
@@ -53,10 +53,10 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/inventory/adapter-netbox_v33#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.3.8",
+    "@itentialopensource/adapter-utils": "^5.3.10",
     "acorn": "^8.10.0",
     "ajv": "^8.12.0",
-    "axios": "^1.6.7",
+    "axios": "^1.6.8",
     "commander": "^11.0.0",
     "dns-lookup-promise": "^1.0.4",
     "fs-extra": "^11.1.1",

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/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "2.0.0",
-  "configLines": 185559,
+  "version": "2.1.6",
+  "configLines": 185571,
   "scriptLines": 1783,
-  "codeLines": 79698,
+  "codeLines": 79704,
   "testLines": 52921,
   "testCases": 2758,
-  "totalCodeLines": 134402,
+  "totalCodeLines": 134408,
   "wfTasks": 896
 }

package/test/integration/adapterTestIntegration.js

@@ -22109,7 +22109,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

@@ -316,7 +316,7 @@ describe('[unit] Netbox_v33 Adapter Test', () => {
           assert.notEqual(null, packageDotJson.dependencies);
           assert.notEqual('', packageDotJson.dependencies);
           assert.equal('^8.12.0', packageDotJson.dependencies.ajv);
-          assert.equal('^1.6.7', packageDotJson.dependencies.axios);
+          assert.equal('^1.6.8', packageDotJson.dependencies.axios);
           assert.equal('^11.0.0', packageDotJson.dependencies.commander);
           assert.equal('^11.1.1', packageDotJson.dependencies['fs-extra']);
           assert.equal('^10.3.0', packageDotJson.dependencies.mocha);