@itentialopensource/adapter-drivenets_networkorchestrator 0.1.1

package/pronghorn.json

@@ -0,0 +1,1598 @@
+{
+  "id": "@itentialopensource/adapter-drivenets_networkorchestrator",
+  "type": "Adapter",
+  "export": "DriveNetsNetworkOrchestrator",
+  "title": "DriveNetsNetworkOrchestrator",
+  "src": "adapter.js",
+  "roles": [
+    "admin"
+  ],
+  "methods": [
+    {
+      "name": "iapUpdateAdapterConfiguration",
+      "summary": "Updates the adapter configuration",
+      "description": "Updates the adapter configuration file with the provided changes",
+      "input": [
+        {
+          "name": "configFile",
+          "type": "string",
+          "info": "The name of the file to change",
+          "required": true,
+          "schema": {
+            "title": "configFile",
+            "type": "string"
+          }
+        },
+        {
+          "name": "changes",
+          "type": "object",
+          "info": "JSON object containing the configuration changes",
+          "required": true,
+          "schema": {
+            "title": "changes",
+            "type": "object"
+          }
+        },
+        {
+          "name": "entity",
+          "type": "string",
+          "info": "The entity in which the changes are being made",
+          "required": false,
+          "schema": {
+            "title": "entity",
+            "type": "string"
+          }
+        },
+        {
+          "name": "type",
+          "type": "string",
+          "info": "The type of file to change - action, schema, or mock",
+          "required": false,
+          "schema": {
+            "title": "type",
+            "type": "string"
+          }
+        },
+        {
+          "name": "action",
+          "type": "string",
+          "info": "The action to be changed",
+          "required": false,
+          "schema": {
+            "title": "action",
+            "type": "string"
+          }
+        }
+      ],
+      "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": "/iapUpdateAdapterConfiguration"
+      },
+      "task": true
+    },
+    {
+      "name": "iapFindAdapterPath",
+      "summary": "Provides the ability to see if a particular API path is supported by the adapter",
+      "description": "Provides the ability to see if a particular API path is supported by the adapter",
+      "input": [
+        {
+          "name": "apiPath",
+          "type": "string",
+          "info": "The API Path you want to check - make sure to not include base path and version",
+          "description": "The API Path you want to check - make sure to not include base path and version",
+          "schema": {
+            "title": "apiPath",
+            "type": "string"
+          },
+          "required": true
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapFindAdapterPath"
+      },
+      "task": true
+    },
+    {
+      "name": "iapSuspendAdapter",
+      "summary": "Suspends the adapter",
+      "description": "Suspends the adapter",
+      "input": [
+        {
+          "name": "mode",
+          "type": "enum",
+          "enumerals": [
+            "pause",
+            "error"
+          ],
+          "info": "How incoming requests are handled. Defaults to 'pause'",
+          "description": "How incoming requests are handled. Defaults to 'pause'",
+          "schema": {
+            "title": "mode",
+            "type": "string"
+          },
+          "required": false
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the adapter suspended status",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapSuspendAdapter"
+      },
+      "task": true
+    },
+    {
+      "name": "iapUnsuspendAdapter",
+      "summary": "Unsuspends the adapter",
+      "description": "Unsuspends the adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the adapter suspended status",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapUnsuspendAdapter"
+      },
+      "task": true
+    },
+    {
+      "name": "iapGetAdapterQueue",
+      "summary": "Return the requests that are waiting in the queue if throttling is enabled",
+      "description": "Return the requests that are waiting in the queue if throttling is enabled",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the adapter queue",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapGetAdapterQueue"
+      },
+      "task": true
+    },
+    {
+      "name": "iapTroubleshootAdapter",
+      "summary": "Runs troubleshoot script for adapter",
+      "description": "Runs troubleshoot script for adapter",
+      "input": [
+        {
+          "name": "props",
+          "type": "object",
+          "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
+          "required": true,
+          "schema": {
+            "title": "props",
+            "type": "object"
+          }
+        },
+        {
+          "name": "persistFlag",
+          "type": "boolean",
+          "info": "Whether the input properties should be saved",
+          "required": true
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the test results",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapTroubleshootAdapter"
+      },
+      "task": true
+    },
+    {
+      "name": "iapRunAdapterHealthcheck",
+      "summary": "Runs healthcheck script for adapter",
+      "description": "Runs healthcheck script for adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "boolean",
+        "description": "Whether healthcheck passed or failed"
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapRunAdapterHealthcheck"
+      },
+      "task": true
+    },
+    {
+      "name": "iapRunAdapterConnectivity",
+      "summary": "Runs connectivity check script for adapter",
+      "description": "Runs connectivity check script for adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the test results",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapRunAdapterConnectivity"
+      },
+      "task": true
+    },
+    {
+      "name": "iapRunAdapterBasicGet",
+      "summary": "Runs basicGet script for adapter",
+      "description": "Runs basicGet script for adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the test results",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapRunAdapterBasicGet"
+      },
+      "task": true
+    },
+    {
+      "name": "iapMoveAdapterEntitiesToDB",
+      "summary": "Moves entities from an adapter into the IAP database",
+      "description": "Moves entities from an adapter into the IAP database",
+      "input": [],
+      "output": {
+        "name": "res",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the response from the mongo transaction",
+        "schema": {
+          "title": "res",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapMoveAdapterEntitiesToDB"
+      },
+      "task": true
+    },
+    {
+      "name": "genericAdapterRequest",
+      "summary": "Makes the requested generic call",
+      "description": "Makes the requested generic call",
+      "input": [
+        {
+          "name": "uriPath",
+          "type": "string",
+          "info": "the path of the api call - do not include the host, port, base path or version",
+          "description": "the path of the api call",
+          "schema": {
+            "title": "uriPath",
+            "type": "string"
+          },
+          "required": true
+        },
+        {
+          "name": "restMethod",
+          "type": "string",
+          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "schema": {
+            "title": "restMethod",
+            "type": "string"
+          },
+          "required": true
+        },
+        {
+          "name": "queryData",
+          "type": "object",
+          "info": "the query parameters to be put on the url (optional)",
+          "description": "the query parameters to be put on the url (optional)",
+          "schema": {
+            "title": "queryData",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "name": "requestBody",
+          "type": "object",
+          "info": "the payload to be sent with the request (optional)",
+          "description": "the payload to be sent with the request (optional)",
+          "schema": {
+            "title": "requestBody",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "name": "addlHeaders",
+          "type": "object",
+          "info": "additional headers to be put on the call (optional)",
+          "description": "additional headers to be put on the call (optional)",
+          "schema": {
+            "title": "addlHeaders",
+            "type": "object"
+          },
+          "required": false
+        }
+      ],
+      "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": "/genericAdapterRequest"
+      },
+      "task": true
+    },
+    {
+      "name": "genericAdapterRequestNoBasePath",
+      "summary": "Makes the requested generic call",
+      "description": "Makes the requested generic call",
+      "input": [
+        {
+          "name": "uriPath",
+          "type": "string",
+          "info": "the path of the api call - do not include the host, port, base path or version",
+          "description": "the path of the api call",
+          "schema": {
+            "title": "uriPath",
+            "type": "string"
+          },
+          "required": true
+        },
+        {
+          "name": "restMethod",
+          "type": "string",
+          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "schema": {
+            "title": "restMethod",
+            "type": "string"
+          },
+          "required": true
+        },
+        {
+          "name": "queryData",
+          "type": "object",
+          "info": "the query parameters to be put on the url (optional)",
+          "description": "the query parameters to be put on the url (optional)",
+          "schema": {
+            "title": "queryData",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "name": "requestBody",
+          "type": "object",
+          "info": "the payload to be sent with the request (optional)",
+          "description": "the payload to be sent with the request (optional)",
+          "schema": {
+            "title": "requestBody",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "name": "addlHeaders",
+          "type": "object",
+          "info": "additional headers to be put on the call (optional)",
+          "description": "additional headers to be put on the call (optional)",
+          "schema": {
+            "title": "addlHeaders",
+            "type": "object"
+          },
+          "required": false
+        }
+      ],
+      "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": "/genericAdapterRequestNoBasePath"
+      },
+      "task": true
+    },
+    {
+      "name": "getDevice",
+      "summary": "Get the Appliance",
+      "description": "Get the Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        }
+      ],
+      "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": "/getDevice"
+      },
+      "task": true
+    },
+    {
+      "name": "getDevicesFiltered",
+      "summary": "Get Appliances that match the filter",
+      "description": "Get Appliances that match the filter",
+      "input": [
+        {
+          "name": "options",
+          "type": "object",
+          "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
+          "required": true,
+          "schema": {
+            "title": "options",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "array",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "array"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getDevicesFiltered"
+      },
+      "task": true
+    },
+    {
+      "name": "isAlive",
+      "summary": "Checks the status for the provided Appliance",
+      "description": "Checks the status for the provided Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "boolean",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "boolean"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/isAlive"
+      },
+      "task": true
+    },
+    {
+      "name": "getConfig",
+      "summary": "Gets a config for the provided Appliance",
+      "description": "Gets a config for the provided Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        },
+        {
+          "name": "format",
+          "type": "string",
+          "info": "The format to be returned - this is ignored as we always return json",
+          "required": false,
+          "schema": {
+            "title": "format",
+            "type": "string"
+          }
+        }
+      ],
+      "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": "/getConfig"
+      },
+      "task": true
+    },
+    {
+      "name": "iapGetDeviceCount",
+      "summary": "Gets a device count from the system",
+      "description": "Gets a device count from the system",
+      "input": [],
+      "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": "/iapGetDeviceCount"
+      },
+      "task": true
+    },
+    {
+      "name": "deploy",
+      "summary": "deploy",
+      "description": "Deploy DNOS to create an NCE.",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": ": object",
+          "required": true,
+          "schema": {
+            "example": {
+              "name": "NY22C",
+              "candidateDNOSYaml": "v13.0",
+              "oobIpv4Address": "Acquired",
+              "oobIpv4Subnet": 24,
+              "oobIpv6Address": "Acquired",
+              "oobIpv6Subnet": 127,
+              "oobIpv4DefaultGateway": "198.51.100.42",
+              "oobIpv6DefaultGateway": "2001:0db8:5b96:0000:0000:426f:8e17:642a",
+              "inBandIpv4Address": "198.51.100.42",
+              "inBandIpv4Subnet": 24,
+              "inBandIpv6Address": "2001:0db8:5b96:0000:0000:426f:8e17:642a",
+              "inBandIpv6Subnet": 127,
+              "minimumNccs": 2,
+              "siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+              "configurationData": {
+                "filename": "baseConfig.xml",
+                "username": "dnroot",
+                "configurationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
+              },
+              "formation": {
+                "type": "Cluster",
+                "specific": "CL-96"
+              },
+              "nccs": [
+                {
+                  "serialNumber": "string",
+                  "nccId": 1
+                }
+              ]
+            },
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/deploy"
+      },
+      "task": true
+    },
+    {
+      "name": "updateNCEbyClusterID",
+      "summary": "updateNCEbyClusterID",
+      "description": "Edit an existing NCE. If NCE is in 'Waiting for equipment' status all required body fields should be provided as in Create NCE",
+      "input": [
+        {
+          "name": "clusterId",
+          "type": "string",
+          "info": "System-ID of the NCE: string",
+          "required": true,
+          "schema": {
+            "title": "clusterId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": ": object",
+          "required": true,
+          "schema": {
+            "example": {
+              "name": "NY22C",
+              "inBandIpv4Address": "198.51.100.42",
+              "inBandIpv4Subnet": 24,
+              "inBandIpv6Address": "2001:0db8:5b96:0000:0000:426f:8e17:642a",
+              "inBandIpv6Subnet": 127,
+              "oobIpv4DefaultGateway": "198.51.100.42",
+              "oobIpv6DefaultGateway": "2001:0db8:5b96:0000:0000:426f:8e17:642a",
+              "siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+              "formation": {
+                "type": "Cluster",
+                "specific": "CL-96"
+              },
+              "targetGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+              "nccs": [
+                {
+                  "serialNumber": "string",
+                  "nccId": 1
+                }
+              ]
+            },
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/updateNCEbyClusterID"
+      },
+      "task": true
+    },
+    {
+      "name": "deleteNCEbyClusterID",
+      "summary": "deleteNCEbyClusterID",
+      "description": "Remove an NCE from DNOR and delete the DNOS installation on the NCE nodes.",
+      "input": [
+        {
+          "name": "clusterId",
+          "type": "string",
+          "info": ": string",
+          "required": true,
+          "schema": {
+            "title": "clusterId",
+            "type": "string"
+          }
+        }
+      ],
+      "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": "/deleteNCEbyClusterID"
+      },
+      "task": true
+    },
+    {
+      "name": "nceManagementDownload",
+      "summary": "download",
+      "description": "Download a newer version of DNOS to the NCE (prior to upgrade).",
+      "input": [
+        {
+          "name": "clusterId",
+          "type": "string",
+          "info": "System-ID of the NCE: string",
+          "required": true,
+          "schema": {
+            "title": "clusterId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "Download values: object",
+          "required": true,
+          "schema": {
+            "example": {
+              "version": "string",
+              "inBand": false
+            },
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/nceManagementDownload"
+      },
+      "task": true
+    },
+    {
+      "name": "nceManagementUpgrade",
+      "summary": "Upgrade",
+      "description": "Upgrade the version of DNOS running on an NCE.",
+      "input": [
+        {
+          "name": "clusterId",
+          "type": "string",
+          "info": "System-ID of the NCE: string",
+          "required": true,
+          "schema": {
+            "title": "clusterId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "Upgrade deatil: object",
+          "required": true,
+          "schema": {
+            "example": {},
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/nceManagementUpgrade"
+      },
+      "task": true
+    },
+    {
+      "name": "nceManagementCancel",
+      "summary": "Cancel",
+      "description": "Cancel the current process running on an NCE",
+      "input": [
+        {
+          "name": "clusterId",
+          "type": "string",
+          "info": "System-ID of the NCE: string",
+          "required": true,
+          "schema": {
+            "title": "clusterId",
+            "type": "string"
+          }
+        }
+      ],
+      "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": "/nceManagementCancel"
+      },
+      "task": true
+    },
+    {
+      "name": "nceManagementPrecheck",
+      "summary": "Preupgrade validation",
+      "description": "Preupgrade validation",
+      "input": [
+        {
+          "name": "clusterId",
+          "type": "string",
+          "info": "System-ID of the NCE: string",
+          "required": true,
+          "schema": {
+            "title": "clusterId",
+            "type": "string"
+          }
+        }
+      ],
+      "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": "/nceManagementPrecheck"
+      },
+      "task": true
+    },
+    {
+      "name": "redundancyDisable",
+      "summary": "Disable all DNOR services on a node",
+      "description": "Disable DNOR node values",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": ": object",
+          "required": false,
+          "schema": {
+            "example": {
+              "dnorRole": "PRIMARY",
+              "addr": "198.51.100.42"
+            },
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/redundancyDisable"
+      },
+      "task": true
+    },
+    {
+      "name": "redundancyEnable",
+      "summary": "Enable all DNOR services on a node",
+      "description": "Enable DNOR node values",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": ": object",
+          "required": false,
+          "schema": {
+            "example": {
+              "dnorRole": "PRIMARY",
+              "addr": "198.51.100.42"
+            },
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/redundancyEnable"
+      },
+      "task": true
+    },
+    {
+      "name": "redundancy",
+      "summary": "Manual switchover",
+      "description": "Trigger manual switchover on the active DNOR node",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "Manual switchover: object",
+          "required": false,
+          "schema": {
+            "example": {},
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/redundancy"
+      },
+      "task": true
+    },
+    {
+      "name": "targetGroupGroups",
+      "summary": "Get all existing target groups",
+      "description": "Get all existing target groups",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "GET",
+        "path": "/targetGroupGroups"
+      },
+      "task": true
+    },
+    {
+      "name": "targetGroupCreateGroup",
+      "summary": "Create new target group",
+      "description": "Create new target gorup",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "Target group details: object",
+          "required": false,
+          "schema": {
+            "example": {
+              "groupName": "firstGroup",
+              "parentGroupId": "firstGroupId"
+            },
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/targetGroupCreateGroup"
+      },
+      "task": true
+    },
+    {
+      "name": "targetGroupUpdateGroupGroupID",
+      "summary": "Update target group",
+      "description": "Update target group",
+      "input": [
+        {
+          "name": "groupId",
+          "type": "string",
+          "info": "Group id: string",
+          "required": true,
+          "schema": {
+            "title": "groupId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "Target group details: object",
+          "required": false,
+          "schema": {
+            "example": {
+              "groupName": "firstGroup",
+              "parentGroupId": "firstGroupId"
+            },
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/targetGroupUpdateGroupGroupID"
+      },
+      "task": true
+    },
+    {
+      "name": "deleteTargetGroupGroupId",
+      "summary": "Delete target group by id",
+      "description": "Delete target group by id",
+      "input": [
+        {
+          "name": "groupId",
+          "type": "string",
+          "info": "Group id: string",
+          "required": true,
+          "schema": {
+            "title": "groupId",
+            "type": "string"
+          }
+        }
+      ],
+      "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": "/deleteTargetGroupGroupId"
+      },
+      "task": true
+    },
+    {
+      "name": "getTaskManagementTaskExecutions",
+      "summary": "Get all tasks executions",
+      "description": "Get all tasks executions, past and currently running",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "GET",
+        "path": "/getTaskManagementTaskExecutions"
+      },
+      "task": true
+    },
+    {
+      "name": "getTaskManagementTasks",
+      "summary": "Get all tasks",
+      "description": "Get all tasks",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "GET",
+        "path": "/getTaskManagementTasks"
+      },
+      "task": true
+    },
+    {
+      "name": "postTaskManagementCreateTask",
+      "summary": "Create new task",
+      "description": "Create new task",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "Task details: object",
+          "required": false,
+          "schema": {
+            "example": {
+              "name": "testTask",
+              "function": "Software Upgrade",
+              "activation": "Recurrence",
+              "scheduledOnce": {
+                "startDate": "08-11-2020",
+                "startTime": "14:15"
+              },
+              "scheduledRecurrent": {
+                "startDate": "08-11-2020",
+                "endDate": "08-11-2020",
+                "timeFrame": "Weekly",
+                "daysOfWeek": [
+                  "Sunday"
+                ],
+                "daysOfMonth": "1,4,15",
+                "months": [
+                  "January"
+                ],
+                "timeOfDay": "14:15"
+              },
+              "targetNCEs": [
+                "string"
+              ],
+              "groupIdList": [
+                "string"
+              ],
+              "additionalInfo": {
+                "management-channel": "In-Band"
+              }
+            },
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/postTaskManagementCreateTask"
+      },
+      "task": true
+    },
+    {
+      "name": "putTaskManagementUpdateTask",
+      "summary": "Update task",
+      "description": "Update task",
+      "input": [
+        {
+          "name": "taskId",
+          "type": "string",
+          "info": "Task id: string",
+          "required": true,
+          "schema": {
+            "title": "taskId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "Task details: object",
+          "required": false,
+          "schema": {
+            "example": {
+              "name": "testTask",
+              "function": "Software Upgrade",
+              "activation": "Recurrence",
+              "scheduledOnce": {
+                "startDate": "08-11-2020",
+                "startTime": "14:15"
+              },
+              "scheduledRecurrent": {
+                "startDate": "08-11-2020",
+                "endDate": "08-11-2020",
+                "timeFrame": "Weekly",
+                "daysOfWeek": [
+                  "Sunday"
+                ],
+                "daysOfMonth": "1,4,15",
+                "months": [
+                  "January"
+                ],
+                "timeOfDay": "14:15"
+              },
+              "targetNCEs": [
+                "string"
+              ],
+              "groupIdList": [
+                "string"
+              ],
+              "additionalInfo": {
+                "management-channel": "In-Band"
+              }
+            },
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/putTaskManagementUpdateTask"
+      },
+      "task": true
+    },
+    {
+      "name": "postTaskManagementExecuteTask",
+      "summary": "Execute task",
+      "description": "Execute task",
+      "input": [
+        {
+          "name": "taskId",
+          "type": "string",
+          "info": "Task id: string",
+          "required": true,
+          "schema": {
+            "title": "taskId",
+            "type": "string"
+          }
+        }
+      ],
+      "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": "/postTaskManagementExecuteTask"
+      },
+      "task": true
+    },
+    {
+      "name": "postTaskManagementCancelTask",
+      "summary": "Cancel running task",
+      "description": "Cancel running task",
+      "input": [
+        {
+          "name": "taskExecutionId",
+          "type": "string",
+          "info": "Task execution id: string",
+          "required": true,
+          "schema": {
+            "title": "taskExecutionId",
+            "type": "string"
+          }
+        }
+      ],
+      "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": "/postTaskManagementCancelTask"
+      },
+      "task": true
+    },
+    {
+      "name": "taskManagementDeleteTask",
+      "summary": "Delete task by task id",
+      "description": "Delete task by task id",
+      "input": [
+        {
+          "name": "taskId",
+          "type": "string",
+          "info": "Task id: string",
+          "required": true,
+          "schema": {
+            "title": "taskId",
+            "type": "string"
+          }
+        }
+      ],
+      "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": "/taskManagementDeleteTask"
+      },
+      "task": true
+    },
+    {
+      "name": "getFaultManagementAlarmConfiguration",
+      "summary": "Get alarm configuration by alarm name.",
+      "description": "Get alarm configuration by alarm name.",
+      "input": [
+        {
+          "name": "alarmName",
+          "type": "string",
+          "info": "Alarm name: string",
+          "required": true,
+          "schema": {
+            "title": "alarmName",
+            "type": "string"
+          }
+        }
+      ],
+      "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": "/getFaultManagementAlarmConfiguration"
+      },
+      "task": true
+    },
+    {
+      "name": "getAllFaultManagementAlarmConfiguration",
+      "summary": "Get all alarms configuration.",
+      "description": "Get all alarms configuration.",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "GET",
+        "path": "/getAllFaultManagementAlarmConfiguration"
+      },
+      "task": true
+    },
+    {
+      "name": "getAllFaultManagementActiveAlarms",
+      "summary": "Get all active alarms.",
+      "description": "Get all active alarms.",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "GET",
+        "path": "/getAllFaultManagementActiveAlarms"
+      },
+      "task": true
+    }
+  ],
+  "views": []
+}