Itential Automation Platform

Table of Contents

• Getting Started
  • Helpful Background Information
  • Prerequisites
  • How to Install
  • Testing
• Configuration
  • Example Properties
  • Connection Properties
  • Authentication Properties
  • Healthcheck Properties
  • Request Properties
  • SSL Properties
  • Throttle Properties
  • Proxy Properties
  • Mongo Properties
  • Device Broker Properties
• Using this Adapter
  • Generic Adapter Calls
  • Adapter Cache Calls
  • Adapter Broker Calls
  • Specific Adapter Calls
  • Authentication
• Additional Information
  • Enhancements
  • Contributing
  • Helpful Links
  • Node Scripts
• Troubleshoot
  • Connectivity Issues
  • Functional Issues

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.

Package	Description
@itentialopensource/adapter-utils	Runtime library classes for all adapters; includes request handling, connection, authentication throttling, and translation.
ajv	Required for validation of adapter properties to integrate with Iap.
axios	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
commander	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
dns-lookup-promise	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
fs-extra	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
mocha	Testing library that is utilized by some of the node scripts that are included with the adapter.
mocha-param	Testing library that is utilized by some of the node scripts that are included with the adapter.
mongodb	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
nyc	Testing coverage library that is utilized by some of the node scripts that are included with the adapter.
ping	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
readline-sync	Utilized by the node script that comes with the adapter; helps to test unit and integration functionality.
semver	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
winston	Utilized 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

2. Clone/unzip/tar the adapter into your IAP environment.

cd \@itentialopensource
git clone git@gitlab.com:\@itentialopensource/adapters/adapter-iap
or
unzip adapter-iap.zip
or
tar -xvf adapter-iap.tar

3. Run the adapter install script.

cd adapter-iap
npm install
npm run lint:errors
npm run test

4. Restart IAP

systemctl restart pronghorn

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

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

7. 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:

3. Install adapter dependencies and check the adapter.

cd adapter-iap
npm run adapter:install

4. Restart IAP

systemctl restart pronghorn

5. 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 Iap. 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 Iap. 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 Iap. 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 Iap 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": "itential.com",
    "port": 443,
    "choosepath": "2021.2",
    "base_path": "",
    "version": "",
    "cache_location": "none",
    "encode_pathvars": true,
    "encode_queryvars": true,
    "save_metric": false,
    "stub": true,
    "protocol": "https",
    "authentication": {
      "auth_method": "request_token",
      "username": "username",
      "password": "password",
      "token": "token",
      "token_timeout": 600000,
      "token_cache": "local",
      "invalid_token_error": 401,
      "auth_field": "header.headers.Cookie",
      "auth_field_format": "token={token}",
      "auth_logging": false,
      "client_id": "",
      "client_secret": "",
      "grant_type": "",
      "sensitive": [],
      "sso": {
        "protocol": "",
        "host": "",
        "port": 0
      },
      "multiStepAuthCalls": [
        {
          "name": "",
          "requestFields": {},
          "responseFields": {},
          "successfullResponseCode": 200
        }
      ]
    },
    "healthcheck": {
      "type": "none",
      "frequency": 60000,
      "query_object": {},
      "addlHeaders": {}
    },
    "throttle": {
      "throttle_enabled": false,
      "number_pronghorns": 1,
      "sync_async": "sync",
      "max_in_queue": 1000,
      "concurrent_max": 1,
      "expire_timeout": 0,
      "avg_runtime": 200,
      "priorities": [
        {
          "value": 0,
          "percent": 100
        }
      ]
    },
    "request": {
      "number_redirects": 0,
      "number_retries": 3,
      "limit_retry_error": [
        0
      ],
      "failover_codes": [],
      "attempt_timeout": 5000,
      "global_request": {
        "payload": {},
        "uriOptions": {},
        "addlHeaders": {},
        "authData": {}
      },
      "healthcheck_on_timeout": true,
      "return_raw": false,
      "archiving": false,
      "return_request": false
    },
    "proxy": {
      "enabled": false,
      "host": "",
      "port": 1,
      "protocol": "http",
      "username": "",
      "password": ""
    },
    "ssl": {
      "ecdhCurve": "",
      "enabled": false,
      "accept_invalid_cert": false,
      "ca_file": "",
      "key_file": "",
      "cert_file": "",
      "secure_protocol": "",
      "ciphers": ""
    },
    "mongo": {
      "host": "",
      "port": 0,
      "database": "",
      "username": "",
      "password": "",
      "replSet": "",
      "db_ssl": {
        "enabled": false,
        "accept_invalid_cert": false,
        "ca_file": "",
        "key_file": "",
        "cert_file": ""
      }
    },
    "devicebroker": {
      "getDevice": [
        {
          "path": "/get/devices/{name}",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {},
          "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/{name}/status",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {},
          "responseDatakey": "",
          "responseFields": {
            "status": "status",
            "statusValue": "online"
          }
        }
      ],
      "getConfig": [
        {
          "path": "/get/devices/{name}/configPart1",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {},
          "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 Iap upon the adapter initially coming up. It is important to set these properties appropriately.

Property	Description
host	Required. A fully qualified domain name or IP address.
port	Required. Used to connect to the server.
base_path	Optional. 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 ``.
version	Optional. 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_location	Optional. 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_pathvars	Optional. 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_queryvars	Optional. 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_metric	Optional. 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.
stub	Optional. Indicates whether the stub should run instead of making calls to Iap (very useful during basic testing). Default is false (which means connect to Iap).
protocol	Optional. 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 Iap.

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

Property	Description
auth_method	Required. Used to define the type of authentication currently supported. Authentication methods currently supported are: `basic user_password`, `static_token`, `request_token`, and `no_authentication`.
username	Used to authenticate with Iap on every request or when pulling a token that will be used in subsequent requests.
password	Used to authenticate with Iap on every request or when pulling a token that will be used in subsequent requests.
token	Defines a static token that can be used on all requests. Only used with `static_token` as an authentication method (auth\_method).
invalid_token_error	Defines 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_timeout	Defines 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 Iap. 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_cache	Used to determine where the token should be stored (local memory or in Redis).
auth_field	Defines 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_format	Defines 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_logging	Setting 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_id	Provide a client id when needed, this is common on some types of OAuth.
client_secret	Provide a client secret when needed, this is common on some types of OAuth.
grant_type	Provide 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 Iap. 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 Iap.
• Startup - Adapter will check for connectivity when the adapter initially comes up, but it will not check afterwards.
• Intermittent - Adapter will check connectivity to Iap at a frequency defined in the frequency property.

Property	Description
type	Required. The type of health check to run.
frequency	Required if intermittent. Defines how often the health check should run. Measured in milliseconds. Default is 300000.
query_object	Query parameters to be added to the adapter healthcheck call.

Request Properties

The request section defines properties to help handle requests.

Property	Description
number_redirects	Optional. 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_retries	Tells 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_error	Optional. 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_codes	An 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_timeout	Optional. 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 Iap, and then will re-attempt the request that aborted. Default is 5000 milliseconds.
global_request	Optional. 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 -> payload	Optional. Defines any information that should be included on all requests sent to the other system that have a payload/body.
global_request -> uriOptions	Optional. Defines any information that should be sent as untranslated query options (e.g. page, size) on all requests to the other system.
global_request -> addlHeaders	Optioonal. Defines any headers that should be sent on all requests to the other system.
global_request -> authData	Optional. Defines any additional authentication data used to authentice with the other system. This authData needs to be consistent on every request.
healthcheck_on_timeout	Required. 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_raw	Optional. 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.
archiving	Optional flag. Default is false. It archives the request, the results and the various times (wait time, Iap 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_request	Optional 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 Iap. SSL can work two different ways: set the accept\_invalid\_certs flag to true (only recommended for lab environments), or provide a ca\_file.

Property	Description
enabled	If SSL is required, set to true.
accept_invalid_certs	Defines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false.
ca_file	Defines 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_file	Defines 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_file	Defines 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_protocol	Defines the protocol (e.g., SSLv3_method) to use on the SSL request.
ciphers	Required if SSL enabled. Specifies a list of SSL ciphers to use.
ecdhCurve	During 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 Iap must be queued (throttled). All of the properties in this section are optional.

Property	Description
throttle_enabled	Default is false. Defines if the adapter should use throttling or not.
number_pronghorns	Default 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-async	This property is not used at the current time (it is for future expansion of the throttling engine).
max_in_queue	Represents 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_max	Defines the number of requests the adapter can send to Iap at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to Iap in a serial manner.
expire_timeout	Default 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_runtime	Represents the approximate average of how long it takes Iap 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 Iap performance is exceptional you might run a little slower than you might like, but when it is poor you still run efficiently.
priorities	An 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 Iap is behind a proxy server.

Property	Description
enabled	Required. Default is false. If Iap is behind a proxy server, set enabled flag to true.
host	Host information for the proxy server. Required if `enabled` is true.
port	Port information for the proxy server. Required if `enabled` is true.
protocol	The protocol (i.e., http, https, etc.) used to connect to the proxy. Default is http.
username	If there is authentication for the proxy, provide the username here.
password	If 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.

Property	Description
host	Optional. Host information for the mongo server.
port	Optional. Port information for the mongo server.
database	Optional. The database for the adapter to use for its data.
username	Optional. If credentials are required to access mongo, this is the user to login as.
password	Optional. If credentials are required to access mongo, this is the password to login with.
replSet	Optional. If the database is set up to use replica sets, define it here so it can be added to the database connection.
db_ssl	Optional. Contains information for SSL connectivity to the database.
db_ssl -> enabled	If SSL is required, set to true.
db_ssl -> accept_invalid_cert	Defines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false.
db_ssl -> ca_file	Defines 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_file	Defines 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_file	Defines 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 Iap 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.

Property	Description
getDevice	The array of calls used to get device details for the broker
getDevicesFiltered	The array of calls used to get devices for the broker
isAlive	The array of calls used to get device status for the broker
getConfig	The array of calls used to get device configuration for the broker
getCount	The array of calls used to get device configuration for the broker
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> path	The path, not including the base_path and version, for making this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> method	The rest method for making this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> query	Query object containing and query parameters and their values for this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> body	Body object containing the payload for this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> headers	Header object containing the headers for this call.
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> handleFailure	Tells the adapter whether to "fail" or "ignore" failures if they occur.
isAlive -> statusValue	Tells the adapter what value to look for in the status field to determine if the device is alive.
getDevice/getDevicesFiltered/isAlive/getConfig -> requestFields	Object 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 -> responseFields	Object 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 Signature	Description	Workflow?
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 IAP. 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 IAP.	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 Signature	Description	Workflow?
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 Signature	Description	Workflow?
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 active	No
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 IAP. 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 Signature	Description	Path	Workflow?
createAutomation(name, description, callback)	Creates an automation	{base_path}/{version}/automation_catalog/automations?{query}	Yes
getAutomations(queryParameters, callback)	Gets all known automations	{base_path}/{version}/automation_catalog/automations?{query}	Yes
deleteAutomations(ids, callback)	Deletes automations	{base_path}/{version}/automation_catalog/automations?{query}	Yes
getAutomationById(id, callback)	Gets an single automation by its id	{base_path}/{version}/automation_catalog/automations/{pathv1}?{query}	Yes
updateAutomation(id, options, callback)	Updates non-scheduling data for an automation	{base_path}/{version}/automation_catalog/automations/{pathv1}?{query}	Yes
scheduleAutomation(id, options, callback)	Updates an automation's schedule	{base_path}/{version}/automation_catalog/automations/{pathv1}/schedule?{query}	Yes
runAutomation(id, options, callback)	Runs an automation outside of it's regularly scheduled runs. Requires a workflow to be attached to the automation.	{base_path}/{version}/automation_catalog/automations/{pathv1}/run?{query}	Yes
importAutomations(automations, options, callback)	Import automation documents	{base_path}/{version}/automation_catalog/automations/import?{query}	Yes
exportAutomation(id, callback)	Export an automation document	{base_path}/{version}/automation_catalog/automations/{pathv1}/export?{query}	Yes
activateWFTask(callback)	Activate Task Worker	{base_path}/{version}/workflow_engine/activate?{query}	Yes
addWFWatchers(jobId, watchers, callback)	Watch a job for multiple users	{base_path}/{version}/workflow_engine/job/watchers/watch?{query}	Yes
cancelWFJob(jobId, callback)	Cancel a job	{base_path}/{version}/workflow_engine/cancelJob?{query}	Yes
checkWorkflowForJobVariables(name, callback)	Get Workflow Job Variables	{base_path}/{version}/workflow_engine/workflows/variables/{pathv1}?{query}	Yes
claimWFTask(taskId, user, callback)	Claim a task	{base_path}/{version}/workflow_engine/tasks/claim?{query}	Yes
createWFJobGroupEntry(id, group, callback)	Add Group to Job	2019.2:{base_path}/{version}/workflow_engine/jobs/{pathv1}/groups?{query} 2021.2:{base_path}/{version}/operations-manager/jobs/{pathv1}/groups?{query}	Yes
listWFJobGroups(id, callback)	List Groups for a Job	{base_path}/{version}/workflow_engine/jobs/{pathv1}/groups?{query}	Yes
replaceWFJobGroups(id, groups, callback)	Overwrite Groups for a Job	2019.2:{base_path}/{version}/workflow_engine/jobs/{pathv1}/groups?{query} 2021.2:{base_path}/{version}/operations-manager/jobs/{pathv1}/groups?{query}	Yes
deleteWFJobGroups(id, callback)	Delete all Groups for a Job	2019.2:{base_path}/{version}/workflow_engine/jobs/{pathv1}/groups?{query} 2021.2:{base_path}/{version}/operations-manager/jobs/{pathv1}/groups?{query}	Yes
deactivateWFTask(callback)	Deactivate Task Worker	{base_path}/{version}/workflow_engine/deactivate?{query}	Yes
wfDiffToHTML(label1, value1, label2, value2, callback)	diff to HTML	{base_path}/{version}/workflow_engine/diffToHTML?{query}	Yes
findWFJob(query, options, callback)	Find Job	{base_path}/{version}/workflow_engine/jobs/find?{query}	Yes
findWFForwardPaths(startTask, endTask, workflowDetails, callback)	Find Forward Paths	{base_path}/{version}/workflow_engine/findForwardPaths?{query}	Yes
finishWFManualTask(taskId, jobId, taskData, callback)	Complete a manual task	{base_path}/{version}/workflow_engine/finishTask?{query}	Yes
fixWFJob(jobId, erroredTask, revertTask, callback)	Fix a job	{base_path}/{version}/workflow_engine/fixJob?{query}	Yes
getAllWFLoopTasks(workflowDetails, callback)	Get All Looped Tasks	{base_path}/{version}/workflow_engine/getAllLoopTasks?{query}	Yes
getWFAssociatedJobs(options, callback)	Get User's Associated Jobs	{base_path}/{version}/workflow_engine/getAssociatedJobs?{query}	Yes
getWFEntireJob(jobData, callback)	Get Job information Fully	{base_path}/{version}/workflow_engine/getEntireJob/{pathv1}?{query}	Yes
getWFJob(jobId, callback)	Get Job	2019.2:{base_path}/{version}/workflow_engine/getJob/{pathv1}?{query} 2021.2:{base_path}/{version}/operations-manager/jobs/{pathv1}?{query}	Yes
getWFJobDeep(jobId, callback)	Get Job Iterations Details	{base_path}/{version}/workflow_engine/job/{pathv1}/deep?{query}	Yes
getWFJobFromTaskQuery(taskQuery, options, callback)	Get Jobs From Tasks	{base_path}/{version}/workflow_engine/getJobFromTaskQuery?{query}	Yes
getWFJobList(status, options, callback)	Get Jobs by Status	{base_path}/{version}/workflow_engine/getJobList/{pathv1}?{query}	Yes
getWFJobShallow(jobData, callback)	Get Brief Job Information	{base_path}/{version}/workflow_engine/getJobShallow/{pathv1}?{query}	Yes
getWFJobVisualizationData(jobId, callback)	Get Job Visualization Data	{base_path}/{version}/workflow_engine/jobs/visdata/{pathv1}?{query}	Yes
getWFManualTaskController(jobId, taskId, callback)	Get a Manual Task's Controller	2019.2:{base_path}/{version}/workflow_engine/tasks/controller/job/{pathv1}/task/{pathv2}?{query} 2021.2:{base_path}/{version}/operations-manager/jobs/{pathv1}/tasks/{pathv2}/manual-controller?{query}	Yes
getWFTask(query, filter, callback)	Query a Single Task	{base_path}/{version}/workflow_engine/getTask?{query}	Yes
getWFTaskDetails(location, pckg, method, callback)	Get Task Details	2019.2:{base_path}/{version}/workflow_engine/locations/{pathv1}/packages/{pathv2}/tasks/{pathv3}?{query} 2022.1:{base_path}/{version}/automation-studio/locations/{pathv1}/packages/{pathv2}/tasks/{pathv3}?{query}	Yes
getWFTaskIterations(jobId, task, callback)	Get Iterations of A Task	{base_path}/{version}/workflow_engine/getTaskIterations/{pathv1}/{pathv2}?{query}	Yes
getWFTaskStatuses(jobId, callback)	Get Tasks Status	{base_path}/{version}/workflow_engine/job/statuses/{pathv1}?{query}	Yes
getWorkflowsDetailedByName(name, callback)	Get Workflow Details	2020.2:{base_path}/{version}/workflow_engine/workflows/detailed/{pathv1}?{query} 2022.1:{base_path}/{version}/automation-studio/workflows/detailed/{pathv1}?{query}	Yes
isWFActive(callback)	Check Staterator State	{base_path}/{version}/workflow_engine/active?{query}	Yes
pauseWFJob(jobId, callback)	Pause a job	{base_path}/{version}/workflow_engine/pauseJob?{query}	Yes
prepareWFMetricsLogs(callback)	Prepare the metrics logs tarball	{base_path}/{version}/workflow_engine/metrics/jobs?{query}	Yes
wfQuery(jobId, passOnNull, query, obj, callback)	Query data	{base_path}/{version}/workflow_engine/query?{query}	Yes
queryWFJobs(query, callback)	Query Jobs Collection	{base_path}/{version}/workflow_engine/queryJobs?{query}	Yes
queryWFTasksBrief(query, callback)	Query Tasks Collection Brief	{base_path}/{version}/workflow_engine/queryTasksBrief?{query}	Yes
releaseWFTask(taskId, callback)	Release a task	{base_path}/{version}/workflow_engine/tasks/release?{query}	Yes
removeWFJobGroup(id, group, callback)	Remove a Group from a Job	2019.2:{base_path}/{version}/workflow_engine/jobs/{pathv1}/groups/{pathv2}?{query} 2021.2:{base_path}/{version}/operations-manager/jobs/{pathv1}/groups/{pathv2}?{query}	Yes
resumeWFJob(jobId, callback)	Resume a job	{base_path}/{version}/workflow_engine/resumeJob?{query}	Yes
returnWFCompletedTaskData(jobId, taskId, taskData, callback)	Finish a task	{base_path}/{version}/workflow_engine/jobs/finish_task/{pathv1}/{pathv2}?{query}	Yes
revertToWFTask(jobId, currentTask, targetTask, callback)	Revert to a task	{base_path}/{version}/workflow_engine/revertToTask?{query}	Yes
runWFEvaluationGroup(evaluationGroup, allTrueFlag, callback)	Evaluation Group	{base_path}/{version}/workflow_engine/runEvaluationGroup?{query}	Yes
runWFEvaluationGroups(evaluationGroups, allTrueFlag, callback)	Evaluation Groups	{base_path}/{version}/workflow_engine/runEvaluationGroups?{query}	Yes
searchWFJobs(options, callback)	Search Jobs	{base_path}/{version}/workflow_engine/jobs/search?{query}	Yes
searchWFTasks(filter, options, callback)	Search Tasks	{base_path}/{version}/workflow_engine/tasks/search?{query}	Yes
searchWFWorkflows(options, callback)	Search Workflows	{base_path}/{version}/workflow_engine/workflows/search?{query}	Yes
startWFJobWithOptions(workflow, options, callback)	Start a Job with Options	{base_path}/{version}/workflow_engine/startJobWithOptions/{pathv1}?{query}	Yes
watchWFJob(jobId, callback)	Watch a job	{base_path}/{version}/workflow_engine/job/{pathv1}/watch?{query}	Yes
unwatchWFJob(jobId, callback)	Unwatch a job	{base_path}/{version}/workflow_engine/job/{pathv1}/watch?{query}	Yes
validateAllWFLoops(workflowDetails, callback)	Validate All Loops	{base_path}/{version}/workflow_engine/validateAllLoops?{query}	Yes
getCMDevicesFiltered(options, callback)	Find Devices	{base_path}/{version}/configuration_manager/devices?{query}	Yes
getCMDevice(name, callback)	Get Device Details	{base_path}/{version}/configuration_manager/devices/{pathv1}?{query}	Yes
getCMDeviceConfig(name, callback)	Get Device Configuration	{base_path}/{version}/configuration_manager/devices/{pathv1}/configuration?{query}	Yes
getCMDeviceConfigFormat(name, format, callback)	Get formatted device config (Deprecated)	{base_path}/{version}/configuration_manager/devices/{pathv1}/configuration/{pathv2}?{query}	Yes
cmBackUpDevice(deviceName, options, callback)	Backup device configuration	{base_path}/{version}/configuration_manager/devices/backups?{query}	Yes
cmImportBackup(backups, callback)	Import backup documents	{base_path}/{version}/configuration_manager/import/backups?{query}	Yes
cmImportGroup(groups, callback)	Import device group documents	{base_path}/{version}/configuration_manager/import/groups?{query}	Yes
getCMBackups(options, callback)	Get Device Backup List	{base_path}/{version}/configuration_manager/backups?{query}	Yes
deleteCMDeviceBackups(backupIds, callback)	Delete one or more device backups by Id	{base_path}/{version}/configuration_manager/backups?{query}	Yes
getCMDeviceBackupById(id, callback)	Get Device Backup	{base_path}/{version}/configuration_manager/backups/{pathv1}?{query}	Yes
updateCMDeviceBackupById(id, options, callback)	Update a device backup by Id	{base_path}/{version}/configuration_manager/backups/{pathv1}?{query}	Yes
getCMDeviceGroupByName(groupName, callback)	Get Device Group by Name	{base_path}/{version}/configuration_manager/name/devicegroups?{query}	Yes
cmIsAlive(name, callback)	Check if device is connected	{base_path}/{version}/configuration_manager/devices/{pathv1}/isAlive?{query}	Yes
createCMDeviceGroups(groupDetails, callback)	Creates a device group (Deprecated)	{base_path}/{version}/configuration_manager/deviceGroups?{query}	Yes
getCMDeviceGroups(callback)	Get all Device Groups	{base_path}/{version}/configuration_manager/deviceGroups?{query}	Yes
deleteCMDeviceGroups(groupIds, callback)	Delete device groups	{base_path}/{version}/configuration_manager/deviceGroups?{query}	Yes
createCMDeviceGroup(groupName, groupDescription, deviceNames, callback)	Creates a device group	{base_path}/{version}/configuration_manager/deviceGroup?{query}	Yes
searchCMDeviceGroups(s, start, limit, callback)	Search all Device Groups	{base_path}/{version}/configuration_manager/deviceGroups/search?{query}	Yes
getCMDeviceGroupById(id, callback)	Get Device Group by ID	{base_path}/{version}/configuration_manager/deviceGroups/{pathv1}?{query}	Yes
updateCMDeviceGroups(id, details, callback)	Update device groups	{base_path}/{version}/configuration_manager/deviceGroups/{pathv1}?{query}	Yes
addCMDevicesToGroup(id, devices, callback)	Adds new devices to the group	{base_path}/{version}/configuration_manager/deviceGroups/{pathv1}/devices?{query}	Yes
removeCMDevicesFromGroup(id, devices, callback)	Removes devices from a group	{base_path}/{version}/configuration_manager/deviceGroups/{pathv1}/devices?{query}	Yes
deleteCMDeviceGroupsByName(groupNames, callback)	Delete device groups	{base_path}/{version}/configuration_manager/name/deviceGroups?{query}	Yes
addCMDevicesToGroupByName(groupName, deviceNames, callback)	Add device(s) to a group (Deprecated)	{base_path}/{version}/configuration_manager/deviceGroups/devices?{query}	Yes
deleteCMDevicesFromGroup(groupName, deviceNames, callback)	Delete device(s) from a group (Deprecated)	{base_path}/{version}/configuration_manager/deviceGroups/devices?{query}	Yes
cmLookupDiff(id, nextId, collection, nextCollection, options, callback)	Diff two strings from a lookup.	{base_path}/{version}/configuration_manager/lookup_diff?{query}	Yes
getCMGoldenConfigTrees(callback)	Get a list of all Golden Config trees.	{base_path}/{version}/configuration_manager/configs?{query}	Yes
createCMGoldenConfigTree(name, deviceType, callback)	Adds a new Golden Config tree	{base_path}/{version}/configuration_manager/configs?{query}	Yes
deleteCMGoldenConfigTrees(treeIds, callback)	Delete one or more golden configuration trees by tree id	{base_path}/{version}/configuration_manager/configs?{query}	Yes
getCMGoldenConfigTree(treeId, callback)	Get summary of a Golden Config tree.	{base_path}/{version}/configuration_manager/configs/{pathv1}?{query}	Yes
createCMGoldenConfigTreeVersion(treeId, version, base, callback)	Adds a new Golden Config tree	{base_path}/{version}/configuration_manager/configs/{pathv1}?{query}	Yes
updateCMGoldenConfigTree(treeId, name, callback)	Updates properties of a Golden Config tree	{base_path}/{version}/configuration_manager/configs/{pathv1}?{query}	Yes
deleteCMGoldenConfigTree(treeId, callback)	Delete a Golden Config tree.	{base_path}/{version}/configuration_manager/configs/{pathv1}?{query}	Yes
getCMGoldenConfigTreeVersion(treeId, version, callback)	Get details of a Golden Config tree version.	{base_path}/{version}/configuration_manager/configs/{pathv1}/{pathv2}?{query}	Yes
updateCMGoldenConfigTreeVersion(treeId, version, name, variables, callback)	Updates properties of a Golden Config tree version	{base_path}/{version}/configuration_manager/configs/{pathv1}/{pathv2}?{query}	Yes
deleteCMGoldenConfigTreeVersion(treeId, version, callback)	Delete a Golden Config tree.	{base_path}/{version}/configuration_manager/configs/{pathv1}/{pathv2}?{query}	Yes
deleteCMVariables(treeId, version, variables, callback)	Deletes one or more variables	{base_path}/{version}/configuration_manager/configs/variables/{pathv1}/{pathv2}?{query}	Yes
exportCMGoldenConfigTree(treeId, callback)	Export a Golden Config tree.	{base_path}/{version}/configuration_manager/export/goldenconfigs?{query}	Yes
importCMGoldenConfigTree(trees, callback)	Import golden config tree documents	{base_path}/{version}/configuration_manager/import/goldenconfigs?{query}	Yes
addCMDevicesToNode(treeId, version, nodePath, devices, callback)	Add Devices to Node	{base_path}/{version}/configuration_manager/configs/{pathv1}/{pathv2}/{pathv3}/devices?{query}	Yes
removeCMDevicesFromNode(treeId, version, nodePath, devices, callback)	Remove Devices from Node	{base_path}/{version}/configuration_manager/configs/{pathv1}/{pathv2}/{pathv3}/devices?{query}	Yes
createCMGoldenConfigNode(treeId, version, parentNodePath, name, callback)	Create a new node in a Golden Config tree.	{base_path}/{version}/configuration_manager/configs/{pathv1}/{pathv2}/{pathv3}?{query}	Yes
updateCMGoldenConfigNode(treeId, version, nodePath, name, attributes, callback)	Update properties of a node in a Golden Config tree.	{base_path}/{version}/configuration_manager/configs/{pathv1}/{pathv2}/{pathv3}?{query}	Yes
deleteCMGoldenConfigNode(treeId, version, nodePath, callback)	Delete a node in a Golden Config tree.	{base_path}/{version}/configuration_manager/configs/{pathv1}/{pathv2}/{pathv3}?{query}	Yes
getCMConfigSpec(id, callback)	Get a Config Spec document.	{base_path}/{version}/configuration_manager/config_specs/{pathv1}?{query}	Yes
updateCMConfigSpec(id, lines, callback)	Update a Config Spec.	{base_path}/{version}/configuration_manager/config_specs/{pathv1}?{query}	Yes
createCMConfigSpec(deviceType, lines, callback)	Create a new Config Spec.	{base_path}/{version}/configuration_manager/config_specs?{query}	Yes
translateCMConfigSpec(treeID, version, nodePath, options, callback)	Convert a config spec into a readable string.	{base_path}/{version}/configuration_manager/translate/config_spec?{query}	Yes
buildCMSpecLines(nativeConfig, deviceType, options, callback)	Builds a config spec from raw config.	{base_path}/{version}/configuration_manager/generate/config_spec?{query}	Yes
runCMCompliance(options, callback)	Kick off one or more compliance reports.	{base_path}/{version}/configuration_manager/compliance_reports?{query}	Yes
getCMComplianceReportTreeSummary(treeId, callback)	Get summary compliance data for a tree.	{base_path}/{version}/configuration_manager/compliance_reports/tree/{pathv1}?{query}	Yes
getCMComplianceReportNodeSummary(treeId, nodePath, callback)	Get summary compliance data for a node.	{base_path}/{version}/configuration_manager/compliance_reports/node/{pathv1}/{pathv2}?{query}	Yes
gradeCMComplianceReports(treeId, version, options, callback)	Get graded compliance reports for a tree or node.	{base_path}/{version}/configuration_manager/compliance_reports/grade?{query}	Yes
gradeCMComplianceReport(reportId, options, callback)	Get grade of compliance report.	{base_path}/{version}/configuration_manager/compliance_reports/grade/single?{query}	Yes
gradeCMDeviceComplianceHistory(treeId, version, nodePath, deviceName, options, callback)	Get historical graded compliance reports.	{base_path}/{version}/configuration_manager/compliance_reports/grade/history?{query}	Yes
getCMComplianceReportsByBatch(batchId, callback)	Get compliance report metadata for a batch.	{base_path}/{version}/configuration_manager/compliance_reports/batch/{pathv1}?{query}	Yes
getCMComplianceReportDeviceHistory(options, callback)	Get historical summary compliance data for a device.	{base_path}/{version}/configuration_manager/compliance_reports/history?{query}	Yes
getCMComplianceReportDetail(reportId, callback)	Get details of a particular compliance check.	{base_path}/{version}/configuration_manager/compliance_reports/details/{pathv1}?{query}	Yes
getCMComplianceReportsDetail(reportIds, callback)	Get details of a particular set of compliance checks.	{base_path}/{version}/configuration_manager/compliance_reports/details?{query}	Yes
getTopIssues(options, callback)	Get the top issues from compliance reports.	{base_path}/{version}/configuration_manager/compliance_reports/topissues?{query}	Yes
patchCMDeviceConfiguration(deviceName, changes, callback)	Alters a device configuration to achieve compliance	{base_path}/{version}/configuration_manager/patch_device/{pathv1}?{query}	Yes
cmAdapterProxy(device, origin, action, callback)	performs all southbound specific logic not caputered by IAP	{base_path}/{version}/devices/actions/{pathv1}&/{pathv2}&/{pathv3}?{query}	Yes
exportMopTemplate(options, type, callback)	Export Template	{base_path}/{version}/mop/export?{query}	Yes
importMopTemplate(template, type, callback)	Import Template	{base_path}/{version}/mop/import?{query}	Yes
listMopTemplates(callback)	Get all Command Templates.	{base_path}/{version}/mop/listTemplates?{query}	Yes
listMopTemplateByName(name, callback)	Get a Command Template by name.	{base_path}/{version}/mop/listATemplate/{pathv1}?{query}	Yes
listMopAnalyticTemplateByName(name, callback)	Get an Analytic Template by Name	{base_path}/{version}/mop/listAnAnalyticTemplate/{pathv1}?{query}	Yes
listMopAnalyticTemplates(callback)	Get All Analytic Templates	{base_path}/{version}/mop/listAnalyticTemplates?{query}	Yes
createMopTemplate(mop, callback)	Create a Command Template.	{base_path}/{version}/mop/createTemplate?{query}	Yes
createMopAnalyticTemplate(template, callback)	Create an Analytic Template	{base_path}/{version}/mop/createAnalyticTemplate?{query}	Yes
deleteMopTemplate(id, callback)	Delete a Command Template	{base_path}/{version}/mop/deleteTemplate/{pathv1}?{query}	Yes
deleteMopAnalyticTemplate(id, callback)	Delete an Analytic Template	{base_path}/{version}/mop/deleteAnalyticTemplate/{pathv1}?{query}	Yes
updateMopTemplate(mopID, mop, callback)	Update a Command Template	{base_path}/{version}/mop/updateTemplate/{pathv1}?{query}	Yes
updateMopAnalyticTemplate(mopID, template, callback)	Update an Analytic Template	{base_path}/{version}/mop/updateAnalyticTemplate/{pathv1}?{query}	Yes
runMopCommandDevices(command, variables, devices, callback)	Run a Command against Devices	{base_path}/{version}/mop/RunCommandDevices?{query}	Yes
runMopTemplateDevice(template, variables, device, callback)	Run a Template against a Devices (Deprecated)	{base_path}/{version}/mop/RunTemplateDevice?{query}	Yes
runMopTemplateDevices(template, variables, devices, callback)	Run a Template against Devices (Deprecated)	{base_path}/{version}/mop/RunTemplateDevices?{query}	Yes
runMopCommand(command, variables, device, callback)	Run a Command against a Device	{base_path}/{version}/mop/RunCommand?{query}	Yes
runMopCommandTemplate(template, variables, devices, callback)	Run Command Template	{base_path}/{version}/mop/RunCommandTemplate?{query}	Yes
runMopCommandTemplateSingleCommand(templateId, commandIndex, variables, devices, callback)	Run single command from template	{base_path}/{version}/mop/RunCommandTemplateSingleCommand?{query}	Yes
mopGetBootFlash(device, callback)	MOP Get Boot Flash	{base_path}/{version}/mop/GetBootFlash?{query}	Yes
mopSetBoot(device, disk, fileName, ned, deletePrevious, callback)	Task to set the boot parameters (Deprecated)	{base_path}/{version}/mop/SetBoot?{query}	Yes
mopPassThruCommand(device, command, callback)	MOP Pass Thru	{base_path}/{version}/mop/passThru/{pathv1}?{query}	Yes
getMopDevicesObjectsFiltered(options, callback)	Get Filtered Devices	{base_path}/{version}/mop/deviceObjects?{query}	Yes
getMopDevicesFilteredDetailedResults(substring, callback)	Get Filtered Devices with detailed query results	{base_path}/{version}/mop/devices/detailed/{pathv1}?{query}	Yes
runMopTemplatesDiffArray(pre, post, callback)	MOP Diff Array (Deprecated)	{base_path}/{version}/mop/runTemplatesDiffArray?{query}	Yes
runMopAnalyticsTemplate(pre, post, analyticTemplateName, variables, callback)	Run an Analytics Template	{base_path}/{version}/mop/runAnalyticsTemplate?{query}	Yes
runMopAnalyticsTemplateDevices(pre, post, analyticTemplateName, variables, callback)	Run an Analytics Template for Devices	{base_path}/{version}/mop/runAnalyticsTemplateDevices?{query}	Yes
mopReattempt(jobId, attemptID, minutes, attempts, callback)	Re-attempt	{base_path}/{version}/mop/reattempt?{query}	Yes
getMopDevicesFiltered(substring, callback)	Get Filtered Devices	{base_path}/{version}/mop/devices/{pathv1}?{query}	Yes
getArtifacts(queryOptions, callback)	Get all installed artifacts	{base_path}/{version}/admin/artifacts?{query}	Yes
updateArtifact(id, callback)	Updates an artifact	{base_path}/{version}/admin/artifacts/{pathv1}?{query}	Yes
removeArtifact(id, callback)	Remove an artifact	{base_path}/{version}/admin/artifacts/{pathv1}?{query}	Yes
importArtifact(artifact, callback)	Import an artifact	{base_path}/{version}/admin/artifacts/import?{query}	Yes
undiscoverAll(callback)	undiscoverAll	{base_path}/{version}/ag-manager/actions?{query}	Yes
getAllAdaptersAllClusters(callback)	getAllAdaptersAllClusters	{base_path}/{version}/ag-manager/getClusterAdapters?{query}	Yes
discoverModules(adapterId, callback)	discoverModules	{base_path}/{version}/ag-manager/actions/{pathv1}?{query}	Yes
undiscoverModules(adapterId, callback)	undiscoverModules	{base_path}/{version}/ag-manager/actions/{pathv1}?{query}	Yes
getPageOfTemplateDocuments(limit, skip, order, sort, include, exclude, inParam, notIn, equals, contains, startsWith, endsWith, callback)	getPageOfTemplateDocuments.	{base_path}/{version}/automation-studio/templates?{query}	Yes
createNewTemplateDocument(body, callback)	createNewTemplateDocument.	{base_path}/{version}/automation-studio/templates?{query}	Yes
importNewTemplateDocument(body, callback)	importNewTemplateDocument.	{base_path}/{version}/automation-studio/templates/import?{query}	Yes
getAllAvailableRestCallsIAP(callback)	getAllAvailableRestCallsIAP.	{base_path}/{version}/automation-studio/json-forms/method-options?{query}	Yes
getListOfAllAppsAndAdapters(callback)	getListOfAllAppsAndAdapters	{base_path}/{version}/automation-studio/apps/list?{query}	Yes
getPageOfWorkflowDocuments(limit, skip, order, sort, include, exclude, expand, inParam, notIn, equals, contains, startsWith, endsWith, callback)	getPageOfWorkflowDocuments.	{base_path}/{version}/automation-studio/workflows?{query}	Yes
createNewWorkflowDocument(body, callback)	createNewWorkflowDocument.	{base_path}/{version}/automation-studio/automations?{query}	Yes
importNewWorkflowDocument(body, callback)	importNewWorkflowDocument.	{base_path}/{version}/automation-studio/automations/import?{query}	Yes
getPageOfComponentGroupDocuments(limit, skip, order, sort, include, exclude, inParam, notIn, equals, contains, startsWith, endsWith, callback)	getPageOfComponentGroupDocuments.	{base_path}/{version}/automation-studio/component-groups?{query}	Yes
createNewComponentGroupDocument(body, callback)	createNewComponentGroupDocument.	{base_path}/{version}/automation-studio/component-groups?{query}	Yes
importNewComponentGroupDocument(body, callback)	importNewComponentGroupDocument.	{base_path}/{version}/automation-studio/component-groups/import?{query}	Yes
validateWorkflow(body, callback)	validateWorkflow	{base_path}/{version}/automation-studio/workflows/validate?{query}	Yes
getReferencesToParticularDocument(targetType, targetIdentifiers, referrerType, callback)	getReferencesToParticularDocument.	{base_path}/{version}/automation-studio/references-to?{query}	Yes
getMultipleTaskDetails(body, callback)	getMultipleTaskDetails	{base_path}/{version}/automation-studio/multipleTaskDetails?{query}	Yes
getSingleTemplateDocument(id, include, exclude, callback)	getSingleTemplateDocument.	{base_path}/{version}/automation-studio/templates/{pathv1}?{query}	Yes
deleteTemplateDocument(id, callback)	deleteTemplateDocument.	{base_path}/{version}/automation-studio/templates/{pathv1}?{query}	Yes
replaceTemplateDocument(id, body, callback)	replaceTemplateDocument.	{base_path}/{version}/automation-studio/templates/{pathv1}?{query}	Yes
exportTemplateDocument(id, callback)	exportTemplateDocument.	{base_path}/{version}/automation-studio/templates/{pathv1}/export?{query}	Yes
transformDataUsingJSTTransformationDocument(transformationId, body, callback)	transformDataUsingJSTTransformationDocument.	{base_path}/{version}/automation-studio/json-forms/runTransformation/{pathv1}?{query}	Yes
getDetailsOfWorkflow(name, callback)	getDetailsOfWorkflow	{base_path}/{version}/automation-studio/workflows/detailed/{pathv1}?{query}	Yes
replaceWorkflowDocument(id, body, callback)	replaceWorkflowDocument.	{base_path}/{version}/automation-studio/automations/{pathv1}?{query}	Yes
getComponentGroup(id, include, exclude, callback)	getComponentGroup.	{base_path}/{version}/automation-studio/component-groups/{pathv1}?{query}	Yes
deleteComponentGroupDocument(id, callback)	deleteComponentGroupDocument.	{base_path}/{version}/automation-studio/component-groups/{pathv1}?{query}	Yes
replaceComponentGroupDocument(id, body, callback)	replaceComponentGroupDocument.	{base_path}/{version}/automation-studio/component-groups/{pathv1}?{query}	Yes
migrateAgendaJobs(body, callback)	migrateAgendaJobs	{base_path}/{version}/automation_catalog/automations/migration?{query}	Yes
fetchesOSTypesToStoreIntoCache(body, callback)	fetchesOSTypesToStoreIntoCache.	{base_path}/{version}/configuration_manager/cache/devices/ostype?{query}	Yes
fetchesOSTypesStoredCache(callback)	fetchesOSTypesStoredCache.	{base_path}/{version}/configuration_manager/cache/devices/ostype?{query}	Yes
deleteCacheForOsTypes(callback)	deleteCacheForOsTypes.	{base_path}/{version}/configuration_manager/cache/devices/ostype?{query}	Yes
deletePinnedItems(callback)	deletePinnedItems.	{base_path}/{version}/configuration_manager/pins?{query}	Yes
handlePin(body, callback)	handlePin	{base_path}/{version}/configuration_manager/pins?{query}	Yes
getListOfPinnedItems(body, callback)	getListOfPinnedItems.	{base_path}/{version}/configuration_manager/pins/fetch?{query}	Yes
renderJinja2Template(body, callback)	renderJinja2Template.	{base_path}/{version}/configuration_manager/jinja2?{query}	Yes
getDataForAllAdaptersWithTasks(body, callback)	getDataForAllAdaptersWithTasks.	{base_path}/{version}/configuration_manager/adaptertasks/search?{query}	Yes
getDataForSpecificAdapterTask(body, callback)	getDataForSpecificAdapterTask.	{base_path}/{version}/configuration_manager/adaptertasks?{query}	Yes
createTaskInstance(body, callback)	createTaskInstance.	{base_path}/{version}/configuration_manager/tasks/instance?{query}	Yes
updateTaskInstance(body, callback)	updateTaskInstance.	{base_path}/{version}/configuration_manager/tasks/instance?{query}	Yes
deleteTaskInstanceS(callback)	deleteTaskInstance(s).	{base_path}/{version}/configuration_manager/tasks/instance?{query}	Yes
getTaskInstances(body, callback)	getTaskInstance(s).	{base_path}/{version}/configuration_manager/tasks/instances?{query}	Yes
runTaskInstance(body, callback)	runTaskInstance.	{base_path}/{version}/configuration_manager/tasks/instance/run?{query}	Yes
runAnAdapterTask(body, callback)	runAnAdapterTask.	{base_path}/{version}/configuration_manager/tasks/run?{query}	Yes
searchDeviceGroups(body, callback)	searchDeviceGroups	{base_path}/{version}/configuration_manager/deviceGroups/query?{query}	Yes
createConfigParser(body, callback)	createConfigParser.	{base_path}/{version}/configuration_manager/configurations/parser?{query}	Yes
updateConfigParser(body, callback)	updateConfigParser.	{base_path}/{version}/configuration_manager/configurations/parser?{query}	Yes
deleteConfigParser(callback)	deleteConfigParser.	{base_path}/{version}/configuration_manager/configurations/parser?{query}	Yes
getAllConfigParsers(start, limit, regex, filter, sort, callback)	getAllConfigParsers.	{base_path}/{version}/configuration_manager/configurations/parser?{query}	Yes
getConfigParser(body, callback)	getConfigParser.	{base_path}/{version}/configuration_manager/configurations/parser/search?{query}	Yes
deleteOneOrMoreConfigParsersById(callback)	deleteOneOrMoreConfigParsersById	{base_path}/{version}/configuration_manager/configurations/parsers?{query}	Yes
importParserDocuments(body, callback)	importParserDocuments	{base_path}/{version}/configuration_manager/import/parsers?{query}	Yes
searchGoldenConfigTrees(body, callback)	searchGoldenConfigTrees.	{base_path}/{version}/configuration_manager/search/configs?{query}	Yes
findTreesWhichContainSpecifiedDevice(body, callback)	findTreesWhichContainSpecifiedDevice.	{base_path}/{version}/configuration_manager/devices/device/trees?{query}	Yes
fetchAllDevicesThatExistOnTree(body, callback)	fetchAllDevicesThatExistOnTree.	{base_path}/{version}/configuration_manager/devices/tree?{query}	Yes
updateJSONConfigRules(body, callback)	updateJSONConfigRules	{base_path}/{version}/configuration_manager/configurations/rules?{query}	Yes
removeDeviceGroupsFromNode(callback)	removeDeviceGroupsFromNode	{base_path}/{version}/configuration_manager/configs/devices/groups?{query}	Yes
addDeviceGroupsToNode(body, callback)	addDeviceGroupsToNode	{base_path}/{version}/configuration_manager/configs/devices/groups?{query}	Yes
addTasksToNode(body, callback)	addTasksToNode	{base_path}/{version}/configuration_manager/configs/node/tasks?{query}	Yes
removeTasksFromNode(callback)	removeTasksFromNode	{base_path}/{version}/configuration_manager/configs/node/tasks?{query}	Yes
getConfigSpecTemplate(body, callback)	getConfigSpecTemplate.	{base_path}/{version}/configuration_manager/config_template?{query}	Yes
updateNodeConfiguration(body, callback)	updateNodeConfiguration.	{base_path}/{version}/configuration_manager/node/config?{query}	Yes
convertConfigSpecIntoReadableString(body, callback)	convertConfigSpecIntoReadableString.	{base_path}/{version}/configuration_manager/translate/config_spec?{query}	Yes
getJSONSpecDocumentWithInheritance(body, callback)	getJSONSpecDocumentWithInheritance.	{base_path}/{version}/configuration_manager/json_specs?{query}	Yes
createNewJSONSpec(body, callback)	createNewJSONSpec.	{base_path}/{version}/configuration_manager/json_specs/create?{query}	Yes
runComplianceReports(body, callback)	runComplianceReports.	{base_path}/{version}/configuration_manager/compliance_reports/config?{query}	Yes
runComplianceReportsOnBackups(body, callback)	runComplianceReportsOnBackups.	{base_path}/{version}/configuration_manager/compliance_reports/backups?{query}	Yes
getHistoricalGradedComplianceReports(body, callback)	getHistoricalGradedComplianceReports.	{base_path}/{version}/configuration_manager/json_compliance_reports/grade/history?{query}	Yes
complianceReportsTotalsForBackup(body, callback)	complianceReportsTotalsForBackup.	{base_path}/{version}/configuration_manager/compliance_reports/history/backups?{query}	Yes
complianceReportsTotalsForTaskInstance(body, callback)	complianceReportsTotalsForTaskInstance.	{base_path}/{version}/configuration_manager/json_compliance_reports/history?{query}	Yes
getTopIssuesFromJSONComplianceReports(body, callback)	getTopIssuesFromJSONComplianceReports	{base_path}/{version}/configuration_manager/json_compliance_reports/topissues?{query}	Yes
convertPatchDataToNativeConfig(body, callback)	convertPatchDataToNativeConfig.	{base_path}/{version}/configuration_manager/changes/convert?{query}	Yes
createDeviceTemplate(body, callback)	createDeviceTemplate	{base_path}/{version}/configuration_manager/templates?{query}	Yes
updateDeviceTemplate(body, callback)	updateDeviceTemplate	{base_path}/{version}/configuration_manager/templates?{query}	Yes
deleteOneOrMoreDeviceTemplateSById(callback)	deleteOneOrMoreDeviceTemplate(s)ById	{base_path}/{version}/configuration_manager/templates?{query}	Yes
getDeviceTemplate(body, callback)	getDeviceTemplate	{base_path}/{version}/configuration_manager/templates/search?{query}	Yes
importDeviceConfigTemplateDocuments(body, callback)	importDeviceConfigTemplateDocuments	{base_path}/{version}/configuration_manager/import/templates?{query}	Yes
applyDeviceConfigTemplate(body, callback)	applyDeviceConfigTemplate	{base_path}/{version}/configuration_manager/templates/apply?{query}	Yes
getJSONSpecDocument(id, callback)	getJSONSpecDocument.	{base_path}/{version}/configuration_manager/json_specs/{pathv1}?{query}	Yes
updateJSONSpec(id, body, callback)	updateJSONSpec	{base_path}/{version}/configuration_manager/json_specs/{pathv1}?{query}	Yes
getComplianceReportMetadataForBatch(batchId, callback)	getComplianceReportMetadataForBatch.	{base_path}/{version}/configuration_manager/json_compliance_reports/batch/{pathv1}?{query}	Yes
getJSONComplianceReport(reportId, callback)	getJSONComplianceReport	{base_path}/{version}/configuration_manager/json_compliance_reports/details/{pathv1}?{query}	Yes
applyDeviceConfig(deviceName, body, callback)	applyDeviceConfig	{base_path}/{version}/configuration_manager/devices/{pathv1}/configuration?{query}	Yes
getOperationalDataForDevice(deviceName, body, callback)	getOperationalDataForDevice	{base_path}/{version}/configuration_manager/devices/{pathv1}/operationaldata?{query}	Yes
saveGeneratedForm(body, callback)	saveGeneratedForm	{base_path}/{version}/formbuilder/saveForm?{query}	Yes
preserveIncomingFormDataFormat(body, callback)	preserveIncomingFormDataFormat	{base_path}/{version}/formbuilder/preserveFormData?{query}	Yes
listAllFormNames(callback)	listAllFormNames	{base_path}/{version}/formbuilder/listForms?{query}	Yes
searchForms(body, callback)	searchForms	{base_path}/{version}/formbuilder/forms/search?{query}	Yes
getServiceInstanceData(body, callback)	getServiceInstanceData	{base_path}/{version}/formbuilder/fetchData?{query}	Yes
listAllElementsUsableForms(callback)	listAllElementsUsableForms	{base_path}/{version}/formbuilder/listElements?{query}	Yes
exportForm(body, callback)	exportForm	{base_path}/{version}/formbuilder/forms/export?{query}	Yes
importForm(body, callback)	importForm	{base_path}/{version}/formbuilder/forms/import?{query}	Yes
getDetailsOfFormByName(formName, callback)	getDetailsOfFormByName	{base_path}/{version}/formbuilder/getFormByName/{pathv1}?{query}	Yes
getDetailsOfFormByID(formId, callback)	getDetailsOfFormByID	{base_path}/{version}/formbuilder/getForm/{pathv1}?{query}	Yes
deleteFormByID(id, callback)	deleteFormByID	{base_path}/{version}/formbuilder/deleteForm/{pathv1}?{query}	Yes
listGroupsForForm(name, callback)	listGroupsForForm	{base_path}/{version}/formbuilder/forms/{pathv1}/groups?{query}	Yes
overwriteGroupsForForm(name, body, callback)	overwriteGroupsForForm	{base_path}/{version}/formbuilder/forms/{pathv1}/groups?{query}	Yes
addGroupToForm(name, body, callback)	addGroupToForm	{base_path}/{version}/formbuilder/forms/{pathv1}/groups?{query}	Yes
deleteFormGroups(name, callback)	deleteFormGroups	{base_path}/{version}/formbuilder/forms/{pathv1}/groups?{query}	Yes
getAnElementDefinition(type, id, callback)	getAnElementDefinition.	{base_path}/{version}/formbuilder/getElementDefinition/{pathv1}/{pathv2}?{query}	Yes
removeGroupFromForm(name, group, callback)	removeGroupFromForm	{base_path}/{version}/formbuilder/forms/{pathv1}/groups/{pathv2}?{query}	Yes
createJsonForm(body, callback)	createJsonForm	{base_path}/{version}/json-forms/forms?{query}	Yes
returnAllForms(callback)	returnAllForms	{base_path}/{version}/json-forms/forms?{query}	Yes
deleteForms(callback)	deleteForms	{base_path}/{version}/json-forms/forms?{query}	Yes
importFormDocuments(body, callback)	importFormDocuments	{base_path}/{version}/json-forms/import/forms?{query}	Yes
validateDataAgainstSchema(body, callback)	validateDataAgainstSchema.	{base_path}/{version}/json-forms/validate-data?{query}	Yes
convertYANGToJSONSchema(body, callback)	convertYANGToJSONSchema.	{base_path}/{version}/json-forms/yangToSchema?{query}	Yes
decodeAnEncodedJSONSchema(body, callback)	decodeAnEncodedJSONSchema.	{base_path}/{version}/json-forms/decode?{query}	Yes
findForm(id, callback)	findForm	{base_path}/{version}/json-forms/forms/{pathv1}?{query}	Yes
updateForm(id, body, callback)	updateForm	{base_path}/{version}/json-forms/forms/{pathv1}?{query}	Yes
validateFormDataAgainstItsSchema(id, body, callback)	validateFormDataAgainstItsSchema	{base_path}/{version}/json-forms/validate-form/{pathv1}?{query}	Yes
createNewResourceModel(body, callback)	createNewResourceModel	{base_path}/{version}/lifecycle-manager/resources?{query}	Yes
importResourceModel(body, callback)	importResourceModel	{base_path}/{version}/lifecycle-manager/resources/import?{query}	Yes
deleteResourceModel(id, callback)	deleteResourceModel	{base_path}/{version}/lifecycle-manager/resources/{pathv1}?{query}	Yes
getResourceModelBasedOnId(id, dereference, callback)	getResourceModelBasedOnId	{base_path}/{version}/lifecycle-manager/resources/{pathv1}?{query}	Yes
updateResourceModel(id, body, callback)	updateResourceModel	{base_path}/{version}/lifecycle-manager/resources/{pathv1}?{query}	Yes
editResourceModelHttp(modelId, body, callback)	editResourceModelHttp	{base_path}/{version}/lifecycle-manager/resources/{pathv1}/edit?{query}	Yes
exportResourceModel(modelId, callback)	exportResourceModel	{base_path}/{version}/lifecycle-manager/resources/{pathv1}/export?{query}	Yes
getSingleActionExecutionRecord(id, sync, callback)	getSingleActionExecutionRecord	{base_path}/{version}/lifecycle-manager/action-executions/{pathv1}?{query}	Yes
runResourceAction(modelId, body, callback)	runResourceAction	{base_path}/{version}/lifecycle-manager/resources/{pathv1}/run-action?{query}	Yes
validateActionsDefinedOnResourceModel(modelId, body, callback)	validateActionsDefinedOnResourceModel	{base_path}/{version}/lifecycle-manager/resources/{pathv1}/actions/validate?{query}	Yes
getSingleResourceInstance(modelId, instanceId, callback)	getSingleResourceInstance	{base_path}/{version}/lifecycle-manager/resources/{pathv1}/instances/{pathv2}?{query}	Yes
updateInstanceMetadataHttp(modelId, instanceId, body, callback)	update`name`And`description`FieldsOfResourceInstance	{base_path}/{version}/lifecycle-manager/resources/{pathv1}/instances/{pathv2}?{query}	Yes
findDiffOfTwoConfigStrings(body, callback)	findDiffOfTwoConfigStrings.	{base_path}/{version}/mop/diff?{query}	Yes
getJSONSchemasOfServiceModels(body, callback)	getJSONSchemasOfServiceModels.	{base_path}/{version}/nso_manager/serviceModel/schemas?{query}	Yes
runLiveStatusCommandAgainstListOfDevices(body, callback)	runLiveStatusCommandAgainstListOfDevices	{base_path}/{version}/nso_manager/runCommand?{query}	Yes
runListOfLiveStatusCommandsAgainstListOfDevices(body, callback)	runListOfLiveStatusCommandsAgainstListOfDevices	{base_path}/{version}/nso_manager/runCommands?{query}	Yes
runLiveStatus(body, callback)	runLiveStatus	{base_path}/{version}/nso_manager/liveStatus?{query}	Yes
runIsLive(body, callback)	runIsLive	{base_path}/{version}/nso_manager/isAlive?{query}	Yes
applytemplateTask(body, callback)	applytemplateTask	{base_path}/{version}/nso_manager/applyTemplates?{query}	Yes
getAllNEDsNSO(callback)	getAllNEDsNSO	{base_path}/{version}/nso_manager/allNeds?{query}	Yes
getAllAuthenticationGroups(callback)	getAllAuthenticationGroups	{base_path}/{version}/nso_manager/allAuthgroups?{query}	Yes
getRollbackFiles(body, callback)	getRollbackFilesBasedOnLabel/comment/fixed-number.	{base_path}/{version}/nso_manager/getRollbackFiles?{query}	Yes
getLeafrefValuesFromNSO(body, callback)	getLeafrefValuesFromNSO	{base_path}/{version}/nso_manager/getLeafrefValues?{query}	Yes
evaluateWhen(body, callback)	evaluateWhen.	{base_path}/{version}/nso_manager/evaluateWhen?{query}	Yes
validateCommit(body, callback)	validateCommit.	{base_path}/{version}/nso_manager/validateCommit?{query}	Yes
getCommitQueueItems(adapterId, callback)	getCommitQueueItems	{base_path}/{version}/nso_manager/getCommitQueueDeep/{pathv1}?{query}	Yes
addLockItem(adapterId, body, callback)	addLockItem	{base_path}/{version}/nso_manager/lockItem/{pathv1}?{query}	Yes
pruneDevicesFromAllItems(adapterId, body, callback)	pruneDevicesFromAllItems	{base_path}/{version}/nso_manager/queueItems/prune/{pathv1}?{query}	Yes
getAllQueuedDevices(adapterId, callback)	getAllQueuedDevices	{base_path}/{version}/nso_manager/queuedDevices/{pathv1}?{query}	Yes
setleafTask(adapterId, body, callback)	setleafTask	{base_path}/{version}/nso_manager/setLeaf/{pathv1}?{query}	Yes
runAction(adapterId, body, callback)	runAction	{base_path}/{version}/nso_manager/runAction/{pathv1}?{query}	Yes
setitemnacmgroupTask(adapterId, body, callback)	setitemnacmgroupTask	{base_path}/{version}/nso_manager/setItemNacmGroup/{pathv1}?{query}	Yes
getNEDsNSO(adapterId, callback)	getNEDsNSO	{base_path}/{version}/nso_manager/neds/{pathv1}?{query}	Yes
getAllNEDsDetailed(adapterId, callback)	getAllNEDsDetailed	{base_path}/{version}/nso_manager/neds/deep/{pathv1}?{query}	Yes
getAuthenticationGroups(adapterId, callback)	getAuthenticationGroups	{base_path}/{version}/nso_manager/authgroups/{pathv1}?{query}	Yes
restqueryTask(adapterId, body, callback)	restqueryTask	{base_path}/{version}/nso_manager/restQuery/{pathv1}?{query}	Yes
makeRESTActionsToNSO(adapterId, body, callback)	makeRESTActionsToNSO	{base_path}/{version}/nso_manager/restAction/{pathv1}?{query}	Yes
getFilteredDevices(substring, callback)	getFilteredDevices	{base_path}/{version}/nso_manager/devices/{pathv1}?{query}	Yes
validateNetworkConfiguration(adapter, nedid, body, callback)	validateNetworkConfiguration	{base_path}/{version}/nso_manager/verifyConfig/{pathv1}/{pathv2}?{query}	Yes
deleteQueueItem(queueItemId, adapterId, callback)	deleteQueueItem	{base_path}/{version}/nso_manager/queueItem/{pathv1}/{pathv2}?{query}	Yes
lockQueueItem(queueItemId, adapterId, callback)	lockQueueItem	{base_path}/{version}/nso_manager/queueItem/lock/{pathv1}/{pathv2}?{query}	Yes
unlockQueueItem(queueItemId, adapterId, callback)	unlockQueueItem	{base_path}/{version}/nso_manager/queueItem/unlock/{pathv1}/{pathv2}?{query}	Yes
pruneDevicesFromAnItem(queueItemId, adapterId, body, callback)	pruneDevicesFromAnItem	{base_path}/{version}/nso_manager/queueItem/prune/{pathv1}/{pathv2}?{query}	Yes
getItemSDetails(adapterId, queueItemId, callback)	getItem'sDetails	{base_path}/{version}/nso_manager/queueItem/detailed/{pathv1}/{pathv2}?{query}	Yes
getFilteredDevicesFromAnAdapter(substring, lockedAdapter, callback)	getFilteredDevicesFromAnAdapter	{base_path}/{version}/nso_manager/devices/{pathv1}/{pathv2}?{query}	Yes
cloneAutomation(body, callback)	cloneAutomation	{base_path}/{version}/operations-manager/automations/clone?{query}	Yes
createOperationsManagerAutomation(body, callback)	createAutomation	{base_path}/{version}/operations-manager/automations?{query}	Yes
getOperationsManagerAutomations(contains, containsField, equals, equalsField, startsWith, startsWithField, limit, skip, order, sort, callback)	getAutomations	{base_path}/{version}/operations-manager/automations?{query}	Yes
importOperationsManagerAutomations(body, callback)	importAutomations	{base_path}/{version}/operations-manager/automations?{query}	Yes
getTriggers(contains, containsField, equals, equalsField, startsWith, startsWithField, greaterThanField, greaterThan, lessThanField, lessThan, enabled, actionId, limit, skip, order, sort, callback)	getTriggers	{base_path}/{version}/operations-manager/triggers?{query}	Yes
createTrigger(body, callback)	createTrigger	{base_path}/{version}/operations-manager/triggers?{query}	Yes
importTriggers(body, callback)	importTriggers	{base_path}/{version}/operations-manager/triggers?{query}	Yes
getEvents(source, topic, limit, skip, sort, callback)	OperationsManagerEvents_GET	{base_path}/{version}/operations-manager/events?{query}	Yes
getPageOfTaskDocumentsBypassingGBAC(limit, skip, order, sort, include, exclude, inParam, notIn, equals, contains, startsWith, endsWith, dereference, gt, gte, lt, lte, q, callback)	getPageOfTaskDocuments,BypassingGBAC.	{base_path}/{version}/operations-manager/tasks?{query}	Yes
unwatchJobs(body, callback)	unwatchJobs	{base_path}/{version}/operations-manager/jobs/unwatch?{query}	Yes
watchJobs(body, callback)	watchJobs	{base_path}/{version}/operations-manager/jobs/watch?{query}	Yes
getPageOfJobDocuments(limit, skip, order, sort, include, exclude, inParam, notIn, equals, contains, startsWith, endsWith, dereference, gt, gte, lt, lte, q, callback)	getPageOfJobDocuments.	{base_path}/{version}/operations-manager/jobs?{query}	Yes
startJob(body, callback)	startJob.	{base_path}/{version}/operations-manager/jobs/start?{query}	Yes
pauseJobs(body, callback)	pauseJobs.	{base_path}/{version}/operations-manager/jobs/pause?{query}	Yes
resumeJobs(body, callback)	resumeJobs.	{base_path}/{version}/operations-manager/jobs/resume?{query}	Yes
cancelJobs(body, callback)	cancelJobs.	{base_path}/{version}/operations-manager/jobs/cancel?{query}	Yes
deleteOperationsManagerAutomation(id, callback)	deleteOperationsManagerAutomation	{base_path}/{version}/operations-manager/automations/{pathv1}?{query}	Yes
getOperationsManagerAutomation(id, callback)	getAutomation	{base_path}/{version}/operations-manager/automations/{pathv1}?{query}	Yes
updateOperationsManagerAutomation(id, body, callback)	updateAutomation	{base_path}/{version}/operations-manager/automations/{pathv1}?{query}	Yes
exportOperationsManagerAutomation(id, callback)	exportAutomation	{base_path}/{version}/operations-manager/automations/{pathv1}/export?{query}	Yes
getTrigger(id, callback)	getTrigger	{base_path}/{version}/operations-manager/triggers/{pathv1}?{query}	Yes
updateTrigger(id, body, callback)	updateTrigger	{base_path}/{version}/operations-manager/triggers/{pathv1}?{query}	Yes
deleteTrigger(id, callback)	deleteTrigger	{base_path}/{version}/operations-manager/triggers/{pathv1}?{query}	Yes
deleteTriggersByActionID(id, callback)	deleteTriggersByActionID	{base_path}/{version}/operations-manager/triggers/action/{pathv1}?{query}	Yes
exportTrigger(id, callback)	exportTrigger	{base_path}/{version}/operations-manager/triggers/{pathv1}/export?{query}	Yes
runEndpointTriggerWithPOST(routeName, body, callback)	runEndpointTriggerWithPOST	{base_path}/{version}/operations-manager/triggers/endpoint/{pathv1}?{query}	Yes
runManualTrigger(id, body, callback)	runManualTrigger	{base_path}/{version}/operations-manager/triggers/manual/{pathv1}/run?{query}	Yes
claimTaskOpsMgr(taskId, callback)	claimTaskOpsMgr	{base_path}/{version}/operations-manager/tasks/{pathv1}/claim?{query}	Yes
assignTaskToUser(taskId, body, callback)	assignTaskToUser	{base_path}/{version}/operations-manager/tasks/{pathv1}/assign?{query}	Yes
releaseCurrentlyAssignedTask(taskId, callback)	releaseCurrentlyAssignedTask	{base_path}/{version}/operations-manager/tasks/{pathv1}/release?{query}	Yes
getTaskByID(id, include, exclude, dereference, callback)	getTaskByID	{base_path}/{version}/operations-manager/tasks/{pathv1}?{query}	Yes
watchOpsMgrJob(jobId, callback)	watchOpsMgrJob	{base_path}/{version}/operations-manager/jobs/{pathv1}/watch?{query}	Yes
unwatchOpsMgrJob(jobId, callback)	unwatchOpsMgrJob	{base_path}/{version}/operations-manager/jobs/{pathv1}/unwatch?{query}	Yes
addWatchersToJobOpsMgr(jobId, body, callback)	addWatchersToJobOpsMgr	{base_path}/{version}/operations-manager/jobs/{pathv1}/add-watchers?{query}	Yes
continueJobFromSpecifiedTask(jobId, body, callback)	continueJobFromSpecifiedTask	{base_path}/{version}/operations-manager/jobs/{pathv1}/continue?{query}	Yes
revertJobOpsMgr(jobId, body, callback)	revertJobOpsMgr	{base_path}/{version}/operations-manager/jobs/{pathv1}/revert?{query}	Yes
getEventDefinition(source, topic, callback)	OperationsManagerEventsBySourceAndTopic_GET	{base_path}/{version}/operations-manager/events/{pathv1}/{pathv2}?{query}	Yes
retryTask(jobId, taskId, body, callback)	retryTask	{base_path}/{version}/operations-manager/jobs/{pathv1}/tasks/{pathv2}/retry?{query}	Yes
finishManualTaskOpsMgr(jobId, taskId, body, callback)	finishManualTaskOpsMgr	{base_path}/{version}/operations-manager/jobs/{pathv1}/tasks/{pathv2}/finish?{query}	Yes
searchIAP(body, callback)	searchIAP	{base_path}/{version}/search/find?{query}	Yes
listOfServiceModels(callback)	listOfServiceModels	{base_path}/{version}/service_catalog/ServiceModels?{query}	Yes
getUserGroups(callback)	getUserGroups	{base_path}/{version}/service_catalog/getGroups?{query}	Yes
getWorkflows(callback)	getWorkflows	{base_path}/{version}/service_catalog/GetWorkflows?{query}	Yes
addServiceToCatalogStore(body, callback)	addServiceToCatalogStore	{base_path}/{version}/service_catalog/AddNewService?{query}	Yes
updateServiceCatalogStore(body, callback)	updateServiceCatalogStore	{base_path}/{version}/service_catalog/UpdateService?{query}	Yes
getCurrentUser(callback)	getCurrentUser	{base_path}/{version}/service_catalog/GetUserObject?{query}	Yes
getMultipleForms(callback)	getMultipleForms	{base_path}/{version}/service_catalog/GetForms?{query}	Yes
createNewServiceOrder(body, callback)	createNewServiceOrder	{base_path}/{version}/service_catalog/createServiceOrder?{query}	Yes
invokeServiceOrder(body, callback)	invokeServiceOrder	{base_path}/{version}/service_catalog/invokeServiceOrder?{query}	Yes
importCatalogItems(body, callback)	importCatalogItems	{base_path}/{version}/service_catalog/catalog-items/import?{query}	Yes
listServicesStore(filter, callback)	listServicesStore	{base_path}/{version}/service_catalog/ServiceCatalogStore/{pathv1}?{query}	Yes
getFormIDForService(serviceId, callback)	getFormIDForService	{base_path}/{version}/service_catalog/GetFormId/{pathv1}?{query}	Yes
getFormData(formId, callback)	getFormData	{base_path}/{version}/service_catalog/GetFormData/{pathv1}?{query}	Yes
deleteService(id, callback)	deleteService	{base_path}/{version}/service_catalog/deleteService/{pathv1}?{query}	Yes
exportCatalogItem(catalogItemId, callback)	exportCatalogItem	{base_path}/{version}/service_catalog/catalog-items/{pathv1}/export?{query}	Yes
getAllServiceModelInformation(callback)	getAllServiceModelInformation.	{base_path}/{version}/service_management/service/models?{query}	Yes
listAllServiceModels(callback)	listAllServiceModels	{base_path}/{version}/service_management/service/models/list?{query}	Yes
getAllServiceModelDetails(callback)	getAllServiceModelDetails	{base_path}/{version}/service_management/service/details?{query}	Yes
getServiceInstanceList(callback)	getServiceInstanceList	{base_path}/{version}/service_management/service/instances?{query}	Yes
getServiceModelFields(callback)	getServiceModelFields	{base_path}/{version}/service_management/service/model/database?{query}	Yes
setUpdateServiceModelFields(body, callback)	set/updateServiceModelFields	{base_path}/{version}/service_management/service/model/database?{query}	Yes
getListOfMergedServiceModels(body, callback)	getListOfMergedServiceModels	{base_path}/{version}/service_management/service/models/update?{query}	Yes
setTenantForServiceInstance(body, callback)	setTenantForServiceInstance	{base_path}/{version}/service_management/service/setTenant?{query}	Yes
mapInstanceDataToServiceModel(body, callback)	mapInstanceDataToServiceModel	{base_path}/{version}/service_management/mapInstanceDataToModel?{query}	Yes
saveAnInstance(body, callback)	saveAnInstance	{base_path}/{version}/service_management/saveInstance?{query}	Yes
saveInstances(body, callback)	saveInstances	{base_path}/{version}/service_management/saveInstances?{query}	Yes
testAnInstance(body, callback)	testAnInstance	{base_path}/{version}/service_management/testInstance?{query}	Yes
configDryRun(body, callback)	configDryRun	{base_path}/{version}/service_management/testInstances?{query}	Yes
getDetailsOfServiceModel(serviceModelPath, callback)	getDetailsOfServiceModel	{base_path}/{version}/service_management/model/{pathv1}?{query}	Yes
deleteServiceModel(service, callback)	deleteServiceModel	{base_path}/{version}/service_management/service/model/database/remove/{pathv1}?{query}	Yes
getAllInstancesOfService(name, callback)	getAllInstancesOfService	{base_path}/{version}/service_management/service/instance/{pathv1}?{query}	Yes
getServiceInstanceCheckSyncStatus(pathParam, body, callback)	getServiceInstanceCheck-SyncStatus	{base_path}/{version}/service_management/instance/{pathv1}/operations/check-sync?{query}	Yes
getServiceInstanceConfiguration(pathParam, body, callback)	getServiceInstanceConfiguration	{base_path}/{version}/service_management/instance/{pathv1}/operations/config?{query}	Yes
getServiceInstanceDeviceModifications(pathParam, body, callback)	getServiceInstanceDeviceModifications	{base_path}/{version}/service_management/instance/{pathv1}/operations/device-modifications?{query}	Yes
issueReactiveReDeployOnServiceInstance(pathParam, body, callback)	issueReactiveRe-deployOnServiceInstance	{base_path}/{version}/service_management/instance/{pathv1}/operations/reactive-redeploy?{query}	Yes
deleteServiceInstances(name, body, callback)	deleteServiceInstances	{base_path}/{version}/service_management/service/instances/delete/{pathv1}?{query}	Yes
deleteServiceInstancesUsingPaths(host, body, callback)	deleteServiceInstancesUsingPaths	{base_path}/{version}/service_management/deleteServicePaths/{pathv1}?{query}	Yes
dryRunDeleteServiceInstances(host, body, callback)	dryRunDeleteServiceInstances	{base_path}/{version}/service_management/deleteServicePathsDryRun/{pathv1}?{query}	Yes
addSaveServiceInstance(host, body, callback)	add/saveServiceInstance	{base_path}/{version}/service_management/service/instance/{pathv1}?{query}	Yes
serviceInstanceDryRunWithFlags(host, body, callback)	serviceInstanceDryRunWithFlags	{base_path}/{version}/service_management/service/instance/{pathv1}/dryrun?{query}	Yes
addSaveMultipleServiceInstances(host, body, callback)	add/saveMultipleServiceInstances	{base_path}/{version}/service_management/service/instances/{pathv1}?{query}	Yes
createServiceModelForm(serviceModelPath, callback)	createServiceModelForm	{base_path}/{version}/service_management/model/{pathv1}/form?{query}	Yes
getDevicesServiceInstance(name, key, host, callback)	getDevicesServiceInstance	{base_path}/{version}/service_management/service/instance/devices/{pathv1}/{pathv2}/{pathv3}?{query}	Yes
deleteServiceInstance(name, key, callback)	deleteServiceInstance	{base_path}/{version}/service_management/service/instance/delete/{pathv1}/{pathv2}?{query}	Yes
deleteServiceInstanceFromPath(servicePath, host, callback)	deleteServiceInstanceFromPath	{base_path}/{version}/service_management/deleteServicePath/{pathv1}/{pathv2}?{query}	Yes
dryRunDeleteServiceInstanceFromPath(servicePath, host, callback)	dryRunDeleteServiceInstanceFromPath	{base_path}/{version}/service_management/deleteServicePathDryRun/{pathv1}/{pathv2}?{query}	Yes
dryRunServiceInstance(host, outformat, body, callback)	dry-runServiceInstance	{base_path}/{version}/service_management/service/instance/{pathv1}/dryrun/{pathv2}?{query}	Yes
getDetailsOfServiceInstance(model, value, callback)	getDetailsOfServiceInstance	{base_path}/{version}/service_management/getInstance/{pathv1}/{pathv2}?{query}	Yes
getTagDetailsGivenAnId(body, callback)	getTagDetailsGivenAnId	{base_path}/{version}/tags/get?{query}	Yes
findTagsByName(body, callback)	findTagsByName	{base_path}/{version}/tags/find?{query}	Yes
getAllTags(callback)	getAllTags	{base_path}/{version}/tags/all?{query}	Yes
createNewTag(body, callback)	createNewTag	{base_path}/{version}/tags/create?{query}	Yes
createManyNewTags(body, callback)	createManyNewTags	{base_path}/{version}/tags/createTags?{query}	Yes
referenceTagToPeiceOfContent(body, callback)	referenceTagToPeiceOfContent	{base_path}/{version}/tags/createReference?{query}	Yes
handleReferences(body, callback)	create/updateReferencesForTags	{base_path}/{version}/tags/handleReferences?{query}	Yes
getTagsByContentId(body, callback)	getTagsByContentId	{base_path}/{version}/tags/getTagsByReference?{query}	Yes
getTagRefsByContentIds(body, callback)	getTagRefsByContentIds	{base_path}/{version}/tags/getTagReferences?{query}	Yes
updatingExistingTag(body, callback)	updatingExistingTag	{base_path}/{version}/tags/update?{query}	Yes
cloneExistingTag(body, callback)	cloneExistingTag	{base_path}/{version}/tags/duplicate?{query}	Yes
deleteExistingTag(body, callback)	deleteExistingTag	{base_path}/{version}/tags/delete?{query}	Yes
parseTemplates(body, callback)	parseTemplates.	{base_path}/{version}/template_builder/parseTemplate?{query}	Yes
applyTemplateUpdated2023(body, callback)	applyTemplateUpdated2023	{base_path}/{version}/template_builder/applyTemplate?{query}	Yes
applyTemplatesUpdated2023(body, callback)	applyTemplatesUpdated2023	{base_path}/{version}/template_builder/applyTemplates?{query}	Yes
applyTemplate(body, callback)	applyTemplate	{base_path}/{version}/template_builder/applyTemplate?{query}	Yes
applyTemplates(body, callback)	applyTemplates	{base_path}/{version}/template_builder/applyTemplates?{query}	Yes
renderJinjaTemplate(name, body, callback)	renderJinjaTemplate	{base_path}/{version}/template_builder/templates/{pathv1}/renderJinja?{query}	Yes
searchTransformations(name, outgoing, schema, contains, containsField, equals, expand, limit, skip, callback)	searchTransformations.	{base_path}/{version}/transformations/?{query}	Yes
createTransformation(body, callback)	createTransformation.	{base_path}/{version}/transformations/?{query}	Yes
importTransformation(body, callback)	importTransformation.	{base_path}/{version}/transformations/import?{query}	Yes
getTransformationDocumentById(id, callback)	getTransformationDocumentById.	{base_path}/{version}/transformations/{pathv1}?{query}	Yes
updateSingleTransformation(id, body, callback)	updateSingleTransformation.	{base_path}/{version}/transformations/{pathv1}?{query}	Yes
deleteTransformation(id, callback)	deleteTransformation.	{base_path}/{version}/transformations/{pathv1}?{query}	Yes
runTransformation(id, body, callback)	runTransformation.	{base_path}/{version}/transformations/{pathv1}?{query}	Yes
getTasks(callback)	getTasks	{base_path}/{version}/workflow_builder/tasks/list?{query}	Yes
calculateIncomingOutgoingSchemasForWorkflow(body, callback)	calculateIncoming/outgoingSchemasForWorkflow	{base_path}/{version}/workflow_builder/workflows/schemas?{query}	Yes
addWorkflow(body, callback)	addWorkflow	{base_path}/{version}/workflow_builder/workflows/save?{query}	Yes
renameWorkflow(body, callback)	renameWorkflow	{base_path}/{version}/workflow_builder/workflows/rename?{query}	Yes
exportWorkflow(body, callback)	exportWorkflow	{base_path}/{version}/workflow_builder/export?{query}	Yes
importWorkflow(body, callback)	importWorkflow	{base_path}/{version}/workflow_builder/import?{query}	Yes
deleteWorkflow(name, callback)	deleteWorkflow	{base_path}/{version}/workflow_builder/workflows/delete/{pathv1}?{query}	Yes
listGroupsForWorkflow(name, callback)	listGroupsForWorkflow	{base_path}/{version}/workflow_builder/workflows/{pathv1}/groups?{query}	Yes
overwriteGroupsForWorkflow(name, body, callback)	overwriteGroupsForWorkflow	{base_path}/{version}/workflow_builder/workflows/{pathv1}/groups?{query}	Yes
addGroupToWorkflow(name, body, callback)	addGroupToWorkflow	{base_path}/{version}/workflow_builder/workflows/{pathv1}/groups?{query}	Yes
deleteAllGroupsForWorkflow(name, callback)	deleteAllGroupsForWorkflow	{base_path}/{version}/workflow_builder/workflows/{pathv1}/groups?{query}	Yes
getTaskDetailsWorkflowBuilder(app, task, callback)	getTaskDetailsWorkflowBuilder	{base_path}/{version}/workflow_builder/getTaskDetails/{pathv1}/{pathv2}?{query}	Yes
removeGroupFromWorkflow(name, group, callback)	removeGroupFromWorkflow	{base_path}/{version}/workflow_builder/workflows/{pathv1}/groups/{pathv2}?{query}	Yes
activateJobWorker(callback)	activateJobWorker	{base_path}/{version}/workflow_engine/jobWorker/activate?{query}	Yes
deactivateJobWorker(callback)	deactivateJobWorker	{base_path}/{version}/workflow_engine/jobWorker/deactivate?{query}	Yes
getAggregateJobMetrics(order, sort, skip, limit, greaterThanEquals, greaterThanEqualsField, contains, containsField, callback)	getAggregateJobMetrics	{base_path}/{version}/workflow_engine/jobs/metrics?{query}	Yes
getAggregateTaskMetrics(order, sort, skip, limit, greaterThanEquals, greaterThanEqualsField, equals, equalsField, callback)	getAggregateTaskMetrics	{base_path}/{version}/workflow_engine/tasks/metrics?{query}	Yes
getCurrentAndFutureStatesOfTaskAndJobWorkers(callback)	getCurrentAndFutureStatesOfTaskAndJobWorkers	{base_path}/{version}/workflow_engine/workers/status?{query}	Yes
getAdapterModelTypes(contains, equals, startsWith, order, callback)	Get the list of available adapter model types.	{base_path}/{version}/adapter-models/types?{query}	Yes
createAdapter(body, callback)	Create a new adapter.	{base_path}/{version}/adapters?{query}	Yes
getAdapters(contains, containsField, equals, equalsField, startsWith, startsWithField, skip, limit, sort, order, callback)	Get all adapters.	{base_path}/{version}/adapters?{query}	Yes
importAdapter(body, callback)	Import a new adapter.	{base_path}/{version}/adapters/import?{query}	Yes
deleteAdapter(name, callback)	Delete an adapter.	{base_path}/{version}/adapters/{pathv1}?{query}	Yes
getAdapter(name, callback)	Get a single adapter.	{base_path}/{version}/adapters/{pathv1}?{query}	Yes
updateAdapter(name, body, callback)	Update an adapter.	{base_path}/{version}/adapters/{pathv1}?{query}	Yes
exportAdapter(name, callback)	Export a single adapter.	{base_path}/{version}/adapters/{pathv1}/export?{query}	Yes
getAdapterChangeLogs(name, release, callback)	Get the list of changelogs.	{base_path}/{version}/adapters/{pathv1}/changelogs?{query}	Yes
startAdapter(name, callback)	Start an adapter.	{base_path}/{version}/adapters/{pathv1}/start?{query}	Yes
stopAdapter(name, callback)	Stop an adapter.	{base_path}/{version}/adapters/{pathv1}/stop?{query}	Yes
restartAdapter(name, callback)	Restart an adapter.	{base_path}/{version}/adapters/{pathv1}/restart?{query}	Yes
updateAdapterLogging(name, body, callback)	Update the log levels.	{base_path}/{version}/adapters/{pathv1}/loglevel?{query}	Yes
updateAdapterProperties(name, body, callback)	Update the properties of an adapter.	{base_path}/{version}/adapters/{pathv1}/properties?{query}	Yes
getBrokerMap(callback)	Get a mapping between brokers and adapters.	{base_path}/{version}/adapters/brokers/mapping?{query}	Yes
getApplication(name, callback)	Get a single application.	{base_path}/{version}/applications/{pathv1}?{query}	Yes
updateApplication(name, body, callback)	Update an application.	{base_path}/{version}/applications/{pathv1}?{query}	Yes
getApplicationChangelogs(name, release, callback)	Get the list of changelogs.	{base_path}/{version}/applications/{pathv1}/changelogs?{query}	Yes
getAllApplications(contains, containsField, equals, equalsField, startsWith, startsWithField, skip, limit, sort, order, callback)	Get all applications.	{base_path}/{version}/applications?{query}	Yes
startApplication(name, callback)	Start an application.	{base_path}/{version}/applications/{pathv1}/start?{query}	Yes
stopApplication(name, callback)	Stop an application.	{base_path}/{version}/applications/{pathv1}/stop?{query}	Yes
restartApplication(name, callback)	Restart an application.	{base_path}/{version}/applications/{pathv1}/restart?{query}	Yes
updateApplicationLogging(name, body, callback)	Update the log levels.	{base_path}/{version}/applications/{pathv1}/loglevel?{query}	Yes
updateApplicationProperties(name, body, callback)	Update the properties of an application.	{base_path}/{version}/applications/{pathv1}/properties?{query}	Yes
whoAmi(roles, callback)	Gets the authorization data for the logged in user	{base_path}/{version}/whoami?{query}	Yes
getMySession(callback)	Gets the session document for the active user	{base_path}/{version}/mySession?{query}	Yes
getMyPrincipal(callback)	Gets the principal document for the active user	{base_path}/{version}/myPrincipal?{query}	Yes
getMyTtl(callback)	Get the number of seconds until the logged in user's session expires.	{base_path}/{version}/myTtl?{query}	Yes
login(body, callback)	Log in an create a session in IAP	{base_path}/{version}/login?{query}	Yes
logout(callback)	Log out of IAP and delete current session	{base_path}/{version}/logout?{query}	Yes
downloadPublicFile(fileName, callback)	Download a public file from IAP	{base_path}/{version}/download?{query}	Yes
getSystemId(callback)	Get system server id.	{base_path}/{version}/system/id?{query}	Yes
getHealthStatus(callback)	Get status.	{base_path}/{version}/health/status?{query}	Yes
getReleaseVersion(callback)	Get verion.	{base_path}/{version}/version?{query}	Yes
getApplicationConfigs(callback)	Get all application configs in IAP.	{base_path}/{version}/config/apps?{query}	Yes
getUserProfile(username, callback)	Gets the user profile for the active user	{base_path}/{version}/profile/{pathv1}?{query}	Yes
updateUserProfile(body, callback)	Updates the user profile for the active user	{base_path}/{version}/profile/update?{query}	Yes
getAccounts(multiContains, multiEquals, multiStartsWith, inactive, isServiceAccount, groupId, skip, limit, sort, order, callback)	Get all accounts.	{base_path}/{version}/authorization/accounts?{query}	Yes
getAccount(accountId, callback)	Get an individual account.	{base_path}/{version}/authorization/accounts/{pathv1}?{query}	Yes
updateAccount(accountId, body, callback)	Update an account.	{base_path}/{version}/authorization/accounts/{pathv1}?{query}	Yes
getGroups(multiContains, multiEquals, multiStartsWith, inactive, skip, limit, sort, order, refresh, callback)	Get a list of groups.	{base_path}/{version}/authorization/groups?{query}	Yes
createGroup(body, callback)	Create a group.	{base_path}/{version}/authorization/groups?{query}	Yes
getGroupsShortGroups(multiContains, multiEquals, multiStartsWith, inactive, skip, limit, sort, order, refresh, callback)	Get a simplified list of groups.	{base_path}/{version}/authorization/groups/list?{query}	Yes
getGroup(groupId, callback)	Get an individual group.	{base_path}/{version}/authorization/groups/{pathv1}?{query}	Yes
updateGroup(groupId, body, callback)	Update a group.	{base_path}/{version}/authorization/groups/{pathv1}?{query}	Yes
deleteGroup(groupId, callback)	Delete a group.	{base_path}/{version}/authorization/groups/{pathv1}?{query}	Yes
getRoles(multiContains, multiEquals, multiStartsWith, inactive, skip, limit, sort, order, callback)	Get a list of roles.	{base_path}/{version}/authorization/roles?{query}	Yes
createRole(body, callback)	Create a role.	{base_path}/{version}/authorization/roles?{query}	Yes
getRole(roleId, callback)	Get an individual role.	{base_path}/{version}/authorization/roles/{pathv1}?{query}	Yes
updateRole(roleId, body, callback)	Update a role.	{base_path}/{version}/authorization/roles/{pathv1}?{query}	Yes
deleteRole(roleId, callback)	Delete a role.	{base_path}/{version}/authorization/roles/{pathv1}?{query}	Yes
getMethods(multiContains, multiEquals, multiStartsWith, skip, limit, sort, order, callback)	Get a list of methods.	{base_path}/{version}/authorization/methods?{query}	Yes
getViews(multiContains, multiEquals, multiStartsWith, skip, limit, sort, order, callback)	Get a list of views.	{base_path}/{version}/authorization/views?{query}	Yes
getDeviceCounts(skip, limit, order, serverId, before, after, callback)	Get device count history	{base_path}/{version}/device-counts?{query}	Yes
getLinks(multiContains, multiEquals, multiStartsWith, skip, limit, sort, order, callback)	Get all links.	{base_path}/{version}/external-links?{query}	Yes
createLink(body, callback)	Update a link.	{base_path}/{version}/external-links?{query}	Yes
getLink(linkId, callback)	Get an individual link.	{base_path}/{version}/external-links/{pathv1}?{query}	Yes
patchUpdatealink(linkId, body, callback)	Update a link.	{base_path}/{version}/external-links/{pathv1}?{query}	Yes
deleteLink(linkId, callback)	Delete a link.	{base_path}/{version}/external-links/{pathv1}?{query}	Yes
getAdapterHealth(name, callback)	Get the health of a single adapter.	{base_path}/{version}/health/adapters/{pathv1}?{query}	Yes
getApplicationHealth(name, callback)	Get the health of a single application.	{base_path}/{version}/health/applications/{pathv1}?{query}	Yes
getAdaptersHealth(contains, containsField, equals, equalsField, startsWith, startsWithField, skip, limit, sort, order, callback)	Get the health of all the adapters.	{base_path}/{version}/health/adapters?{query}	Yes
getApplicationsHealth(contains, containsField, equals, equalsField, startsWith, startsWithField, skip, limit, sort, order, callback)	Get the health of all the applications.	{base_path}/{version}/health/applications?{query}	Yes
getServerHealth(callback)	Get the health of the server.	{base_path}/{version}/health/server?{query}	Yes
getSystemHealth(callback)	Get the health of the system.	{base_path}/{version}/health/system?{query}	Yes
getAdaptersHtml(callback)	Generate documentation for adapters	{base_path}/{version}/help/adapters/html?{query}	Yes
getBrokersHtml(callback)	Generate documentation for brokers	{base_path}/{version}/help/brokers/html?{query}	Yes
getApplicationsHtml(callback)	Generate documentation for applications	{base_path}/{version}/help/applications/html?{query}	Yes
getOpenApi(url, callback)	Generate an OpenAPI v3 document for IAP	{base_path}/{version}/help/openapi?{query}	Yes
getIndexes(application, callback)	Get all pre-defined indexes.	{base_path}/{version}/indexes?{query}	Yes
checkIndexes(collection, callback)	Check the status of a collection's indexes in Mongo	{base_path}/{version}/indexes/{pathv1}/status?{query}	Yes
checkMultipleIndexes(collections, callback)	Check the status of multiple collections' indexes in Mongo	{base_path}/{version}/indexes/status?{query}	Yes
createIndexes(collection, callback)	Create a collection's indexes in Mongo	{base_path}/{version}/indexes/{pathv1}?{query}	Yes
createIntegrationModel(body, callback)	Create a new integration model.	{base_path}/{version}/integration-models?{query}	Yes
getIntegrationModels(contains, containsField, equals, equalsField, startsWith, startsWithField, skip, limit, sort, order, callback)	Get all integration models.	{base_path}/{version}/integration-models?{query}	Yes
updateIntegrationModel(body, callback)	Update an integration model.	{base_path}/{version}/integration-models?{query}	Yes
deleteIntegrationModel(name, callback)	Delete an integration model.	{base_path}/{version}/integration-models/{pathv1}?{query}	Yes
getIntegrationModel(name, callback)	Get a specific integration model.	{base_path}/{version}/integration-models/{pathv1}?{query}	Yes
exportIntegrationModel(name, callback)	Export an integration model.	{base_path}/{version}/integration-models/{pathv1}/export?{query}	Yes
validateIntegrationModel(body, callback)	Validate an integration model.	{base_path}/{version}/integration-models/validation?{query}	Yes
createIntegration(body, callback)	Create a new integration.	{base_path}/{version}/integrations?{query}	Yes
getIntegrations(contains, containsField, equals, equalsField, startsWith, startsWithField, skip, limit, sort, order, callback)	Get all integrations.	{base_path}/{version}/integrations?{query}	Yes
deleteIntegration(name, callback)	Delete an integration.	{base_path}/{version}/integrations/{pathv1}?{query}	Yes
getIntegration(name, callback)	Get a single integration.	{base_path}/{version}/integrations/{pathv1}?{query}	Yes
updateIntegration(name, body, callback)	Update an integration.	{base_path}/{version}/integrations/{pathv1}?{query}	Yes
updateIntegrationProperties(name, body, callback)	Update the properties of an integration.	{base_path}/{version}/integrations/{pathv1}/properties?{query}	Yes
searchResourceModels(callback)	Searches resource models	{base_path}/{version}/lifecycle-manager/resources?{query}	Yes
getActionExecutions(callback)	Searches resource action history documents	{base_path}/{version}/lifecycle-manager/action-executions?{query}	Yes
getResourceInstancesHttp(modelId, callback)	Searches resource instances	{base_path}/{version}/lifecycle-manager/resources/{pathv1}/instances?{query}	Yes
createServiceAccount(body, callback)	Create a service account in the database.	{base_path}/{version}/oauth/serviceAccounts?{query}	Yes
getServiceAccounts(multiContains, multiEquals, multiStartsWith, skip, limit, sort, order, callback)	Get service accounts from the database.	{base_path}/{version}/oauth/serviceAccounts?{query}	Yes
updateServiceAccount(clientId, body, callback)	Updates a service account in the database.	{base_path}/{version}/oauth/serviceAccounts/{pathv1}?{query}	Yes
deleteServiceAccount(clientId, callback)	Deletes a service account in the database.	{base_path}/{version}/oauth/serviceAccounts/{pathv1}?{query}	Yes
regenerateSecret(clientId, callback)	Regenerates the client_secret and returns the new value	{base_path}/{version}/oauth/serviceAccounts/{pathv1}/regenerate?{query}	Yes
machineAuthentication(body, callback)	Retrieve a JWT from a client's credentials	{base_path}/{version}/oauth/token?{query}	Yes
exportPrebuilt(id, callback)	Export a prebuilt	{base_path}/{version}/prebuilts/{pathv1}/export?{query}	Yes
getPrebuilt(id, callback)	Get a single prebuilt.	{base_path}/{version}/prebuilts/{pathv1}?{query}	Yes
removePrebuilt(id, callback)	Remove a prebuilt.	{base_path}/{version}/prebuilts/{pathv1}?{query}	Yes
updatePrebuilt(id, body, callback)	Update a prebuilt	{base_path}/{version}/prebuilts/{pathv1}?{query}	Yes
getPrebuilts(contains, containsField, equals, equalsField, startsWith, startsWithField, skip, limit, sort, order, config, callback)	Get all the prebuilts.	{base_path}/{version}/prebuilts?{query}	Yes
importPrebuilt(body, callback)	Import a prebuilt.	{base_path}/{version}/prebuilts/import?{query}	Yes
validatePrebuilt(body, callback)	Validate the data structure of a prebuilt.	{base_path}/{version}/prebuilts/import/validation?{query}	Yes
createRepositoryConfig(body, callback)	Create repository configuration	{base_path}/{version}/prebuilts-repository/configs?{query}	Yes
getRepositoryConfigurations(contains, containsField, equals, equalsField, startsWith, startsWithField, sort, order, callback)	Get Repository Configurations	{base_path}/{version}/prebuilts-repository/configs?{query}	Yes
deleteRepositoryConfig(name, callback)	Delete repository configuration	{base_path}/{version}/prebuilts-repository/configs/{pathv1}?{query}	Yes
updateRepositoryConfig(name, body, callback)	Update repository configuration	{base_path}/{version}/prebuilts-repository/configs/{pathv1}?{query}	Yes
getRepositoryPrebuilts(page, order, iapVersion, search, config, versionStatus, callback)	Get all prebuilts	{base_path}/{version}/prebuilts-repository?{query}	Yes
createProfile(body, callback)	Creates a new profile	{base_path}/{version}/profiles?{query}	Yes
getProfiles(contains, containsField, equals, equalsField, startsWith, startsWithField, skip, limit, sort, order, callback)	Get all profiles.	{base_path}/{version}/profiles?{query}	Yes
importProfile(body, callback)	Import a new profile	{base_path}/{version}/profiles/import?{query}	Yes
deleteProfile(id, callback)	Delete a profile.	{base_path}/{version}/profiles/{pathv1}?{query}	Yes
getProfile(id, callback)	Get a single profile.	{base_path}/{version}/profiles/{pathv1}?{query}	Yes
updateProfile(id, body, callback)	Updates a profile.	{base_path}/{version}/profiles/{pathv1}?{query}	Yes
exportProfile(id, callback)	Export a single profile.	{base_path}/{version}/profiles/{pathv1}/export?{query}	Yes
switchActiveProfile(id, callback)	Switch the active profile.	{base_path}/{version}/profiles/{pathv1}/active?{query}	Yes
getPrometheusMetrics(callback)	Get prometheus metrics.	{base_path}/{version}/prometheus_metrics?{query}	Yes
getAdapterSchema(name, callback)	Get the adapter schema.	{base_path}/{version}/schema/adapters/{pathv1}?{query}	Yes
getApplicationSchema(name, callback)	Get the application schema.	{base_path}/{version}/schema/applications/{pathv1}?{query}	Yes
getIntegrationSchema(name, callback)	Get the integration schema.	{base_path}/{version}/schema/integrations/{pathv1}?{query}	Yes
getProfileSchema(callback)	Get the profile schema.	{base_path}/{version}/schema/profiles?{query}	Yes

Authentication

This document will go through the steps for authenticating the Itential Automation Platform 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 Itential Automation Platform 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 Itential Automation Platform 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.Cookie",
      "auth_field_format": "token={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-iap
cd adapter-iap
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.

Run	Description
npm run adapter:install	Provides an easier way to install the adapter.
npm run adapter:checkMigrate	Checks whether your adapter can and should be migrated to the latest foundation.
npm run adapter:findPath	Can be used to see if the adapter supports a particular API call.
npm run adapter:migrate	Provides an easier way to update your adapter after you download the migration zip from Itential DevSite.
npm run adapter:update	Provides an easier way to update your adapter after you download the update zip from Itential DevSite.
npm run adapter:revert	Allows you to revert after a migration or update if it resulted in issues.
npm run troubleshoot	Provides a way to troubleshoot the adapter - runs connectivity, healthcheck and basic get.
npm run connectivity	Provides a connectivity check to the Servicenow system.
npm run healthcheck	Checks whether the configured healthcheck call works to Servicenow.
npm run basicget	Checks 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

2. Verify the adapter properties are set up correctly.

Go into the Itential Platform GUI and verify/update the properties

3. Verify there is connectivity between the Itential Platform Server and Iap Server.

ping the ip address of Iap server
try telnet to the ip address port of Iap
execute a curl command to the other system

4. Verify the credentials provided for Iap.

login to Iap using the provided credentials

5. Verify the API of the call utilized for Iap 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.