F5 BIG-IQ

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 F5BigIQ.
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-f5_bigiq
or
unzip adapter-f5_bigiq.zip
or
tar -xvf adapter-f5_bigiq.tar

3. Run the adapter install script.

cd adapter-f5_bigiq
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-f5_bigiq
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 F5BigIQ. 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 F5BigIQ. 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 F5BigIQ. 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 F5BigIQ which change order dependencies or required data.

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

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

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

Configuration

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

Example Properties

  "properties": {
    "host": "localhost",
    "port": 443,
    "choosepath": "",
    "base_path": "/",
    "version": "",
    "cache_location": "none",
    "encode_pathvars": false,
    "encode_queryvars": false,
    "save_metric": false,
    "stub": false,
    "protocol": "https",
    "authentication": {
      "auth_method": "request_token",
      "username": "username",
      "password": "password",
      "token": "token",
      "token_timeout": 1800000,
      "token_cache": "local",
      "invalid_token_error": 401,
      "auth_field": "header.headers.X-F5-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": "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": 10000,
      "global_request": {
        "payload": {},
        "uriOptions": {},
        "addlHeaders": {},
        "authData": {
          "loginProviderName": "local"
        }
      },
      "healthcheck_on_timeout": true,
      "return_raw": false,
      "archiving": false,
      "return_request": false
    },
    "proxy": {
      "enabled": false,
      "host": "",
      "port": 1,
      "protocol": "http",
      "username": "",
      "password": ""
    },
    "ssl": {
      "ecdhCurve": "",
      "enabled": false,
      "accept_invalid_cert": false,
      "ca_file": "",
      "key_file": "",
      "cert_file": "",
      "secure_protocol": "",
      "ciphers": ""
    },
    "mongo": {
      "host": "",
      "port": 0,
      "database": "",
      "username": "",
      "password": "",
      "replSet": "",
      "db_ssl": {
        "enabled": false,
        "accept_invalid_cert": false,
        "ca_file": "",
        "key_file": "",
        "cert_file": ""
      }
    },
    "devicebroker": {
      "getDevice": [
        {
          "path": "/get/devices/{id}",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {
            "id": "name"
          },
          "responseDatakey": "",
          "responseFields": {
            "name": "host",
            "ostype": "os",
            "ostypePrefix": "system-",
            "ipaddress": "attributes.ipaddr",
            "port": "443"
          }
        }
      ],
      "getDevicesFiltered": [
        {
          "path": "/get/devices",
          "method": "GET",
          "pagination": {
            "offsetVar": "",
            "limitVar": "",
            "incrementBy": "limit",
            "requestLocation": "query"
          },
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {},
          "responseDatakey": "",
          "responseFields": {
            "name": "host",
            "ostype": "os",
            "ostypePrefix": "system-",
            "ipaddress": "attributes.ipaddr",
            "port": "443"
          }
        }
      ],
      "isAlive": [
        {
          "path": "/get/devices/{id}/status",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {
            "id": "name"
          },
          "responseDatakey": "",
          "responseFields": {
            "status": "status",
            "statusValue": "online"
          }
        }
      ],
      "getConfig": [
        {
          "path": "/get/devices/{id}/configPart1",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {
            "id": "name"
          },
          "responseDatakey": "",
          "responseFields": {}
        }
      ],
      "getCount": [
        {
          "path": "/get/devices",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {},
          "responseDatakey": "",
          "responseFields": {}
        }
      ]
    },
    "cache": {
      "enabled": false,
      "entities": [
        {
          "entityType": "",
          "frequency": 1440,
          "flushOnFail": false,
          "limit": 1000,
          "retryAttempts": 5,
          "sort": true,
          "populate": [
            {
              "path": "",
              "method": "GET",
              "pagination": {
                "offsetVar": "",
                "limitVar": "",
                "incrementBy": "limit",
                "requestLocation": "query"
              },
              "query": {},
              "body": {},
              "headers": {},
              "handleFailure": "ignore",
              "requestFields": {},
              "responseDatakey": "",
              "responseFields": {}
            }
          ],
          "cachedTasks": [
            {
              "name": "",
              "filterField": "",
              "filterLoc": ""
            }
          ]
        }
      ]
    }
  }

Connection Properties

These base properties are used to connect to F5BigIQ 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 F5BigIQ (very useful during basic testing). Default is false (which means connect to F5BigIQ).
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 F5BigIQ.

Note: Depending on the method that is used to authenticate with F5BigIQ, 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 F5BigIQ on every request or when pulling a token that will be used in subsequent requests.
password	Used to authenticate with F5BigIQ 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 F5BigIQ. 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 F5BigIQ. 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 F5BigIQ.
• Startup - Adapter will check for connectivity when the adapter initially comes up, but it will not check afterwards.
• Intermittent - Adapter will check connectivity to F5BigIQ 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 F5BigIQ, 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, F5BigIQ 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 F5BigIQ. 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 F5BigIQ 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 F5BigIQ at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to F5BigIQ 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 F5BigIQ 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 F5BigIQ 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 F5BigIQ is behind a proxy server.

Property	Description
enabled	Required. Default is false. If F5BigIQ 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 F5BigIQ 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 F5 BIG-IQ. 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 F5 BIG-IQ.	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 f5 BIG-IQ. 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?
getAlertRule(name, callback)	Get Alert Rule	{base_path}/{version}/mgmt/cm/shared/policymgmt/alert-rules/{pathv1}?{query}	Yes
patchAlertRule(name, body, callback)	Patch Alert Rule	{base_path}/{version}/mgmt/cm/shared/policymgmt/alert-rules/{pathv1}?{query}	Yes
deleteAlertRule(name, callback)	Delete Alert Rule	{base_path}/{version}/mgmt/cm/shared/policymgmt/alert-rules/{pathv1}?{query}	Yes
postAlertRule(body, callback)	Post Alert Rule	{base_path}/{version}/mgmt/cm/shared/policymgmt/alert-rules?{query}	Yes
getConfigSet(id, callback)	Get Config Set	{base_path}/{version}/mgmt/cm/global/config-sets/{pathv1}?{query}	Yes
getApplyTemplate(id, callback)	Get Apply Template	{base_path}/{version}/mgmt/cm/global/tasks/apply-template/{pathv1}?{query}	Yes
patchApplyTemplate(id, body, callback)	Patch Apply Template	{base_path}/{version}/mgmt/cm/global/tasks/apply-template/{pathv1}?{query}	Yes
postApplyTemplate(body, callback)	Post Apply Template	{base_path}/{version}/mgmt/cm/global/tasks/apply-template?{query}	Yes
getAllApplicationsList(callback)	Get All Applications List	{base_path}/{version}/mgmt/ap/query/v1/tenants/default/reports/AllApplicationsList?{query}	Yes
getCloudEnvironment(id, callback)	Get Cloud Environment	{base_path}/{version}/mgmt/cm/cloud/environments/{pathv1}?{query}	Yes
listCloudEnvironments(callback)	List all Cloud Environments	{base_path}/{version}/mgmt/cm/cloud/environments?{query}	Yes
patchCloudEnvironment(id, body, callback)	Patch Cloud Enviornment	{base_path}/{version}/mgmt/cm/cloud/environments/{pathv1}?{query}	Yes
deleteCloudEnvironment(id, callback)	Delete Cloud Environment	{base_path}/{version}/mgmt/cm/cloud/environments/{pathv1}?{query}	Yes
postCloudEnvironment(body, callback)	Post Cloud Environment	{base_path}/{version}/mgmt/cm/cloud/environments?{query}	Yes
getCloudProvider(id, callback)	Get Cloud Provider	{base_path}/{version}/mgmt/cm/cloud/providers/{pathv1}?{query}	Yes
listCloudProviders(callback)	List all Cloud Providers	{base_path}/{version}/mgmt/cm/cloud/providers?{query}	Yes
patchCloudProvider(id, body, callback)	Patch Cloud Provider	{base_path}/{version}/mgmt/cm/cloud/providers/{pathv1}?{query}	Yes
deleteCloudProvider(id, callback)	Delete Cloud Provider	{base_path}/{version}/mgmt/cm/cloud/providers/{pathv1}?{query}	Yes
postCloudProvider(body, callback)	Post Cloud Provider	{base_path}/{version}/mgmt/cm/cloud/providers?{query}	Yes
getGlobalTemplate(id, callback)	Get Global Template	{base_path}/{version}/mgmt/cm/global/templates/{pathv1}?{query}	Yes
deleteGlobalTemplate(id, callback)	Delete Global Template	{base_path}/{version}/mgmt/cm/global/templates/{pathv1}?{query}	Yes
patchGlobalTemplate(id, body, callback)	Patch Global Template	{base_path}/{version}/mgmt/cm/global/templates/{pathv1}?{query}	Yes
postGlobalTemplate(body, callback)	Post Global Template	{base_path}/{version}/mgmt/cm/global/templates?{query}	Yes
getServiceScalingGroup(id, callback)	Get Service Scaling Group	{base_path}/{version}/mgmt/cm/cloud/service-scaling-groups/{pathv1}?{query}	Yes
patchServiceScalingGroup(id, body, callback)	Patch Service Scaling Group	{base_path}/{version}/mgmt/cm/cloud/service-scaling-groups/{pathv1}?{query}	Yes
patchWorkflowRule(name, callback)	Patch Workflow Rule	{base_path}/{version}/mgmt/cm/shared/policymgmt/workflow-rules/{pathv1}?{query}	Yes
deleteWorkflowRule(name, callback)	Delete Workflow Rule	{base_path}/{version}/mgmt/cm/shared/policymgmt/workflow-rules/{pathv1}?{query}	Yes
getWorkflowRule(name, callback)	Get Workflow Rule	{base_path}/{version}/mgmt/cm/shared/policymgmt/workflow-rules/{pathv1}?{query}	Yes
postWorkflowRule(body, callback)	Post Workflow Rule	{base_path}/{version}/mgmt/cm/shared/policymgmt/workflow-rules?{query}	Yes
postSuperDeploy(body, callback)	Post Super Deploy	{base_path}/{version}/mgmt/cm/access/tasks/super-deploy?{query}	Yes
deleteSuperDeploy(id, callback)	Delete Super Deploy	{base_path}/{version}/mgmt/cm/access/tasks/super-deploy/{pathv1}?{query}	Yes
patchSuperDeploy(id, body, callback)	Patch Super Deploy	{base_path}/{version}/mgmt/cm/access/tasks/super-deploy/{pathv1}?{query}	Yes
getSuperDeploy(id, callback)	Get Super Deploy	{base_path}/{version}/mgmt/cm/access/tasks/super-deploy{pathv1}?{query}	Yes
getAccessPolicies(callback)	Get Access Policies	{base_path}/{version}/mgmt/cm/access/working-config/apm/policy/access-policy?{query}	Yes
getAccessProfile(id, callback)	Get Access Profile	{base_path}/{version}/mgmt/cm/access/working-config/apm/profile/access/{pathv1}?{query}	Yes
getActiveDirectoryServer(id, callback)	Get Active Directory Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/active-directory/{pathv1}?{query}	Yes
deleteActiveDirectoryServer(id, callback)	Delete Active Directory Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/active-directory/{pathv1}?{query}	Yes
patchActiveDirectoryServer(id, body, callback)	Patch Active Directory Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/active-directory/{pathv1}?{query}	Yes
postActiveDirectoryServer(body, callback)	Post Active Directory Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/active-directory?{query}	Yes
postRevokeTokens(body, callback)	Post Revoke Tokens	{base_path}/{version}/mgmt/cm/access/tasks/revoke-tokens?{query}	Yes
getRevokeTokens(id, callback)	Get Revoke Tokens	{base_path}/{version}/mgmt/cm/access/tasks/revoke-tokens/{pathv1}?{query}	Yes
getCRLDPServer(id, callback)	Get CRLDP Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/crldp/{pathv1}?{query}	Yes
deleteCRLDPServer(id, callback)	Delete CRLDP Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/crldp/{pathv1}?{query}	Yes
patchCRLDPServer(id, body, callback)	Patch CRLDP Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/crldp/{pathv1}?{query}	Yes
putCRLDPServer(id, body, callback)	Put CRLDP Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/crldp/{pathv1}?{query}	Yes
postCRLDPServer(body, callback)	Post CRLDP Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/crldp?{query}	Yes
getClientRateClass(id, callback)	Get Client Rate Class	{base_path}/{version}/mgmt/cm/access/working-config/apm/resource/clientRateClass/{pathv1}?{query}	Yes
getClientTrafficClassifier(id, callback)	Get Client Traffic Classifier	{base_path}/{version}/mgmt/cm/access/working-config/apm/resource/clientTrafficClassifier/{pathv1}?{query}	Yes
getConnectivityProfile(id, callback)	Get Connectivity Profile	{base_path}/{version}/mgmt/cm/access/working-config/apm/profile/connectivity/{pathv1}?{query}	Yes
getDeviceDiscoveryImportController(id, callback)	Get Device Discovery Import Controller	{base_path}/{version}/mgmt/cm/global/tasks/device-discovery-import-controller/{pathv1}?{query}	Yes
deleteDeviceDiscoveryImportController(id, callback)	Delete Device Discovery Import Controller	{base_path}/{version}/mgmt/cm/global/tasks/device-discovery-import-controller/{pathv1}?{query}	Yes
postDeviceDiscoveryImportController(body, callback)	Post Device Discovery Import Controller	{base_path}/{version}/mgmt/cm/global/tasks/device-discovery-import-controller?{query}	Yes
getHTTPServer(id, callback)	Get HTTP Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/http/{pathv1}?{query}	Yes
putHTTPServer(id, body, callback)	Put HTTP Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/http/{pathv1}?{query}	Yes
deleteHTTPServer(id, callback)	Delete HTTP Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/http/{pathv1}?{query}	Yes
patchHTTPServer(id, body, callback)	Patch HTTP Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/http/{pathv1}?{query}	Yes
postHTTPServer(body, callback)	Post HTTP Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/http?{query}	Yes
getIpv4LeasePool(id, callback)	Get IPv4 Lease Pool	{base_path}/{version}/mgmt/cm/access/working-config/apm/resource/leasepool/{pathv1}?{query}	Yes
getIpv6LeasePool(id, callback)	Get IPv6 Lease Pool	{base_path}/{version}/mgmt/cm/access/working-config/apm/resource/ipv6Leasepool/{pathv1}?{query}	Yes
getKerberosKeyTabFile(id, callback)	Get Kerberos Key Tab File	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/kerberos-keytab-file/{pathv1}?{query}	Yes
putKerberosKeyTabFile(id, body, callback)	Put Kerberos Key Tab File	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/kerberos-keytab-file/{pathv1}?{query}	Yes
deleteKerberosKeyTabFile(id, callback)	Delete Kerberos Key Tab File	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/kerberos-keytab-file/{pathv1}?{query}	Yes
patchKerberosKeyTabFile(id, body, callback)	Patch Kerberos Key Tab File	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/kerberos-keytab-file/{pathv1}?{query}	Yes
postKerberosKeyTabFile(body, callback)	Post Kerberos Key Tab File	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/kerberos-keytab-file?{query}	Yes
postKillSession(body, callback)	Post Kill Session	{base_path}/{version}/mgmt/cm/access/tasks/kill-sessions?{query}	Yes
getKillSession(id, callback)	Get Kill Session	{base_path}/{version}/mgmt/cm/access/tasks/kill-sessions/{pathv1}?{query}	Yes
getLDAPServer(id, callback)	Get LDAP Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/ldap/{pathv1}?{query}	Yes
putLDAPServer(id, body, callback)	Put LDAP Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/ldap/{pathv1}?{query}	Yes
deleteLDAPServer(id, callback)	Delete LDAP Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/ldap/{pathv1}?{query}	Yes
patchLDAPServer(id, body, callback)	Patch LDAP Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/ldap/{pathv1}?{query}	Yes
postLDAPServer(body, callback)	Post LDAP Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/ldap?{query}	Yes
getNetworkAccess(id, callback)	Get Network Access	{base_path}/{version}/mgmt/cm/access/working-config/apm/resource/network-access/{pathv1}?{query}	Yes
putNetworkAccess(id, body, callback)	Put Network Access	{base_path}/{version}/mgmt/cm/access/working-config/apm/resource/network-access/{pathv1}?{query}	Yes
deleteNetworkAccess(id, callback)	Delete Network Access	{base_path}/{version}/mgmt/cm/access/working-config/apm/resource/network-access/{pathv1}?{query}	Yes
patchNetworkAccess(id, body, callback)	Patch Network Access	{base_path}/{version}/mgmt/cm/access/working-config/apm/resource/network-access/{pathv1}?{query}	Yes
postNetworkAccess(body, callback)	Post Network Access	{base_path}/{version}/mgmt/cm/access/working-config/apm/resource/network-access?{query}	Yes
getNetworkAccessOptimizedApp(networkAccessId, id, callback)	Get Network Access Optimized App	{base_path}/{version}/mgmt/cm/access/working-config/apm/resource/network-access/{pathv1}/optimized-app/{pathv2}?{query}	Yes
putNetworkAccessOptimizedApp(networkAccessId, id, body, callback)	Put Network Access Optimized App	{base_path}/{version}/mgmt/cm/access/working-config/apm/resource/network-access/{pathv1}/optimized-app/{pathv2}?{query}	Yes
deleteNetworkAccessOptimizedApp(networkAccessId, id, callback)	Delete Network Access Optimized App	{base_path}/{version}/mgmt/cm/access/working-config/apm/resource/network-access/{pathv1}/optimized-app/{pathv2}?{query}	Yes
patchNetworkAccessOptimizedApp(networkAccessId, id, body, callback)	Patch Network Access Optimized App	{base_path}/{version}/mgmt/cm/access/working-config/apm/resource/network-access/{pathv1}/optimized-app/{pathv2}?{query}	Yes
postNetworkAccessOptimizedApp(networkAccessId, body, callback)	Post Network Access Optimized App	{base_path}/{version}/mgmt/cm/access/working-config/apm/resource/network-access/{pathv1}/optimized-app?{query}	Yes
getPingAccessProfile(id, callback)	Get Ping Access Profile	{base_path}/{version}/mgmt/cm/access/working-config/apm/profile/ping-access/{pathv1}?{query}	Yes
getProfileServerSSL(id, callback)	Get Profile Server SSL	{base_path}/{version}/mgmt/cm/adc-core/working-config/ltm/profile/server-ssl/{pathv1}?{query}	Yes
getRadiusServer(id, callback)	Get Radius Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/radius/{pathv1}?{query}	Yes
putRadiusServer(id, body, callback)	Put Radius Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/radius/{pathv1}?{query}	Yes
deleteRadiusServer(id, callback)	Delete Radius Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/radius/{pathv1}?{query}	Yes
patchRadiusServer(id, body, callback)	Patch Radius Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/radius/{pathv1}?{query}	Yes
postRadiusServer(body, callback)	Post Radius Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/radius?{query}	Yes
getRewriteProfile(id, callback)	Get Rewrite Profile	{base_path}/{version}/mgmt/cm/adc-core/working-config/ltm/profile/rewrite/{pathv1}?{query}	Yes
getSAMLArtifactResolutionService(id, callback)	Get SAML Artifact Resolution Service	{base_path}/{version}/mgmt/cm/access/working-config/apm/saml/artifact-resolution-service/{pathv1}?{query}	Yes
putSAMLArtifactResolutionService(id, body, callback)	Put SAML Artifact Resolution Service	{base_path}/{version}/mgmt/cm/access/working-config/apm/saml/artifact-resolution-service/{pathv1}?{query}	Yes
deleteSAMLArtifactResolutionService(id, callback)	Delete SAML Artifact Resolution Service	{base_path}/{version}/mgmt/cm/access/working-config/apm/saml/artifact-resolution-service/{pathv1}?{query}	Yes
patchSAMLArtifactResolutionService(id, body, callback)	Patch SAML Artifact Resolution Service	{base_path}/{version}/mgmt/cm/access/working-config/apm/saml/artifact-resolution-service/{pathv1}?{query}	Yes
postSAMLArtifactResolutionService(id, callback)	Post SAML Artifact Resolution Service	{base_path}/{version}/mgmt/cm/access/working-config/apm/saml/artifact-resolution-service?{query}	Yes
getSecurIDConfigFile(securId, id, callback)	Get SecurID Config File	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/securid/{pathv1}/config-files/{pathv2}?{query}	Yes
putSecurIDConfigFile(securId, id, body, callback)	Put SecurID Config File	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/securid/{pathv1}/config-files/{pathv2}?{query}	Yes
deleteSecurIDConfigFile(securId, id, callback)	Delete SecurID Config File	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/securid/{pathv1}/config-files/{pathv2}?{query}	Yes
patchSecurIDConfigFile(securId, id, callback)	Patch SecurID Config File	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/securid/{pathv1}/config-files/{pathv2}?{query}	Yes
postSecurIDConfigFile(securId, body, callback)	Post SecurID Config File	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/securid/{pathv1}/config-files?{query}	Yes
getSecureIDServer(id, callback)	Get SecurID Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/securid/{pathv1}?{query}	Yes
putSecurIDServer(id, body, callback)	Put SecurID Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/securid/{pathv1}?{query}	Yes
deleteSecurIDServer(id, callback)	Delete SecurID Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/securid/{pathv1}?{query}	Yes
patchSecurIDServer(id, body, callback)	Patch SecurID Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/securid/{pathv1}?{query}	Yes
postSecurIDServer(body, callback)	Post SecurID Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/securid?{query}	Yes
getSNATPool(id, callback)	Get SNAT Pool	{base_path}/{version}/mgmt/cm/adc-core/working-config/ltm/snatpool/{pathv1}?{query}	Yes
getTacacsServer(id, callback)	Get TACACS Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/tacacsplus/{pathv1}?{query}	Yes
putTacacsServer(id, body, callback)	Put TACACS Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/tacacsplus/{pathv1}?{query}	Yes
deleteTacacsServer(id, callback)	Delete TACACS Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/tacacsplus/{pathv1}?{query}	Yes
patchTacacsServer(id, body, callback)	Patch TACACS Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/tacacsplus/{pathv1}?{query}	Yes
postTACACSServer(body, callback)	Post TACACS Server	{base_path}/{version}/mgmt/cm/access/working-config/apm/aaa/tacacsplus?{query}	Yes
getUserDefinedACL(id, callback)	Get User Defined ACL	{base_path}/{version}/mgmt/cm/access/working-config/apm/acl/{pathv1}?{query}	Yes
putUserDefinedACL(id, body, callback)	Put User Defined ACL	{base_path}/{version}/mgmt/cm/access/working-config/apm/acl/{pathv1}?{query}	Yes
deleteUserDefinedACL(id, callback)	Delete User Defined ACL	{base_path}/{version}/mgmt/cm/access/working-config/apm/acl/{pathv1}?{query}	Yes
patchUserDefinedACL(id, body, callback)	Patch User Defined ACL	{base_path}/{version}/mgmt/cm/access/working-config/apm/acl/{pathv1}?{query}	Yes
postUserDefinedACL(body, callback)	Post User Defined ACL	{base_path}/{version}/mgmt/cm/access/working-config/apm/acl?{query}	Yes
getVDIProfile(id, callback)	Get VDI Profile	{base_path}/{version}/mgmt/cm/access/working-config/apm/profile/vdi/{pathv1}?{query}	Yes
getVirtualServer(id, callback)	Get Virtual Server	{base_path}/{version}/mgmt/cm/access/working-config/ltm/virtual/{pathv1}?{query}	Yes
putVirtualServer(id, body, callback)	Put Virtual Server	{base_path}/{version}/mgmt/cm/access/working-config/ltm/virtual/{pathv1}?{query}	Yes
patchVirtualServer(id, body, callback)	Patch Virtual Server	{base_path}/{version}/mgmt/cm/access/working-config/ltm/virtual/{pathv1}?{query}	Yes
getVirtualServerProfile(virtualServerId, id, callback)	Get Virtual Server Profile	{base_path}/{version}/mgmt/cm/access/working-config/ltm/virtual/{pathv1}/profiles/{pathv2}?{query}	Yes
deleteVirtualServerProfile(virtualServerId, id, callback)	Delete Virtual Server Profile	{base_path}/{version}/mgmt/cm/access/working-config/ltm/virtual/{pathv1}/profiles/{pathv2}?{query}	Yes
postVirtualServerProfile(virtualServerId, body, callback)	Post Virtual Server Profile	{base_path}/{version}/mgmt/cm/access/working-config/ltm/virtual/{pathv1}/profiles?{query}	Yes
getDeclareManagementAuthorityCollection(callback)	Get Declare Management Authority Collection	{base_path}/{version}/mgmt/cm/adc-core/tasks/declare-mgmt-authority?{query}	Yes
postDeclareManagementAuthority(body, callback)	Post Declare Management Authority	{base_path}/{version}/mgmt/cm/adc-core/tasks/declare-mgmt-authority?{query}	Yes
getDeclareManagementAuthority(objectId, callback)	Get Declare Management Authority	{base_path}/{version}/mgmt/cm/adc-core/tasks/declare-mgmt-authority/{pathv1}?{query}	Yes
getAllVirtualPools(callback)	Get All Virtual Pools	{base_path}/{version}/mgmt/cm/adc-core/working-config/ltm/pool?{query}	Yes
getVirtualPool(objectId, callback)	Get Virtual Pool	{base_path}/{version}/mgmt/cm/adc-core/working-config/ltm/pool/{pathv1}?{query}	Yes
postLTMPoolMember(body, callback)	Post LTM Pool Member	{base_path}/{version}/mgmt/cm/adc-core/working-config/ltm/pool/{pathv1}/members?{query}	Yes
deleteApplicationServerNode(objectId, callback)	Delete Application Server Node	{base_path}/{version}/mgmt/cm/adc-core/working-config/ltm/pool/{pathv1}/members?{query}	Yes
getAllPoolMembers(objectId, callback)	Get All Pool Members	{base_path}/{version}/mgmt/cm/adc-core/working-config/ltm/pool/{pathv1}/members?{query}	Yes
getPoolMember(poolId, objectId, callback)	Get Pool Member	{base_path}/{version}/mgmt/cm/adc-core/working-config/ltm/pool/{pathv1}/members/{pathv2}?{query}	Yes
postADCSelfServiceTask(body, callback)	Post ADC Self Service Task	{base_path}/{version}/mgmt/cm/adc-core/tasks/self-service?{query}	Yes
getAllADCSelfServiceTasks(callback)	Get All ADC Self Service Tasks	{base_path}/{version}/mgmt/cm/adc-core/tasks/self-service?{query}	Yes
getADCSelfServiceTask(objectId, callback)	Get ADC Self Service Task	{base_path}/{version}/mgmt/cm/adc-core/tasks/self-service/{pathv1}?{query}	Yes
postLTMApplicationServerNode(body, callback)	Post LTM Application Server Node	{base_path}/{version}/mgmt/cm/adc-core/working-config/ltm/node?{query}	Yes
getAllLTMApplicationServerNodes(callback)	Get All LTM Application Server Nodes	{base_path}/{version}/mgmt/cm/adc-core/working-config/ltm/node?{query}	Yes
getLTMApplicationServerNode(objectId, callback)	Get LTM Application Server Node	{base_path}/{version}/mgmt/cm/adc-core/working-config/ltm/node/{pathv1}?{query}	Yes
postLTMVirtualServer(body, callback)	Post LTM Virtual Server	{base_path}/{version}/mgmt/cm/adc-core/working-config/ltm/virtual?{query}	Yes
getAllLTMVirtualServers(callback)	Get All LTM Virtual Servers	{base_path}/{version}/mgmt/cm/adc-core/working-config/ltm/virtual?{query}	Yes
getLTMVirtualServer(objectId, callback)	Get LTM Virtual Server	{base_path}/{version}/mgmt/cm/adc-core/working-config/ltm/virtual/{pathv1}?{query}	Yes
getSSLCert(id, callback)	Get SSL Cert	{base_path}/{version}/mgmt/cm/adc-core/working-config/sys/file/ssl-cert/{pathv1}?{query}	Yes
deleteSSLCert(id, callback)	Delete SSL Cert	{base_path}/{version}/mgmt/cm/adc-core/working-config/sys/file/ssl-cert/{pathv1}?{query}	Yes
deleteSSLCertRevocationList(id, callback)	Delete SSL Cert Revocation List	{base_path}/{version}/mgmt/cm/adc-core/working-config/sys/file/ssl-crl/{pathv1}?{query}	Yes
geleteSSLCertRevocationList(id, callback)	Get SSL Cert Revocation List	{base_path}/{version}/mgmt/cm/adc-core/working-config/sys/file/ssl-crl/{pathv1}?{query}	Yes
getSSLCertificateSigningRequest(id, callback)	Get SSL Certificate Signing Request	{base_path}/{version}/mgmt/cm/adc-core/working-config/sys/file/ssl-csr/{pathv1}?{query}	Yes
deleteSSLCertificateSigningRequest(id, callback)	Delete SSL Certificate Signing Request	{base_path}/{version}/mgmt/cm/adc-core/working-config/sys/file/ssl-csr/{pathv1}?{query}	Yes
getSSLKey(id, callback)	Get SSL Key	{base_path}/{version}/mgmt/cm/adc-core/working-config/sys/file/ssl-key/{pathv1}?{query}	Yes
deleteSSLKey(id, callback)	Delete SSL Key	{base_path}/{version}/mgmt/cm/adc-core/working-config/sys/file/ssl-key/{pathv1}?{query}	Yes
postASMPolicy(body, callback)	Post ASM Policy	{base_path}/{version}/mgmt/cm/asm/working-config/policies?{query}	Yes
getAllASMPolicies(callback)	Get All ASM Policies	{base_path}/{version}/mgmt/cm/asm/working-config/policies?{query}	Yes
getASMPolicy(objectId, callback)	Get ASM Policy	{base_path}/{version}/mgmt/cm/asm/working-config/policies/{pathv1}?{query}	Yes
getAllASMSignatures(callback)	Get All ASM Signatures	{base_path}/{version}/mgmt/cm/asm/working-config/signatures?{query}	Yes
getASMSignature(objectId, callback)	Get ASM Signature	{base_path}/{version}/mgmt/cm/asm/working-config/signatures/{pathv1}?{query}	Yes
getDeviceIPPool(id, callback)	Get Device IP Pool	{base_path}/{version}/mgmt/cm/device/ip-pool/pools/{pathv1}?{query}	Yes
patchDeviceIPPools(id, body, callback)	Patch Device IP Pools	{base_path}/{version}/mgmt/cm/device/ip-pool/pools/{pathv1}?{query}	Yes
deleteDeviceIPPool(id, callback)	Delete Device IP Pool	{base_path}/{version}/mgmt/cm/device/ip-pool/pools/{pathv1}?{query}	Yes
listDeviceIPPools(callback)	Get all IP Pools	{base_path}/{version}/mgmt/cm/device/ip-pool/pools?{query}	Yes
postDeviceIPPool(body, callback)	Post Device IP Pool	{base_path}/{version}/mgmt/cm/device/ip-pool/pools?{query}	Yes
postDeviceDiscovery(body, callback)	Post Device Discovery	{base_path}/{version}/mgmt/cm/global/tasks/device-discovery?{query}	Yes
getAllDeviceDiscoveryTasks(callback)	Get All Device Discovery Tasks	{base_path}/{version}/mgmt/cm/global/tasks/device-discovery?{query}	Yes
getDeviceDiscoveryTask(objectId, callback)	Get Device Discovery Task	{base_path}/{version}/mgmt/cm/global/tasks/device-discovery/{pathv1}?{query}	Yes
performDeviceDiscoveryTask(objectId, body, callback)	Perform Device Discovery Task	{base_path}/{version}/mgmt/cm/global/tasks/device-discovery/{pathv1}?{query}	Yes
postDeviceTrustTask(body, callback)	Post Device Trust Task	{base_path}/{version}/mgmt/cm/global/tasks/device-trust?{query}	Yes
getAllDeviceTrustTasks(callback)	Get All Device Trust Tasks	{base_path}/{version}/mgmt/cm/global/tasks/device-trust?{query}	Yes
getDeviceTrustTask(objectId, callback)	Get Device Trust Task	{base_path}/{version}/mgmt/cm/global/tasks/device-trust/{pathv1}?{query}	Yes
postDeviceReferenceQuery(body, callback)	Post Device Reference Query	{base_path}/{version}/mgmt/cm/shared/device-reference-query?{query}	Yes
getDeviceTemplate(id, callback)	Get Device Template	{base_path}/{version}/mgmt/cm/device/templates/{pathv1}?{query}	Yes
patchDeviceTemplate(id, body, callback)	Patch Device Template	{base_path}/{version}/mgmt/cm/device/templates/{pathv1}?{query}	Yes
deleteDeviceTemplate(id, callback)	Delete Device Template	{base_path}/{version}/mgmt/cm/device/templates/{pathv1}?{query}	Yes
postDeviceTemplate(body, callback)	Post Device Template	{base_path}/{version}/mgmt/cm/device/templates?{query}	Yes
getDNSDataCenter(id, callback)	Get DNS Data Center	{base_path}/{version}/mgmt/cm/dns/working-config/datacenter/{pathv1}?{query}	Yes
patchDNSDataCenter(id, body, callback)	Patch DNS Data Center	{base_path}/{version}/mgmt/cm/dns/working-config/datacenter/{pathv1}?{query}	Yes
deleteDNSDataCenter(id, callback)	Delete DNS Data Center	{base_path}/{version}/mgmt/cm/dns/working-config/datacenter/{pathv1}?{query}	Yes
postDNSDataCenter(body, callback)	Post DNS Data Center	{base_path}/{version}/mgmt/cm/dns/working-config/datacenter?{query}	Yes
getDNSiRule(id, callback)	Get DNS iRule	{base_path}/{version}/mgmt/cm/dns/working-config/rule/{pathv1}?{query}	Yes
deleteDNSiRule(id, callback)	Delete DNS iRule	{base_path}/{version}/mgmt/cm/dns/working-config/rule/{pathv1}?{query}	Yes
patchDNSiRule(id, body, callback)	Patch DNS iRule	{base_path}/{version}/mgmt/cm/dns/working-config/rule/{pathv1}?{query}	Yes
postDNSiRule(body, callback)	Post DNS iRule	{base_path}/{version}/mgmt/cm/dns/working-config/rule?{query}	Yes
getDNSPoolA(id, callback)	Get DNS Pool A	{base_path}/{version}/mgmt/cm/dns/working-config/pool/a/{pathv1}?{query}	Yes
deleteDNSPoolA(id, callback)	Delete DNS Pool A	{base_path}/{version}/mgmt/cm/dns/working-config/pool/a/{pathv1}?{query}	Yes
patchDNSPoolA(id, body, callback)	Patch DNS Pool A	{base_path}/{version}/mgmt/cm/dns/working-config/pool/a/{pathv1}?{query}	Yes
postDNSPoolA(body, callback)	Post DNS Pool A	{base_path}/{version}/mgmt/cm/dns/working-config/pool/a?{query}	Yes
getDNSPoolAAAA(id, callback)	Get DNS Pool AAAA	{base_path}/{version}/mgmt/cm/dns/working-config/pool/aaaa/{pathv1}?{query}	Yes
deleteDNSPoolAAAA(id, callback)	Delete DNS Pool AAAA	{base_path}/{version}/mgmt/cm/dns/working-config/pool/aaaa/{pathv1}?{query}	Yes
patchDNSPoolAAAA(id, body, callback)	Patch DNS Pool AAAA	{base_path}/{version}/mgmt/cm/dns/working-config/pool/aaaa/{pathv1}?{query}	Yes
postDNSPoolAAAA(body, callback)	Post DNS Pool AAAA	{base_path}/{version}/mgmt/cm/dns/working-config/pool/aaaa?{query}	Yes
getDNSPoolCNAME(id, callback)	Get DNS Pool CNAME	{base_path}/{version}/mgmt/cm/dns/working-config/cname/{pathv1}?{query}	Yes
deleteDNSPoolCNAME(id, callback)	Delete DNS Pool CNAME	{base_path}/{version}/mgmt/cm/dns/working-config/cname/{pathv1}?{query}	Yes
patchDNSPoolCNAME(id, body, callback)	Patch DNS Pool CNAME	{base_path}/{version}/mgmt/cm/dns/working-config/cname/{pathv1}?{query}	Yes
postDNSPoolCNAME(body, callback)	Post DNS Pool CNAME	{base_path}/{version}/mgmt/cm/dns/working-config/cname?{query}	Yes
getDNSPoolMemberA(poolId, poolMemberId, callback)	Get DNS Pool Member A	{base_path}/{version}/mgmt/cm/dns/working-config/pool/a/{pathv1}/members/{pathv2}?{query}	Yes
deleteDNSPoolMemberA(poolId, poolMemberId, callback)	Delete DNS Pool Member A	{base_path}/{version}/mgmt/cm/dns/working-config/pool/a/{pathv1}/members/{pathv2}?{query}	Yes
patchDNSPoolMemberA(poolId, poolMemberId, body, callback)	Patch DNS Pool Member A	{base_path}/{version}/mgmt/cm/dns/working-config/pool/a/{pathv1}/members/{pathv2}?{query}	Yes
postDNSPoolMemberA(poolId, body, callback)	Post DNS Pool Member A	{base_path}/{version}/mgmt/cm/dns/working-config/pool/a/{pathv1}/members?{query}	Yes
getDNSPoolMemberAAAA(poolId, poolMemberId, callback)	Get DNS Pool Member AAAA	{base_path}/{version}/mgmt/cm/dns/working-config/pool/aaaa/{pathv1}/members/{pathv2}?{query}	Yes
deleteDNSPoolMember(poolId, poolMemberId, callback)	Delete DNS Pool Member AAAA	{base_path}/{version}/mgmt/cm/dns/working-config/pool/aaaa/{pathv1}/members/{pathv2}?{query}	Yes
patchDNSPoolMemberAAAA(poolId, poolMemberId, body, callback)	Patch DNS Pool Member AAAA	{base_path}/{version}/mgmt/cm/dns/working-config/pool/aaaa/{pathv1}/members/{pathv2}?{query}	Yes
postDNSPoolMemberAAAA(poolId, body, callback)	Post DNS Pool Member AAAA	{base_path}/{version}/mgmt/cm/dns/working-config/pool/aaaa/{pathv1}/members?{query}	Yes
getDNSPoolMemberCNAME(poolId, poolMemberId, callback)	Get DNS Pool Member CNAME	{base_path}/{version}/mgmt/cm/dns/working-config/pool/cname/{pathv1}/members/{pathv2}?{query}	Yes
deleteDNSPoolMemberCNAME(poolId, poolMemberId, callback)	Delete DNS Pool Member CNAME	{base_path}/{version}/mgmt/cm/dns/working-config/pool/cname/{pathv1}/members/{pathv2}?{query}	Yes
patchDNSPoolMemberCNAME(poolId, poolMemberId, body, callback)	Patch DNS Pool Member CNAME	{base_path}/{version}/mgmt/cm/dns/working-config/pool/cname/{pathv1}/members/{pathv2}?{query}	Yes
postDNSPoolMemberCNAME(poolId, body, callback)	Post DNS Pool Member CNAME	{base_path}/{version}/mgmt/cm/dns/working-config/pool/cname/{pathv1}/members?{query}	Yes
getDNSPoolMemberMX(poolId, poolMemberId, callback)	Get DNS Pool Member MX	{base_path}/{version}/mgmt/cm/dns/working-config/pool/mx/{pathv1}/members/{pathv2}?{query}	Yes
deleteDNSPoolMemberMX(poolId, poolMemberId, callback)	Delete DNS Pool Member MX	{base_path}/{version}/mgmt/cm/dns/working-config/pool/mx/{pathv1}/members/{pathv2}?{query}	Yes
patchDNSPoolMemberMX(poolId, poolMemberId, body, callback)	Patch DNS Pool Member MX	{base_path}/{version}/mgmt/cm/dns/working-config/pool/mx/{pathv1}/members/{pathv2}?{query}	Yes
postDNSPoolMemberMX(poolId, body, callback)	Post DNS Pool Member MX	{base_path}/{version}/mgmt/cm/dns/working-config/pool/mx/{pathv1}/members?{query}	Yes
getDNSPoolMemberNAPTR(poolId, poolMemberId, callback)	Get DNS Pool Member NAPTR	{base_path}/{version}/mgmt/cm/dns/working-config/pool/naptr/{pathv1}/members/{pathv2}?{query}	Yes
deleteDNSPoolMemberNAPTR(poolId, poolMemberId, callback)	Delete DNS Pool Member NAPTR	{base_path}/{version}/mgmt/cm/dns/working-config/pool/naptr/{pathv1}/members/{pathv2}?{query}	Yes
patchDNSPoolMemberNAPTR(poolId, poolMemberId, body, callback)	Patch DNS Pool Member NAPTR	{base_path}/{version}/mgmt/cm/dns/working-config/pool/naptr/{pathv1}/members/{pathv2}?{query}	Yes
postDNSPoolMemberNAPTR(poolId, body, callback)	Post DNS Pool Member NAPTR	{base_path}/{version}/mgmt/cm/dns/working-config/pool/naptr/{pathv1}/members?{query}	Yes
getDNSPoolMemberSRV(poolId, poolMemberId, callback)	Get DNS Pool Member SRV	{base_path}/{version}/mgmt/cm/dns/working-config/pool/srv/{pathv1}/members/{pathv2}?{query}	Yes
deleteDNSPoolMemberSRV(poolId, poolMemberId, callback)	Delete DNS Pool Member SRV	{base_path}/{version}/mgmt/cm/dns/working-config/pool/srv/{pathv1}/members/{pathv2}?{query}	Yes
patchDNSPoolMemberSRV(poolId, poolMemberId, body, callback)	Patch DNS Pool Member SRV	{base_path}/{version}/mgmt/cm/dns/working-config/pool/srv/{pathv1}/members/{pathv2}?{query}	Yes
postDNSPoolMemberSRV(poolId, body, callback)	Post DNS Pool Member SRV	{base_path}/{version}/mgmt/cm/dns/working-config/pool/srv/{pathv1}/members?{query}	Yes
patchDNSPoolMX(id, body, callback)	Patch DNS Pool MX	{base_path}/{version}/mgmt/cm/dns/working-config/pool/mx/{pathv1}?{query}	Yes
deleteDNSPoolMX(id, callback)	Delete DNS Pool MX	{base_path}/{version}/mgmt/cm/dns/working-config/pool/mx/{pathv1}?{query}	Yes
getDNSPoolMX(id, callback)	Get DNS Pool MX	{base_path}/{version}/mgmt/cm/dns/working-config/pool/mx/{pathv1}?{query}	Yes
postDNSPoolMX(body, callback)	Post DNS Pool MX	{base_path}/{version}/mgmt/cm/dns/working-config/pool/mx?{query}	Yes
getDNSPoolNAPTR(id, callback)	Get DNS Pool NAPTR	{base_path}/{version}/mgmt/cm/dns/working-config/pool/naptr/{pathv1}?{query}	Yes
deleteDNSPoolNAPTR(id, callback)	Delete DNS Pool NAPTR	{base_path}/{version}/mgmt/cm/dns/working-config/pool/naptr/{pathv1}?{query}	Yes
patchDNSPoolNAPTR(id, body, callback)	Patch DNS Pool NAPTR	{base_path}/{version}/mgmt/cm/dns/working-config/pool/naptr/{pathv1}?{query}	Yes
getDNSPoolSRV(id, callback)	Get DNS Pool SRV	{base_path}/{version}/mgmt/cm/dns/working-config/pool/srv/{pathv1}?{query}	Yes
deleteDNSPoolSRV(id, callback)	Delete DNS Pool SRV	{base_path}/{version}/mgmt/cm/dns/working-config/pool/srv/{pathv1}?{query}	Yes
patchDNSPoolSRV(id, body, callback)	Patch DNS Pool SRV	{base_path}/{version}/mgmt/cm/dns/working-config/pool/srv/{pathv1}?{query}	Yes
postDNSPoolNAPTR(body, callback)	Post DNS Pool NAPTR	{base_path}/{version}/mgmt/cm/dns/working-config/pool/naptr?{query}	Yes
postDNSPoolSRV(body, callback)	Post DNS Pool SRV	{base_path}/{version}/mgmt/cm/dns/working-config/pool/srv?{query}	Yes
getDNSRegion(id, callback)	Get DNS Region	{base_path}/{version}/mgmt/cm/dns/working-config/region/{pathv1}?{query}	Yes
deleteDNSRegion(id, callback)	Delete DNS Region	{base_path}/{version}/mgmt/cm/dns/working-config/region/{pathv1}?{query}	Yes
patchDNSRegion(id, body, callback)	Patch DNS Region	{base_path}/{version}/mgmt/cm/dns/working-config/region/{pathv1}?{query}	Yes
postDNSRegion(body, callback)	Post DNS Region	{base_path}/{version}/mgmt/cm/dns/working-config/region?{query}	Yes
patchDNSServer(id, body, callback)	Patch DNS Server	{base_path}/{version}/mgmt/cm/dns/working-config/server/{pathv1}?{query}	Yes
getDNSServer(id, callback)	Get DNS Server	{base_path}/{version}/mgmt/cm/dns/working-config/server/{pathv1}?{query}	Yes
deleteDNSServer(id, callback)	Delete DNS Server	{base_path}/{version}/mgmt/cm/dns/working-config/server/{pathv1}?{query}	Yes
postDNSServer(body, callback)	Post DNS Server	{base_path}/{version}/mgmt/cm/dns/working-config/server?{query}	Yes
getDNSServerDevice(serverId, deviceId, callback)	Get DNS Server Device	{base_path}/{version}/mgmt/cm/dns/working-config/server/{pathv1}/devices/{pathv2}?{query}	Yes
deleteDNSServerDevice(serverId, deviceId, callback)	Delete DNS Server Device	{base_path}/{version}/mgmt/cm/dns/working-config/server/{pathv1}/devices/{pathv2}?{query}	Yes
patchDNSServerDevice(serverId, deviceId, body, callback)	Patch DNS Server Device	{base_path}/{version}/mgmt/cm/dns/working-config/server/{pathv1}/devices/{pathv2}?{query}	Yes
postDNSServerDevice(serverId, body, callback)	Post DNS Server Device	{base_path}/{version}/mgmt/cm/dns/working-config/server/{pathv1}/devices?{query}	Yes
getDNSTopology(id, callback)	Get DNS Topology	{base_path}/{version}/mgmt/cm/dns/working-config/topology/{pathv1}?{query}	Yes
deleteDNSTopolgoy(id, callback)	Delete DNS Topology	{base_path}/{version}/mgmt/cm/dns/working-config/topology/{pathv1}?{query}	Yes
patchDNSTopology(id, body, callback)	Patch DNS Topology	{base_path}/{version}/mgmt/cm/dns/working-config/topology/{pathv1}?{query}	Yes
postDNSTopology(body, callback)	Post DNS Topology	{base_path}/{version}/mgmt/cm/dns/working-config/topology?{query}	Yes
patchDNSVirtualServer(serverId, virtualServerId, body, callback)	Patch DNS Virtual Server	{base_path}/{version}/mgmt/cm/dns/working-config/server/{pathv1}/virtual-servers/{pathv2}?{query}	Yes
getDNSVirtualServer(serverId, virtualServerId, callback)	Get DNS Virtual Server	{base_path}/{version}/mgmt/cm/dns/working-config/server/{pathv1}/virtual-servers/{pathv2}?{query}	Yes
deleteDNSVirtualServer(serverId, virtualServerId, callback)	Delete DNS Virtual Server	{base_path}/{version}/mgmt/cm/dns/working-config/server/{pathv1}/virtual-servers/{pathv2}?{query}	Yes
postDNSVirtualServer(serverId, body, callback)	Post DNS Virtual Server	{base_path}/{version}/mgmt/cm/dns/working-config/server/{pathv1}/virtual-servers?{query}	Yes
getDNSWideIPA(id, callback)	Get DNS Wide IP A	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/a/{pathv1}?{query}	Yes
deleteDNSWideIPA(id, callback)	Delete DNS Wide IP A	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/a/{pathv1}?{query}	Yes
patchDNSWideIPA(id, callback)	Patch DNS Wide IP A	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/a/{pathv1}?{query}	Yes
postDNSWideIPA(body, callback)	Post DNS Wide IP A	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/a?{query}	Yes
getDNSWideIPAAAA(id, callback)	Get DNS Wide IP AAAA	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/aaaa/{pathv1}?{query}	Yes
deleteDNSWideIPAAAA(id, callback)	Delete DNS Wide IP AAAA	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/aaaa/{pathv1}?{query}	Yes
patchDNSWideIPAAAA(id, body, callback)	Patch DNS Wide IP AAAA	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/aaaa/{pathv1}?{query}	Yes
postDNSWideIPAAAA(body, callback)	Post DNS Wide IP AAAA	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/aaaa?{query}	Yes
getDNSWideIPCNAME(id, callback)	Get DNS Wide IP CNAME	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/cname/{pathv1}?{query}	Yes
deleteDNSWideIPCNAME(id, callback)	Delete DNS Wide IP CNAME	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/cname/{pathv1}?{query}	Yes
patchDNSWideIPCNAME(id, body, callback)	Patch DNS Wide IP CNAME	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/cname/{pathv1}?{query}	Yes
getDNSWideIPMX(id, callback)	Get DNS Wide IP MX	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/mx/{pathv1}?{query}	Yes
deleteDNSWideIPMX(id, callback)	Delete DNS Wide IP MX	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/mx/{pathv1}?{query}	Yes
patchDNSWideIPMX(id, body, callback)	Patch DNS Wide IP MX	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/mx/{pathv1}?{query}	Yes
getDNSWideIPNAPTR(id, callback)	Get DNS Wide IP NAPTR	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/naptr/{pathv1}?{query}	Yes
deleteDNSWideIPNAPTR(id, callback)	Delete DNS Wide IP NAPTR	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/naptr/{pathv1}?{query}	Yes
getDNSWideIPSRV(id, callback)	Get DNS Wide IP SRV	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/srv/{pathv1}?{query}	Yes
deleteDNSWideIPSRV(id, callback)	Delete DNS Wide IP SRV	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/srv/{pathv1}?{query}	Yes
postDNSWideIPCNAME(body, callback)	Post DNS Wide IP CNAME	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/cname?{query}	Yes
postDNSWideIPMX(body, callback)	Post DNS Wide IP MX	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/mx?{query}	Yes
postDNSWideIPNAPTR(body, callback)	Post DNS Wide IP NAPTR	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/naptr?{query}	Yes
postDNSWideIPSRV(body, callback)	Post DNS Wide IP SRV	{base_path}/{version}/mgmt/cm/dns/working-config/wideip/srv?{query}	Yes
patchDNSWideIPSRV(id, body, callback)	Patch DNS Wide IP SRV	{base_path}/{version}/mgmt/cm/dns/working-config/srv/mx/{pathv1}?{query}	Yes
patchDNSWideIPNAPTR(id, body, callback)	Patch DNS Wide IP NAPTR	{base_path}/{version}/mgmt/cm/dns/working-config/naptr/mx/{pathv1}?{query}	Yes
postRetrieveFirewallExpanedRules(body, callback)	Post Retrieve Firewall Expanded Rules	{base_path}/{version}/mgmt/cm/firewall/utility/expanded-rules?{query}	Yes
postFirewallRuleDeclareManagementAuthorityTask(body, callback)	Post Firewall Rule Declare Management Authority Task	{base_path}/{version}/mgmt/cm/firewall/tasks/declare-mgmt-authority?{query}	Yes
getAllFirewallRuleDeclareManagementAuthorityTask(callback)	Get All Firewall Rule Declare Management Authority Task	{base_path}/{version}/mgmt/cm/firewall/tasks/declare-mgmt-authority?{query}	Yes
getFirewallRuleDeclareManagementAuthorityTask(objectId, callback)	Get Firewall Rule Declare Management Authority Task	{base_path}/{version}/mgmt/cm/firewall/tasks/declare-mgmt-authority/{pathv1}?{query}	Yes
getAllFirewalls(callback)	Get All Firewalls	{base_path}/{version}/mgmt/cm/firewalls/working-config/firewalls?{query}	Yes
getFirewall(objectId, callback)	Get Firewall	{base_path}/{version}/mgmt/cm/firewalls/working-config/firewalls/{pathv1}?{query}	Yes
patchFirewall(objectId, body, callback)	Patch Firewall	{base_path}/{version}/mgmt/cm/firewalls/working-config/firewalls/{pathv1}?{query}	Yes
getAllFirewallDeployConfiguration(callback)	Get All Firewall Deploy Configuration	{base_path}/{version}/mgmt/cm/firewall/tasks/deploy-configuration?{query}	Yes
getFirewallDeployConfiguration(objectId, callback)	Get Firewall Deploy Configuration	{base_path}/{version}/mgmt/cm/firewall/tasks/deploy-configuration/{pathv1}?{query}	Yes
postFirewallDeployConfiguration(body, callback)	Post Firewall Deploy Configuration	{base_path}/{version}/mgmt/cm/firewall/tasks/deploy-configuration/{pathv1}?{query}	Yes
getAllFirewallPolicies(callback)	Get All Firewall Policies	{base_path}/{version}/mgmt/cm/firewalls/working-config/policies?{query}	Yes
getFirewallPolicy(objectId, callback)	Get Firewall Policy	{base_path}/{version}/mgmt/cm/firewalls/working-config/policies/{pathv1}?{query}	Yes
getAllFirewallPolicyRules(objectId, callback)	Get All Firewall Policy Rules	{base_path}/{version}/mgmt/cm/firewalls/working-config/policies/{pathv1}/rules?{query}	Yes
getFirewallPolicyRule(policyId, ruleId, callback)	Get Firewall Policy Rule	{base_path}/{version}/mgmt/cm/firewalls/working-config/policies/{pathv1}/rules/{pathv2}?{query}	Yes
getResolveMachineId(filter, callback)	Resolve machineId	{base_path}/{version}/mgmt/cm/system/machineid-resolver?{query}	Yes
getExampleQkview(callback)	EXAMPLE - Qkview	{base_path}/{version}/mgmt/cm/autodeploy/qkview/example?{query}	Yes
retrieveQkviewTasks(callback)	Retrieve Qkview Tasks	{base_path}/{version}/mgmt/cm/autodeploy/qkview?{query}	Yes
generateaQkview(body, callback)	Generate a Qkview	{base_path}/{version}/mgmt/cm/autodeploy/qkview?{query}	Yes
queryBIGIQQkviewTask(bIGIQQKVIEWTASKID, callback)	Query BIG-IQ Qkview Task	{base_path}/{version}/mgmt/cm/autodeploy/qkview/{pathv1}?{query}	Yes
deleteBIGIQQkview(bIGIQQKVIEWTASKID, callback)	Delete BIG-IQ Qkview	{base_path}/{version}/mgmt/cm/autodeploy/qkview/{pathv1}?{query}	Yes
queryBIGIPQkviewTask(bIGIPQKVIEWTASKID, callback)	Query BIGIP Qkview Task	{base_path}/{version}/mgmt/cm/autodeploy/qkview/{pathv1}?{query}	Yes
deleteaBIGIQQkview(bIGIPQKVIEWTASKID, callback)	Delete a BIGIP Qkview	{base_path}/{version}/mgmt/cm/autodeploy/qkview/{pathv1}?{query}	Yes
getExampleBIGIPiHealthReport(callback)	EXAMPLE - BIG-IP iHealth Report	{base_path}/{version}/mgmt/cm/device/ihealth/reports/example?{query}	Yes
getExampleBIGIPiHealthUploads(callback)	EXAMPLE - BIG-IP iHealth Uploads	{base_path}/{version}/mgmt/cm/device/ihealth/uploads/example?{query}	Yes
getExampleBIGIPiHealthCredentials(callback)	EXAMPLE - BIG-IP iHealth Credentials	{base_path}/{version}/mgmt/cm/device/ihealth/credentials/example?{query}	Yes
getExampleBIGIPiHealthConfig(callback)	EXAMPLE - BIG-IP iHealth Config	{base_path}/{version}/mgmt/cm/device/ihealth/config/example?{query}	Yes
retrieveBIGIPiHealthReports(callback)	Retrieve BIG-IP iHealth Reports	{base_path}/{version}/mgmt/cm/device/ihealth/reports?{query}	Yes
generateBIGIPiHealthReport(body, callback)	Generate BIG-IP iHealth Report	{base_path}/{version}/mgmt/cm/device/ihealth/reports?{query}	Yes
retrieveBIGIPiHealthCredentials(filter, callback)	Retrieve BIG-IP iHealth Credentials	{base_path}/{version}/mgmt/cm/device/ihealth/credentials?{query}	Yes
createTestBIGIPiHealthCredentials(body, callback)	Create Test BIG-IP iHealth Credentials	{base_path}/{version}/mgmt/cm/device/ihealth/credentials?{query}	Yes
retrieveBIGIPiHealthConfig(callback)	Retrieve BIG-IP iHealth Config	{base_path}/{version}/mgmt/cm/device/ihealth/config?{query}	Yes
updateBIGIPiHealthConfig(body, callback)	Update BIG-IP iHealth Config	{base_path}/{version}/mgmt/cm/device/ihealth/config?{query}	Yes
retrieveBIGIPiHealthUploads(callback)	Retrieve BIG-IP iHealth Uploads	{base_path}/{version}/mgmt/cm/device/ihealth/uploads?{query}	Yes
createBIGIPiHealthUploadTask(body, callback)	Create BIG-IP iHealth Upload Task	{base_path}/{version}/mgmt/cm/device/ihealth/uploads?{query}	Yes
queryUploadTaskStatus(iHealthUploadTaskId, callback)	Query Upload Task Status	{base_path}/{version}/mgmt/cm/device/ihealth/uploads/{pathv1}?{query}	Yes
modifyTestBIGIPiHealthCredentials(credentialsId, body, callback)	Modify Test BIG-IP iHealth Credentials	{base_path}/{version}/mgmt/cm/device/ihealth/credentials/{pathv1}?{query}	Yes
deleteTestBIGIPiHealthCredentials(credentialsId, callback)	Delete Test BIG-IP iHealth Credentials	{base_path}/{version}/mgmt/cm/device/ihealth/credentials/{pathv1}?{query}	Yes
verifyProperSystemStatus(callback)	Verify Proper System Status	{base_path}/{version}/info/system?{query}	Yes
verifyProperHAStatus(callback)	Verify Proper HA Status	{base_path}/{version}/mgmt/shared/failover-state?{query}	Yes
getExampleBackupRestoreTask(callback)	EXAMPLE - Backup/Restore Task	{base_path}/{version}/mgmt/cm/system/backup-restore/example?{query}	Yes
retrieveallBackupTasks(callback)	Retrieve all Backup Tasks	{base_path}/{version}/mgmt/cm/system/backup-restore?{query}	Yes
generateBackupofDevice(body, callback)	Generate Backup of Device	{base_path}/{version}/mgmt/cm/system/backup-restore?{query}	Yes
queryBackupTaskStatus(backupTaskId, callback)	Query Backup Task Status	{base_path}/{version}/mgmt/cm/system/backup-restore/{pathv1}?{query}	Yes
deleteBackupFile(backupTaskId, callback)	Delete Backup File	{base_path}/{version}/mgmt/cm/system/backup-restore/{pathv1}?{query}	Yes
generateBackupFileDownloadPathHash(body, callback)	Generate Backup File Download Path Hash	{base_path}/{version}/info/filedownload?{query}	Yes
downloadBackupFileusingPathHash(pathHash, callback)	Download Backup File using Path Hash	{base_path}/{version}/info/filedownload/{pathv1}?{query}	Yes
getExampleBIGIPscripts(callback)	EXAMPLE - BIG-IP scripts	{base_path}/{version}/mgmt/shared/user-scripts/example?{query}	Yes
retrieveallBIGIPscripts(callback)	Retrieve all BIG-IP scripts	{base_path}/{version}/mgmt/shared/user-scripts?{query}	Yes
createaBIGIPscript(body, callback)	Create a BIG-IP script	{base_path}/{version}/mgmt/shared/user-scripts?{query}	Yes
executeaBIGIPscript(body, callback)	Execute a BIG-IP script	{base_path}/{version}/mgmt/shared/user-script-execution?{query}	Yes
queryBIGIPscriptstatus(scriptTaskId, callback)	Query BIG-IP script status	{base_path}/{version}/mgmt/shared/user-script-execution/{pathv1}?{query}	Yes
deleteBIGIPscript(scriptId, callback)	Delete BIG-IP script	{base_path}/{version}/mgmt/shared/user-scripts/{pathv1}?{query}	Yes
retrieveallSoftwareImages(filter, orderby, callback)	Retrieve all Software Images	{base_path}/{version}/mgmt/cm/autodeploy/software-images?{query}	Yes
retrieveallBIGIPsandimageslots(filter, callback)	Retrieve all BIG-IPs and image slots	{base_path}/{version}/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices?{query}	Yes
retrievaallUpgradeTasks(callback)	Retrieve all upgrade tasks	{base_path}/{version}/mgmt/cm/device/upgrades?{query}	Yes
performSoftwareUpgrade(body, callback)	Perform software upgrade	{base_path}/{version}/mgmt/cm/device/upgrades?{query}	Yes
retrieveBIGIPdevices(select, filter, callback)	Retrieve BIG-IP devices	{base_path}/{version}/mgmt/shared/resolver/device-groups/cm-bigip-allDevices/devices?{query}	Yes
retrieveDeviceGroups(filter, orderby, select, callback)	Retrieve Device Groups	{base_path}/{version}/mgmt/shared/resolver/device-groups?{query}	Yes
retrieveBIGIPHealthSummary(instanceUuid, callback)	Retrieve BIG-IP Health Summary	{base_path}/{version}/mgmt/shared/resolver/device-groups/cm-bigip-allDevices/devices/{pathv1}/stats?{query}	Yes
retrieveBIGIPDeviceImportTasks(filter, callback)	Retrieve BIG-IP Device Import Tasks	{base_path}/{version}/mgmt/cm/global/tasks/device-import?{query}	Yes
performBIGIPDeviceImportusingmachineId(body, callback)	Perform BIG-IP Device Import using machineId	{base_path}/{version}/mgmt/cm/global/tasks/device-import?{query}	Yes
performBIGIPDeviceImportusingImportTask(deviceImportId, body, callback)	Perform BIG-IP Device Import using Import Task	{base_path}/{version}/mgmt/cm/global/tasks/device-import/{pathv1}?{query}	Yes
monitorImportTask(deviceImportId, callback)	Monitor Import Task	{base_path}/{version}/mgmt/cm/global/tasks/device-import/{pathv1}?{query}	Yes
queryDevicebyDeviceReference(uuid, callback)	Query Device by Device Reference	{base_path}/{version}/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/{pathv1}?{query}	Yes
queryDSCGroup(filter, callback)	Query DSC Group	{base_path}/{version}/mgmt/cm/device/dsc-group?{query}	Yes
queryDSCGroupByGroupId(groupId, callback)	Query DSC Group by group id	{base_path}/{version}/mgmt/cm/device/dsc-group/{pathv1}?{query}	Yes
rebootDevice(body, callback)	Reboot Device	{base_path}/{version}/mgmt/cm/device/tasks/device-item-deploy?{query}	Yes
removeDeviceServices(body, callback)	Remove Device Services	{base_path}/{version}/mgmt/cm/global/tasks/device-remove-mgmt-authority?{query}	Yes
getRemoveDeviceServicesStatusById(id, callback)	Get Remove Device Services Status by Id	{base_path}/{version}/mgmt/cm/global/tasks/device-remove-mgmt-authority/{pathv1}?{query}	Yes
removeDeviceTrust(body, callback)	Remove Device Trust	{base_path}/{version}/mgmt/cm/global/tasks/device-remove-trust?{query}	Yes
getRemoveDeviceTrustStatusById(id, callback)	Get Remove Device Trust Status By Id	{base_path}/{version}/mgmt/cm/global/tasks/device-remove-trust/{pathv1}?{query}	Yes
updateDeviceUpgrade(body, callback)	Update Device Upgrade	{base_path}/{version}/mgmt/cm/device/upgrade-backups?{query}	Yes
getAllUpgradeInstances(callback)	Get All Upgrade Instances	{base_path}/{version}/mgmt/cm/device/upgrade-backups?{query}	Yes
getUpgradeInstancesById(upgradeTaskId, callback)	Get Upgrade Instance By Id	{base_path}/{version}/mgmt/cm/device/upgrade-backups/{pathv1}?{query}	Yes

Authentication

This document will go through the steps for authenticating the F5 BIG-IQ adapter with the authentication methods we have worked with in the past. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication HERE.

Companies periodically change authentication methods to provide better security. As this happens this section should be updated and contributed/merge back into the adapter repository.

Two Step Token

The F5 BIG-IQ adapter requires Two Step Token. 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 F5 BIG-IQ 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",
   "token_timeout": 1800000,
   "token_cache": "local",
   "invalid_token_error": 401,
   "auth_field": "header.headers.X-F5-AUTH-TOKEN",
   "auth_field_format": "{token}",
   "auth_logging": false,
   }

   you can leave all of the other properties in the authentication section, they will not be used when the auth_method is request_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-f5_bigiq
cd adapter-f5_bigiq
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 F5BigIQ Server.

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

4. Verify the credentials provided for F5BigIQ.

login to F5BigIQ using the provided credentials

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