@itentialopensource/adapter-f5_bigiq 0.3.4 → 0.4.0

package/changelogs/CHANGELOG.MD

@@ -0,0 +1,48 @@
+
+## 0.3.3 [07-25-2023]
+
+* Add default value to schema files
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-f5_bigiq!5
+
+---
+
+## 0.3.2 [07-20-2023]
+
+* Remove additional headers
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-f5_bigiq!4
+
+---
+
+## 0.3.1 [07-20-2023]
+
+* Delete big-ip endpoints and add a big-iq task
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-f5_bigiq!3
+
+---
+
+## 0.3.0 [07-20-2023]
+
+* Add missing endpoints
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-f5_bigiq!2
+
+---
+
+## 0.2.0 [05-21-2022]
+
+* Migration to the latest Adapter Foundation
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-f5_bigiq!1
+
+---
+
+## 0.1.1 [07-20-2021]
+
+- Initial Commit
+
+See commit b3bb5ef
+
+---

package/entities/.system/action.json

@@ -29,7 +29,7 @@
       "name": "healthcheck",
       "protocol": "REST",
       "method": "GET",
-      "entitypath": "{base_path}/{version}/healthcheck?{query}",
+      "entitypath": "{base_path}/{version}/mgmt/shared/user-scripts/example?{query}",
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,

package/entities/DeviceUpgrades/action.json

@@ -142,6 +142,68 @@
           "mockFile": "mockdatafiles/getRemoveDeviceTrustStatusById-default.json"
         }
       ]
+    },
+    {
+      "name": "updateDeviceUpgrade",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/mgmt/cm/device/upgrade-backups?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/updateDeviceUpgrade-default.json"
+        }
+      ]
+    },
+    {
+      "name": "getAllUpgradeInstances",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/mgmt/cm/device/upgrade-backups?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getAllUpgradeInstances-default.json"
+        }
+      ]
+    },
+    {
+      "name": "getUpgradeInstancesById",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/mgmt/cm/device/upgrade-backups/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getUpgradeInstancesById-default.json"
+        }
+      ]
     }
   ]
 }

package/entities/DeviceUpgrades/mockdatafiles/getAllUpgradeInstances-default.json

@@ -0,0 +1,58 @@
+{
+  "items": [
+    {
+      "id": "3a010684-47c5-48f0-ba4a-82eece96aa3a",
+      "kind": "cm:device:upgrade-backups:prepostupgradebackupstate",
+      "selfLink": "https://localhost/mgmt/cm/device/upgrade-backups/3a010684-47c5-48f0-ba4a-82eece96aa3a",
+      "generation": 4,
+      "hasPreBackup": true,
+      "hasPostBackup": false,
+      "needPreBackup": true,
+      "taskReference": {
+        "link": "https://localhost/mgmt/cm/device/upgrades/dbc4369f-8e33-4364-a612-4cfc6756b8da"
+      },
+      "needPostBackup": false,
+      "lastUpdateMicros": 1695828377417472,
+      "preBackupRecords": [
+        {
+          "backupReference": {
+            "link": "https://localhost/mgmt/cm/system/backup-restore/e34e6090-b5db-4973-8cb6-fe9217d3b394"
+          },
+          "deviceReference": {
+            "link": "https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/3fd9cf87-17ff-44b3-afc8-461c115bc5c8"
+          }
+        }
+      ],
+      "includePrivateKeys": true
+    },
+    {
+      "id": "03e01c63-44cd-44f5-ae2f-446391ae436f",
+      "kind": "cm:device:upgrade-backups:prepostupgradebackupstate",
+      "selfLink": "https://localhost/mgmt/cm/device/upgrade-backups/03e01c63-44cd-44f5-ae2f-446391ae436f",
+      "generation": 3,
+      "hasPreBackup": true,
+      "hasPostBackup": false,
+      "needPreBackup": true,
+      "taskReference": {
+        "link": "https://localhost/mgmt/cm/device/upgrades/e577fed5-17ea-4bf6-b811-3045890173ab"
+      },
+      "needPostBackup": false,
+      "lastUpdateMicros": 1695272987904849,
+      "preBackupRecords": [
+        {
+          "backupReference": {
+            "link": "https://localhost/mgmt/cm/system/backup-restore/83c3b188-3172-4639-b665-2196a08b9fd4"
+          },
+          "deviceReference": {
+            "link": "https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/b14fc503-0fa0-4597-9042-cb43809b50e5"
+          }
+        }
+      ],
+      "includePrivateKeys": false
+    }
+  ],
+  "generation": 18,
+  "kind": "cm:device:upgrade-backups:prepostupgradebackupcollectionstate",
+  "lastUpdateMicros": 1695830761033292,
+  "selfLink": "https://localhost/mgmt/cm/device/upgrade-backups"
+}

package/entities/DeviceUpgrades/mockdatafiles/getUpgradeInstancesById-default.json

@@ -0,0 +1,15 @@
+{
+  "id": "538c14b3-0331-45df-8663-11caab266c0a",
+  "kind": "cm:device:upgrade-backups:prepostupgradebackupstate",
+  "selfLink": "https://localhost/mgmt/cm/device/upgrade-backups/538c14b3-0331-45df-8663-11caab266c0a",
+  "generation": 1,
+  "hasPreBackup": false,
+  "hasPostBackup": false,
+  "needPreBackup": true,
+  "taskReference": {
+    "link": "https://localhost/mgmt/cm/device/upgrades/48b1368c-765c-4e1a-b049-d8ed0ba02c60"
+  },
+  "needPostBackup": false,
+  "lastUpdateMicros": 1695830761023352,
+  "includePrivateKeys": true
+}

package/entities/DeviceUpgrades/mockdatafiles/updateDeviceUpgrade-default.json

@@ -0,0 +1,15 @@
+{
+  "id": "538c14b3-0331-45df-8663-11caab266c0a",
+  "includePrivateKeys": true,
+  "needPreBackup": true,
+  "hasPreBackup": false,
+  "needPostBackup": false,
+  "hasPostBackup": false,
+  "taskReference": {
+    "link": "https://localhost/mgmt/cm/device/upgrades/48b1368c-765c-4e1a-b049-d8ed0ba02c60"
+  },
+  "generation": 1,
+  "lastUpdateMicros": 1695830761023352,
+  "kind": "cm:device:upgrade-backups:prepostupgradebackupstate",
+  "selfLink": "https://localhost/mgmt/cm/device/upgrade-backups/538c14b3-0331-45df-8663-11caab266c0a"
+}

package/entities/DeviceUpgrades/schema.json

@@ -16,7 +16,10 @@
         "removeDeviceServices",
         "getRemoveDeviceServicesStatusById",
         "removeDeviceTrust",
-        "getRemoveDeviceTrustStatusById"
+        "getRemoveDeviceTrustStatusById",
+        "updateDeviceUpgrade",
+        "getAllUpgradeInstances",
+        "getUpgradeInstancesById"
       ],
       "external_name": "ph_request_type"
     }

package/metadata.json

@@ -0,0 +1,72 @@
+{
+  "name": "adapter-f5_bigiq",
+  "webName": "Adapter for Integration to F5 BIG-IQ",
+  "vendor": "F5",
+  "product": "BIG-IQ",
+  "osVersion": [],
+  "apiVersions": [
+    "v6.0.1"
+  ],
+  "iapVersions": [
+    "2021.1.x",
+    "2021.2.x",
+    "2022.1.x",
+    "2023.1.x"
+  ],
+  "method": "REST",
+  "type": "Adapter",
+  "domains": [
+    "Security (SASE)"
+  ],
+  "tags": [
+    "Firewall",
+    "Security Rule Management"
+  ],
+  "useCases": [
+    "Add, update, manage and remove Security Policies and Rules",
+    "Automate Security Rule Validation"
+  ],
+  "deprecated": {
+    "isDeprecated": false
+  },
+  "brokerSince": "",
+  "documentation": {
+    "storeLink": "",
+    "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-f5_bigiq",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/controller-orchestrator/adapter-f5_bigiq",
+    "docLink": "https://docs.itential.com/opensource/docs/f5-big-iq",
+    "demoLinks": [],
+    "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": "https://www.itential.com/adapters/f5-big-iq/",
+    "vendorLink": "https://www.f5.com/",
+    "productLink": "https://www.f5.com/products/big-ip-services/big-iq",
+    "apiLinks": [
+      "https://clouddocs.f5.com/products/big-iq/mgmt-api/v6.0.1/"
+    ]
+  },
+  "assets": [],
+  "relatedItems": {
+    "adapters": [],
+    "integrations": [],
+    "ecosystemApplications": [],
+    "workflowProjects": [
+      {
+        "name": "F5 - BIG-IQ - REST",
+        "webName": "Project with workflows for the BIG-IQ from F5",
+        "overview": "Project with workflows for the BIG-IQ from F5",
+        "isDependency": false,
+        "versions": [
+          "^0.3.0"
+        ],
+        "repoLink": "https://gitlab.com/itentialopensource/pre-built-automations/staging/f5-big-iq-rest",
+        "docLink": "",
+        "webLink": ""
+      }
+
+    ],
+    "transformationProjects": [],
+    "exampleProjects": []
+  }
+}

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@itentialopensource/adapter-f5_bigiq",
-  "version": "0.3.4",
+  "version": "0.4.0",
   "description": "This adapter integrates with system described as: f5Big-iqApi.",
   "main": "adapter.js",
-  "systemName": "f5 BIG-IQ",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.61.6",
+  "engineVersion": "1.67.10",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
-    "preinstall": "node utils/setup.js && npm install --package-lock-only --ignore-scripts && npx npm-force-resolutions",
+    "preinstall": "node utils/setup.js",
+    "deinstall": "node utils/removeHooks.js",
     "lint": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js",
     "lint:errors": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js --quiet",
     "test:baseunit": "mocha test/unit/adapterBaseTestUnit.js --LOG=error",
@@ -23,7 +23,7 @@
     "adapter:migrate": "node utils/modify.js -m",
     "adapter:update": "node utils/modify.js -u",
     "adapter:revert": "node utils/modify.js -r",
-    "troubleshoot": "node utils/tbScript.js",
+    "troubleshoot": "node utils/tbScript.js troubleshoot",
     "healthcheck": "node utils/tbScript.js healthcheck",
     "basicget": "node utils/tbScript.js basicget",
     "connectivity": "node utils/tbScript.js connectivity",
@@ -55,34 +55,33 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/controller-orchestrator/adapter-f5_bigiq#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^4.45.6",
-    "ajv": "^6.12.0",
-    "axios": "^0.21.0",
-    "commander": "^2.20.0",
-    "fs-extra": "^8.1.0",
+    "@itentialopensource/adapter-utils": "^5.3.0",
+    "acorn": "^8.10.0",
+    "ajv": "^8.12.0",
+    "axios": "^1.4.0",
+    "commander": "^11.0.0",
+    "dns-lookup-promise": "^1.0.4",
+    "fs-extra": "^11.1.1",
     "json-query": "^2.2.2",
-    "mocha": "^9.0.1",
+    "mocha": "^10.2.0",
     "mocha-param": "^2.0.1",
-    "mongodb": "^4.1.0",
-    "network-diagnostics": "^0.5.3",
+    "mongodb": "^4.17.1",
     "nyc": "^15.1.0",
+    "ping": "^0.4.4",
+    "prompts": "^2.4.2",
     "readline-sync": "^1.4.10",
-    "semver": "^7.3.2",
-    "winston": "^3.3.3"
+    "semver": "^7.5.3",
+    "winston": "^3.9.0"
   },
   "devDependencies": {
     "@babel/helper-function-name": "^7.14.2",
-    "chai": "^4.3.4",
-    "eslint": "^7.29.0",
-    "eslint-config-airbnb-base": "^14.2.1",
+    "chai": "^4.3.7",
+    "eslint": "^8.44.0",
+    "eslint-config-airbnb-base": "^15.0.0",
     "eslint-module-utils": "^2.6.1",
-    "eslint-plugin-import": "^2.23.4",
-    "eslint-plugin-json": "^3.0.0",
-    "package-json-validator": "^0.6.3",
-    "testdouble": "^3.16.1"
-  },
-  "resolutions": {
-    "minimist": "^1.2.5"
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-json": "^3.1.0",
+    "testdouble": "^3.18.0"
   },
   "private": false
 }