Adapter
Adapter for Integration to 6connect
Overview
This adapter is used to integrate the Itential Automation Platform (IAP) with the Six_connect System. The API that was used to build the adapter for Six_connect is usually available in the report directory of this adapter. The adapter utilizes the Six_connect API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
For further technical details on how to install and use this adapter, please click the Technical Documentation tab.
Six_connect
Table of Contents
Getting Started
These instructions will help you get a copy of the project on your local machine for development and testing. Reading this section is also helpful for deployments as it provides you with pertinent information on prerequisites and properties.
Helpful Background Information
There is Adapter documentation available on the Itential Documentation Site. This documentation includes information and examples that are helpful for:
Authentication
IAP Service Instance Configuration
Code Files
Endpoint Configuration (Action & Schema)
Mock Data
Adapter Generic Methods
Headers
Security
Linting and Testing
Build an Adapter
Troubleshooting an AdapterOthers 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
GitThe 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 Six_connect. |
| 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
testdoubleHow to Install
- 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- Clone/unzip/tar the adapter into your IAP environment.
cd \@itentialopensource
git clone git@gitlab.com:\@itentialopensource/adapters/adapter-six_connect
or
unzip adapter-six_connect.zip
or
tar -xvf adapter-six_connect.tar- Run the adapter install script.
cd adapter-six_connect
npm install
npm run lint:errors
npm run test- Restart IAP
systemctl restart pronghornCreate an adapter service instance configuration in IAP Admin Essentials GUI
Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.
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:
- Install adapter dependencies and check the adapter.
cd adapter-six_connect
npm run adapter:install- Restart IAP
systemctl restart pronghorn- 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:baseunitTo 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 Six_connect. 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:integrationTo 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 Six_connect. 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
createsandupdates. Hence, integration tests may have to be enhanced before they will work (integrate) with Six_connect. 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 Six_connect which change order dependencies or required data.
node utils/testRunner
answer yes at the first prompt
answer all other questions on connectivity and credentialsTest 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": "system.access.resolved",
"port": 443,
"choosepath": "",
"base_path": "/",
"version": "v1",
"cache_location": "local",
"encode_pathvars": true,
"encode_queryvars": true,
"save_metric": false,
"stub": false,
"protocol": "https",
"authentication": {
"auth_method": "basic user_password",
"username": "username",
"password": "password",
"token": "",
"token_timeout": 180000,
"token_cache": "local",
"invalid_token_error": 401,
"auth_field": "header.headers.X-AUTH-TOKEN",
"auth_field_format": "{token}",
"auth_logging": false,
"client_id": "",
"client_secret": "",
"grant_type": "",
"sensitive": [],
"sso": {
"protocol": "",
"host": "",
"port": 0
},
"multiStepAuthCalls": [
{
"name": "",
"requestFields": {},
"responseFields": {},
"successfullResponseCode": 200
}
]
},
"healthcheck": {
"type": "startup",
"frequency": 300000,
"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": 401,
"failover_codes": [
404,
405
],
"attempt_timeout": 5000,
"global_request": {
"payload": {},
"uriOptions": {},
"addlHeaders": {},
"authData": {}
},
"healthcheck_on_timeout": false,
"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": true,
"ca_file": "",
"key_file": "",
"cert_file": "",
"secure_protocol": "",
"ciphers": ""
},
"mongo": {
"host": "",
"port": 0,
"database": "",
"username": "",
"password": "",
"replSet": "",
"db_ssl": {
"enabled": false,
"accept_invalid_cert": false,
"ca_file": "",
"key_file": "",
"cert_file": ""
}
},
"devicebroker": {
"getDevice": [
{
"path": "/get/devices/{id}",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"id": "name"
},
"responseDatakey": "",
"responseFields": {
"name": "host",
"ostype": "os",
"ostypePrefix": "system-",
"ipaddress": "attributes.ipaddr",
"port": "443"
}
}
],
"getDevicesFiltered": [
{
"path": "/get/devices",
"method": "GET",
"pagination": {
"offsetVar": "",
"limitVar": "",
"incrementBy": "limit",
"requestLocation": "query"
},
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {},
"responseDatakey": "",
"responseFields": {
"name": "host",
"ostype": "os",
"ostypePrefix": "system-",
"ipaddress": "attributes.ipaddr",
"port": "443"
}
}
],
"isAlive": [
{
"path": "/get/devices/{id}/status",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"id": "name"
},
"responseDatakey": "",
"responseFields": {
"status": "status",
"statusValue": "online"
}
}
],
"getConfig": [
{
"path": "/get/devices/{id}/configPart1",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"id": "name"
},
"responseDatakey": "",
"responseFields": {}
}
],
"getCount": [
{
"path": "/get/devices",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {},
"responseDatakey": "",
"responseFields": {}
}
]
},
"cache": {
"enabled": false,
"entities": [
{
"entityType": "",
"frequency": 1440,
"flushOnFail": false,
"limit": 1000,
"retryAttempts": 5,
"sort": true,
"populate": [
{
"path": "",
"method": "GET",
"pagination": {
"offsetVar": "",
"limitVar": "",
"incrementBy": "limit",
"requestLocation": "query"
},
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {},
"responseDatakey": "",
"responseFields": {}
}
],
"cachedTasks": [
{
"name": "",
"filterField": "",
"filterLoc": ""
}
]
}
]
}
}Connection Properties
These base properties are used to connect to Six_connect 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 Six_connect (very useful during basic testing). Default is false (which means connect to Six_connect). |
| 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 Six_connect.
Note: Depending on the method that is used to authenticate with Six_connect, 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 Six_connect on every request or when pulling a token that will be used in subsequent requests. |
| password | Used to authenticate with Six_connect 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 Six_connect. 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 Six_connect. 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 Six_connect.
- Startup - Adapter will check for connectivity when the adapter initially comes up, but it will not check afterwards.
- Intermittent - Adapter will check connectivity to Six_connect at a frequency defined in the
frequencyproperty.
| 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 Six_connect, 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, Six_connect 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 Six_connect. 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 Six_connect 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 Six_connect at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to Six_connect 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 Six_connect 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 Six_connect 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 Six_connect is behind a proxy server.
| Property | Description |
|---|---|
| enabled | Required. Default is false. If Six_connect 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 Six_connect 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 Six_connect. 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 Six_connect. | 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 |
| iapFindAdapterPath(apiPath, callback) | This call provides the ability to see if a particular API path is supported by the adapter. | 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 |
| 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 |
| 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 |
| iapHasAdapterEntity(entityType, entityId, callback) | This call verifies the adapter has the specific entity. | No |
| iapVerifyAdapterCapability(entityType, actionType, entityId, callback) | This call verifies the adapter can perform the provided action on the specific entity. | No |
| iapUpdateAdapterEntityCache() | This call will update the entity cache. | No |
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. | Yes |
| getDevicesFiltered(options, callback) | This call returns the list of devices that match the criteria provided in the options filter. | Yes |
| isAlive(deviceName, callback) | This call returns whether the device status is active | Yes |
| getConfig(deviceName, format, callback) | This call returns the configuration for the selected device. | Yes |
| iapGetDeviceCount(callback) | This call returns the count of devices. | Yes |
Specific Adapter Calls
Specific adapter calls are built based on the API of the Six_connect. 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? |
|---|---|---|---|
| getLirs(limit, offset, q, callback) | GET Lirs | {base_path}/{version}/ipam/lirs?{query} | Yes |
| postLir(body, callback) | Create LIR | {base_path}/{version}/ipam/lirs?{query} | Yes |
| deleteLir(id, callback) | Delete LIR | {base_path}/{version}/ipam/lirs/{pathv1}?{query} | Yes |
| retrieveLir(id, callback) | Retrieve LIR | {base_path}/{version}/ipam/lirs/{pathv1}?{query} | Yes |
| patchLir(id, body, callback) | Update LIR (PATCH) | {base_path}/{version}/ipam/lirs/{pathv1}?{query} | Yes |
| putLir(id, body, callback) | Update LIR (PUT) | {base_path}/{version}/ipam/lirs/{pathv1}?{query} | Yes |
| attributesByResource(id, callback) | Attributes by Resource | {base_path}/{version}/ipam/management/attributes_by_resource/{pathv1}?{query} | Yes |
| mergeIpamTopAggregates(body, callback) | Merge IPAM Top aggregates | {base_path}/{version}/ipam/management/merge?{query} | Yes |
| getNetblocks(id, rir, lirId, address, type, swipped, assigned, isAggregate, lastUpdateTime, swipTime, cidr, endAddress, mask, topAggregate, genericCode, regionId, vlanId, asn, resourceId, resourceQuery, allowSubAssignments, tags, tagsMode, limit, offset, sort, orderBy, assignTime, reservedTime, parent, ruleId, netHandle, customerHandle, orgId, output, outputName, q, attributes, includeRegionList, includingRegionId, resourceType, meta1, meta2, meta3, meta4, meta5, meta6, meta7, meta8, meta9, meta10, callback) | Get netblocks | {base_path}/{version}/ipam/netblocks?{query} | Yes |
| postNetblock(body, callback) | Create netblock | {base_path}/{version}/ipam/netblocks?{query} | Yes |
| byRegion(recentAssignments, callback) | Get netblock region usage | {base_path}/{version}/ipam/netblocks/by_region?{query} | Yes |
| directAssignMultiple(body, callback) | Direct assign by using Resource ID | {base_path}/{version}/ipam/netblocks/direct_assign?{query} | Yes |
| ipamGenerateDns(body, callback) | Generate DNS Zones and records based on the provided netblock | {base_path}/{version}/ipam/netblocks/generate_dns?{query} | Yes |
| getIpamAttributes(callback) | GET IPAM Attributes | {base_path}/{version}/ipam/netblocks/ipam_attributes?{query} | Yes |
| retrieveIpamAttributesGlobal(attribute, limit, offset, q, callback) | IPAM Attributes | {base_path}/{version}/ipam/netblocks/ipam_attributes/{pathv1}?{query} | Yes |
| maskReport(resourceId, tags, regions, callback) | Mask Report | {base_path}/{version}/ipam/netblocks/mask_report?{query} | Yes |
| getMetaValues(metaId, limit, offset, q, callback) | GET unique meta values | {base_path}/{version}/ipam/netblocks/meta_values/{pathv1}?{query} | Yes |
| smartAssignObject(body, callback) | Smart assign by using Resource ID | {base_path}/{version}/ipam/netblocks/smart_assign?{query} | Yes |
| deleteSwip1(cidr, lirId, entityHandle, netHandle, callback) | Deassign by using Netblock CIDR | {base_path}/{version}/ipam/netblocks/swip/{pathv1}?{query} | Yes |
| manualSwip1(cidr, body, callback) | SWIP by using netblock CIDR | {base_path}/{version}/ipam/netblocks/swip/{pathv1}/manual?{query} | Yes |
| postSwip1(cidr, action, body, callback) | SWIP by using Netblock CIDR | {base_path}/{version}/ipam/netblocks/swip/{pathv1}/{pathv2}?{query} | Yes |
| deleteSwip(id, lirId, entityHandle, netHandle, callback) | Deassign by using Netblock ID | {base_path}/{version}/ipam/netblocks/swip/{pathv1}?{query} | Yes |
| manualSwip(id, body, callback) | SWIP by using netblock ID | {base_path}/{version}/ipam/netblocks/swip/{pathv1}/manual?{query} | Yes |
| postSwip(id, action, body, callback) | SWIP by using Netblock ID | {base_path}/{version}/ipam/netblocks/swip/{pathv1}/{pathv2}?{query} | Yes |
| deleteNetblock1(cidr, force, callback) | Deletes an aggregate rules using Netblock CIDR | {base_path}/{version}/ipam/netblocks/{pathv1}?{query} | Yes |
| retrieveNetblock1(cidr, callback) | Retrieve Netblock CIDR | {base_path}/{version}/ipam/netblocks/{pathv1}?{query} | Yes |
| patchNetblock1(cidr, body, callback) | Update netblock by using Netblock CIDR | {base_path}/{version}/ipam/netblocks/{pathv1}?{query} | Yes |
| putNetblock1(cidr, body, callback) | Update netblock by using Netblock CIDR | {base_path}/{version}/ipam/netblocks/{pathv1}/{pathv2}?{query} | Yes |
| getNetblockAssignments1(cidr, offset, limit, callback) | GET Assignments using Netblock CIDR | {base_path}/{version}/ipam/netblocks/{pathv1}/assignments?{query} | Yes |
| updateNetblockAttributes1(cidr, callback) | Update netblock attributes using Netblock CIDR | {base_path}/{version}/ipam/netblocks/{pathv1}/attributes?{query} | Yes |
| directAssign1(cidr, body, callback) | Direct assign by using netblock cidr and resource id | {base_path}/{version}/ipam/netblocks/{pathv1}/direct_assign?{query} | Yes |
| getFirstAvailableIp1(cidr, callback) | Get by using Netblock CIDR | {base_path}/{version}/ipam/netblocks/{pathv1}/first_available?{query} | Yes |
| getNetblockIpamAttributes1(cidr, callback) | Get IPAM Attributes by netblock cidr | {base_path}/{version}/ipam/netblocks/{pathv1}/ipam_attributes?{query} | Yes |
| retrieveNetblockIpamAttributes1(cidr, attribute, limit, offset, q, callback) | Get IPAM Attribute by netblock cidr | {base_path}/{version}/ipam/netblocks/{pathv1}/ipam_attributes/{pathv2}?{query} | Yes |
| mergeNetblock1(cidr, body, callback) | Aggregates by using Netblock CIDR | {base_path}/{version}/ipam/netblocks/{pathv1}/merge?{query} | Yes |
| getNetblockOptions1(cidr, callback) | Get netblock options using Netblock CIDR | {base_path}/{version}/ipam/netblocks/{pathv1}/options?{query} | Yes |
| getNetblockRules1(cidr, callback) | Get netblock rules using Netblock CIDR | {base_path}/{version}/ipam/netblocks/{pathv1}/rules?{query} | Yes |
| scanNetblock1(cidr, callback) | Scan Netblock CIDR | {base_path}/{version}/ipam/netblocks/{pathv1}/scan?{query} | Yes |
| getNetblockScanResults(cidr, callback) | GET Netblock Scan results | {base_path}/{version}/ipam/netblocks/{pathv1}/scan_results?{query} | Yes |
| splitNetblock1(cidr, body, callback) | Splits netblock by using Netblock CIDR | {base_path}/{version}/ipam/netblocks/{pathv1}/split?{query} | Yes |
| unassignNetblock1(cidr, body, callback) | Unassign netblock using Netblock CIDR | {base_path}/{version}/ipam/netblocks/{pathv1}/{pathv2}/unassign?{query} | Yes |
| getNetblockUtilization1(cidr, mask, callback) | Get netblock utilization using Netblock CIDR | {base_path}/{version}/ipam/netblocks/{pathv1}/utilization?{query} | Yes |
| getNetblockVlan1(cidr, callback) | Get by using Netblock CIDR | {base_path}/{version}/ipam/netblocks/{pathv1}/vlan?{query} | Yes |
| deleteNetblock(id, force, callback) | Deletes an aggregate rules using Netblock ID | {base_path}/{version}/ipam/netblocks/{pathv1}?{query} | Yes |
| retrieveNetblock(id, callback) | Retrieve Netblock ID | {base_path}/{version}/ipam/netblocks/{pathv1}?{query} | Yes |
| patchNetblock(id, body, callback) | Update netblock by using Netblock ID | {base_path}/{version}/ipam/netblocks/{pathv1}?{query} | Yes |
| putNetblock(id, body, callback) | Update netblock by using Netblock ID | {base_path}/{version}/ipam/netblocks/{pathv1}?{query} | Yes |
| getNetblockAssignments(id, offset, limit, callback) | GET Assignments using Netblock ID | {base_path}/{version}/ipam/netblocks/{pathv1}/assignments?{query} | Yes |
| updateNetblockAttributes(id, callback) | Update netblock attributes using Netblock ID | {base_path}/{version}/ipam/netblocks/{pathv1}/attributes?{query} | Yes |
| directAssign(id, body, callback) | Direct assign by using netblock id and resource id | {base_path}/{version}/ipam/netblocks/{pathv1}/direct_assign?{query} | Yes |
| getFirstAvailableIp(id, callback) | Get by using using Netblock ID | {base_path}/{version}/ipam/netblocks/{pathv1}/first_available?{query} | Yes |
| getNetblockIpamAttributes(id, callback) | Get IPAM Attributes by netblock id | {base_path}/{version}/ipam/netblocks/{pathv1}/ipam_attributes?{query} | Yes |
| retrieveNetblockIpamAttributes(id, attribute, limit, offset, q, callback) | Retrieve IPAM Attribute by netblock id | {base_path}/{version}/ipam/netblocks/{pathv1}/ipam_attributes/{pathv2}?{query} | Yes |
| mergeNetblock(id, body, callback) | Aggregates by using Netblock ID | {base_path}/{version}/ipam/netblocks/{pathv1}/merge?{query} | Yes |
| getNetblockMetaValues(metaId, id, limit, offset, callback) | GET unique meta values for an aggregate | {base_path}/{version}/ipam/netblocks/{pathv1}/meta_values/{pathv2}?{query} | Yes |
| getNetblockOptions(id, callback) | Get netblock options using Netblock ID | {base_path}/{version}/ipam/netblocks/{pathv1}/options?{query} | Yes |
| getNetblockResourceHierarchy(id, callback) | GET Netblock resource hierarchy | {base_path}/{version}/ipam/netblocks/{pathv1}/resource_hierarchy?{query} | Yes |
| getNetblockRules(id, callback) | Get netblock rules using Netblock ID | {base_path}/{version}/ipam/netblocks/{pathv1}/rules?{query} | Yes |
| scanNetblock(id, callback) | Scan Netblock ID | {base_path}/{version}/ipam/netblocks/{pathv1}/scan?{query} | Yes |
| splitNetblock(id, body, callback) | Splits netblock by using Netblock ID | {base_path}/{version}/ipam/netblocks/{pathv1}/split?{query} | Yes |
| unassignNetblock(id, body, callback) | Unassign netblock using Netblock ID | {base_path}/{version}/ipam/netblocks/{pathv1}/unassign?{query} | Yes |
| getNetblockUtilization(id, mask, callback) | Get netblock utilization using Netblock ID | {base_path}/{version}/ipam/netblocks/{pathv1}/utilization?{query} | Yes |
| getNetblockVlan(id, callback) | Get by using Netblock ID | {base_path}/{version}/ipam/netblocks/{pathv1}/vlan?{query} | Yes |
| hostUtilization(type, rir, genericCode, regionId, vlan, tags, callback) | Host utilization | {base_path}/{version}/ipam/netblocks/{pathv1}/host_utilization?{query} | Yes |
| postRocessHolding(body, callback) | Process holding tank | {base_path}/{version}/ipam/process_holding?{query} | Yes |
| getRegions(limit, offset, q, callback) | Get Regions | {base_path}/{version}/ipam/regions?{query} | Yes |
| postRegion(body, callback) | Create Region | {base_path}/{version}/ipam/regions?{query} | Yes |
| deleteRegion(id, callback) | Delete region | {base_path}/{version}/ipam/regions/{pathv1}?{query} | Yes |
| putRegion(id, body, callback) | Update region | {base_path}/{version}/ipam/regions/{pathv1}?{query} | Yes |
| getAggregatesByRegion(id, recentAssignments, callback) | Get list of top level aggregates for a region | {base_path}/{version}/ipam/regions/{pathv1}/top_aggregates?{query} | Yes |
| getRirList(callback) | GET RIR List | {base_path}/{version}/ipam/rir?{query} | Yes |
| getIpamRules(id, q, loadPositions, limit, offset, orderBy, sort, callback) | GET IPAM Rules | {base_path}/{version}/ipam/rules?{query} | Yes |
| createIpamRule(body, callback) | Create IPAM Rule | {base_path}/{version}/ipam/rules?{query} | Yes |
| deleteIpamRule(id, callback) | Delete IPAM Rule | {base_path}/{version}/ipam/rules/{pathv1}?{query} | Yes |
| retrieveIpamRule(id, callback) | Retrieve IPAM Rule | {base_path}/{version}/ipam/rules/{pathv1}?{query} | Yes |
| patchIpamRule(id, body, callback) | Update IPAM Rule (PATCH) | {base_path}/{version}/ipam/rules/{pathv1}?{query} | Yes |
| updateIpamRule(id, body, callback) | Update IPAM Rule (PUT) | {base_path}/{version}/ipam/rules/{pathv1}?{query} | Yes |
| previewIpamRule(id, body, callback) | Preview IPAM Rule | {base_path}/{version}/ipam/rules/{pathv1}/preview?{query} | Yes |
| getIpamTags(limit, offset, q, callback) | GET IPAM Tags | {base_path}/{version}/ipam/tags?{query} | Yes |
| postIpamTag(body, callback) | Create IPAM Tag | {base_path}/{version}/ipam/tags?{query} | Yes |
| deleteIpamTag(tag, callback) | Delete IPAM tag | {base_path}/{version}/ipam/tags/{pathv1}?{query} | Yes |
| getVlans(domainId, vlan, name, tags, offset, limit, unavailable, q, callback) | GET Vlans | {base_path}/{version}/ipam/vlans?{query} | Yes |
| getVlanDomains(q, attrCustom, tags, offset, limit, callback) | Get VLAN Domains | {base_path}/{version}/ipam/vlans/domains?{query} | Yes |
| retrieveDomainVlan(id, callback) | Retrieve VLAN | {base_path}/{version}/ipam/vlans/domains/{pathv1}?{query} | Yes |
| retrieveVlan(id, callback) | Retrieve VLAN | {base_path}/{version}/ipam/vlans/{pathv1}?{query} | Yes |
| getSizeSizes(size, callback) | GET IPAM Sizes | {base_path}/{version}/ipam/{pathv1}/sizes?{query} | Yes |
| postIpamSwip(netblockId, body, callback) | Create IPAM Swip | {base_path}/{version}/ipam/swip/{pathv1}/simple?{query} | Yes |
| getWorkflows(q, offset, limit, orderBy, sort, callback) | Get workflows | {base_path}/{version}/workflows?{query} | Yes |
| postWorkflows(body, callback) | Create new workflow | {base_path}/{version}/workflows?{query} | Yes |
| getWorkflowsconnectors(callback) | Get all available ACP Connectors | {base_path}/{version}/workflows/connectors?{query} | Yes |
| getWorkflowsconnectorsgeneric(callback) | Get all available ACP Generic Connectors | {base_path}/{version}/workflows/connectors/generic?{query} | Yes |
| postWorkflowsconnectorsgeneric(body, callback) | Create ACP Generic connector | {base_path}/{version}/workflows/connectors/generic?{query} | Yes |
| getWorkflowsconnectorsgenericauthMechanisms(callback) | Get all available auth mechanisms for an ACP Generic Connector | {base_path}/{version}/workflows/connectors/generic/auth_mechanisms?{query} | Yes |
| getWorkflowsconnectorsgenericprotocols(callback) | Get all available connection protocols for an ACP Generic Connector | {base_path}/{version}/workflows/connectors/generic/protocols?{query} | Yes |
| getWorkflowsconnectorsgenericid(id, callback) | Retrieve information about generic connector | {base_path}/{version}/workflows/connectors/generic/{pathv1}?{query} | Yes |
| putWorkflowsconnectorsgenericid(id, body, callback) | Update ACP Generic connector | {base_path}/{version}/workflows/connectors/generic/{pathv1}?{query} | Yes |
| postWorkflowsconnectorsconnectorcallsquery(connector, body, callback) | Query for connector calls | {base_path}/{version}/workflows/connectors/{pathv1}/calls/query?{query} | Yes |
| getWorkflowsconnectorsconnectorcallsfamily(connector, family, callback) | Get connector's calls | {base_path}/{version}/workflows/connectors/{pathv1}/calls/{pathv2}?{query} | Yes |
| postWorkflowsconnectorsconnectortestCredentials(connector, body, callback) | Test connector's credentials | {base_path}/{version}/workflows/connectors/{pathv1}/test_credentials?{query} | Yes |
| postWorkflowsvalidate(body, callback) | Validate workflow | {base_path}/{version}/workflows/validate?{query} | Yes |
| deleteWorkflowsid(id, callback) | Delete an existing workflow | {base_path}/{version}/workflows/{pathv1}?{query} | Yes |
| getWorkflowsid(id, callback) | Retrieve workflow data | {base_path}/{version}/workflows/{pathv1}?{query} | Yes |
| postWorkflowsidclone(id, body, callback) | Clone workflow | {base_path}/{version}/workflows/{pathv1}/clone?{query} | Yes |
| getWorkflowsiddownload(id, callback) | Download workflow data | {base_path}/{version}/workflows/{pathv1}/download?{query} | Yes |
| postWorkflowsidexecute(id, callback) | Execute by using workflow ID | {base_path}/{version}/workflows/{pathv1}/execute?{query} | Yes |
| postWorkflowsidrollbackcallId(id, callId, callback) | Rollback using workflow ID | {base_path}/{version}/workflows/{pathv1}/rollback/{pathv2}?{query} | Yes |
| postWorkflowsidtestcallId(id, callId, callback) | Test by using workflow ID | {base_path}/{version}/workflows/{pathv1}/test/{pathv2}?{query} | Yes |
| postWorkflowsslugexecute(slug, callback) | Execute by using workflow slug | {base_path}/{version}/workflows/{pathv1}/execute?{query} | Yes |
| postWorkflowsslugrollbackcallId(slug, callId, callback) | Rollback using workflow slug | {base_path}/{version}/workflows/{pathv1}/rollback/{pathv2}?{query} | Yes |
| postWorkflowsslugtestcallId(slug, callId, callback) | Test by using workflow slug | {base_path}/{version}/workflows/{pathv1}/test/{pathv2}?{query} | Yes |
| getUsergroups(callback) | Get usergroups | {base_path}/{version}/usergroups?{query} | Yes |
| postUsergroups(body, callback) | Create new usergroup | {base_path}/{version}/usergroups?{query} | Yes |
| postUsergroupssearch(body, callback) | Search for a usergroup | {base_path}/{version}/usergroups/search?{query} | Yes |
| getUsergroupsid(id, callback) | Retrieve usergroup | {base_path}/{version}/usergroups/{pathv1}?{query} | Yes |
| getUsergroupsidpermissionActions(id, callback) | Retrieve usergroup permission actions | {base_path}/{version}/usergroups/{pathv1}/permission_actions?{query} | Yes |
| getSchedulertasks(date, callback) | Get all tasks | {base_path}/{version}/scheduler/tasks?{query} | Yes |
| getSchedulertasksadvanced(date, callback) | Get all available tasks | {base_path}/{version}/scheduler/tasks/advanced?{query} | Yes |
| getSchedulertasksavailable(callback) | Get all available tasks | {base_path}/{version}/scheduler/tasks/available?{query} | Yes |
| deleteSchedulertasksid(id, callback) | Delete existing task | {base_path}/{version}/scheduler/tasks/{pathv1}?{query} | Yes |
| getSchedulertasksidhistory(id, callback) | Retrieve task history | {base_path}/{version}/scheduler/tasks/{pathv1}/history?{query} | Yes |
| getResources(id, type, slug, name, sort, orderBy, offset, limit, page, q, parentId, loadPermissions, loadAttributes, query, permissionsTrue, permissionsFalse, callback) | Get resources | {base_path}/{version}/resources?{query} | Yes |
| postResources(body, callback) | Create resource | {base_path}/{version}/resources?{query} | Yes |
| postResourcesquery(body, callback) | Resource query | {base_path}/{version}/resources/query?{query} | Yes |
| getResourcestopOfTree(sectionId, limit, section, body, callback) | Get using section ID | {base_path}/{version}/resources/top_of_tree?{query} | Yes |
| deleteResourcesid(id, recursive, callback) | Delete resource | {base_path}/{version}/resources/{pathv1}?{query} | Yes |
| getResourcesid(id, callback) | Retrieve resource | {base_path}/{version}/resources/{pathv1}?{query} | Yes |
| patchResourcesid(id, body, callback) | Update resource (patch) | {base_path}/{version}/resources/{pathv1}?{query} | Yes |
| putResourcesid(id, body, callback) | Update resource (PUT) | {base_path}/{version}/resources/{pathv1}?{query} | Yes |
| getResourcesidattachments(id, attachmentId, callback) | Get resource attachments | {base_path}/{version}/resources/{pathv1}/attachments?{query} | Yes |
| postResourcesidattachments(id, body, callback) | Attach file to a resource | {base_path}/{version}/resources/{pathv1}/attachments?{query} | Yes |
| deleteResourcesidattachmentsattachmentId(id, attachmentId, callback) | Delete resource attachment | {base_path}/{version}/resources/{pathv1}/attachments/{pathv2}?{query} | Yes |
| getResourcesidattachmentsattachmentId(id, attachmentId, callback) | Preview resource attachment | {base_path}/{version}/resources/{pathv1}/attachments/{pathv2}?{query} | Yes |
| getResourcesidattachmentsattachmentIddownload(id, attachmentId, callback) | Download resource attachment | {base_path}/{version}/resources/{pathv1}/attachments/{pathv2}/download?{query} | Yes |
| getResourcesidattrs(id, callback) | Get resource attributes | {base_path}/{version}/resources/{pathv1}/attrs?{query} | Yes |
| patchResourcesidattrs(id, body, callback) | Update resource attributes (patch) | {base_path}/{version}/resources/{pathv1}/attrs?{query} | Yes |
| postResourcesidattrs(id, body, callback) | Add resource attribute | {base_path}/{version}/resources/{pathv1}/attrs?{query} | Yes |
| putResourcesidattrs(id, body, callback) | Update resource attributes (PUT) | {base_path}/{version}/resources/{pathv1}/attrs?{query} | Yes |
| deleteResourcesidattrsattributes(id, attributes, callback) | Delete resource attribute | {base_path}/{version}/resources/{pathv1}/attrs/{pathv2}?{query} | Yes |
| getResourcesidbackup(id, callback) | Get resource backups | {base_path}/{version}/resources/{pathv1}/backup?{query} | Yes |
| postResourcesidbackup(id, body, callback) | Backup a resource | {base_path}/{version}/resources/{pathv1}/backup?{query} | Yes |
| getResourcesidchildren(id, type, slug, name, sort, orderBy, offset, limit, page, q, origId, parentId, loadPermissions, loadAttributes, query, permissionsTrue, permissionsFalse, callback) | Get resource children | {base_path}/{version}/resources/{pathv1}/children?{query} | Yes |
| postResourcesidclone(id, body, callback) | Clone resource | {base_path}/{version}/resources/{pathv1}/clone?{query} | Yes |
| getResourcesidlinks(id, loadResourceData, orderBy, sort, limit, offset, q, callback) | Get resource links | {base_path}/{version}/resources/{pathv1}/links?{query} | Yes |
| patchResourcesidlinks(id, body, callback) | Update resource links | {base_path}/{version}/resources/{pathv1}/links?{query} | Yes |
| postResourcesidlinks(id, body, callback) | Create resource link | {base_path}/{version}/resources/{pathv1}/links?{query} | Yes |
| putResourcesidlinks(id, body, callback) | Replace resource links | {base_path}/{version}/resources/{pathv1}/links?{query} | Yes |
| getResourcesidlinksrelations(id, loadResourceData, relations, orderBy, sort, limit, offset, q, callback) | Get resource links using relation | {base_path}/{version}/resources/{pathv1}/links/{pathv2}?{query} | Yes |
| patchResourcesidlinksrelation(id, relation, body, callback) | Update resource links for a given relation | {base_path}/{version}/resources/{pathv1}/links/{pathv2}?{query} | Yes |
| putResourcesidlinksrelation(id, relation, body, callback) | Replace resource links for a given relation | {base_path}/{version}/resources/{pathv1}/links/{pathv2}?{query} | Yes |
| deleteResourcesidlinksrelationlinkId(id, relation, linkId, callback) | Delete specific link | {base_path}/{version}/resources/{pathv1}/links/{pathv2}/{pathv3}?{query} | Yes |
| putResourcesidlinksrelationlinkId(id, relation, linkId, body, callback) | Update resource link | {base_path}/{version}/resources/{pathv1}/links/{pathv2}/{pathv3}?{query} | Yes |
| postResourcesidpush(id, body, callback) | Push resource | {base_path}/{version}/resources/{pathv1}/push?{query} | Yes |
| getResourcesidpushStatuspid(id, pid, callback) | Get push resource status | {base_path}/{version}/resources/{pathv1}/push_status/{pathv2}?{query} | Yes |
| getResourcesidtopOfTree(id, limit, callback) | Resource top of tree | {base_path}/{version}/resources/{pathv1}/top_of_tree?{query} | Yes |
| getDnsacls(sort, orderBy, offset, parentId, limit, page, callback) | GET ACLs | {base_path}/{version}/dns/acls?{query} | Yes |
| postDnsacls(body, callback) | Create DNS ACL | {base_path}/{version}/dns/acls?{query} | Yes |
| deleteDnsaclsid(id, recursive, callback) | Delete ACL | {base_path}/{version}/dns/acls/{pathv1}?{query} | Yes |
| getDnsgroups(sort, orderBy, offset, parentId, limit, page, callback) | GET DNS Groups | {base_path}/{version}/dns/groups?{query} | Yes |
| postDnsgroups(body, callback) | Create DNS Group | {base_path}/{version}/dns/groups?{query} | Yes |
| deleteDnsgroupsgroupIdaclsid(id, relations, resourceId, groupId, callback) | Delete resource link | {base_path}/{version}/dns/groups/{pathv1}/acls/{pathv2}?{query} | Yes |
| getDnsgroupsgroupIdservers(groupId, orderBy, sort, limit, offset, callback) | Get Servers to group | {base_path}/{version}/dns/groups/{pathv1}/servers?{query} | Yes |
| patchDnsgroupsgroupIdservers(groupId, body, callback) | Update group servers (PATCH) | {base_path}/{version}/dns/groups/{pathv1}/servers?{query} | Yes |
| postDnsgroupsgroupIdservers(groupId, body, callback) | Add server to group | {base_path}/{version}/dns/groups/{pathv1}/servers?{query} | Yes |
| putDnsgroupsgroupIdservers(groupId, body, callback) | Update group servers (PUT) | {base_path}/{version}/dns/groups/{pathv1}/servers?{query} | Yes |
| deleteDnsgroupsgroupIdserversid(id, relations, resourceId, groupId, callback) | Delete server from group | {base_path}/{version}/dns/groups/{pathv1}/servers/{pathv2}?{query} | Yes |
| getDnsgroupsgroupIdzones(groupId, orderBy, sort, limit, offset, callback) | Get DNS zones for group | {base_path}/{version}/dns/groups/{pathv1}/zones?{query} | Yes |
| deleteDnsgroupsid(id, recursive, callback) | Delete DNS Group | {base_path}/{version}/dns/groups/{pathv1}?{query} | Yes |
| getDnsgroupsid(id, callback) | Retrieve DNS Group | {base_path}/{version}/dns/groups/{pathv1}?{query} | Yes |
| patchDnsgroupsid(id, body, callback) | Update DNS Group (PATCH) | {base_path}/{version}/dns/groups/{pathv1}?{query} | Yes |
| putDnsgroupsid(id, body, callback) | Update DNS Groups (PUT) | {base_path}/{version}/dns/groups/{pathv1}?{query} | Yes |
| getDnsgroupsidavailableCommands(id, callback) | DNS Group available commands | {base_path}/{version}/dns/groups/{pathv1}/available_commands?{query} | Yes |
| postDnsgroupsidexecutecommand(id, command, body, callback) | Execute GROUP command | {base_path}/{version}/dns/groups/{pathv1}/execute/{pathv2}?{query} | Yes |
| getDnsservers(sort, orderBy, offset, limit, page, serverBackend, serverType, server, username, password, enableViews, port, snmpType, parentId, callback) | GET DNS Servers | {base_path}/{version}/dns/servers?{query} | Yes |
| postDnsservers(body, callback) | Create DNS Server | {base_path}/{version}/dns/servers?{query} | Yes |
| deleteDnsserversid(id, recursive, callback) | Delete DNS Server | {base_path}/{version}/dns/servers/{pathv1}?{query} | Yes |
| getDnsserversid(id, serverBackend, serverType, server, username, password, enableViews, port, snmpType, parentId, callback) | Retrieve DNS Server | {base_path}/{version}/dns/servers/{pathv1}?{query} | Yes |
| patchDnsserversid(id, body, callback) | Update DNS Server (PATCH) | {base_path}/{version}/dns/servers/{pathv1}?{query} | Yes |
| putDnsserversid(id, body, callback) | Update DNS Server (PUT) | {base_path}/{version}/dns/servers/{pathv1}?{query} | Yes |
| getDnsserversidavailableCommands(id, callback) | DNS Server Available commands | {base_path}/{version}/dns/servers/{pathv1}/available_commands?{query} | Yes |
| getDnsserversidconfig(id, callback) | Get DNS Server configuration | {base_path}/{version}/dns/servers/{pathv1}/config?{query} | Yes |
| patchDnsserversidconfig(id, body, callback) | Update DNS Server configuration | {base_path}/{version}/dns/servers/{pathv1}/config?{query} | Yes |
| postDnsserversidconfig(id, body, callback) | Create DNS Server configuration | {base_path}/{version}/dns/servers/{pathv1}/config?{query} | Yes |
| postDnsserversidexecutecommand(id, command, body, callback) | Execute DNS Server command | {base_path}/{version}/dns/servers/{pathv1}/execute/{pathv2}?{query} | Yes |
| getDnsserversidmonitor(id, callback) | Monitor DNS Server | {base_path}/{version}/dns/servers/{pathv1}/monitor?{query} | Yes |
| postDnsserversidpush(id, body, callback) | Push DNS Server | {base_path}/{version}/dns/servers/{pathv1}/push?{query} | Yes |
| postDnsserversidpushConfiguration(id, body, callback) | Push DNS Server configuration | {base_path}/{version}/dns/servers/{pathv1}/push_configuration?{query} | Yes |
| getDnsserversidpushStatus(id, pid, callback) | DNS Server push status | {base_path}/{version}/dns/servers/{pathv1}/push_status?{query} | Yes |
| getDnsserversidpushedConfiguration(id, callback) | Current DNS Server Pushed configuration | {base_path}/{version}/dns/servers/{pathv1}/pushed_configuration?{query} | Yes |
| getDnsserversserverIdzones(serverId, orderBy, sort, limit, offset, zoneType, relations, callback) | Get attached zones to DNS Server | {base_path}/{version}/dns/servers/{pathv1}/zones?{query} | Yes |
| postDnsserversserverIdzones(serverId, body, callback) | Add zone to DNS Server | {base_path}/{version}/dns/servers/{pathv1}/zones?{query} | Yes |
| deleteDnsserversserverIdzonesid(serverId, id, callback) | Delete zone from DNS server | {base_path}/{version}/dns/servers/{pathv1}/zones/{pathv2}?{query} | Yes |
| getDnsserversserverIdzonesrelations(serverId, relations, orderBy, sort, limit, offset, zoneType, callback) | Get attached zones to DNS Server with specified relation | {base_path}/{version}/dns/servers/{pathv1}/zones/{pathv2}?{query} | Yes |
| getDnszones(sort, orderBy, name, zoneType, offset, parentId, limit, page, callback) | Get DNS Zones | {base_path}/{version}/dns/zones?{query} | Yes |
| postDnszonesrecordsvalidate(body, callback) | Validate DNS Record | {base_path}/{version}/dns/zones/records/validate?{query} | Yes |
| deleteDnszonesid(id, recursive, callback) | Delete dns zone | {base_path}/{version}/dns/zones/{pathv1}?{query} | Yes |
| patchDnszonesid(id, body, callback) | Update DNS Zone (PATCH) | {base_path}/{version}/dns/zones/{pathv1}?{query} | Yes |
| putDnszonesid(id, body, callback) | Update DNS Zone (PUT) | {base_path}/{version}/dns/zones/{pathv1}?{query} | Yes |
| getDnszonesidmonitor(id, callback) | Monitor DNS Zone | {base_path}/{version}/dns/zones/{pathv1}/monitor?{query} | Yes |
| postDnszonesidpush(id, body, callback) | Push DNS Zone | {base_path}/{version}/dns/zones/{pathv1}/push?{query} | Yes |
| postDnszonesidpushQueue(id, body, callback) | Push DNS Zone records in queue | {base_path}/{version}/dns/zones/{pathv1}/push_queue?{query} | Yes |
| getDnszonesidpushStatuspid(id, pid, callback) | DNS Zone push status | {base_path}/{version}/dns/zones/{pathv1}/push_status/{pathv2}?{query} | Yes |
| getDnszonesname(name, sort, orderBy, offset, limit, page, callback) | Search DNS Zone name | {base_path}/{version}/dns/zones/{pathv1}?{query} | Yes |
| getDnszoneszoneIdrecords(zoneId, sort, orderBy, offset, parentId, limit, page, recordType, recordHost, recordValue, q, callback) | GET DNS Records | {base_path}/{version}/dns/zones/{pathv1}/records?{query} | Yes |
| postDnszoneszoneIdrecords(zoneId, body, callback) | Create DNS Record | {base_path}/{version}/dns/zones/{pathv1}/records?{query} | Yes |
| deleteDnszoneszoneIdrecordsid(id, recursive, zoneId, callback) | Delete DNS Record | {base_path}/{version}/dns/zones/{pathv1}/records/{pathv2}?{query} | Yes |
| getDnszoneszoneIdrecordsid(id, recordType, recordHost, recordValue, q, zoneId, callback) | Retrieve DNS Record | {base_path}/{version}/dns/zones/{pathv1}/records/{pathv2}?{query} | Yes |
| patchDnszoneszoneIdrecordsid(zoneId, id, body, callback) | Update DNS Record (PATCH) | {base_path}/{version}/dns/zones/{pathv1}/records/{pathv2}?{query} | Yes |
| putDnszoneszoneIdrecordsid(zoneId, id, body, callback) | Update dns record (PUT) | {base_path}/{version}/dns/zones/{pathv1}/records/{pathv2}?{query} | Yes |
| getDnszoneszoneIdrecordsidmonitor(zoneId, id, callback) | Monitor DNS Record | {base_path}/{version}/dns/zones/{pathv1}/records/{pathv2}/monitor?{query} | Yes |
| getDnszoneszoneIdrecordsrecordHost(zoneId, recordHost, sort, orderBy, offset, limit, page, recordType, recordValue, q, callback) | Search DNS Record by hostname | {base_path}/{version}/dns/zones/{pathv1}/records/{pathv2}?{query} | Yes |
| getDnszoneszoneIdrecordsrecordType(zoneId, recordType, sort, orderBy, offset, limit, page, recordHost, recordValue, q, callback) | Search DNS Record by Record type | {base_path}/{version}/dns/zones/{pathv1}/records/{pathv2}?{query} | Yes |
| getDnszoneszoneIdrecordsQueue(zoneId, sort, orderBy, offset, parentId, limit, page, recordType, recordHost, recordValue, q, callback) | GET DNS Records in queue | {base_path}/{version}/dns/zones/{pathv1}/records_queue?{query} | Yes |
| deleteDnszoneszoneIdrecordsQueueid(id, recursive, zoneId, callback) | Delete DNS Record in queue | {base_path}/{version}/dns/zones/{pathv1}/records_queue/{pathv2}?{query} | Yes |
| getDnszoneszoneIdrecordsQueueid(id, recordType, recordHost, recordValue, q, zoneId, callback) | Retrieve DNS Record in Queue | {base_path}/{version}/dns/zones/{pathv1}/records_queue/{pathv2}?{query} | Yes |
| getDnszoneszoneType(zoneType, sort, orderBy, name, offset, limit, page, callback) | Get DNS Zones by zone type | {base_path}/{version}/dns/zones/{pathv1}?{query} | Yes |
| postDnszoneszoneType(zoneType, body, callback) | Create DNS Zone | {base_path}/{version}/dns/zones/{pathv1}?{query} | Yes |
| getDnszoneszoneTypename(id, name, zoneType, body, callback) | Retrieve by zone id | {base_path}/{version}/dns/zones/{pathv1}/{pathv2}?{query} | Yes |
Authentication
This document will go through the steps for authenticating the Six_connect adapter with Basic Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication HERE.
Basic Authentication
The Six_connect adapter requires Basic Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
STEPS
- Ensure you have access to a Six_connect server and that it is running
- Follow the steps in the README.md to import the adapter into IAP if you have not already done so
- Use the properties below for the
properties.authenticationfield"authentication": { "auth_method": "basic user_password", "username": "<username>", "password": "<password>", "token": "", "token_timeout": 1800000, "token_cache": "local", "invalid_token_error": 401, "auth_field": "header.headers.Authorization", "auth_field_format": "Basic {b64}{username}:{password}{/b64}", "auth_logging": false, "client_id": "", "client_secret": "", "grant_type": "" } - Restart the adapter. If your properties were set correctly, the adapter should go online.
Troubleshooting
- Make sure you copied over the correct username and password.
- Turn on debug level logs for the adapter in IAP Admin Essentials.
- Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
- Investigate the logs - in particular:
- The FULL REQUEST log to make sure the proper headers are being sent with the request.
- The FULL BODY log to make sure the payload is accurate.
- The CALL RETURN log to see what the other system is telling us.
- Remember when you are done to turn auth_logging off as you do not want to log credentials.
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-six_connect
cd adapter-six_connect
npm run adapter:updateIf 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 testAdding 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 propertiesChanging 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 propertiesEnhancing 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
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 healthcheckwill perform a healthcheck request of with current setting.npm run basicgetwill perform some non-parameter GET request with current setting.npm run connectivitywill perform networking diagnostics of the adatper endpoint.
Connectivity Issues
- You can run the adapter troubleshooting script which will check connectivity, run the healthcheck and run basic get calls.
npm run troubleshoot- Verify the adapter properties are set up correctly.
Go into the Itential Platform GUI and verify/update the properties- Verify there is connectivity between the Itential Platform Server and Six_connect Server.
ping the ip address of Six_connect server
try telnet to the ip address port of Six_connect
execute a curl command to the other system- Verify the credentials provided for Six_connect.
login to Six_connect using the provided credentials- Verify the API of the call utilized for Six_connect Healthcheck.
Go into the Itential Platform GUI and verify/update the propertiesFunctional 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.