Accedian vendor logo

Vendor

Accedian

Product

Skylight

Method

REST

Category

Service Assurance

Project Type

Adapter

View Repository
Adapter

Adapter for Integration to Accedian Skylight

Overview

This adapter is used to integrate the Itential Automation Platform (IAP) with the Accedian_skylight System. The API that was used to build the adapter for Accedian_skylight is usually available in the report directory of this adapter. The adapter utilizes the Accedian_skylight 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.

Details

The Accedian Skylight adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Accedian Skylight. With this adapter you have the ability to perform operations such as:

  • Manage configuration and sensor orchestration service

For further technical details on how to install and use this adapter, please click the Technical Documentation tab.

Accedian Skylight

Table of Contents

Getting Started

These instructions will help you get a copy of the project on your local machine for development and testing. Reading this section is also helpful for deployments as it provides you with pertinent information on prerequisites and properties.

Helpful Background Information

There is Adapter documentation available on the Itential Documentation Site. This documentation includes information and examples that are helpful for:

Authentication
IAP Service Instance Configuration
Code Files
Endpoint Configuration (Action & Schema)
Mock Data
Adapter Generic Methods
Headers
Security
Linting and Testing
Build an Adapter
Troubleshooting an Adapter

Others will be added over time. Want to build a new adapter? Use the Itential Adapter Builder

Prerequisites

The following is a list of required packages for installation on the system the adapter will run on:

Node.js
npm
Git

The following list of packages are required for Itential opensource adapters or custom adapters that have been built utilizing the Itential Adapter Builder. You can install these packages by running npm install inside the adapter directory.

PackageDescription
@itentialopensource/adapter-utilsRuntime library classes for all adapters; includes request handling, connection, authentication throttling, and translation.
ajvRequired for validation of adapter properties to integrate with Accedian_skylight.
axiosUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
commanderUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
dns-lookup-promiseUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
fs-extraUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
mochaTesting library that is utilized by some of the node scripts that are included with the adapter.
mocha-paramTesting library that is utilized by some of the node scripts that are included with the adapter.
mongodbUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
nycTesting coverage library that is utilized by some of the node scripts that are included with the adapter.
pingUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
readline-syncUtilized by the node script that comes with the adapter; helps to test unit and integration functionality.
semverUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
winstonUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.

If you are developing and testing a custom adapter, or have testing capabilities on an Itential opensource adapter, you will need to install these packages as well.

chai
eslint
eslint-config-airbnb-base
eslint-plugin-import
eslint-plugin-json
testdouble

How to Install

  1. Set up the name space location in your IAP node_modules.
cd /opt/pronghorn/current/node_modules (* could be in a different place)
if the @itentialopensource directory does not exist, create it:
    mkdir @itentialopensource
  1. Clone/unzip/tar the adapter into your IAP environment.
cd \@itentialopensource
git clone git@gitlab.com:\@itentialopensource/adapters/adapter-accedian_skylight
or
unzip adapter-accedian_skylight.zip
or
tar -xvf adapter-accedian_skylight.tar
  1. Run the adapter install script.
cd adapter-accedian_skylight
npm install
npm run lint:errors
npm run test
  1. Restart IAP
systemctl restart pronghorn

  1. Create an adapter service instance configuration in IAP Admin Essentials GUI

  2. Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.

  3. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI

For an easier install of the adapter use npm run adapter:install, it will install the adapter in IAP. Please note that it can be dependent on where the adapter is installed and on the version of IAP so it is subject to fail. If using this, you can replace step 3-5 above with these:

  1. Install adapter dependencies and check the adapter.
cd adapter-accedian_skylight
npm run adapter:install
  1. Restart IAP
systemctl restart pronghorn
  1. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI

Testing

Mocha is generally used to test all Itential Opensource Adapters. There are unit tests as well as integration tests performed. Integration tests can generally be run as standalone using mock data and running the adapter in stub mode, or as integrated. When running integrated, every effort is made to prevent environmental failures, however there is still a possibility.

Unit Testing

Unit Testing includes testing basic adapter functionality as well as error conditions that are triggered in the adapter prior to any integration. There are two ways to run unit tests. The prefered method is to use the testRunner script; however, both methods are provided here.

node utils/testRunner --unit

npm run test:unit
npm run test:baseunit

To add new unit tests, edit the test/unit/adapterTestUnit.js file. The tests that are already in this file should provide guidance for adding additional tests.

Integration Testing - Standalone

Standalone Integration Testing requires mock data to be provided with the entities. If this data is not provided, standalone integration testing will fail. When the adapter is set to run in stub mode (setting the stub property to true), the adapter will run through its code up to the point of making the request. It will then retrieve the mock data and return that as if it had received that data as the response from Accedian_skylight. It will then translate the data so that the adapter can return the expected response to the rest of the Itential software. Standalone is the default integration test.

Similar to unit testing, there are two ways to run integration tests. Using the testRunner script is better because it prevents you from having to edit the test script; it will also resets information after testing is complete so that credentials are not saved in the file.

node utils/testRunner
  answer no at the first prompt

npm run test:integration

To add new integration tests, edit the test/integration/adapterTestIntegration.js file. The tests that are already in this file should provide guidance for adding additional tests.

Integration Testing

Integration Testing requires connectivity to Accedian_skylight. By using the testRunner script it prevents you from having to edit the integration test. It also resets the integration test after the test is complete so that credentials are not saved in the file.

Note: These tests have been written as a best effort to make them work in most environments. However, the Adapter Builder often does not have the necessary information that is required to set up valid integration tests. For example, the order of the requests can be very important and data is often required for creates and updates. Hence, integration tests may have to be enhanced before they will work (integrate) with Accedian_skylight. Even after tests have been set up properly, it is possible there are environmental constraints that could result in test failures. Some examples of possible environmental issues are customizations that have been made within Accedian_skylight which change order dependencies or required data.

node utils/testRunner
answer yes at the first prompt
answer all other questions on connectivity and credentials

Test should also be written to clean up after themselves. However, it is important to understand that in some cases this may not be possible. In addition, whenever exceptions occur, test execution may be stopped, which will prevent cleanup actions from running. It is recommended that tests be utilized in dev and test labs only.

Reminder: Do not check in code with actual credentials to systems.

Configuration

This section defines all the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or IAP are provided in the sampleProperties.

Example Properties

  "properties": {
    "host": "localhost",
    "port": 443,
    "choosepath": "",
    "base_path": "/nbapi",
    "version": "",
    "cache_location": "none",
    "encode_pathvars": true,
    "encode_queryvars": true,
    "save_metric": false,
    "stub": false,
    "protocol": "https",
    "authentication": {
      "auth_method": "request_token",
      "username": "username",
      "password": "password",
      "token": "token",
      "token_timeout": 1800000,
      "token_cache": "local",
      "invalid_token_error": 401,
      "auth_field": "header.headers.Authorization",
      "auth_field_format": "Bearer {token}",
      "auth_logging": false,
      "client_id": "",
      "client_secret": "",
      "grant_type": "",
      "sensitive": [],
      "sso": {
        "protocol": "",
        "host": "",
        "port": 0
      },
      "multiStepAuthCalls": [
        {
          "name": "",
          "requestFields": {},
          "responseFields": {},
          "successfullResponseCode": 200
        }
      ]
    },
    "healthcheck": {
      "type": "startup",
      "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": {
          "Content-Type": "application/vnd.api+json"
        },
        "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": ""
            }
          ]
        }
      ]
    }
  }

Connection Properties

These base properties are used to connect to Accedian_skylight upon the adapter initially coming up. It is important to set these properties appropriately.

PropertyDescription
hostRequired. A fully qualified domain name or IP address.
portRequired. Used to connect to the server.
base_pathOptional. Used to define part of a path that is consistent for all or most endpoints. It makes the URIs easier to use and maintain but can be overridden on individual calls. An example **base_path** might be `/rest/api`. Default is ``.
versionOptional. Used to set a global version for action endpoints. This makes it faster to update the adapter when endpoints change. As with the base-path, version can be overridden on individual endpoints. Default is ``.
cache_locationOptional. Used to define where the adapter cache is located. The cache is used to maintain an entity list to improve performance. Storage locally is lost when the adapter is restarted. Storage in Redis is preserved upon adapter restart. Default is none which means no caching of the entity list.
encode_pathvarsOptional. Used to tell the adapter to encode path variables or not. The default behavior is to encode them so this property can be used to stop that behavior.
encode_queryvarsOptional. Used to tell the adapter to encode query parameters or not. The default behavior is to encode them so this property can be used to stop that behavior.
save_metricOptional. Used to tell the adapter to save metric information (this does not impact metrics returned on calls). This allows the adapter to gather metrics over time. Metric data can be stored in a database or on the file system.
stubOptional. Indicates whether the stub should run instead of making calls to Accedian_skylight (very useful during basic testing). Default is false (which means connect to Accedian_skylight).
protocolOptional. Notifies the adapter whether to use HTTP or HTTPS. Default is HTTP.

A connectivity check tells IAP the adapter has loaded successfully.

Authentication Properties

The following properties are used to define the authentication process to Accedian_skylight.

Note: Depending on the method that is used to authenticate with Accedian_skylight, you may not need to set all of the authentication properties.

PropertyDescription
auth_methodRequired. Used to define the type of authentication currently supported. Authentication methods currently supported are: `basic user_password`, `static_token`, `request_token`, and `no_authentication`.
usernameUsed to authenticate with Accedian_skylight on every request or when pulling a token that will be used in subsequent requests.
passwordUsed to authenticate with Accedian_skylight on every request or when pulling a token that will be used in subsequent requests.
tokenDefines a static token that can be used on all requests. Only used with `static_token` as an authentication method (auth\_method).
invalid_token_errorDefines the HTTP error that is received when the token is invalid. Notifies the adapter to pull a new token and retry the request. Default is 401.
token_timeoutDefines how long a token is valid. Measured in milliseconds. Once a dynamic token is no longer valid, the adapter has to pull a new token. If the token_timeout is set to -1, the adapter will pull a token on every request to Accedian_skylight. If the timeout_token is 0, the adapter will use the expiration from the token response to determine when the token is no longer valid.
token_cacheUsed to determine where the token should be stored (local memory or in Redis).
auth_fieldDefines the request field the authentication (e.g., token are basic auth credentials) needs to be placed in order for the calls to work.
auth_field_formatDefines the format of the auth\_field. See examples below. Items enclosed in {} inform the adapter to perofrm an action prior to sending the data. It may be to replace the item with a value or it may be to encode the item.
auth_loggingSetting this true will add some additional logs but this should only be done when trying to debug an issue as certain credential information may be logged out when this is true.
client_idProvide a client id when needed, this is common on some types of OAuth.
client_secretProvide a client secret when needed, this is common on some types of OAuth.
grant_typeProvide a grant type when needed, this is common on some types of OAuth.

Examples of authentication field format

"{token}"
"Token {token}"
"{username}:{password}"
"Basic {b64}{username}:{password}{/b64}"

Healthcheck Properties

The healthcheck properties defines the API that runs the healthcheck to tell the adapter that it can reach Accedian_skylight. There are currently three types of healthchecks.

  • None - Not recommended. Adapter will not run a healthcheck. Consequently, unable to determine before making a request if the adapter can reach Accedian_skylight.
  • Startup - Adapter will check for connectivity when the adapter initially comes up, but it will not check afterwards.
  • Intermittent - Adapter will check connectivity to Accedian_skylight at a frequency defined in the frequency property.
PropertyDescription
typeRequired. The type of health check to run.
frequencyRequired if intermittent. Defines how often the health check should run. Measured in milliseconds. Default is 300000.
query_objectQuery parameters to be added to the adapter healthcheck call.

Request Properties

The request section defines properties to help handle requests.

PropertyDescription
number_redirectsOptional. Tells the adapter that the request may be redirected and gives it a maximum number of redirects to allow before returning an error. Default is 0 - no redirects.
number_retriesTells the adapter how many times to retry a request that has either aborted or reached a limit error before giving up and returning an error.
limit_retry_errorOptional. Can be either an integer or an array. Indicates the http error status number to define that no capacity was available and, after waiting a short interval, the adapter can retry the request. If an array is provvided, the array can contain integers or strings. Strings in the array are used to define ranges (e.g. "502-506"). Default is [0].
failover_codesAn array of error codes for which the adapter will send back a failover flag to IAP so that the Platform can attempt the action in another adapter.
attempt_timeoutOptional. Tells how long the adapter should wait before aborting the attempt. On abort, the adapter will do one of two things: 1) return the error; or 2) if **healthcheck\_on\_timeout** is set to true, it will abort the request and run a Healthcheck until it re-establishes connectivity to Accedian_skylight, and then will re-attempt the request that aborted. Default is 5000 milliseconds.
global_requestOptional. This is information that the adapter can include in all requests to the other system. This is easier to define and maintain than adding this information in either the code (adapter.js) or the action files.
global_request -> payloadOptional. Defines any information that should be included on all requests sent to the other system that have a payload/body.
global_request -> uriOptionsOptional. Defines any information that should be sent as untranslated query options (e.g. page, size) on all requests to the other system.
global_request -> addlHeadersOptioonal. Defines any headers that should be sent on all requests to the other system.
global_request -> authDataOptional. Defines any additional authentication data used to authentice with the other system. This authData needs to be consistent on every request.
healthcheck_on_timeoutRequired. Defines if the adapter should run a health check on timeout. If set to true, the adapter will abort the request and run a health check until it re-establishes connectivity and then it will re-attempt the request.
return_rawOptional. Tells the adapter whether the raw response should be returned as well as the IAP response. This is helpful when running integration tests to save mock data. It does add overhead to the response object so it is not ideal from production.
archivingOptional flag. Default is false. It archives the request, the results and the various times (wait time, Accedian_skylight time and overall time) in the `adapterid_results` collection in MongoDB. Although archiving might be desirable, be sure to develop a strategy before enabling this capability. Consider how much to archive and what strategy to use for cleaning up the collection in the database so that it does not become too large, especially if the responses are large.
return_requestOptional flag. Default is false. Will return the actual request that is made including headers. This should only be used during debugging issues as there could be credentials in the actual request.

SSL Properties

The SSL section defines the properties utilized for ssl authentication with Accedian_skylight. SSL can work two different ways: set the accept\_invalid\_certs flag to true (only recommended for lab environments), or provide a ca\_file.

PropertyDescription
enabledIf SSL is required, set to true.
accept_invalid_certsDefines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false.
ca_fileDefines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required.
key_fileDefines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL.
cert_fileDefines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL.
secure_protocolDefines the protocol (e.g., SSLv3_method) to use on the SSL request.
ciphersRequired if SSL enabled. Specifies a list of SSL ciphers to use.
ecdhCurveDuring testing on some Node 8 environments, you need to set `ecdhCurve` to auto. If you do not, you will receive PROTO errors when attempting the calls. This is the only usage of this property and to our knowledge it only impacts Node 8 and 9.

Throttle Properties

The throttle section is used when requests to Accedian_skylight must be queued (throttled). All of the properties in this section are optional.

PropertyDescription
throttle_enabledDefault is false. Defines if the adapter should use throttling or not.
number_pronghornsDefault is 1. Defines if throttling is done in a single Itential instance or whether requests are being throttled across multiple Itential instances (minimum = 1, maximum = 20). Throttling in a single Itential instance uses an in-memory queue so there is less overhead. Throttling across multiple Itential instances requires placing the request and queue information into a shared resource (e.g. database) so that each instance can determine what is running and what is next to run. Throttling across multiple instances requires additional I/O overhead.
sync-asyncThis property is not used at the current time (it is for future expansion of the throttling engine).
max_in_queueRepresents the maximum number of requests the adapter should allow into the queue before rejecting requests (minimum = 1, maximum = 5000). This is not a limit on what the adapter can handle but more about timely responses to requests. The default is currently 1000.
concurrent_maxDefines the number of requests the adapter can send to Accedian_skylight at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to Accedian_skylight in a serial manner.
expire_timeoutDefault is 0. Defines a graceful timeout of the request session. After a request has completed, the adapter will wait additional time prior to sending the next request. Measured in milliseconds (minimum = 0, maximum = 60000).
average_runtimeRepresents the approximate average of how long it takes Accedian_skylight to handle each request. Measured in milliseconds (minimum = 50, maximum = 60000). Default is 200. This metric has performance implications. If the runtime number is set too low, it puts extra burden on the CPU and memory as the requests will continually try to run. If the runtime number is set too high, requests may wait longer than they need to before running. The number does not need to be exact but your throttling strategy depends heavily on this number being within reason. If averages range from 50 to 250 milliseconds you might pick an average run-time somewhere in the middle so that when Accedian_skylight performance is exceptional you might run a little slower than you might like, but when it is poor you still run efficiently.
prioritiesAn array of priorities and how to handle them in relation to the throttle queue. Array of objects that include priority value and percent of queue to put the item ex { value: 1, percent: 10 }

Proxy Properties

The proxy section defines the properties to utilize when Accedian_skylight is behind a proxy server.

PropertyDescription
enabledRequired. Default is false. If Accedian_skylight is behind a proxy server, set enabled flag to true.
hostHost information for the proxy server. Required if `enabled` is true.
portPort information for the proxy server. Required if `enabled` is true.
protocolThe protocol (i.e., http, https, etc.) used to connect to the proxy. Default is http.
usernameIf there is authentication for the proxy, provide the username here.
passwordIf there is authentication for the proxy, provide the password here.

Mongo Properties

The mongo section defines the properties used to connect to a Mongo database. Mongo can be used for throttling as well as to persist metric data. If not provided, metrics will be stored in the file system.

PropertyDescription
hostOptional. Host information for the mongo server.
portOptional. Port information for the mongo server.
databaseOptional. The database for the adapter to use for its data.
usernameOptional. If credentials are required to access mongo, this is the user to login as.
passwordOptional. If credentials are required to access mongo, this is the password to login with.
replSetOptional. If the database is set up to use replica sets, define it here so it can be added to the database connection.
db_sslOptional. Contains information for SSL connectivity to the database.
db_ssl -> enabledIf SSL is required, set to true.
db_ssl -> accept_invalid_certDefines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false.
db_ssl -> ca_fileDefines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required.
db_ssl -> key_fileDefines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL.
db_ssl -> cert_fileDefines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL.

Device Broker Properties

The device broker section defines the properties used integrate Accedian_skylight to the device broker. Each broker call is represented and has an array of calls that can be used to build the response. This describes the calls and then the fields which are available in the calls.

PropertyDescription
getDeviceThe array of calls used to get device details for the broker
getDevicesFilteredThe array of calls used to get devices for the broker
isAliveThe array of calls used to get device status for the broker
getConfigThe array of calls used to get device configuration for the broker
getCountThe array of calls used to get device configuration for the broker
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> pathThe path, not including the base_path and version, for making this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> methodThe rest method for making this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> queryQuery object containing and query parameters and their values for this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> bodyBody object containing the payload for this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> headersHeader object containing the headers for this call.
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> handleFailureTells the adapter whether to "fail" or "ignore" failures if they occur.
isAlive -> statusValueTells the adapter what value to look for in the status field to determine if the device is alive.
getDevice/getDevicesFiltered/isAlive/getConfig -> requestFieldsObject containing fields the adapter should send on the request and where it should get the data. The where can be from a response to a getDevicesFiltered or a static value.
getDevice/getDevicesFiltered/isAlive/getConfig -> responseFieldsObject containing fields the adapter should set to send back to iap and where the value should come from in the response or request data.

Using this Adapter

The adapter.js file contains the calls the adapter makes available to the rest of the Itential Platform. The API detailed for these calls should be available through JSDOC. The following is a brief summary of the calls.

Generic Adapter Calls

These are adapter methods that IAP or you might use. There are some other methods not shown here that might be used for internal adapter functionality.

Method SignatureDescriptionWorkflow?
connect()This call is run when the Adapter is first loaded by he Itential Platform. It validates the properties have been provided correctly.No
healthCheck(callback)This call ensures that the adapter can communicate with Adapter for Accedian Skylight. The actual call that is used is defined in the adapter properties and .system entities action.json file.No
refreshProperties(properties)This call provides the adapter the ability to accept property changes without having to restart the adapter.No
encryptProperty(property, technique, callback)This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for Accedian Skylight.No
iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback)This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.Yes
iapSuspendAdapter(mode, callback)This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.Yes
iapUnsuspendAdapter(callback)This call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests.Yes
iapGetAdapterQueue(callback)This call will return the requests that are waiting in the queue if throttling is enabled.Yes
iapFindAdapterPath(apiPath, callback)This call provides the ability to see if a particular API path is supported by the adapter.Yes
iapTroubleshootAdapter(props, persistFlag, adapter, callback)This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.Yes
iapRunAdapterHealthcheck(adapter, callback)This call will return the results of a healthcheck.Yes
iapRunAdapterConnectivity(callback)This call will return the results of a connectivity check.Yes
iapRunAdapterBasicGet(callback)This call will return the results of running basic get API calls.Yes
iapMoveAdapterEntitiesToDB(callback)This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.Yes
iapDeactivateTasks(tasks, callback)This call provides the ability to remove tasks from the adapter.Yes
iapActivateTasks(tasks, callback)This call provides the ability to add deactivated tasks back into the adapter.Yes
iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.Yes
genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.Yes
genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)This call is the same as the genericAdapterRequest only it does not add a base_path or version to the call.Yes
iapRunAdapterLint(callback)Runs lint on the addapter and provides the information back.Yes
iapRunAdapterTests(callback)Runs baseunit and unit tests on the adapter and provides the information back.Yes
iapGetAdapterInventory(callback)This call provides some inventory related information about the adapter.Yes

Adapter Cache Calls

These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.

Method SignatureDescriptionWorkflow?
iapPopulateEntityCache(entityTypes, callback)This call populates the adapter cache.Yes
iapRetrieveEntitiesCache(entityType, options, callback)This call retrieves the specific items from the adapter cache.Yes

Adapter Broker Calls

These are adapter methods that are used to integrate to IAP Brokers. This adapter currently supports the following broker calls.

Method SignatureDescriptionWorkflow?
hasEntities(entityType, entityList, callback)This call is utilized by the IAP Device Broker to determine if the adapter has a specific entity and item of the entity.No
getDevice(deviceName, callback)This call returns the details of the requested device.No
getDevicesFiltered(options, callback)This call returns the list of devices that match the criteria provided in the options filter.No
isAlive(deviceName, callback)This call returns whether the device status is activeNo
getConfig(deviceName, format, callback)This call returns the configuration for the selected device.No
iapGetDeviceCount(callback)This call returns the count of devices.No

Specific Adapter Calls

Specific adapter calls are built based on the API of the Accedian Skylight. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls.

Method SignatureDescriptionPathWorkflow?
getEndpoints(callback)Get endpoints{base_path}/{version}/endpoint?{query}Yes
deleteEndpoint(id, callback)Delete endpoint{base_path}/{version}/endpoint/{pathv1}?{query}Yes
alterEndpointDescription(id, description, callback)Alter endpoint description.{base_path}/{version}/endpoint/{pathv1}/description?{query}Yes
getEndpointInformation(id, callback)Get information about a endpoint (EndpointHead).{base_path}/{version}/endpoint/{pathv1}/endpointhead?{query}Yes
changeNameOfEndpoint(id, name, callback)Change name of endpoint.{base_path}/{version}/endpoint/{pathv1}/name?{query}Yes
operationOnEndpoint(id, action, callback)Operation on endpoint{base_path}/{version}/endpoint/{pathv1}/operate?{query}Yes
getInformationOnEndpointsByType(type, callback)Get information on all endpoints of given type.{base_path}/{version}/endpoint/type/{pathv1}?{query}Yes
createNewReflectorEndpoint(body, callback)Create a new unmanaged reflector endpoint.{base_path}/{version}/endpoint/reflector?{query}Yes
getReflectorEndpointByName(id, callback)Get reflector endpoint parameters by name (id).{base_path}/{version}/endpoint/reflector/{pathv1}?{query}Yes
changeIpAddressUnmanagedEndpoint(id, ipAddress, callback)Change ip address of terminated/unresolved unmanaged endpoint.{base_path}/{version}/endpoint/reflector/{pathv1}/address?{query}Yes
changeCapabilityUnmanagedEndpoint(id, capabilities, callback)Change capability of unmanaged endpoint.{base_path}/{version}/endpoint/reflector/{pathv1}/capability?{query}Yes
getReflectorEndpointByMAC(id, callback)Get reflector endpoint parameters by mac.{base_path}/{version}/endpoint/reflector/{pathv1}/mac?{query}Yes
changeTwampControlProtocolSettings(id, twampCp, callback)Change Twamp control protocol settings of unmanaged endpoint.{base_path}/{version}/endpoint/reflector/{pathv1}/twampcp?{query}Yes
deleteTwampCp(id, callback)Delete twamp cp.{base_path}/{version}/endpoint/reflector/{pathv1}/twampcp?{query}Yes
createSupervisonEndpoint(body, callback)Create a new supervision endpoint.{base_path}/{version}/endpoint/supervision?{query}Yes
getSupervisionEndpointByName(id, callback)Get supervision endpoint parameters by name (id).{base_path}/{version}/endpoint/supervision/{pathv1}?{query}Yes
getSessionInformation(callback)Get information (SessionHead) on all nodes.{base_path}/{version}/session?{query}Yes
deleteSession(id, callback)Delete a session.{base_path}/{version}/session/{pathv1}?{query}Yes
alterSessionDescription(id, description, callback)Alter session description.{base_path}/{version}/session/{pathv1}/description?{query}Yes
getSessionHeadInformationByName(id, callback)Get information (SessionHead) by name (id).{base_path}/{version}/session/{pathv1}/head?{query}Yes
getSessionLastRR(id, callback)Get last RR.{base_path}/{version}/session/{pathv1}/lastrr?{query}Yes
alterTerminatedNotResolvedSessionName(id, body, callback)Alter a Terminated or NotResolved session name.{base_path}/{version}/session/{pathv1}/name?{query}Yes
operationOnSession(id, action, callback)Operation on session.{base_path}/{version}/session/{pathv1}/operate?{query}Yes
alterTerminatedNotResolvedSessionStream(id, stream, callback)Alter Terminated or NotResolved session stream.{base_path}/{version}/session/{pathv1}/stream?{query}Yes
createEchoSession(body, callback)Create a new ECHO session.{base_path}/{version}/session/echo?{query}Yes
getEchoSessionInformation(id, callback)Get information about a ECHO session.{base_path}/{version}/session/echo/{pathv1}?{query}Yes
createEthOamSession(body, callback)Create a new eth-oam session.{base_path}/{version}/session/ethoam?{query}Yes
getEthOamSessionInformation(id, callback)Get information about a eth-oam session.{base_path}/{version}/session/ethoam/{pathv1}?{query}Yes
createTWAMPSession(body, callback)Create a new TWAMP session.{base_path}/{version}/session/twamp?{query}Yes
getTWAMPSessionInformation(id, callback)Get information about a TWAMP session.{base_path}/{version}/session/twamp/{pathv1}?{query}Yes
createSLA(body, callback)Create a new SLA.{base_path}/{version}/sla?{query}Yes
getSLAs(callback)Get all SLAs{base_path}/{version}/sla?{query}Yes
deleteSLA(id, callback)Delete a SLA{base_path}/{version}/sla/{pathv1}?{query}Yes
putSessionReferenceToSLA(id, sessionRef, callback)Put session reference to SLA.{base_path}/{version}/sla/{pathv1}/session?{query}Yes
getSessionReferencesForSLA(id, callback)Get all session references for sla.{base_path}/{version}/sla/{pathv1}/session?{query}Yes
deleteSessionReferenceFromSLA(id, ref, callback)Delete a session reference from a sla.{base_path}/{version}/sla/{pathv1}/session/{pathv2}?{query}Yes
getSystemVersion(callback)System Version{base_path}/{version}/version?{query}Yes
getApiOrchestrateV3Agents(page, limit, callback)Retrieve all agents{base_path}/{version}/orchestrate/v3/agents?{query}Yes
getApiOrchestrateV3AgentsAgentId(agentId, callback)Retrieve an agent by agentId.{base_path}/{version}/orchestrate/v3/agents/{pathv1}?{query}Yes
deleteApiOrchestrateV3AgentsAgentId(agentId, callback)Delete an agent specified by the provided agentId.{base_path}/{version}/orchestrate/v3/agents/{pathv1}?{query}Yes
postApiOrchestrateV3AgentsConfiguration(page, limit, body, callback)Create an agent configuration{base_path}/{version}/orchestrate/v3/agents/configuration?{query}Yes
getApiOrchestrateV3AgentsConfiguration(page, limit, callback)Retrieve all agent configurations{base_path}/{version}/orchestrate/v3/agents/configuration?{query}Yes
getApiOrchestrateV3AgentsConfigurationAgentId(agentId, callback)Retrieve an agent configuration by agentId.{base_path}/{version}/orchestrate/v3/agents/configuration/{pathv1}?{query}Yes
putApiOrchestrateV3AgentsConfigurationAgentId(agentId, body, callback)Update an agent configuration specified by the provided agentId.{base_path}/{version}/orchestrate/v3/agents/configuration/{pathv1}?{query}Yes
deleteApiOrchestrateV3AgentsConfigurationAgentId(agentId, callback)Delete an agent configuration specified by the provided agentId.{base_path}/{version}/orchestrate/v3/agents/configuration/{pathv1}?{query}Yes
postApiOrchestrateV3AgentsAgentIdCommand(agentId, body, callback)Sends a given command to be run for the agent specified by agentId{base_path}/{version}/orchestrate/v3/agents/{pathv1}/command?{query}Yes
getApiOrchestrateV3AgentsSessions(page, limit, callback)Retrieve all sessions{base_path}/{version}/orchestrate/v3/agents/sessions?{query}Yes
postApiOrchestrateV3AgentsSessions(page, limit, body, callback)Create agent sessions{base_path}/{version}/orchestrate/v3/agents/sessions?{query}Yes
postApiOrchestrateV3AgentsSession(body, callback)Create an agent session{base_path}/{version}/orchestrate/v3/agents/session?{query}Yes
putApiOrchestrateV3AgentsSession(body, callback)Update an agent session.{base_path}/{version}/orchestrate/v3/agents/session?{query}Yes
getApiOrchestrateV3AgentsSessionSessionId(sessionId, callback)Retrieve an agent session by sessionId.{base_path}/{version}/orchestrate/v3/agents/session/{pathv1}?{query}Yes
deleteApiOrchestrateV3AgentsSessionSessionId(sessionId, callback)Delete an agent session by sessionId.{base_path}/{version}/orchestrate/v3/agents/session/{pathv1}?{query}Yes
getApiOrchestrateV3AgentsSessionsAgentId(agentId, callback)Retrieve agent sessions by agentId.{base_path}/{version}/orchestrate/v3/agents/sessions/{pathv1}?{query}Yes
deleteApiOrchestrateV3AgentsSessionsAgentId(agentId, callback)Delete all sessions for the provided agentId.{base_path}/{version}/orchestrate/v3/agents/sessions/{pathv1}?{query}Yes
getApiOrchestrateV3AgentsSessionstatusSessionId(sessionId, callback)Retrieves the session status for session with sessionId{base_path}/{version}/orchestrate/v3/agents/sessionstatus/{pathv1}?{query}Yes
postApiOrchestrateV3AgentsAgentIdSecrets(agentId, callback)Generates and returns the agent secrets required to start an agent{base_path}/{version}/orchestrate/v3/agents/{pathv1}/secrets?{query}Yes
openIDConfiguration(clientName, callback)OpenIDConfiguration{base_path}/{version}/openid-configuration/{pathv1}?{query}Yes
openIDToken(clientName, grantType = 'authorization_code', code, clientId, clientSecret, callback)OpenIDToken{base_path}/{version}/openid-token/{pathv1}?{query}Yes
openIDAuth(clientId, redirectUri, responseType, state, delegatedclientid, scope, callback)OpenIDAuth{base_path}/{version}/openid-auth?{query}Yes
samlRedirect(clientName, callback)SamlRedirect{base_path}/{version}/saml-redirect?{query}Yes
samlCallback(sAMLResponse, relayState, callback)SamlCallback{base_path}/{version}/saml-callback?{query}Yes
samlSpMetadata(clientName, callback)SamlSpMetadata{base_path}/{version}/saml-metadata/{pathv1}?{query}Yes
createGrantingTicket(username, password, service = 'https://cas.local/aastubs/', callback)CreateGrantingTicket{base_path}/{version}/v1/grant?{query}Yes
createServiceTicket(grantingTicket, service = 'https://cas.local/aastubs/', callback)CreateServiceTicket{base_path}/{version}/v1/service?{query}Yes
validateServiceTicket(ticket, service = 'https://cas.local/aastubs/', format = 'JSON', callback)ValidateServiceTicket{base_path}/{version}/v1/validate?{query}Yes
createUser(body, callback)CreateUser{base_path}/{version}/v1/auth/users?{query}Yes
getAllUsers(callback)GetAllUsers{base_path}/{version}/v1/auth/users?{query}Yes
updateUser(userId, body, callback)UpdateUser{base_path}/{version}/v1/auth/users/{pathv1}?{query}Yes
updateUserProperties(userId, body, callback)UpdateUserProperties{base_path}/{version}/v1/auth/users/{pathv1}?{query}Yes
getUser(userId, callback)GetUser{base_path}/{version}/v1/auth/users/{pathv1}?{query}Yes
deleteUser(userId, callback)DeleteUser{base_path}/{version}/v1/auth/users/{pathv1}?{query}Yes
resetPassword(userId, callback)ResetPassword{base_path}/{version}/v1/auth/users/{pathv1}/password?{query}Yes
changeEmailAddress(userId, body, callback)ChangeEmailAddress{base_path}/{version}/v1/auth/users/{pathv1}/email?{query}Yes
updateAuthenticatedUserProperties(body, callback)UpdateAuthenticatedUserProperties{base_path}/{version}/v1/auth/me?{query}Yes
getAuthenticatedUser(callback)GetAuthenticatedUser{base_path}/{version}/v1/auth/me?{query}Yes
deleteAuthenticatedUser(callback)DeleteAuthenticatedUser{base_path}/{version}/v1/auth/me?{query}Yes
updateAuthenticatedUserPassword(body, callback)UpdateAuthenticatedUserPassword{base_path}/{version}/v1/auth/me/password?{query}Yes
changeAuthenticatedUserEmailAddress(body, callback)ChangeAuthenticatedUserEmailAddress{base_path}/{version}/v1/auth/me/email?{query}Yes
getUserByToken(onboardingToken, callback)GetUserByToken{base_path}/{version}/v1/onboarding/{pathv1}?{query}Yes
setUserPassword(body, callback)SetUserPassword{base_path}/{version}/v1/onboarding/password?{query}Yes
login(username, password, token, callback)Login{base_path}/{version}/v1/auth/login?{query}Yes
logout(callback)Logout{base_path}/{version}/v1/auth/logout?{query}Yes
validate(callback)Validate{base_path}/{version}/v1/auth/session?{query}Yes
validateSessionForProxy(callback)ValidateSessionForProxy{base_path}/{version}/v1/auth/validate?{query}Yes
createService(serviceName, username, password, callback)CreateService{base_path}/{version}/v1/auth/service?{query}Yes
getTenantInfo(callback)GetTenantInfo{base_path}/{version}/v1/onboarding/tenant-info?{query}Yes
setTenantIdentity(body, callback)SetTenantIdentity{base_path}/{version}/v1/onboarding/tenant-identity?{query}Yes
deleteTenantIdentity(subdomain, callback)DeleteTenantIdentity{base_path}/{version}/v1/onboarding/tenant-identity?{query}Yes
createToken(body, callback)CreateToken{base_path}/{version}/v1/auth/tokens?{query}Yes
getAllTokens(callback)GetAllTokens{base_path}/{version}/v1/auth/tokens?{query}Yes
getToken(tokenId, callback)GetToken{base_path}/{version}/v1/auth/tokens/{pathv1}?{query}Yes
updateToken(tokenId, body, callback)UpdateToken{base_path}/{version}/v1/auth/tokens/{pathv1}?{query}Yes
deleteToken(tokenId, callback)DeleteToken{base_path}/{version}/v1/auth/tokens/{pathv1}?{query}Yes
getAuthenticationMethod(emailAddress, callback)GetAuthenticationMethod{base_path}/{version}/v1/auth/method/{pathv1}?{query}Yes
createUsergroup(body, callback)CreateUsergroup{base_path}/{version}/v1/auth/usergroups?{query}Yes
getAllUsergroups(callback)GetAllUsergroups{base_path}/{version}/v1/auth/usergroups?{query}Yes
getUsergroup(usergroupId, callback)GetUsergroup{base_path}/{version}/v1/auth/usergroups/{pathv1}?{query}Yes
updateUsergroup(usergroupId, body, callback)UpdateUsergroup{base_path}/{version}/v1/auth/usergroups/{pathv1}?{query}Yes
deleteUsergroup(usergroupId, callback)DeleteUsergroup{base_path}/{version}/v1/auth/usergroups/{pathv1}?{query}Yes
createRole(body, callback)CreateRole{base_path}/{version}/v1/auth/roles?{query}Yes
getAllRoles(callback)GetAllRoles{base_path}/{version}/v1/auth/roles?{query}Yes
getRole(roleId, callback)GetRole{base_path}/{version}/v1/auth/roles/{pathv1}?{query}Yes
updateRole(roleId, body, callback)UpdateRole{base_path}/{version}/v1/auth/roles/{pathv1}?{query}Yes
deleteRole(roleId, callback)DeleteRole{base_path}/{version}/v1/auth/roles/{pathv1}?{query}Yes
createPermission(body, callback)CreatePermission{base_path}/{version}/v1/auth/permissions?{query}Yes
getAllPermissions(domains, app, callback)GetAllPermissions{base_path}/{version}/v1/auth/permissions?{query}Yes
getPermission(permissionId, callback)GetPermission{base_path}/{version}/v1/auth/permissions/{pathv1}?{query}Yes
updatePermission(permissionId, body, callback)UpdatePermission{base_path}/{version}/v1/auth/permissions/{pathv1}?{query}Yes
deletePermission(permissionId, callback)DeletePermission{base_path}/{version}/v1/auth/permissions/{pathv1}?{query}Yes
createScheduledExport(body, callback)CreateScheduledExport{base_path}/{version}/v1/export/configurations?{query}Yes
getAllExportConfigurations(includeDoc, rawMetadataKey, enabled, callback)GetAllExportConfigurations{base_path}/{version}/v1/export/configurations?{query}Yes
getExportConfiguration(confId, rawMetadataKey, callback)GetExportConfiguration{base_path}/{version}/v1/export/configurations/{pathv1}?{query}Yes
patchExportConfiguration(confId, body, callback)PatchExportConfiguration{base_path}/{version}/v1/export/configurations/{pathv1}?{query}Yes
disableExportConfiguration(confId, callback)DisableExportConfiguration{base_path}/{version}/v1/export/configurations/{pathv1}?{query}Yes
getAllExportReport(confId, callback)GetAllExportReport{base_path}/{version}/v1/export/{pathv1}/reports?{query}Yes
getExportReport(confId, fileName, callback)GetExportReport{base_path}/{version}/v1/export/{pathv1}/report/{pathv2}?{query}Yes
getSolutionManifest(callback)GetSolutionManifest{base_path}/{version}/v1/solution-version-manifest?{query}Yes
createTimeExclusion(body, callback)CreateTimeExclusion{base_path}/{version}/v3/twe?{query}Yes
getAllTimeExclusion(callback)GetAllTimeExclusion{base_path}/{version}/v3/twe?{query}Yes
updateTimeExclusion(id, body, callback)UpdateTimeExclusion{base_path}/{version}/v3/twe/{pathv1}?{query}Yes
getTimeExclusion(id, callback)GetTimeExclusion{base_path}/{version}/v3/twe/{pathv1}?{query}Yes
deleteTimeExclusion(id, callback)DeleteTimeExclusion{base_path}/{version}/v3/twe/{pathv1}?{query}Yes
timeExclusionEvents(start, end, monitoredObjectID, callback)TimeExclusionEvents{base_path}/{version}/v3/twe/events?{query}Yes
createTenantV2(body, callback)CreateTenantV2{base_path}/{version}/v2/tenants?{query}Yes
getAllTenantsV2(callback)GetAllTenantsV2{base_path}/{version}/v2/tenants?{query}Yes
getTenantV2(tenantId, callback)GetTenantV2{base_path}/{version}/v2/tenants/{pathv1}?{query}Yes
deleteTenantV2(tenantId, callback)DeleteTenantV2{base_path}/{version}/v2/tenants/{pathv1}?{query}Yes
patchTenantV2(tenantId, body, callback)PatchTenantV2{base_path}/{version}/v2/tenants/{pathv1}?{query}Yes
getTenantIdByAliasV2(value, callback)GetTenantIdByAliasV2{base_path}/{version}/v2/tenant-by-alias/{pathv1}?{query}Yes
getTenantSummaryByAliasV2(value, callback)GetTenantSummaryByAliasV2{base_path}/{version}/v2/tenant-summary-by-alias/{pathv1}?{query}Yes
getIngestionDictionaryV2(callback)GetIngestionDictionaryV2{base_path}/{version}/v2/ingestion-dictionaries?{query}Yes
getValidTypesV2(callback)GetValidTypesV2{base_path}/{version}/v2/valid-types?{query}Yes
getTenantMetadataV2(tenantId, callback)GetTenantMetadataV2{base_path}/{version}/v2/tenant-metadata/{pathv1}?{query}Yes
updateTenantMetadataV2(tenantId, body, callback)UpdateTenantMetadataV2{base_path}/{version}/v2/tenant-metadata/{pathv1}?{query}Yes
getAlertsForMonitoredObject(monitoredObjectId, interval, alertState = 'raised', policyId, callback)getAlertsForMonitoredObject{base_path}/{version}/v2/alerts/monitoredObjectIds/{pathv1}?{query}Yes
getActiveAlertsForMonitoredObject(monitoredObjectId, policyId, callback)getActiveAlertsForMonitoredObject{base_path}/{version}/v2/alerts/active/monitoredObjectIds/{pathv1}?{query}Yes
deleteActiveAlertsForMonitoredObject(monitoredObjectId, policyId, callback)deleteActiveAlertsForMonitoredObject{base_path}/{version}/v2/alerts/active/monitoredObjectIds/{pathv1}?{query}Yes
createActiveAlertForMonitoredObject(body, callback)createActiveAlertForMonitoredObject{base_path}/{version}/v2/alerts/active/monitoredObjectIds?{query}Yes
getActiveAlertsForPolicy(policyId, callback)getActiveAlertsForPolicy{base_path}/{version}/v2/alerts/active/policies/{pathv1}?{query}Yes
deleteActiveAlertsForPolicy(policyId, monitoredObjectId, callback)deleteActiveAlertsForPolicy{base_path}/{version}/v2/alerts/active/policies/{pathv1}?{query}Yes
getActiveAlertGroupBy(body, callback)getActiveAlertGroupBy{base_path}/{version}/v2/alerts/active/groupBy?{query}Yes
getActiveAlertsForMetaFilter(body, callback)getActiveAlertsForMetaFilter{base_path}/{version}/v2/alerts/active?{query}Yes
getActiveAlertsFilteredCounts(body, callback)getActiveAlertsFilteredCounts{base_path}/{version}/v2/alerts/active/count?{query}Yes
updateActiveAlertsSecurityState(body, callback)updateActiveAlertsSecurityState{base_path}/{version}/v2/alerts/active/securityState?{query}Yes
createRequestAlertPolicy(body, callback)createRequestAlertPolicy{base_path}/{version}/v2/policies/alerting?{query}Yes
getAllRequestAlertPolicy(useRawMetaKey, includeDeleted, policyType, callback)getAllRequestAlertPolicy{base_path}/{version}/v2/policies/alerting?{query}Yes
patchAutomaticAlertPolicy(body, callback)patchAutomaticAlertPolicy{base_path}/{version}/v2/policies/alerting/automatic?{query}Yes
getAutomaticAlertPolicy(callback)getAutomaticAlertPolicy{base_path}/{version}/v2/policies/alerting/automatic?{query}Yes
getRequestAlertPolicy(id, useRawMetaKey, callback)getRequestAlertPolicy{base_path}/{version}/v2/policies/alerting/{pathv1}?{query}Yes
deleteRequestAlertPolicy(id, callback)deleteRequestAlertPolicy{base_path}/{version}/v2/policies/alerting/{pathv1}?{query}Yes
patchRequestAlertPolicy(id, force = 'false', body, callback)PatchRequestAlertPolicy{base_path}/{version}/v2/policies/alerting/{pathv1}?{query}Yes
getAlertPolicyHistory(policyId, interval, monitoredObjectId, alertState = 'raised', policyType = 'micro-tca', limit, useRawMetaKey, category, callback)getAlertPolicyHistory{base_path}/{version}/v2/alerts/history/?{query}Yes
getAlertingGroupByV3(body, callback)GetAlertingGroupByV3{base_path}/{version}/v2/alerting/groupBy?{query}Yes
getAlertingAggregateV3(body, callback)GetAlertingAggregateV3{base_path}/{version}/v2/alerting/aggregate?{query}Yes
getRamenState(tenantId, callback)getRamenState{base_path}/{version}/v2/ramen/state/{pathv1}?{query}Yes
createAnalyticsV2(body, callback)CreateAnalyticsV2{base_path}/{version}/v2/analytics?{query}Yes
getAllAnalyticsV2(callback)GetAllAnalyticsV2{base_path}/{version}/v2/analytics?{query}Yes
getAnalyticsV2(analyticsId, callback)GetAnalyticsV2{base_path}/{version}/v2/analytics/{pathv1}?{query}Yes
deleteAnalyticsV2(analyticsId, callback)DeleteAnalyticsV2{base_path}/{version}/v2/analytics/{pathv1}?{query}Yes
createBrandingV2(body, callback)CreateBrandingV2{base_path}/{version}/v2/brandings?{query}Yes
getAllBrandingsV2(zone, callback)GetAllBrandingsV2{base_path}/{version}/v2/brandings?{query}Yes
getBrandingV2(brandingId, callback)GetBrandingV2{base_path}/{version}/v2/brandings/{pathv1}?{query}Yes
updateBrandingV2(brandingId, body, callback)UpdateBrandingV2{base_path}/{version}/v2/brandings/{pathv1}?{query}Yes
deleteBrandingV2(brandingId, callback)DeleteBrandingV2{base_path}/{version}/v2/brandings/{pathv1}?{query}Yes
createLocaleV2(body, callback)CreateLocaleV2{base_path}/{version}/v2/locales?{query}Yes
getAllLocalesV2(callback)GetAllLocalesV2{base_path}/{version}/v2/locales?{query}Yes
getLocaleV2(localeId, callback)GetLocaleV2{base_path}/{version}/v2/locales/{pathv1}?{query}Yes
updateLocaleV2(localeId, body, callback)UpdateLocaleV2{base_path}/{version}/v2/locales/{pathv1}?{query}Yes
deleteLocaleV2(localeId, callback)DeleteLocaleV2{base_path}/{version}/v2/locales/{pathv1}?{query}Yes
createCompositeMetricV2(body, callback)CreateCompositeMetricV2{base_path}/{version}/v2/composite-metrics?{query}Yes
getAllCompositeMetricsV2(callback)GetAllCompositeMetricsV2{base_path}/{version}/v2/composite-metrics?{query}Yes
getCompositeMetricV2(compositeMetricId, callback)GetCompositeMetricV2{base_path}/{version}/v2/composite-metrics/{pathv1}?{query}Yes
updateCompositeMetricV2(compositeMetricId, body, callback)UpdateCompositeMetricV2{base_path}/{version}/v2/composite-metrics/{pathv1}?{query}Yes
deleteCompositeMetricV2(compositeMetricId, callback)DeleteCompositeMetricV2{base_path}/{version}/v2/composite-metrics/{pathv1}?{query}Yes
createConnectorConfigV2(body, callback)CreateConnectorConfigV2{base_path}/{version}/v2/connector-configs?{query}Yes
getAllConnectorConfigsV2(zone, callback)GetAllConnectorConfigsV2{base_path}/{version}/v2/connector-configs?{query}Yes
getConnectorConfigV2(connectorId, callback)GetConnectorConfigV2{base_path}/{version}/v2/connector-configs/{pathv1}?{query}Yes
updateConnectorConfigV2(connectorId, body, callback)UpdateConnectorConfigV2{base_path}/{version}/v2/connector-configs/{pathv1}?{query}Yes
deleteConnectorConfigV2(connectorId, callback)DeleteConnectorConfigV2{base_path}/{version}/v2/connector-configs/{pathv1}?{query}Yes
createConnectorInstanceV2(body, callback)CreateConnectorInstanceV2{base_path}/{version}/v2/connector-instances?{query}Yes
getAllConnectorInstancesV2(callback)GetAllConnectorInstancesV2{base_path}/{version}/v2/connector-instances?{query}Yes
getConnectorInstanceV2(connectorInstanceId, callback)GetConnectorInstanceV2{base_path}/{version}/v2/connector-instances/{pathv1}?{query}Yes
updateConnectorInstanceV2(connectorInstanceId, body, callback)UpdateConnectorInstanceV2{base_path}/{version}/v2/connector-instances/{pathv1}?{query}Yes
deleteConnectorInstanceV2(connectorInstanceId, callback)DeleteConnectorInstanceV2{base_path}/{version}/v2/connector-instances/{pathv1}?{query}Yes
createDashboardV2(body, callback)CreateDashboardV2{base_path}/{version}/v2/dashboards?{query}Yes
getAllDashboardsV2(zone, callback)GetAllDashboardsV2{base_path}/{version}/v2/dashboards?{query}Yes
getDashboardV2(dashboardId, callback)GetDashboardV2{base_path}/{version}/v2/dashboards/{pathv1}?{query}Yes
updateDashboardV2(dashboardId, body, callback)UpdateDashboardV2{base_path}/{version}/v2/dashboards/{pathv1}?{query}Yes
deleteDashboardV2(dashboardId, callback)DeleteDashboardV2{base_path}/{version}/v2/dashboards/{pathv1}?{query}Yes
createCardV2(body, callback)CreateCardV2{base_path}/{version}/v2/cards?{query}Yes
getAllCardsV2(zone, callback)GetAllCardsV2{base_path}/{version}/v2/cards?{query}Yes
getCardV2(cardId, callback)GetCardV2{base_path}/{version}/v2/cards/{pathv1}?{query}Yes
updateCardV2(cardId, body, callback)UpdateCardV2{base_path}/{version}/v2/cards/{pathv1}?{query}Yes
deleteCardV2(cardId, callback)DeleteCardV2{base_path}/{version}/v2/cards/{pathv1}?{query}Yes
createDataCleaningProfile(body, callback)CreateDataCleaningProfile{base_path}/{version}/v2/data-cleaning-profiles?{query}Yes
getDataCleaningProfiles(callback)GetDataCleaningProfiles{base_path}/{version}/v2/data-cleaning-profiles?{query}Yes
getDataCleaningProfile(profileId, callback)GetDataCleaningProfile{base_path}/{version}/v2/data-cleaning-profiles/{pathv1}?{query}Yes
updateDataCleaningProfile(profileId, body, callback)UpdateDataCleaningProfile{base_path}/{version}/v2/data-cleaning-profiles/{pathv1}?{query}Yes
deleteDataCleaningProfile(profileId, callback)DeleteDataCleaningProfile{base_path}/{version}/v2/data-cleaning-profiles/{pathv1}?{query}Yes
getDataCleaningHistory(monitoredObjectId, interval, callback)GetDataCleaningHistory{base_path}/{version}/v2/data-cleaning-history?{query}Yes
downloadRoadrunner(zone, callback)DownloadRoadrunner{base_path}/{version}/v2/distribution/download-roadrunner?{query}Yes
createIngestionProfileV2(body, callback)CreateIngestionProfileV2{base_path}/{version}/v2/ingestion-profiles?{query}Yes
getAllIngestionProfilesV2(callback)GetAllIngestionProfilesV2{base_path}/{version}/v2/ingestion-profiles?{query}Yes
getIngestionProfileV2(ingestionProfileId, callback)GetIngestionProfileV2{base_path}/{version}/v2/ingestion-profiles/{pathv1}?{query}Yes
updateIngestionProfileV2(ingestionProfileId, body, callback)UpdateIngestionProfileV2{base_path}/{version}/v2/ingestion-profiles/{pathv1}?{query}Yes
deleteIngestionProfileV2(ingestionProfileId, callback)DeleteIngestionProfileV2{base_path}/{version}/v2/ingestion-profiles/{pathv1}?{query}Yes
createMetadataConfigV2(body, callback)CreateMetadataConfigV2{base_path}/{version}/v2/metadata-configs?{query}Yes
getAllMetadataConfigsV2(callback)GetAllMetadataConfigsV2{base_path}/{version}/v2/metadata-configs?{query}Yes
getMetadataConfigV2(metadataConfigId, callback)GetMetadataConfigV2{base_path}/{version}/v2/metadata-configs/{pathv1}?{query}Yes
updateMetadataConfigV2(metadataConfigId, body, callback)UpdateMetadataConfigV2{base_path}/{version}/v2/metadata-configs/{pathv1}?{query}Yes
deleteMetadataConfigV2(metadataConfigId, callback)DeleteMetadataConfigV2{base_path}/{version}/v2/metadata-configs/{pathv1}?{query}Yes
getMetricBaselineByMonitoredObjectIdV2(monitoredObjectId, interval, directions, metrics, callback)GetMetricBaselineByMonitoredObjectIdV2{base_path}/{version}/v2/metric-baselines/by-monitored-object/{pathv1}?{query}Yes
getAllDuplicateMonitoredObjectReportsV2(callback)GetAllDuplicateMonitoredObjectReportsV2{base_path}/{version}/v2/duplicate-monitored-object-reports?{query}Yes
generateDuplicateMonitoredObjectReportV2(callback)GenerateDuplicateMonitoredObjectReportV2{base_path}/{version}/v2/duplicate-monitored-object-reports?{query}Yes
getDuplicateMonitoredObjectReportV2(duplicateMonitoredObjectResportId, callback)GetDuplicateMonitoredObjectReportV2{base_path}/{version}/v2/duplicate-monitored-object-reports/{pathv1}?{query}Yes
createMonitoredObjectTagMappingV2(body, callback)CreateMonitoredObjectTagMappingV2{base_path}/{version}/v2/monitored-object-tag-mappings?{query}Yes
getAllMonitoredObjectTagMappingsV2(zone, callback)GetAllMonitoredObjectTagMappingsV2{base_path}/{version}/v2/monitored-object-tag-mappings?{query}Yes
getMonitoredObjectTagMappingV2(monitoredObjectTagMappingId, callback)GetMonitoredObjectTagMappingV2{base_path}/{version}/v2/monitored-object-tag-mappings/{pathv1}?{query}Yes
updateMonitoredObjectTagMappingV2(monitoredObjectTagMappingId, body, callback)UpdateMonitoredObjectTagMappingV2{base_path}/{version}/v2/monitored-object-tag-mappings/{pathv1}?{query}Yes
deleteMonitoredObjectTagMappingV2(monitoredObjectTagMappingId, callback)DeleteMonitoredObjectTagMappingV2{base_path}/{version}/v2/monitored-object-tag-mappings/{pathv1}?{query}Yes
getAllMonitoredObjectsV2(startKey, limit, callback)GetAllMonitoredObjectsV2{base_path}/{version}/v2/monitored-objects?{query}Yes
createMonitoredObjectV2(body, callback)CreateMonitoredObjectV2{base_path}/{version}/v2/monitored-objects?{query}Yes
getFilteredMonitoredObjectCountV2(groupBy = 'object-type', body, callback)GetFilteredMonitoredObjectCountV2{base_path}/{version}/v2/monitored-objects/count?{query}Yes
getFilteredMonitoredObjectListV2(body, callback)GetFilteredMonitoredObjectListV2{base_path}/{version}/v2/monitored-objects/id-list?{query}Yes
getMonitoredObjectReportingListV2(body, callback)GetMonitoredObjectReportingListV2{base_path}/{version}/v2/monitored-objects/reporting?{query}Yes
getMonitoredObjectGeoClustersV2(precision, location = 'source', body, callback)GetMonitoredObjectGeoClustersV2{base_path}/{version}/v2/monitored-object-geo-clusters?{query}Yes
getMonitoredObjectMetadataDetailsV2(meta, valuePrefix, categoriesOnly, callback)GetMonitoredObjectMetadataDetailsV2{base_path}/{version}/v2/monitored-object-meta-details?{query}Yes
getFilteredMonitoredObjectMetadataDetailsV2(body, callback)GetFilteredMonitoredObjectMetadataDetailsV2{base_path}/{version}/v2/monitored-object-meta-details?{query}Yes
getMonitoredObjectV2(monObjId, callback)GetMonitoredObjectV2{base_path}/{version}/v2/monitored-objects/{pathv1}?{query}Yes
updateMonitoredObjectV2(monObjId, body, callback)UpdateMonitoredObjectV2{base_path}/{version}/v2/monitored-objects/{pathv1}?{query}Yes
deleteMonitoredObjectV2(monObjId, callback)DeleteMonitoredObjectV2{base_path}/{version}/v2/monitored-objects/{pathv1}?{query}Yes
bulkPatchMonitoredObjectsV2(body, callback)BulkPatchMonitoredObjectsV2{base_path}/{version}/v2/bulk/patch/monitored-objects?{query}Yes
bulkInsertMonitoredObjectsV2(body, callback)BulkInsertMonitoredObjectsV2{base_path}/{version}/v2/bulk/insert/monitored-objects?{query}Yes
bulkUpdateMonitoredObjectsV2(body, callback)BulkUpdateMonitoredObjectsV2{base_path}/{version}/v2/bulk/insert/monitored-objects?{query}Yes
bulkInsertMonitoredObjectsMetaV2(body, callback)BulkInsertMonitoredObjectsMetaV2{base_path}/{version}/v2/bulk/insert/monitored-objects/meta?{query}Yes
getAllMonitoredObjectSummariesV2(startKey, limit, callback)GetAllMonitoredObjectSummariesV2{base_path}/{version}/v2/monitored-object-summaries?{query}Yes
getMonitoredObjectSummaryV2(monObjId, callback)GetMonitoredObjectSummaryV2{base_path}/{version}/v2/monitored-object-summaries/{pathv1}?{query}Yes
getAllMetadataCategoryMappingsV2(callback)GetAllMetadataCategoryMappingsV2{base_path}/{version}/v2/metadata-category-mappings?{query}Yes
getMetadataCategoryMappingV2(mappingType = 'unknown', callback)GetMetadataCategoryMappingV2{base_path}/{version}/v2/metadata-category-mappings/{pathv1}?{query}Yes
updateMetadataCategoryMappingV2(mappingType = 'unknown', body, callback)UpdateMetadataCategoryMappingV2{base_path}/{version}/v2/metadata-category-mappings/{pathv1}?{query}Yes
createSessionFilterProfileV2(body, callback)CreateSessionFilterProfileV2{base_path}/{version}/v2/session-filter-profiles?{query}Yes
getAllSessionFilterProfilesV2(callback)GetAllSessionFilterProfilesV2{base_path}/{version}/v2/session-filter-profiles?{query}Yes
getSessionFilterProfileV2(sessionFilterProfileId, callback)GetSessionFilterProfileV2{base_path}/{version}/v2/session-filter-profiles/{pathv1}?{query}Yes
updateSessionFilterProfileV2(sessionFilterProfileId, body, callback)UpdateSessionFilterProfileV2{base_path}/{version}/v2/session-filter-profiles/{pathv1}?{query}Yes
patchSessionFilterProfileV2(sessionFilterProfileId, body, callback)PatchSessionFilterProfileV2{base_path}/{version}/v2/session-filter-profiles/{pathv1}?{query}Yes
deleteSessionFilterProfileV2(sessionFilterProfileId, callback)DeleteSessionFilterProfileV2{base_path}/{version}/v2/session-filter-profiles/{pathv1}?{query}Yes
createSessionFilterV2(body, callback)CreateSessionFilterV2{base_path}/{version}/v2/session-filters?{query}Yes
getAllSessionFiltersV2(callback)GetAllSessionFiltersV2{base_path}/{version}/v2/session-filters?{query}Yes
getSessionFilterV2(sessionFilterId, callback)GetSessionFilterV2{base_path}/{version}/v2/session-filters/{pathv1}?{query}Yes
updateSessionFilterV2(sessionFilterId, body, callback)UpdateSessionFilterV2{base_path}/{version}/v2/session-filters/{pathv1}?{query}Yes
patchSessionFilterV2(sessionFilterId, body, callback)PatchSessionFilterV2{base_path}/{version}/v2/session-filters/{pathv1}?{query}Yes
deleteSessionFilterV2(sessionFilterId, callback)DeleteSessionFilterV2{base_path}/{version}/v2/session-filters/{pathv1}?{query}Yes
createThresholdProfileV2(body, callback)CreateThresholdProfileV2{base_path}/{version}/v2/threshold-profiles?{query}Yes
getAllThresholdProfilesV2(callback)GetAllThresholdProfilesV2{base_path}/{version}/v2/threshold-profiles?{query}Yes
getThresholdProfileV2(thrPrfId, callback)GetThresholdProfileV2{base_path}/{version}/v2/threshold-profiles/{pathv1}?{query}Yes
updateThresholdProfileV2(thrPrfId, body, callback)UpdateThresholdProfileV2{base_path}/{version}/v2/threshold-profiles/{pathv1}?{query}Yes
deleteThresholdProfileV2(thrPrfId, callback)DeleteThresholdProfileV2{base_path}/{version}/v2/threshold-profiles/{pathv1}?{query}Yes
createNetworkAssetV2(body, callback)CreateNetworkAssetV2{base_path}/{version}/v2/cyber/network-assets?{query}Yes
getAllNetworkAssetsV2(callback)GetAllNetworkAssetsV2{base_path}/{version}/v2/cyber/network-assets?{query}Yes
getNetworkAssetV2(networkAssetId, callback)GetNetworkAssetV2{base_path}/{version}/v2/cyber/network-assets/{pathv1}?{query}Yes
updateNetworkAssetV2(networkAssetId, body, callback)UpdateNetworkAssetV2{base_path}/{version}/v2/cyber/network-assets/{pathv1}?{query}Yes
deleteNetworkAssetV2(networkAssetId, callback)DeleteNetworkAssetV2{base_path}/{version}/v2/cyber/network-assets/{pathv1}?{query}Yes
getFilteredNetworkAssetCountV2(body, callback)GetFilteredNetworkAssetCountV2{base_path}/{version}/v2/cyber/network-assets/count?{query}Yes
getFilteredNetworkAssetListV2(body, callback)GetFilteredNetworkAssetListV2{base_path}/{version}/v2/cyber/network-assets/list?{query}Yes
getNetworkAssetGroupByV2(body, callback)GetNetworkAssetGroupByV2{base_path}/{version}/v2/cyber/network-assets/groupBy?{query}Yes
bootstrapsthemonitoredobjectcacheforalltenants(callback)Bootstraps the monitored object cache for all tenants{base_path}/{version}/v2/manager/monitoredObjectCache/build?{query}Yes
invokesbaselinebulkupdate(callback)Invokes baseline bulk update{base_path}/{version}/v2/manager/baseline/bulkUpdate?{query}Yes
purgesanalyticsreports(callback)Purges analytics reports{base_path}/{version}/v2/manager/analytics/purgeRecords?{query}Yes
bootstrapsthenetworkassetcacheforalltenants(callback)Bootstraps the network asset cache for all tenants{base_path}/{version}/v2/manager/networkAssetCache/build?{query}Yes
createIngestionDictionaryV3(body, callback)CreateIngestionDictionaryV3{base_path}/{version}/v3/ingestion-dictionaries?{query}Yes
getAllIngestionDictionariesV3(callback)GetAllIngestionDictionariesV3{base_path}/{version}/v3/ingestion-dictionaries?{query}Yes
getIngestionDictionaryV3(ingestionDictionaryId, callback)GetIngestionDictionaryV3{base_path}/{version}/v3/ingestion-dictionaries/{pathv1}?{query}Yes
updateIngestionDictionaryV3(ingestionDictionaryId, body, callback)UpdateIngestionDictionaryV3{base_path}/{version}/v3/ingestion-dictionaries/{pathv1}?{query}Yes
deleteIngestionDictionaryV3(ingestionDictionaryId, callback)DeleteIngestionDictionaryV3{base_path}/{version}/v3/ingestion-dictionaries/{pathv1}?{query}Yes
createDatasourceReconciliationTasksV3(datasource, taskCount, body, callback)CreateDatasourceReconciliationTasksV3{base_path}/{version}/v3/metrics-admin/reconciliation/datasource/{pathv1}?{query}Yes
createDatasourceReindexTasksV3(datasource, taskCount, periodOffsetMultiplier, body, callback)CreateDatasourceReindexTasksV3{base_path}/{version}/v3/metrics-admin/reindex/datasource/{pathv1}?{query}Yes
getGroupByV3(body, callback)GetGroupByV3{base_path}/{version}/v3/metrics/groupBy?{query}Yes
getAggregateV3(body, callback)GetAggregateV3{base_path}/{version}/v3/metrics/aggregate?{query}Yes
createTcpThroughputTestReportV3(body, callback)CreateTcpThroughputTestReportV3{base_path}/{version}/v3/tcpThroughput/tests?{query}Yes
getAllTcpThroughputTestReportsV3(shallow, token, callback)GetAllTcpThroughputTestReportsV3{base_path}/{version}/v3/tcpThroughput/tests?{query}Yes
getAllTcpThroughputReportsForTestV3(testId, shallow, token, callback)GetAllTcpThroughputReportsForTestV3{base_path}/{version}/v3/tcpThroughput/tests/{pathv1}/reports?{query}Yes
getTcpThroughputTestReportV3(testId, runId, shallow, callback)GetTcpThroughputTestReportV3{base_path}/{version}/v3/tcpThroughput/tests/{pathv1}/reports/{pathv2}?{query}Yes
updateTcpThroughputTestReportV3(testId, runId, body, callback)UpdateTcpThroughputTestReportV3{base_path}/{version}/v3/tcpThroughput/tests/{pathv1}/reports/{pathv2}?{query}Yes
deleteTcpThroughputTestReportV3(testId, runId, callback)DeleteTcpThroughputTestReportV3{base_path}/{version}/v3/tcpThroughput/tests/{pathv1}/reports/{pathv2}?{query}Yes
getFilteredTcpThroughputCountV3(body, callback)GetFilteredTcpThroughputCountV3{base_path}/{version}/v3/tcpThroughput/tests/count?{query}Yes
getFilteredTcpThroughputListV3(shallow, token, body, callback)GetFilteredTcpThroughputListV3{base_path}/{version}/v3/tcpThroughput/tests/list?{query}Yes

Authentication

This document will go through the steps for authenticating the Accedian Skylight adapter with Two Step Token Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication HERE.

Two Step Token Authentication

The Accedian Skylight adapter requires Two Step Token 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 Accedian Skylight 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
    "authentication": {
   "auth_method": "request_token",
   "username": "<username>",
   "password": "<password>",
   "token_timeout": 1800000,
   "token_cache": "local",
   "invalid_token_error": 401,
   "auth_field": "header.headers.Authorization",
   "auth_field_format": "Bearer {token}"
}
  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.
  • 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.

Additional Information

Enhancements

Adding a Second Instance of an Adapter

You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.

Adding Adapter Calls

There are multiple ways to add calls to an existing adapter.

The easiest way would be to use the Adapter Builder update process. This process takes in a Swagger or OpenAPI document, allows you to select the calls you want to add and then generates a zip file that can be used to update the adapter. Once you have the zip file simply put it in the adapter directory and execute npm run adapter:update.

mv updatePackage.zip adapter-accedian_skylight
cd adapter-accedian_skylight
npm run adapter:update

If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.

If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the Adapter Technical Resources on our Documentation Site.

Files to update
* entities/<entity>/action.json: add an action
* entities/<entity>/schema.json (or the schema defined on the action): add action to the enum for ph_request_type
* adapter.js: add the new method and make sure it calls the proper entity and action
* pronghorn.json: add the new method
* test/unit/adapterTestUnit.js (optional but best practice): add unit test(s) - function is there, any required parameters error when not passed in
* test/integration/adapterTestIntegration.js (optional but best practice): add integration test

Adding Adapter Properties

While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.

Files to update
* propertiesSchema.json: add the new property and how it is defined
* sampleProperties: add the new property with a default value
* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties

Changing Adapter Authentication

Often an adapter is built before knowing the authentication and authentication processes can also change over time. The adapter supports many different kinds of authentication but it does require configuration. Some forms of authentication can be defined entirely with the adapter properties but others require configuration.

Files to update
* entities/.system/action.json: change the getToken action as needed
* entities/.system/schemaTokenReq.json: add input parameters (external name is name in other system)
* entities/.system/schemaTokenResp.json: add response parameters (external name is name in other system)
* propertiesSchema.json: add any new property and how it is defined
* sampleProperties: add any new property with a default value
* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties

Enhancing Adapter Integration Tests

The adapter integration tests are written to be able to test in either stub (standalone) mode or integrated to the other system. However, if integrating to the other system, you may need to provide better data than what the adapter provides by default as that data is likely to fail for create and update. To provide better data, edit the adapter integration test file. Make sure you do not remove the marker and keep custom code below the marker so you do not impact future migrations. Once the edits are complete, run the integration test as it instructs you to above. When you run integrated to the other system, you can also save mockdata for future use by changing the isSaveMockData flag to true.

Files to update
* test/integration/adapterTestIntegration.js: add better data for the create and update calls so that they will not fail.

As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the Adapter Technical Resources on our Documentation Site.

Contributing

First off, thanks for taking the time to contribute!

The following is a set of rules for contributing.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@itential.com.

How to Contribute

Follow the contributing guide (here)[https://gitlab.com/itentialopensource/adapters/contributing-guide]

Helpful Links

Adapter Technical Resources

Node Scripts

There are several node scripts that now accompany the adapter. These scripts are provided to make several activities easier. Many of these scripts can have issues with different versions of IAP as they have dependencies on IAP and Mongo. If you have issues with the scripts please report them to the Itential Adapter Team. Each of these scripts are described below.

RunDescription
npm run adapter:installProvides an easier way to install the adapter.
npm run adapter:checkMigrateChecks whether your adapter can and should be migrated to the latest foundation.
npm run adapter:findPathCan be used to see if the adapter supports a particular API call.
npm run adapter:migrateProvides an easier way to update your adapter after you download the migration zip from Itential DevSite.
npm run adapter:updateProvides an easier way to update your adapter after you download the update zip from Itential DevSite.
npm run adapter:revertAllows you to revert after a migration or update if it resulted in issues.
npm run troubleshootProvides a way to troubleshoot the adapter - runs connectivity, healthcheck and basic get.
npm run connectivityProvides a connectivity check to the Servicenow system.
npm run healthcheckChecks whether the configured healthcheck call works to Servicenow.
npm run basicgetChecks whether the basic get calls works to Servicenow.

Troubleshoot

Run npm run troubleshoot to start the interactive troubleshooting process. The command allows you to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into IAP.

You also have the option to run individual commands to perform specific test:

  • npm run healthcheck will perform a healthcheck request of with current setting.
  • npm run basicget will perform some non-parameter GET request with current setting.
  • npm run connectivity will perform networking diagnostics of the adatper endpoint.

Connectivity Issues

  1. You can run the adapter troubleshooting script which will check connectivity, run the healthcheck and run basic get calls.
npm run troubleshoot
  1. Verify the adapter properties are set up correctly.
Go into the Itential Platform GUI and verify/update the properties
  1. Verify there is connectivity between the Itential Platform Server and Accedian_skylight Server.
ping the ip address of Accedian_skylight server
try telnet to the ip address port of Accedian_skylight
execute a curl command to the other system
  1. Verify the credentials provided for Accedian_skylight.
login to Accedian_skylight using the provided credentials
  1. Verify the API of the call utilized for Accedian_skylight Healthcheck.
Go into the Itential Platform GUI and verify/update the properties

Functional Issues

Adapter logs are located in /var/log/pronghorn. In older releases of the Itential Platform, there is a pronghorn.log file which contains logs for all of the Itential Platform. In newer versions, adapters can be configured to log into their own files.