VMware vendor logo

Vendor

VMware

Product

NSX T

Method

REST

Category

Data Center

Network Services

Project Type

Adapter


Download Adapter
Adapter

Adapter for Integration to VMware NSX T

Overview

This adapter is used to integrate the Itential Automation Platform (IAP) with the Vmware_nsx_t System. The API that was used to build the adapter for Vmware_nsx_t is usually available in the report directory of this adapter. The adapter utilizes the Vmware_nsx_t API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.

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

VMware NSX-T

Table of Contents

Getting Started

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

Helpful Background Information

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

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

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

Prerequisites

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

Node.js
npm
Git

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

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

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

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

How to Install

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

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

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

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

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

Testing

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

Unit Testing

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

node utils/testRunner --unit

npm run test:unit
npm run test:baseunit

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

Integration Testing - Standalone

Standalone Integration Testing requires mock data to be provided with the entities. If this data is not provided, standalone integration testing will fail. When the adapter is set to run in stub mode (setting the stub property to true), the adapter will run through its code up to the point of making the request. It will then retrieve the mock data and return that as if it had received that data as the response from Vmware_nsx_t. 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 Vmware_nsx_t. 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 Vmware_nsx_t. 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 Vmware_nsx_t 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": "/api",
    "version": "v1",
    "cache_location": "none",
    "encode_pathvars": true,
    "encode_queryvars": true,
    "save_metric": false,
    "stub": true,
    "protocol": "https",
    "authentication": {
      "auth_method": "basic user_password",
      "username": "exampleUsername",
      "password": "examplePassword",
      "token": "",
      "token_timeout": 180000,
      "token_cache": "local",
      "invalid_token_error": 401,
      "auth_field": "header.headers.Authorization",
      "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
      "auth_logging": false,
      "client_id": "",
      "client_secret": "",
      "grant_type": "",
      "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": 35000,
      "global_request": {
        "payload": {},
        "uriOptions": {},
        "addlHeaders": {},
        "authData": {}
      },
      "healthcheck_on_timeout": false,
      "return_raw": false,
      "archiving": false,
      "return_request": false
    },
    "proxy": {
      "enabled": false,
      "host": "",
      "port": 1,
      "protocol": "http",
      "username": "",
      "password": ""
    },
    "ssl": {
      "ecdhCurve": "",
      "enabled": false,
      "accept_invalid_cert": true,
      "ca_file": "",
      "key_file": "",
      "cert_file": "",
      "secure_protocol": "",
      "ciphers": ""
    },
    "mongo": {
      "host": "",
      "port": 0,
      "database": "",
      "username": "",
      "password": "",
      "replSet": "",
      "db_ssl": {
        "enabled": false,
        "accept_invalid_cert": false,
        "ca_file": "",
        "key_file": "",
        "cert_file": ""
      }
    },
    "devicebroker": {
      "getDevice": [
        {
          "path": "/get/devices/{id}",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {
            "id": "name"
          },
          "responseDatakey": "",
          "responseFields": {
            "name": "host",
            "ostype": "os",
            "ostypePrefix": "system-",
            "ipaddress": "attributes.ipaddr",
            "port": "443"
          }
        }
      ],
      "getDevicesFiltered": [
        {
          "path": "/get/devices",
          "method": "GET",
          "pagination": {
            "offsetVar": "",
            "limitVar": "",
            "incrementBy": "limit",
            "requestLocation": "query"
          },
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {},
          "responseDatakey": "",
          "responseFields": {
            "name": "host",
            "ostype": "os",
            "ostypePrefix": "system-",
            "ipaddress": "attributes.ipaddr",
            "port": "443"
          }
        }
      ],
      "isAlive": [
        {
          "path": "/get/devices/{id}/status",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {
            "id": "name"
          },
          "responseDatakey": "",
          "responseFields": {
            "status": "status",
            "statusValue": "online"
          }
        }
      ],
      "getConfig": [
        {
          "path": "/get/devices/{id}/configPart1",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {
            "id": "name"
          },
          "responseDatakey": "",
          "responseFields": {}
        }
      ],
      "getCount": [
        {
          "path": "/get/devices",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {},
          "responseDatakey": "",
          "responseFields": {}
        }
      ]
    },
    "cache": {
      "enabled": false,
      "entities": [
        {
          "entityType": "",
          "frequency": 1440,
          "flushOnFail": false,
          "limit": 1000,
          "retryAttempts": 5,
          "sort": true,
          "populate": [
            {
              "path": "",
              "method": "GET",
              "pagination": {
                "offsetVar": "",
                "limitVar": "",
                "incrementBy": "limit",
                "requestLocation": "query"
              },
              "query": {},
              "body": {},
              "headers": {},
              "handleFailure": "ignore",
              "requestFields": {},
              "responseDatakey": "",
              "responseFields": {}
            }
          ],
          "cachedTasks": [
            {
              "name": "",
              "filterField": "",
              "filterLoc": ""
            }
          ]
        }
      ]
    }
  }

Connection Properties

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

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

A connectivity check tells IAP the adapter has loaded successfully.

Authentication Properties

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

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

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

Examples of authentication field format

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

Healthcheck Properties

The healthcheck properties defines the API that runs the healthcheck to tell the adapter that it can reach Vmware_nsx_t. 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 Vmware_nsx_t.
  • Startup - Adapter will check for connectivity when the adapter initially comes up, but it will not check afterwards.
  • Intermittent - Adapter will check connectivity to Vmware_nsx_t at a frequency defined in the frequency property.
PropertyDescription
typeRequired. The type of health check to run.
frequencyRequired if intermittent. Defines how often the health check should run. Measured in milliseconds. Default is 300000.
query_objectQuery parameters to be added to the adapter healthcheck call.

Request Properties

The request section defines properties to help handle requests.

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

SSL Properties

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

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

Throttle Properties

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

PropertyDescription
throttle_enabledDefault is false. Defines if the adapter should use throttling or not.
number_pronghornsDefault is 1. Defines if throttling is done in a single Itential instance or whether requests are being throttled across multiple Itential instances (minimum = 1, maximum = 20). Throttling in a single Itential instance uses an in-memory queue so there is less overhead. Throttling across multiple Itential instances requires placing the request and queue information into a shared resource (e.g. database) so that each instance can determine what is running and what is next to run. Throttling across multiple instances requires additional I/O overhead.
sync-asyncThis property is not used at the current time (it is for future expansion of the throttling engine).
max_in_queueRepresents the maximum number of requests the adapter should allow into the queue before rejecting requests (minimum = 1, maximum = 5000). This is not a limit on what the adapter can handle but more about timely responses to requests. The default is currently 1000.
concurrent_maxDefines the number of requests the adapter can send to Vmware_nsx_t at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to Vmware_nsx_t in a serial manner.
expire_timeoutDefault is 0. Defines a graceful timeout of the request session. After a request has completed, the adapter will wait additional time prior to sending the next request. Measured in milliseconds (minimum = 0, maximum = 60000).
average_runtimeRepresents the approximate average of how long it takes Vmware_nsx_t 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 Vmware_nsx_t performance is exceptional you might run a little slower than you might like, but when it is poor you still run efficiently.
prioritiesAn array of priorities and how to handle them in relation to the throttle queue. Array of objects that include priority value and percent of queue to put the item ex { value: 1, percent: 10 }

Proxy Properties

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

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

Mongo Properties

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

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

Device Broker Properties

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

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

Using this Adapter

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

Generic Adapter Calls

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

Method SignatureDescriptionWorkflow?
connect()This call is run when the Adapter is first loaded by he Itential Platform. It validates the properties have been provided correctly.No
healthCheck(callback)This call ensures that the adapter can communicate with VMware NSX-T. 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 VMware NSX-T.No
iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback)This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.Yes
iapFindAdapterPath(apiPath, callback)This call provides the ability to see if a particular API path is supported by the adapter.Yes
iapSuspendAdapter(mode, callback)This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.Yes
iapUnsuspendAdapter(callback)This call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests.Yes
iapGetAdapterQueue(callback)This call will return the requests that are waiting in the queue if throttling is enabled.Yes
iapTroubleshootAdapter(props, persistFlag, adapter, callback)This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.Yes
iapRunAdapterHealthcheck(adapter, callback)This call will return the results of a healthcheck.Yes
iapRunAdapterConnectivity(callback)This call will return the results of a connectivity check.Yes
iapRunAdapterBasicGet(callback)This call will return the results of running basic get API calls.Yes
iapMoveAdapterEntitiesToDB(callback)This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.Yes
genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.Yes
genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)This call is the same as the genericAdapterRequest only it does not add a base_path or version to the call.Yes
iapHasAdapterEntity(entityType, entityId, callback)This call verifies the adapter has the specific entity.No
iapVerifyAdapterCapability(entityType, actionType, entityId, callback)This call verifies the adapter can perform the provided action on the specific entity.No
iapUpdateAdapterEntityCache()This call will update the entity cache.No

Adapter Broker Calls

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

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

Specific Adapter Calls

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

Method SignatureDescriptionPathWorkflow?
putHpmfeaturesfeatureStackName(featurestackname, FeatureStackCollectionConfiguration, callback)Update health performance monitoring configuration for feature stack{base_path}/{version}/hpm/features/{pathv1}?{query}Yes
getHpmfeaturesfeatureStackName(featurestackname, callback)Read health performance monitoring configuration for feature stack{base_path}/{version}/hpm/features/{pathv1}?{query}Yes
postHpmfeaturesfeatureStackNameactionresetCollectionFrequency(featurestackname, action, callback)Reset the data collection frequency configuration setting to the default values{base_path}/{version}/hpm/features/{pathv1}?{query}Yes
putHpmglobalConfig(GlobalCollectionConfiguration, callback)Set the global configuration for aggregation service related data collection{base_path}/{version}/hpm/global-config?{query}Yes
getHpmglobalConfig(callback)Read global health performance monitoring configuration{base_path}/{version}/hpm/global-config?{query}Yes
getHpmfeatures(callback)List all health performance monitoring feature stacks{base_path}/{version}/hpm/features?{query}Yes
getLogicalSwitcheslswitchIdvtepTable(lswitchid, cursor, includedFields, pageSize, sortAscending, sortBy, source, transportNodeId, callback)Get virtual tunnel endpoint table for logical switch of the given ID (lswitch-id){base_path}/{version}/logical-switches/{pathv1}/vtep-table?{query}Yes
getSwitchingProfilesswitchingProfileIdsummary(switchingprofileid, callback)Get Counts of Ports and Switches Using This Switching Profile{base_path}/{version}/switching-profiles/{pathv1}/summary?{query}Yes
postLogicalSwitches(LogicalSwitch, callback)Create a Logical Switch{base_path}/{version}/logical-switches?{query}Yes
getLogicalSwitches(cursor, diagnostic, includedFields, pageSize, sortAscending, sortBy, switchingProfileId, transportType, transportZoneId, callback)List all Logical Switches{base_path}/{version}/logical-switches?{query}Yes
postLogicalPorts(LogicalPort, callback)Create a Logical Port{base_path}/{version}/logical-ports?{query}Yes
getLogicalPorts(attachmentId, attachmentType, bridgeClusterId, containerPortsOnly, cursor, diagnostic, includedFields, logicalSwitchId, pageSize, parentVifId, sortAscending, sortBy, switchingProfileId, transportNodeId, transportZoneId, callback)List All Logical Ports{base_path}/{version}/logical-ports?{query}Yes
getLogicalPortslportIdstate(lportid, callback)Get realized state & location of a logical port{base_path}/{version}/logical-ports/{pathv1}/state?{query}Yes
getLogicalSwitcheslswitchIdsummary(lswitchid, callback)Get Logical Switch runtime status info for a given logical switch{base_path}/{version}/logical-switches/{pathv1}/summary?{query}Yes
getLogicalSwitcheslswitchIdmacTableformatcsv(lswitchid, source, transportNodeId, callback)Get MAC Table for Logical Switch of the Given ID (lswitch-id){base_path}/{version}/logical-switches/{pathv1}/mac-table?{query}Yes
getLogicalSwitcheslswitchIdstate(lswitchid, callback)Get the realized state associated with provided logical switch id{base_path}/{version}/logical-switches/{pathv1}/state?{query}Yes
getLogicalSwitcheslswitchIdstatistics(lswitchid, source, callback)Get Statistics for Logical Switch of the Given ID (lswitch-id){base_path}/{version}/logical-switches/{pathv1}/statistics?{query}Yes
getLogicalSwitchesstatus(cursor, diagnostic, includedFields, pageSize, sortAscending, sortBy, source, switchingProfileId, transportType, transportZoneId, callback)Get Status Summary of All Logical Switches in the System{base_path}/{version}/logical-switches/status?{query}Yes
putSwitchingProfilesswitchingProfileId(switchingprofileid, BaseSwitchingProfile, callback)Update a Switching Profile{base_path}/{version}/switching-profiles/{pathv1}?{query}Yes
getSwitchingProfilesswitchingProfileId(switchingprofileid, callback)Get Switching Profile by ID{base_path}/{version}/switching-profiles/{pathv1}?{query}Yes
deleteSwitchingProfilesswitchingProfileId(switchingprofileid, unbind, callback)Delete a Switching Profile{base_path}/{version}/switching-profiles/{pathv1}?{query}Yes
postSwitchingProfiles(BaseSwitchingProfile, callback)Create a Switching Profile{base_path}/{version}/switching-profiles?{query}Yes
getSwitchingProfiles(cursor, includeSystemOwned, includedFields, pageSize, sortAscending, sortBy, switchingProfileType, callback)List Switching Profiles{base_path}/{version}/switching-profiles?{query}Yes
getLogicalPortslportIdstatus(lportid, source, callback)Get Operational Status for Logical Port of a Given Port ID (lport-id){base_path}/{version}/logical-ports/{pathv1}/status?{query}Yes
getLogicalPortslportIdmacTableformatcsv(lportid, cursor, includedFields, pageSize, sortAscending, sortBy, source, transportNodeId, callback)Get MAC table of a logical port with a given port id (lport-id){base_path}/{version}/logical-ports/{pathv1}/mac-table?{query}Yes
getLogicalPortslportIdmacTable(lportid, cursor, includedFields, pageSize, sortAscending, sortBy, source, transportNodeId, callback)Get MAC table of a logical port with a given port id (lport-id){base_path}/{version}/logical-ports/{pathv1}/mac-table?{query}Yes
getLogicalSwitcheslswitchIdvtepTableformatcsv(lswitchid, source, transportNodeId, callback)Get virtual tunnel endpoint table for logical switch of the given ID (lswitch-id){base_path}/{version}/logical-switches/{pathv1}/vtep-table?{query}Yes
getLogicalSwitcheslswitchIdmacTable(lswitchid, cursor, includedFields, pageSize, sortAscending, sortBy, source, transportNodeId, callback)Get MAC Table for Logical Switch of the Given ID (lswitch-id){base_path}/{version}/logical-switches/{pathv1}/mac-table?{query}Yes
getLogicalPortsstatus(attachmentId, attachmentType, bridgeClusterId, containerPortsOnly, cursor, diagnostic, includedFields, logicalSwitchId, pageSize, parentVifId, sortAscending, sortBy, source, switchingProfileId, transportNodeId, transportZoneId, callback)Get Operational Status Summary of All Logical Ports in the System{base_path}/{version}/logical-ports/status?{query}Yes
getLogicalPortslportIdstatistics(lportid, source, callback)Get Statistics for Logical Port of a Given Port ID (lport-id){base_path}/{version}/logical-ports/{pathv1}/statistics?{query}Yes
putLogicalSwitcheslswitchId(lswitchid, LogicalSwitch, callback)Update a Logical Switch{base_path}/{version}/logical-switches/{pathv1}?{query}Yes
deleteLogicalSwitcheslswitchId(lswitchid, cascade, detach, callback)Delete a Logical Switch{base_path}/{version}/logical-switches/{pathv1}?{query}Yes
getLogicalSwitcheslswitchId(lswitchid, callback)Get Logical Switch associated with the provided id (lswitch-id){base_path}/{version}/logical-switches/{pathv1}?{query}Yes
getLogicalSwitchesstate(status, callback)List logical switches by realized state{base_path}/{version}/logical-switches/state?{query}Yes
putLogicalPortslportId(lportid, LogicalPort, callback)Update a Logical Port{base_path}/{version}/logical-ports/{pathv1}?{query}Yes
getLogicalPortslportId(lportid, callback)Get Information About a Logical Port{base_path}/{version}/logical-ports/{pathv1}?{query}Yes
deleteLogicalPortslportId(lportid, detach, callback)Delete a Logical Port{base_path}/{version}/logical-ports/{pathv1}?{query}Yes
getAppDiscoverysessionssessionIdinstalledApps(sessionid, appProfileId, cursor, includedFields, pageSize, sortAscending, sortBy, vmId, callback)Returns the details of the installed apps for the app profile ID in that session{base_path}/{version}/app-discovery/sessions/{pathv1}/installed-apps?{query}Yes
postAppDiscoverysessionssessionIdreClassify(sessionid, SessionReclassificationParameter, callback)Re-classify a completed application discovery session.{base_path}/{version}/app-discovery/sessions/{pathv1}/re-classify?{query}Yes
postAppDiscoverysessionssessionIdreportappInfoAndVmformatcsv(sessionid, ReportAppResultsForVmsRequestParameters, callback)Export app discovery results in CSV format{base_path}/{version}/app-discovery/sessions/{pathv1}/report/app-info-and-vm?{query}Yes
getAppDiscoverysessionssessionIdnsGroups(sessionid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)ns-groups in this application discovery session{base_path}/{version}/app-discovery/sessions/{pathv1}/ns-groups?{query}Yes
getAppDiscoverysessionssessionIdsummary(sessionid, callback)Returns the summary of the application discovery session{base_path}/{version}/app-discovery/sessions/{pathv1}/summary?{query}Yes
postAppDiscoveryappProfiles(AppProfile, callback)Adds a new app profile{base_path}/{version}/app-discovery/app-profiles?{query}Yes
getAppDiscoveryappProfiles(cursor, includedFields, pageSize, sortAscending, sortBy, callback)Returns list of app profile IDs created{base_path}/{version}/app-discovery/app-profiles?{query}Yes
getAppDiscoverysessionssessionIdreportappProfileAndAppInfoformatcsv(sessionid, callback)Export app profiles in CSV format for a given sessiom{base_path}/{version}/app-discovery/sessions/{pathv1}/report/app-profile-and-app-info?{query}Yes
deleteAppDiscoverysessionssessionId(sessionid, callback)Cancel and delete the application discovery session{base_path}/{version}/app-discovery/sessions/{pathv1}?{query}Yes
getAppDiscoverysessionssessionId(sessionid, callback)Returns the status of the application discovery session and other details{base_path}/{version}/app-discovery/sessions/{pathv1}?{query}Yes
getAppDiscoverysessionssessionIdappProfiles(sessionid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)application profiles in this application discovery session{base_path}/{version}/app-discovery/sessions/{pathv1}/app-profiles?{query}Yes
getAppDiscoverysessionssessionIdnsGroupsnsGroupIdmembers(sessionid, nsgroupid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)vms in the ns-group of the application discovery session{base_path}/{version}/app-discovery/sessions/{pathv1}/ns-groups/{pathv2}/members?{query}Yes
putAppDiscoveryappProfilesappProfileId(appprofileid, AppProfile, callback)Update AppProfile{base_path}/{version}/app-discovery/app-profiles/{pathv1}?{query}Yes
getAppDiscoveryappProfilesappProfileId(appprofileid, callback)Returns detail of the app profile{base_path}/{version}/app-discovery/app-profiles/{pathv1}?{query}Yes
deleteAppDiscoveryappProfilesappProfileId(appprofileid, force, callback)Delete App Profile{base_path}/{version}/app-discovery/app-profiles/{pathv1}?{query}Yes
postAppDiscoverysessions(StartAppDiscoverySessionParameters, callback)Starts the discovery of application discovery session{base_path}/{version}/app-discovery/sessions?{query}Yes
getAppDiscoverysessions(cursor, groupId, includedFields, pageSize, sortAscending, sortBy, status, callback)Returns the list of the application discovery sessions available{base_path}/{version}/app-discovery/sessions?{query}Yes
deleteMacSetsmacSetIdmembersmacAddress(macsetid, macaddress, callback)Remove a MAC address from given MACSet{base_path}/{version}/mac-sets/{pathv1}/members/{pathv2}?{query}Yes
putNsServicesnsServiceId(nsserviceid, NSService, callback)Update NSService{base_path}/{version}/ns-services/{pathv1}?{query}Yes
deleteNsServicesnsServiceId(nsserviceid, force, callback)Delete NSService{base_path}/{version}/ns-services/{pathv1}?{query}Yes
getNsServicesnsServiceId(nsserviceid, callback)Read NSService{base_path}/{version}/ns-services/{pathv1}?{query}Yes
postMacSetsmacSetIdmembers(macsetid, MACAddressElement, callback)Add a MAC address to a MACSet{base_path}/{version}/mac-sets/{pathv1}/members?{query}Yes
getMacSetsmacSetIdmembers(macsetid, callback)Get all MACAddresses in a MACSet{base_path}/{version}/mac-sets/{pathv1}/members?{query}Yes
getNsGroupsnsgroupIdserviceAssociations(nsgroupid, cursor, fetchParentgroupAssociations, includedFields, pageSize, serviceType, sortAscending, sortBy, callback)Get services to which the given nsgroup belongs to{base_path}/{version}/ns-groups/{pathv1}/service-associations?{query}Yes
getNsGroupsnsGroupIdeffectiveIpAddressMembers(nsgroupid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)Get Effective IPAddress translated from the NSGroup{base_path}/{version}/ns-groups/{pathv1}/effective-ip-address-members?{query}Yes
postIpSets(IPSet, callback)Create IPSet{base_path}/{version}/ip-sets?{query}Yes
getIpSets(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List IPSets{base_path}/{version}/ip-sets?{query}Yes
getNsGroupsnsGroupIdeffectiveLogicalSwitchMembers(nsgroupid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)Get Effective switch members translated from the NSGroup{base_path}/{version}/ns-groups/{pathv1}/effective-logical-switch-members?{query}Yes
getNsGroupsnsGroupIdmemberTypes(nsgroupid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)Get member types from NSGroup{base_path}/{version}/ns-groups/{pathv1}/member-types?{query}Yes
putNsGroupsnsGroupId(nsgroupid, NSGroup, callback)Update NSGroup{base_path}/{version}/ns-groups/{pathv1}?{query}Yes
postNsGroupsnsGroupId(nsgroupid, NSGroupExpressionList, action, callback)Add NSGroup expression{base_path}/{version}/ns-groups/{pathv1}?{query}Yes
getNsGroupsnsGroupId(nsgroupid, populateReferences, callback)Read NSGroup{base_path}/{version}/ns-groups/{pathv1}?{query}Yes
deleteNsGroupsnsGroupId(nsgroupid, force, callback)Delete NSGroup{base_path}/{version}/ns-groups/{pathv1}?{query}Yes
getNsGroupsnsGroupIdeffectiveVirtualMachineMembers(nsgroupid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)Get Effective Virtual Machine members of the specified NSGroup.{base_path}/{version}/ns-groups/{pathv1}/effective-virtual-machine-members?{query}Yes
putNsServiceGroupsnsServiceGroupId(nsservicegroupid, NSServiceGroup, callback)Update NSServiceGroup{base_path}/{version}/ns-service-groups/{pathv1}?{query}Yes
deleteNsServiceGroupsnsServiceGroupId(nsservicegroupid, force, callback)Delete NSServiceGroup{base_path}/{version}/ns-service-groups/{pathv1}?{query}Yes
getNsServiceGroupsnsServiceGroupId(nsservicegroupid, callback)Read NSServiceGroup{base_path}/{version}/ns-service-groups/{pathv1}?{query}Yes
putIpSetsipSetId(ipsetid, IPSet, callback)Update IPSet{base_path}/{version}/ip-sets/{pathv1}?{query}Yes
deleteIpSetsipSetId(ipsetid, force, callback)Delete IPSet{base_path}/{version}/ip-sets/{pathv1}?{query}Yes
getIpSetsipSetId(ipsetid, callback)Read IPSet{base_path}/{version}/ip-sets/{pathv1}?{query}Yes
putMacSetsmacSetId(macsetid, MACSet, callback)Update MACSet{base_path}/{version}/mac-sets/{pathv1}?{query}Yes
deleteMacSetsmacSetId(macsetid, force, callback)Delete MACSet{base_path}/{version}/mac-sets/{pathv1}?{query}Yes
getMacSetsmacSetId(macsetid, callback)Read MACSet{base_path}/{version}/mac-sets/{pathv1}?{query}Yes
postNsServices(NSService, callback)Create NSService{base_path}/{version}/ns-services?{query}Yes
getNsServices(cursor, defaultService, includedFields, pageSize, sortAscending, sortBy, callback)List all NSServices{base_path}/{version}/ns-services?{query}Yes
getNsGroupsunassociatedVirtualMachines(cursor, displayName, externalId, hostId, includedFields, pageSize, sortAscending, sortBy, callback)Get the list of all the virtual machines that are not a part of any existing NSGroup.{base_path}/{version}/ns-groups/unassociated-virtual-machines?{query}Yes
postMacSets(MACSet, callback)Create MACSet{base_path}/{version}/mac-sets?{query}Yes
getMacSets(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List MACSets{base_path}/{version}/mac-sets?{query}Yes
getNsGroupsnsGroupIdeffectiveLogicalPortMembers(nsgroupid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)Get Effective Logical Ports translated from the NSgroup{base_path}/{version}/ns-groups/{pathv1}/effective-logical-port-members?{query}Yes
postNsServiceGroups(NSServiceGroup, callback)Create NSServiceGroup{base_path}/{version}/ns-service-groups?{query}Yes
getNsServiceGroups(cursor, defaultService, includedFields, pageSize, sortAscending, sortBy, callback)List all NSServiceGroups{base_path}/{version}/ns-service-groups?{query}Yes
postNsGroups(NSGroup, callback)Create NSGroup{base_path}/{version}/ns-groups?{query}Yes
getNsGroups(cursor, includedFields, memberTypes, pageSize, populateReferences, sortAscending, sortBy, callback)List NSGroups{base_path}/{version}/ns-groups?{query}Yes
putIpfixObsPointsswitchGlobal(IpfixObsPointConfig, callback)Update global switch IPFIX export configuration{base_path}/{version}/ipfix-obs-points/switch-global?{query}Yes
getIpfixObsPointsswitchGlobal(callback)Read global switch IPFIX export configuration{base_path}/{version}/ipfix-obs-points/switch-global?{query}Yes
deleteTraceflowstraceflowId(traceflowid, callback)Delete the Traceflow round{base_path}/{version}/traceflows/{pathv1}?{query}Yes
getTraceflowstraceflowId(traceflowid, callback)Get the Traceflow round status and result summary{base_path}/{version}/traceflows/{pathv1}?{query}Yes
getTransportZoneszoneIdtransportNodeStatus(zoneid, cursor, includedFields, pageSize, sortAscending, sortBy, source, status, callback)Read status of transport nodes in a transport zone{base_path}/{version}/transport-zones/{pathv1}/transport-node-status?{query}Yes
postTraceflows(TraceflowRequest, callback)Initiate a Traceflow Operation on the Specified Port{base_path}/{version}/traceflows?{query}Yes
getTraceflows(cursor, includedFields, lportId, pageSize, sortAscending, sortBy, callback)List all Traceflow rounds{base_path}/{version}/traceflows?{query}Yes
getNodelogslogName(logname, callback)Read node log properties{base_path}/{version}/node/logs/{pathv1}?{query}Yes
getNodelogslogNamedata(logname, callback)Read node log contents{base_path}/{version}/node/logs/{pathv1}/data?{query}Yes
getTransportNodesnodeIdpnicBondStatus(nodeid, callback)Get high-level summary of a transport node{base_path}/{version}/transport-nodes/{pathv1}/pnic-bond-status?{query}Yes
getNodelogs(callback)List available node logs{base_path}/{version}/node/logs?{query}Yes
getTransportNodesstatus(callback)Get high-level summary of all transport nodes. The service layer does not support source = realtime or cached.{base_path}/{version}/transport-nodes/status?{query}Yes
getTransportNodesnodeIdremoteTransportNodeStatus(nodeid, bfdDiagnosticCode, cursor, includedFields, pageSize, sortAscending, sortBy, source, tunnelStatus, callback)Read status of all transport nodes with tunnel connections to transport node{base_path}/{version}/transport-nodes/{pathv1}/remote-transport-node-status?{query}Yes
getTransportNodesnodeIdstatus(nodeid, source, callback)Read status of a transport node{base_path}/{version}/transport-nodes/{pathv1}/status?{query}Yes
postMirrorSessions(PortMirroringSession, callback)Create a mirror session{base_path}/{version}/mirror-sessions?{query}Yes
getMirrorSessions(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List all mirror sessions{base_path}/{version}/mirror-sessions?{query}Yes
putMirrorSessionsmirrorSessionId(mirrorsessionid, PortMirroringSession, callback)Update the mirror session{base_path}/{version}/mirror-sessions/{pathv1}?{query}Yes
getMirrorSessionsmirrorSessionId(mirrorsessionid, callback)Get the mirror session{base_path}/{version}/mirror-sessions/{pathv1}?{query}Yes
deleteMirrorSessionsmirrorSessionId(mirrorsessionid, callback)Delete the mirror session{base_path}/{version}/mirror-sessions/{pathv1}?{query}Yes
getLogicalPortslportIdforwardingPath(lportid, peerPortId, callback)Get networking entities between two logical ports with VIF attachment{base_path}/{version}/logical-ports/{pathv1}/forwarding-path?{query}Yes
getTraceflowstraceflowIdobservations(traceflowid, componentName, componentType, cursor, includedFields, pageSize, resourceType, sortAscending, sortBy, transportNodeName, callback)Get observations for the Traceflow round{base_path}/{version}/traceflows/{pathv1}/observations?{query}Yes
getTransportZonesstatus(callback)Get high-level summary of a transport zone. The service layer does not support source = realtime or cached.{base_path}/{version}/transport-zones/status?{query}Yes
getIpfixObsPoints(callback)Get the list of IPFIX observation points{base_path}/{version}/ipfix-obs-points?{query}Yes
getTransportZoneszoneIdstatus(zoneid, source, callback)Get high-level summary of a transport zone{base_path}/{version}/transport-zones/{pathv1}/status?{query}Yes
getTransportZoneszoneIdtransportNodeStatusReport(zoneid, source, status, callback)Creates a status report of transport nodes in a transport zone{base_path}/{version}/transport-zones/{pathv1}/transport-node-status-report?{query}Yes
getTransportZonestransportNodeStatusReport(source, status, callback)Creates a status report of transport nodes of all the transport zones{base_path}/{version}/transport-zones/transport-node-status-report?{query}Yes
postMirrorSessionsmirrorSessionIdactionverify(mirrorsessionid, callback)Verify whether the mirror session is still valid{base_path}/{version}/mirror-sessions/{pathv1}?{query}Yes
getTransportZonestransportNodeStatus(cursor, includedFields, pageSize, sortAscending, sortBy, source, status, callback)Read status of all the transport nodes{base_path}/{version}/transport-zones/transport-node-status?{query}Yes
postLogicalRouterslogicalRouterIdroutingstaticRoutes(logicalrouterid, StaticRoute, callback)Add Static Routes on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/static-routes?{query}Yes
getLogicalRouterslogicalRouterIdroutingstaticRoutes(logicalrouterid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)Paginated List of Static Routes{base_path}/{version}/logical-routers/{pathv1}/routing/static-routes?{query}Yes
postLogicalRouters(LogicalRouter, callback)Create a Logical Router{base_path}/{version}/logical-routers?{query}Yes
getLogicalRouters(cursor, includedFields, pageSize, routerType, sortAscending, sortBy, callback)List Logical Routers{base_path}/{version}/logical-routers?{query}Yes
getLogicalRouterslogicalRouterIdroutingforwardingTable(logicalrouterid, cursor, includedFields, networkPrefix, pageSize, sortAscending, sortBy, source, transportNodeId, callback)Get FIB table on a specified node for a logical router{base_path}/{version}/logical-routers/{pathv1}/routing/forwarding-table?{query}Yes
postLogicalRouterslogicalRouterIdroutingrouteMaps(logicalrouterid, RouteMap, callback)Add RouteMap on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/route-maps?{query}Yes
getLogicalRouterslogicalRouterIdroutingrouteMaps(logicalrouterid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)Paginated List of RouteMaps{base_path}/{version}/logical-routers/{pathv1}/routing/route-maps?{query}Yes
getLogicalRouterslogicalRouterIdnatrulesruleIdstatistics(logicalrouterid, ruleid, source, callback)Get the statistics of a specified logical router NAT Rule{base_path}/{version}/logical-routers/{pathv1}/nat/rules/{pathv2}/statistics?{query}Yes
getLogicalRouterslogicalRouterIdroutingrouteTableformatcsv(logicalrouterid, source, transportNodeId, callback)Get route table on a node for a logical router{base_path}/{version}/logical-routers/{pathv1}/routing/route-table?{query}Yes
putLogicalRouterslogicalRouterIdroutingstaticRoutesbfdPeersbfdPeerId(logicalrouterid, bfdpeerid, StaticHopBfdPeer, callback)Update a static route BFD peer{base_path}/{version}/logical-routers/{pathv1}/routing/static-routes/bfd-peers/{pathv2}?{query}Yes
getLogicalRouterslogicalRouterIdroutingstaticRoutesbfdPeersbfdPeerId(logicalrouterid, bfdpeerid, callback)Read a static route BFD peer{base_path}/{version}/logical-routers/{pathv1}/routing/static-routes/bfd-peers/{pathv2}?{query}Yes
deleteLogicalRouterslogicalRouterIdroutingstaticRoutesbfdPeersbfdPeerId(logicalrouterid, bfdpeerid, force, callback)Delete a specified static route BFD peer cofigured on a specified logical router{base_path}/{version}/logical-routers/{pathv1}/routing/static-routes/bfd-peers/{pathv2}?{query}Yes
getLogicalRouterslogicalRouterIdstatus(logicalrouterid, source, callback)Get the status for the Logical Router of the given id{base_path}/{version}/logical-routers/{pathv1}/status?{query}Yes
postLogicalRouterslogicalRouterIdroutingipPrefixLists(logicalrouterid, IPPrefixList, callback)Add IPPrefixList on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/ip-prefix-lists?{query}Yes
getLogicalRouterslogicalRouterIdroutingipPrefixLists(logicalrouterid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)Paginated List of IPPrefixLists{base_path}/{version}/logical-routers/{pathv1}/routing/ip-prefix-lists?{query}Yes
putLogicalRouterslogicalRouterIdroutingredistribution(logicalrouterid, RedistributionConfig, callback)Update the Redistribution Configuration on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/redistribution?{query}Yes
getLogicalRouterslogicalRouterIdroutingredistribution(logicalrouterid, callback)Read the Redistribution Configuration on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/redistribution?{query}Yes
putDhcprelaysrelayId(relayid, DhcpRelayService, callback)Update a DHCP Relay Service{base_path}/{version}/dhcp/relays/{pathv1}?{query}Yes
getDhcprelaysrelayId(relayid, callback)Read a DHCP Relay Service{base_path}/{version}/dhcp/relays/{pathv1}?{query}Yes
deleteDhcprelaysrelayId(relayid, callback)Delete a DHCP Relay Service{base_path}/{version}/dhcp/relays/{pathv1}?{query}Yes
putLogicalRouterslogicalRouterIdroutingstaticRoutesid(logicalrouterid, id, StaticRoute, callback)Update a specific Static Route Rule on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/static-routes/{pathv2}?{query}Yes
getLogicalRouterslogicalRouterIdroutingstaticRoutesid(logicalrouterid, id, callback)Get a specific Static Route on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/static-routes/{pathv2}?{query}Yes
deleteLogicalRouterslogicalRouterIdroutingstaticRoutesid(logicalrouterid, id, callback)Delete a specific Static Route on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/static-routes/{pathv2}?{query}Yes
putDhcprelayProfilesrelayProfileId(relayprofileid, DhcpRelayProfile, callback)Update a DHCP Relay Profile{base_path}/{version}/dhcp/relay-profiles/{pathv1}?{query}Yes
deleteDhcprelayProfilesrelayProfileId(relayprofileid, callback)Delete a DHCP Relay Profile{base_path}/{version}/dhcp/relay-profiles/{pathv1}?{query}Yes
getDhcprelayProfilesrelayProfileId(relayprofileid, callback)Read a DHCP Relay Profile{base_path}/{version}/dhcp/relay-profiles/{pathv1}?{query}Yes
postLogicalRouterslogicalRouterIdactionreprocess(logicalrouterid, callback)Reprocesses a logical router configuration and publish updates to controller{base_path}/{version}/logical-routers/{pathv1}?{query}Yes
getLogicalRouterslogicalRouterIddebugInfoformattext(logicalrouterid, callback)Read the debug information for the logical router{base_path}/{version}/logical-routers/{pathv1}/debug-info?{query}Yes
getLogicalRouterslogicalRouterIdroutingbgpneighborsstatus(logicalrouterid, cursor, includedFields, pageSize, sortAscending, sortBy, source, transportNodeId, callback)Get the status of all the BGP neighbors for the Logical Router of the given id{base_path}/{version}/logical-routers/{pathv1}/routing/bgp/neighbors/status?{query}Yes
putLogicalRouterslogicalRouterIdroutingredistributionrules(logicalrouterid, RedistributionRuleList, callback)Update All the Redistribution Rules on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/redistribution/rules?{query}Yes
getLogicalRouterslogicalRouterIdroutingredistributionrules(logicalrouterid, callback)Read All the Redistribution Rules on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/redistribution/rules?{query}Yes
postServices(LogicalService, callback)Create a Logical Router Service{base_path}/{version}/services?{query}Yes
getServices(cursor, includedFields, pageSize, resourceType, sortAscending, sortBy, callback)List all Logical Router Services{base_path}/{version}/services?{query}Yes
postDhcprelayProfiles(DhcpRelayProfile, callback)Create a DHCP Relay Profile{base_path}/{version}/dhcp/relay-profiles?{query}Yes
getDhcprelayProfiles(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List All DHCP Relay Profiles{base_path}/{version}/dhcp/relay-profiles?{query}Yes
getLogicalRouterslogicalRouterIdroutingrouteTable(logicalrouterid, cursor, includedFields, pageSize, sortAscending, sortBy, source, transportNodeId, callback)Get route table on a given node for a logical router{base_path}/{version}/logical-routers/{pathv1}/routing/route-table?{query}Yes
postLogicalRouterslogicalRouterIdroutingbgpneighbors(logicalrouterid, BgpNeighbor, callback)Add a new BGP Neighbor on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/bgp/neighbors?{query}Yes
getLogicalRouterslogicalRouterIdroutingbgpneighbors(logicalrouterid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)Paginated list of BGP Neighbors on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/bgp/neighbors?{query}Yes
getLogicalRouterslogicalRouterIdroutingforwardingTableformatcsv(logicalrouterid, networkPrefix, source, transportNodeId, callback)Get FIB table on a specified node for a logical router{base_path}/{version}/logical-routers/{pathv1}/routing/forwarding-table?{query}Yes
getLogicalRouterslogicalRouterIdroutingroutingTable(logicalrouterid, cursor, includedFields, networkPrefix, pageSize, routeSource, sortAscending, sortBy, source, transportNodeId, callback)Get RIB table on a specified node for a logical router{base_path}/{version}/logical-routers/{pathv1}/routing/routing-table?{query}Yes
getLogicalRouterPortslogicalRouterPortIdarpTable(logicalrouterportid, cursor, includedFields, pageSize, sortAscending, sortBy, source, transportNodeId, callback)Get the ARP table for the Logical Router Port of the given id{base_path}/{version}/logical-router-ports/{pathv1}/arp-table?{query}Yes
getLogicalRouterPortslogicalRouterPortIdstatisticssummary(logicalrouterportid, source, callback)Get the statistics summary of a specified logical router port{base_path}/{version}/logical-router-ports/{pathv1}/statistics/summary?{query}Yes
postServiceProfiles(ServiceProfile, callback)Create a Service Profile{base_path}/{version}/service-profiles?{query}Yes
getServiceProfiles(cursor, includedFields, pageSize, resourceType, sortAscending, sortBy, callback)List All Service Profiles{base_path}/{version}/service-profiles?{query}Yes
postLogicalRouterPorts(LogicalRouterPort, callback)Create a Logical Router Port{base_path}/{version}/logical-router-ports?{query}Yes
getLogicalRouterPorts(cursor, includedFields, logicalRouterId, logicalSwitchId, pageSize, resourceType, sortAscending, sortBy, callback)List Logical Router Ports{base_path}/{version}/logical-router-ports?{query}Yes
getLogicalRouterslogicalRouterIdnatrulesstatistics(logicalrouterid, source, callback)Get the statistics of all rules of the logical router{base_path}/{version}/logical-routers/{pathv1}/nat/rules/statistics?{query}Yes
getTransportNodesnodeIdstatisticsnatRules(nodeid, source, callback)Get statistics for all logical router NAT rules on a transport node{base_path}/{version}/transport-nodes/{pathv1}/statistics/nat-rules?{query}Yes
postLogicalRouterslogicalRouterIdroutingstaticRoutesbfdPeers(logicalrouterid, StaticHopBfdPeer, callback)Create a static hop BFD peer{base_path}/{version}/logical-routers/{pathv1}/routing/static-routes/bfd-peers?{query}Yes
getLogicalRouterslogicalRouterIdroutingstaticRoutesbfdPeers(logicalrouterid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)List static routes BFD Peers{base_path}/{version}/logical-routers/{pathv1}/routing/static-routes/bfd-peers?{query}Yes
putLogicalRouterslogicalRouterId(logicalrouterid, LogicalRouter, callback)Update a Logical Router{base_path}/{version}/logical-routers/{pathv1}?{query}Yes
getLogicalRouterslogicalRouterId(logicalrouterid, callback)Read Logical Router{base_path}/{version}/logical-routers/{pathv1}?{query}Yes
deleteLogicalRouterslogicalRouterId(logicalrouterid, force, callback)Delete a Logical Router{base_path}/{version}/logical-routers/{pathv1}?{query}Yes
putLogicalRouterslogicalRouterIdroutingadvertisementrules(logicalrouterid, AdvertiseRuleList, callback)Update the Advertisement Rules on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/advertisement/rules?{query}Yes
getLogicalRouterslogicalRouterIdroutingadvertisementrules(logicalrouterid, callback)Read the Advertisement Rules on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/advertisement/rules?{query}Yes
getLogicalRouterslogicalRouterIdroutingroutingTableformatcsv(logicalrouterid, networkPrefix, routeSource, source, transportNodeId, callback)Get RIB table on a specified node for a logical router{base_path}/{version}/logical-routers/{pathv1}/routing/routing-table?{query}Yes
postDhcprelays(DhcpRelayService, callback)Create a DHCP Relay Service{base_path}/{version}/dhcp/relays?{query}Yes
getDhcprelays(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List all DHCP Relay Services{base_path}/{version}/dhcp/relays?{query}Yes
putLogicalRouterslogicalRouterIdroutingipPrefixListsid(logicalrouterid, id, IPPrefixList, callback)Update a specific IPPrefixList on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/ip-prefix-lists/{pathv2}?{query}Yes
getLogicalRouterslogicalRouterIdroutingipPrefixListsid(logicalrouterid, id, callback)Get a specific IPPrefixList on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/ip-prefix-lists/{pathv2}?{query}Yes
deleteLogicalRouterslogicalRouterIdroutingipPrefixListsid(logicalrouterid, id, callback)Delete a specific IPPrefixList on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/ip-prefix-lists/{pathv2}?{query}Yes
getLogicalRouterPortslogicalRouterPortIdstatistics(logicalrouterportid, source, transportNodeId, callback)Get the statistics of a specified logical router port on all or a specified node{base_path}/{version}/logical-router-ports/{pathv1}/statistics?{query}Yes
putLogicalRouterslogicalRouterIdroutingrouteMapsid(logicalrouterid, id, RouteMap, callback)Update a specific RouteMap on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/route-maps/{pathv2}?{query}Yes
getLogicalRouterslogicalRouterIdroutingrouteMapsid(logicalrouterid, id, callback)Get a specific RouteMap on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/route-maps/{pathv2}?{query}Yes
deleteLogicalRouterslogicalRouterIdroutingrouteMapsid(logicalrouterid, id, callback)Delete a specific RouteMap on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/route-maps/{pathv2}?{query}Yes
putLogicalRouterslogicalRouterIdroutingbgp(logicalrouterid, BgpConfig, callback)Update the BGP Configuration on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/bgp?{query}Yes
getLogicalRouterslogicalRouterIdroutingbgp(logicalrouterid, callback)Read the BGP Configuration on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/bgp?{query}Yes
putLogicalRouterslogicalRouterIdrouting(logicalrouterid, RoutingConfig, callback)Update the Routing Configuration{base_path}/{version}/logical-routers/{pathv1}/routing?{query}Yes
getLogicalRouterslogicalRouterIdrouting(logicalrouterid, callback)Read the Routing Configuration{base_path}/{version}/logical-routers/{pathv1}/routing?{query}Yes
putLogicalRouterslogicalRouterIdroutingadvertisement(logicalrouterid, AdvertisementConfig, callback)Update the Advertisement Configuration on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/advertisement?{query}Yes
getLogicalRouterslogicalRouterIdroutingadvertisement(logicalrouterid, callback)Read the Advertisement Configuration on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/advertisement?{query}Yes
putServicesserviceId(serviceid, LogicalService, callback)Update a Logical Router Service{base_path}/{version}/services/{pathv1}?{query}Yes
getServicesserviceId(serviceid, callback)Read a Logical Router Service{base_path}/{version}/services/{pathv1}?{query}Yes
deleteServicesserviceId(serviceid, callback)Delete a Logical Router Service{base_path}/{version}/services/{pathv1}?{query}Yes
putLogicalRouterslogicalRouterIdroutingbgpneighborsid(logicalrouterid, id, BgpNeighbor, callback)Update a specific BGP Neighbor on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/bgp/neighbors/{pathv2}?{query}Yes
postLogicalRouterslogicalRouterIdroutingbgpneighborsid(logicalrouterid, id, action, callback)Unset/Delete password property on specific BGP Neighbor on Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/bgp/neighbors/{pathv2}?{query}Yes
getLogicalRouterslogicalRouterIdroutingbgpneighborsid(logicalrouterid, id, callback)Read a specific BGP Neighbor on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/bgp/neighbors/{pathv2}?{query}Yes
deleteLogicalRouterslogicalRouterIdroutingbgpneighborsid(logicalrouterid, id, callback)Delete a specific BGP Neighbor on a Logical Router{base_path}/{version}/logical-routers/{pathv1}/routing/bgp/neighbors/{pathv2}?{query}Yes
putLogicalRouterslogicalRouterIdroutingbfdConfig(logicalrouterid, BfdConfig, callback)Update the BFD Configuration for BFD peers for routing{base_path}/{version}/logical-routers/{pathv1}/routing/bfd-config?{query}Yes
getLogicalRouterslogicalRouterIdroutingbfdConfig(logicalrouterid, callback)Read the Routing BFD Configuration{base_path}/{version}/logical-routers/{pathv1}/routing/bfd-config?{query}Yes
putServiceProfilesserviceProfileId(serviceprofileid, ServiceProfile, callback)Update a Service Profile{base_path}/{version}/service-profiles/{pathv1}?{query}Yes
getServiceProfilesserviceProfileId(serviceprofileid, callback)Read a Service Profile{base_path}/{version}/service-profiles/{pathv1}?{query}Yes
deleteServiceProfilesserviceProfileId(serviceprofileid, callback)Delete a Service Profile{base_path}/{version}/service-profiles/{pathv1}?{query}Yes
getLogicalRouterPortslogicalRouterPortIdarpTableformatcsv(logicalrouterportid, source, transportNodeId, callback)Get the ARP table for the Logical Router Port of the given id{base_path}/{version}/logical-router-ports/{pathv1}/arp-table?{query}Yes
putLogicalRouterPortslogicalRouterPortId(logicalrouterportid, LogicalRouterPort, callback)Update a Logical Router Port{base_path}/{version}/logical-router-ports/{pathv1}?{query}Yes
getLogicalRouterPortslogicalRouterPortId(logicalrouterportid, callback)Read Logical Router Port{base_path}/{version}/logical-router-ports/{pathv1}?{query}Yes
deleteLogicalRouterPortslogicalRouterPortId(logicalrouterportid, force, callback)Delete a Logical Router Port{base_path}/{version}/logical-router-ports/{pathv1}?{query}Yes
putLogicalRouterslogicalRouterIdnatrulesruleId(logicalrouterid, ruleid, NatRule, callback)Update a specific NAT rule from a given logical router{base_path}/{version}/logical-routers/{pathv1}/nat/rules/{pathv2}?{query}Yes
getLogicalRouterslogicalRouterIdnatrulesruleId(logicalrouterid, ruleid, callback)Get a specific NAT rule from a given logical router{base_path}/{version}/logical-routers/{pathv1}/nat/rules/{pathv2}?{query}Yes
deleteLogicalRouterslogicalRouterIdnatrulesruleId(logicalrouterid, ruleid, callback)Delete a specific NAT rule from a logical router{base_path}/{version}/logical-routers/{pathv1}/nat/rules/{pathv2}?{query}Yes
postLogicalRouterslogicalRouterIdnatrules(logicalrouterid, NatRule, callback)Add a NAT rule in a specific logical router{base_path}/{version}/logical-routers/{pathv1}/nat/rules?{query}Yes
getLogicalRouterslogicalRouterIdnatrules(logicalrouterid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)List NAT rules of the logical router{base_path}/{version}/logical-routers/{pathv1}/nat/rules?{query}Yes
getClusternodesnodeIdnetworkinterfaces(nodeid, source, callback)List the specified node's Network Interfaces{base_path}/{version}/cluster/nodes/{pathv1}/network/interfaces?{query}Yes
postNodeservicessyslogexporters(NodeSyslogExporterProperties, callback)Add node syslog exporter{base_path}/{version}/node/services/syslog/exporters?{query}Yes
getNodeservicessyslogexporters(callback)List node syslog exporters{base_path}/{version}/node/services/syslog/exporters?{query}Yes
postNodeservicescmInventoryactionstop(callback)Restart, start or stop the manager service{base_path}/{version}/node/services/cm-inventory?{query}Yes
getNodenetwork(callback)Read network configuration properties{base_path}/{version}/node/network?{query}Yes
getClusternodesnodeIdstatus(nodeid, source, callback)Read Cluster Node Status{base_path}/{version}/cluster/nodes/{pathv1}/status?{query}Yes
postNodeservicesmgmtPlaneBusactionrestart(callback)Restart, start or stop the Rabbit MQ service{base_path}/{version}/node/services/mgmt-plane-bus?{query}Yes
putNodenetworknameServers(NodeNameServersProperties, callback)Update the NSX Manager's Name Servers{base_path}/{version}/node/network/name-servers?{query}Yes
getNodenetworknameServers(callback)Read the NSX Manager's Name Servers{base_path}/{version}/node/network/name-servers?{query}Yes
postClusternodes(AddClusterNodeSpec, action, callback)Add a Node to the Cluster{base_path}/{version}/cluster/nodes?{query}Yes
getClusternodes(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List Cluster Node Configurations{base_path}/{version}/cluster/nodes?{query}Yes
postNodefileStorefileNameactioncopyToRemoteFile(filename, CopyToRemoteFileProperties, callback)Copy file in the file store to a remote file store{base_path}/{version}/node/file-store/{pathv1}?{query}Yes
putNodefileStorefileNamedata(filename, callback)Replace file contents{base_path}/{version}/node/file-store/{pathv1}/data?{query}Yes
getNodefileStorefileNamedata(filename, callback)Read file contents{base_path}/{version}/node/file-store/{pathv1}/data?{query}Yes
postNodeservicesnsxUpgradeAgentactionrestart(callback)Restart, start or stop the NSX upgrade agent service{base_path}/{version}/node/services/nsx-upgrade-agent?{query}Yes
getNodeservicessearchstatus(callback)Read NSX Search service status{base_path}/{version}/node/services/search/status?{query}Yes
postNodeservicesntpactionrestart(callback)Restart, start or stop the NTP service{base_path}/{version}/node/services/ntp?{query}Yes
postNodeservicesmanageractionrestart(callback)Restart, start or stop the service{base_path}/{version}/node/services/manager?{query}Yes
putNodeservicessnmp(NodeSnmpServiceProperties, callback)Update SNMP service properties{base_path}/{version}/node/services/snmp?{query}Yes
getNodeservicessnmp(callback)Read SNMP service properties{base_path}/{version}/node/services/snmp?{query}Yes
getClusterrestorestatus(callback)Query Restore Request Status{base_path}/{version}/cluster/restore/status?{query}Yes
getTrustManagement(callback)Return the Properties of a Trust Manager{base_path}/{version}/trust-management?{query}Yes
getClusterbackupshistory(callback)Get backup history{base_path}/{version}/cluster/backups/history?{query}Yes
postNodeservicesliagentactionstop(callback)Restart, start or stop the liagent service{base_path}/{version}/node/services/liagent?{query}Yes
putNodeservicesntp(NodeNtpServiceProperties, callback)Update NTP service properties{base_path}/{version}/node/services/ntp?{query}Yes
getNodeservicesntp(callback)Read NTP service properties{base_path}/{version}/node/services/ntp?{query}Yes
postNodeserviceshttpactionstop(callback)Stop the http service{base_path}/{version}/node/services/http?{query}Yes
postNodeservicesnsxUpgradeAgentactionstart(callback)Restart, start or stop the NSX upgrade agent service{base_path}/{version}/node/services/nsx-upgrade-agent?{query}Yes
postNodeservicessshactionstart(callback)Restart, start or stop the ssh service{base_path}/{version}/node/services/ssh?{query}Yes
getNodeservicesliagent(callback)Read liagent service properties{base_path}/{version}/node/services/liagent?{query}Yes
postTrustManagementcrlsactionimport(CrlObjectData, callback)Add a New Certificate Revocation List{base_path}/{version}/trust-management/crls?{query}Yes
getClusterrestorebackuptimestamps(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List timestamps of all available Cluster Backups.{base_path}/{version}/cluster/restore/backuptimestamps?{query}Yes
postNodeservicesmgmtPlaneBusactionstop(callback)Restart, start or stop the Rabbit MQ service{base_path}/{version}/node/services/mgmt-plane-bus?{query}Yes
postAdministrationsupportBundlesactioncollect(SupportBundleRequest, overrideAsyncResponse, callback)Collect support bundles from registered cluster and fabric nodes{base_path}/{version}/administration/support-bundles?{query}Yes
postNodeservicessnmpactionstop(callback)Restart, start or stop the SNMP service{base_path}/{version}/node/services/snmp?{query}Yes
postClusterrestoreactionretry(callback)Retry any failed restore operation{base_path}/{version}/cluster/restore?{query}Yes
postNodeservicesinstallUpgradeactionstart(callback)Restart, start or stop the NSX install-upgrade service{base_path}/{version}/node/services/install-upgrade?{query}Yes
postNodeserviceshttpactionstart(callback)Start the http service{base_path}/{version}/node/services/http?{query}Yes
postNodeactionrestart(callback)Restart or shutdown node{base_path}/{version}/node?{query}Yes
putNodenetworkinterfacesinterfaceId(interfaceid, NodeNetworkInterfaceProperties, callback)Update the NSX Manager's Network Interface{base_path}/{version}/node/network/interfaces/{pathv1}?{query}Yes
getNodenetworkinterfacesinterfaceId(interfaceid, callback)Read the NSX Manager's Network Interface{base_path}/{version}/node/network/interfaces/{pathv1}?{query}Yes
putNodeservicesssh(NodeSshServiceProperties, callback)Update ssh service properties{base_path}/{version}/node/services/ssh?{query}Yes
getNodeservicesssh(callback)Read ssh service properties{base_path}/{version}/node/services/ssh?{query}Yes
postNoderabbitmqManagementPort(callback)Set RabbitMQ management port{base_path}/{version}/node/rabbitmq-management-port?{query}Yes
deleteNoderabbitmqManagementPort(callback)Delete RabbitMQ management port{base_path}/{version}/node/rabbitmq-management-port?{query}Yes
getNoderabbitmqManagementPort(callback)Check if RabbitMQ management port is enabled or not{base_path}/{version}/node/rabbitmq-management-port?{query}Yes
deleteNodetaskstaskId(taskid, callback)Delete task{base_path}/{version}/node/tasks/{pathv1}?{query}Yes
getNodetaskstaskId(taskid, suppressRedirect, callback)Read task properties{base_path}/{version}/node/tasks/{pathv1}?{query}Yes
postClusteractionsummarizeInventoryToRemote(callback)Request one-time inventory summary.{base_path}/{version}/cluster?{query}Yes
getNodetaskstaskIdresponse(taskid, callback)Read asynchronous task response{base_path}/{version}/node/tasks/{pathv1}/response?{query}Yes
getNodeservicesmgmtPlaneBusstatus(callback)Read Rabbit MQ service status{base_path}/{version}/node/services/mgmt-plane-bus/status?{query}Yes
postClusteractionbackupToRemote(callback)Request one-time backup{base_path}/{version}/cluster?{query}Yes
getClusterbackupsstatus(callback)Get backup status{base_path}/{version}/cluster/backups/status?{query}Yes
postTrustManagementcsrscsrIdactionimport(csrid, TrustObjectData, callback)Import a Certificate Associated with an Approved CSR{base_path}/{version}/trust-management/csrs/{pathv1}?{query}Yes
postNodeservicesntpactionstart(callback)Restart, start or stop the NTP service{base_path}/{version}/node/services/ntp?{query}Yes
getClusterstatus(source, callback)Read Cluster Status{base_path}/{version}/cluster/status?{query}Yes
postNodeservicesmanageractionstart(callback)Restart, start or stop the service{base_path}/{version}/node/services/manager?{query}Yes
getNodeservicescmInventorystatus(callback)Read manager service status{base_path}/{version}/node/services/cm-inventory/status?{query}Yes
putNodeusersuserid(userid, NodeUserProperties, callback)Update node user{base_path}/{version}/node/users/{pathv1}?{query}Yes
getNodeusersuserid(userid, callback)Read node user{base_path}/{version}/node/users/{pathv1}?{query}Yes
postNodeservicescmInventoryactionstart(callback)Restart, start or stop the manager service{base_path}/{version}/node/services/cm-inventory?{query}Yes
postNodeservicesnsxMessageBusactionstart(callback)Restart, start or stop the NSX Message Bus service{base_path}/{version}/node/services/nsx-message-bus?{query}Yes
getClusternodesnodeIdnetworkinterfacesinterfaceIdstats(nodeid, interfaceid, source, callback)Read the NSX Manager/Controller's Network Interface Statistics{base_path}/{version}/cluster/nodes/{pathv1}/network/interfaces/{pathv2}/stats?{query}Yes
postClusternodesactionrevokeMissingNodes(RevokeNodeRequest, callback)Revoke Missing Nodes from the Cluster{base_path}/{version}/cluster/nodes?{query}Yes
putConfigsmanagement(ManagementConfig, callback)Update NSX Management nodes global configuration{base_path}/{version}/configs/management?{query}Yes
getConfigsmanagement(callback)Read NSX Management nodes global configuration.{base_path}/{version}/configs/management?{query}Yes
getNodeservicesntpstatus(callback)Read NTP service status{base_path}/{version}/node/services/ntp/status?{query}Yes
getClusterrestoreinstructionResources(cursor, includedFields, instructionId, pageSize, sortAscending, sortBy, callback)List resources for a given instruction, to be shown to/executed by users.{base_path}/{version}/cluster/restore/instruction-resources?{query}Yes
getTrustManagementcertificates(cursor, details, includedFields, pageSize, sortAscending, sortBy, callback)Return All the User-Facing Components' Certificates{base_path}/{version}/trust-management/certificates?{query}Yes
getTrustManagementcertificatescertId(certid, details, callback)Show Certificate Data for the Given Certificate ID{base_path}/{version}/trust-management/certificates/{pathv1}?{query}Yes
deleteTrustManagementcertificatescertId(certid, callback)Delete Certificate for the Given Certificate ID{base_path}/{version}/trust-management/certificates/{pathv1}?{query}Yes
putNodenetworksearchDomains(NodeSearchDomainsProperties, callback)Update the NSX Manager's Search Domains{base_path}/{version}/node/network/search-domains?{query}Yes
getNodenetworksearchDomains(callback)Read the NSX Manager's Search Domains{base_path}/{version}/node/network/search-domains?{query}Yes
postNodeservicesnodeMgmtactionrestart(callback)Restart the node management service{base_path}/{version}/node/services/node-mgmt?{query}Yes
postNodeservicessshactionrestart(callback)Restart, start or stop the ssh service{base_path}/{version}/node/services/ssh?{query}Yes
getNodeservicessyslogexportersexporterName(exportername, callback)Read node syslog exporter{base_path}/{version}/node/services/syslog/exporters/{pathv1}?{query}Yes
deleteNodeservicessyslogexportersexporterName(exportername, callback)Delete node syslog exporter{base_path}/{version}/node/services/syslog/exporters/{pathv1}?{query}Yes
getClusternodesnodeIdnetworkinterfacesinterfaceId(nodeid, interfaceid, source, callback)Read the node's Network Interface{base_path}/{version}/cluster/nodes/{pathv1}/network/interfaces/{pathv2}?{query}Yes
postNodeservicessnmpactionstart(callback)Restart, start or stop the SNMP service{base_path}/{version}/node/services/snmp?{query}Yes
postNodeservicessnmpactionrestart(callback)Restart, start or stop the SNMP service{base_path}/{version}/node/services/snmp?{query}Yes
getNodefileStorefileNamethumbprint(filename, callback)Read file thumbprint{base_path}/{version}/node/file-store/{pathv1}/thumbprint?{query}Yes
getNodeservicesliagentstatus(callback)Read liagent service status{base_path}/{version}/node/services/liagent/status?{query}Yes
postClusterrestoreactionstart(InitiateClusterRestoreRequest, callback)Initiate a restore operation{base_path}/{version}/cluster/restore?{query}Yes
postNodeservicesnsxMessageBusactionstop(callback)Restart, start or stop the NSX Message Bus service{base_path}/{version}/node/services/nsx-message-bus?{query}Yes
getNodeservicessnmpstatus(callback)Read SNMP service status{base_path}/{version}/node/services/snmp/status?{query}Yes
getNodesupportBundle(all, callback)Read node support bundle{base_path}/{version}/node/support-bundle?{query}Yes
getNodeservicessearch(callback)Read NSX Search service properties{base_path}/{version}/node/services/search?{query}Yes
postClusterrestoreactioncancel(callback)Cancel any running restore operation{base_path}/{version}/cluster/restore?{query}Yes
getTrustManagementcsrscsrIdpemFile(csrid, callback)Get CSR PEM File for the Given CSR ID{base_path}/{version}/trust-management/csrs/{pathv1}/pem-file?{query}Yes
postClusterrestoreactionadvance(AdvanceClusterRestoreRequest, callback)Advance any suspended restore operation{base_path}/{version}/cluster/restore?{query}Yes
getNodeservicessshstatus(callback)Read ssh service status{base_path}/{version}/node/services/ssh/status?{query}Yes
postNodeservicesnsxMessageBusactionrestart(callback)Restart, start or stop the NSX Message Bus service{base_path}/{version}/node/services/nsx-message-bus?{query}Yes
putClusterrestoreconfig(RestoreConfiguration, callback)Configure Restore SFTP server credentials{base_path}/{version}/cluster/restore/config?{query}Yes
getClusterrestoreconfig(callback)Get Restore configuration{base_path}/{version}/cluster/restore/config?{query}Yes
getNodeservicescmInventory(callback)Read cm inventory service properties{base_path}/{version}/node/services/cm-inventory?{query}Yes
postClusterrestoreactionsuspend(callback)Suspend any running restore operation{base_path}/{version}/cluster/restore?{query}Yes
postNodetaskstaskIdactioncancel(taskid, callback)Cancel specified task{base_path}/{version}/node/tasks/{pathv1}?{query}Yes
deleteTrustManagementprincipalIdentitiesprincipalIdentityId(principalidentityid, callback)Delete a principal identity{base_path}/{version}/trust-management/principal-identities/{pathv1}?{query}Yes
postNodefileStorefileName(filename, callback)Upload a file to the file store{base_path}/{version}/node/file-store/{pathv1}?{query}Yes
deleteNodefileStorefileName(filename, callback)Delete file{base_path}/{version}/node/file-store/{pathv1}?{query}Yes
getNodefileStorefileName(filename, callback)Read file properties{base_path}/{version}/node/file-store/{pathv1}?{query}Yes
postNodeservicescmInventoryactionrestart(callback)Restart, start or stop the manager service{base_path}/{version}/node/services/cm-inventory?{query}Yes
postNodeusersuseridsshKeysactionaddSshKey(userid, SshKeyProperties, callback)Add SSH public key to authorized_keys file for node user{base_path}/{version}/node/users/{pathv1}/ssh-keys?{query}Yes
postNodeservicessshactionremoveHostFingerprint(KnownHostParameter, callback)Remove a host's fingerprint from known hosts file{base_path}/{version}/node/services/ssh?{query}Yes
getNodetasks(fields, requestMethod, requestPath, requestUri, status, user, callback)List appliance management tasks{base_path}/{version}/node/tasks?{query}Yes
postNodeservicesmgmtPlaneBusactionstart(callback)Restart, start or stop the Rabbit MQ service{base_path}/{version}/node/services/mgmt-plane-bus?{query}Yes
getNodeservicesnsxMessageBusstatus(callback)Read NSX Message Bus service status{base_path}/{version}/node/services/nsx-message-bus/status?{query}Yes
getNodeservicesnodeMgmtstatus(callback)Read appliance management service status{base_path}/{version}/node/services/node-mgmt/status?{query}Yes
deleteClusternodesnodeId(nodeid, callback)Remove a Node from the Cluster{base_path}/{version}/cluster/nodes/{pathv1}?{query}Yes
getClusternodesnodeId(nodeid, callback)Read Cluster Node Configuration{base_path}/{version}/cluster/nodes/{pathv1}?{query}Yes
postNodeservicesntpactionstop(callback)Restart, start or stop the NTP service{base_path}/{version}/node/services/ntp?{query}Yes
postNodeservicessyslogactionrestart(callback)Restart, start or stop the syslog service{base_path}/{version}/node/services/syslog?{query}Yes
putNodeservicesmanager(NodeProtonServiceProperties, callback)Update service properties{base_path}/{version}/node/services/manager?{query}Yes
getNodeservicesmanager(callback)Read service properties{base_path}/{version}/node/services/manager?{query}Yes
postNodeserviceshttpactionrestart(callback)Restart the http service{base_path}/{version}/node/services/http?{query}Yes
getNodeaaaprovidersvidmstatus(callback)Read AAA provider vIDM status{base_path}/{version}/node/aaa/providers/vidm/status?{query}Yes
postNodeservicesmanageractionresetManagerLoggingLevels(callback)Reset the logging levels to default values{base_path}/{version}/node/services/manager?{query}Yes
getNodeusers(callback)List node users{base_path}/{version}/node/users?{query}Yes
getClusternodesstatus(callback)Read Cluster Status{base_path}/{version}/cluster/nodes/status?{query}Yes
getNodeservicesnsxUpgradeAgentstatus(callback)Read Nsx upgrade agent service status{base_path}/{version}/node/services/nsx-upgrade-agent/status?{query}Yes
postNodefileStorefileNameactioncopyFromRemoteFile(filename, CopyFromRemoteFileProperties, callback)Copy a remote file to the file store{base_path}/{version}/node/file-store/{pathv1}?{query}Yes
getNodeservicesnodeMgmt(callback)Read appliance management service properties{base_path}/{version}/node/services/node-mgmt?{query}Yes
putNodeservicesinstallUpgrade(NodeInstallUpgradeServiceProperties, callback)Update NSX install-upgrade service properties{base_path}/{version}/node/services/install-upgrade?{query}Yes
getNodeservicesinstallUpgrade(callback)Read NSX install-upgrade service properties{base_path}/{version}/node/services/install-upgrade?{query}Yes
getNodeprocesses(callback)List node processes{base_path}/{version}/node/processes?{query}Yes
deleteNodenetworkroutesrouteId(routeid, callback)Delete node network route{base_path}/{version}/node/network/routes/{pathv1}?{query}Yes
getNodenetworkroutesrouteId(routeid, callback)Read node network route{base_path}/{version}/node/network/routes/{pathv1}?{query}Yes
getNodefileStore(callback)List node files{base_path}/{version}/node/file-store?{query}Yes
postTrustManagementcsrs(Csr, callback)Generate a New Certificate Signing Request{base_path}/{version}/trust-management/csrs?{query}Yes
getTrustManagementcsrs(cursor, includedFields, pageSize, sortAscending, sortBy, callback)Return All the Generated CSRs{base_path}/{version}/trust-management/csrs?{query}Yes
getNodeservicesnsxUpgradeAgent(callback)Read NSX upgrade Agent service properties{base_path}/{version}/node/services/nsx-upgrade-agent?{query}Yes
getNodehardeningPolicymandatoryAccessControlreport(callback)Get the report for Mandatory Access Control{base_path}/{version}/node/hardening-policy/mandatory-access-control/report?{query}Yes
getNodeservicesinstallUpgradestatus(callback)Read NSX install-upgrade service status{base_path}/{version}/node/services/install-upgrade/status?{query}Yes
getCluster(callback)Read Cluster Configuration{base_path}/{version}/cluster?{query}Yes
postNodefileStoreactioncreateRemoteDirectory(CreateRemoteDirectoryProperties, callback)Create directory in remote file server{base_path}/{version}/node/file-store?{query}Yes
postNodeservicessyslogactionstart(callback)Restart, start or stop the syslog service{base_path}/{version}/node/services/syslog?{query}Yes
getNodeservicessyslog(callback)Read syslog service properties{base_path}/{version}/node/services/syslog?{query}Yes
putClusterbackupsconfig(BackupConfiguration, callback)Configure backup{base_path}/{version}/cluster/backups/config?{query}Yes
getClusterbackupsconfig(callback)Get backup configuration{base_path}/{version}/cluster/backups/config?{query}Yes
putTrustManagementcrlscrlId(crlid, Crl, callback)Update CRL for the Given CRL ID{base_path}/{version}/trust-management/crls/{pathv1}?{query}Yes
getTrustManagementcrlscrlId(crlid, details, callback)Show CRL Data for the Given CRL ID{base_path}/{version}/trust-management/crls/{pathv1}?{query}Yes
deleteTrustManagementcrlscrlId(crlid, callback)Delete a CRL{base_path}/{version}/trust-management/crls/{pathv1}?{query}Yes
postTrustManagementcsrscsrIdactionselfSign(csrid, daysValid, callback)Self-Sign the CSR{base_path}/{version}/trust-management/csrs/{pathv1}?{query}Yes
postNodeusersuseridsshKeysactionremoveSshKey(userid, SshKeyBaseProperties, callback)Remove SSH public key from authorized_keys file for node user{base_path}/{version}/node/users/{pathv1}/ssh-keys?{query}Yes
getNodenetworkinterfacesinterfaceIdstats(interfaceid, callback)Read the NSX Manager's Network Interface Statistics{base_path}/{version}/node/network/interfaces/{pathv1}/stats?{query}Yes
postNodeservicessshactionstop(callback)Restart, start or stop the ssh service{base_path}/{version}/node/services/ssh?{query}Yes
getNodeservicessyslogstatus(callback)Read syslog service status{base_path}/{version}/node/services/syslog/status?{query}Yes
postTrustManagementcertificatesactionimport(TrustObjectData, callback)Add a New Certificate{base_path}/{version}/trust-management/certificates?{query}Yes
postNodeservicessyslogactionstop(callback)Restart, start or stop the syslog service{base_path}/{version}/node/services/syslog?{query}Yes
postTrustManagementprincipalIdentities(PrincipalIdentity, callback)Register a name-certificate combination.{base_path}/{version}/trust-management/principal-identities?{query}Yes
getTrustManagementprincipalIdentities(callback)Return the list of principal identities{base_path}/{version}/trust-management/principal-identities?{query}Yes
postNodeservicesmanageractionstop(callback)Restart, start or stop the service{base_path}/{version}/node/services/manager?{query}Yes
getTrustManagementcrls(cursor, details, includedFields, pageSize, sortAscending, sortBy, callback)Return All Added CRLs{base_path}/{version}/trust-management/crls?{query}Yes
putNodeaaaprovidersvidm(NodeAuthProviderVidmProperties, callback)Update AAA provider vIDM properties{base_path}/{version}/node/aaa/providers/vidm?{query}Yes
getNodeaaaprovidersvidm(callback)Read AAA provider vIDM properties{base_path}/{version}/node/aaa/providers/vidm?{query}Yes
getNodeservices(callback)List node services{base_path}/{version}/node/services?{query}Yes
deleteTrustManagementcsrscsrId(csrid, callback)Delete a CSR{base_path}/{version}/trust-management/csrs/{pathv1}?{query}Yes
getTrustManagementcsrscsrId(csrid, callback)Show CSR Data for the Given CSR ID{base_path}/{version}/trust-management/csrs/{pathv1}?{query}Yes
postNodeactionshutdown(callback)Restart or shutdown node{base_path}/{version}/node?{query}Yes
getNodeserviceshttpstatus(callback)Read http service status{base_path}/{version}/node/services/http/status?{query}Yes
getNodenetworkinterfaces(callback)List the NSX Manager's Network Interfaces{base_path}/{version}/node/network/interfaces?{query}Yes
postNodeserviceshttpactionapplyCertificate(certificateId, callback)Update http service certificate{base_path}/{version}/node/services/http?{query}Yes
postNodeservicessearchactionstop(callback)Restart, start or stop the NSX Search service{base_path}/{version}/node/services/search?{query}Yes
getNodeusersuseridsshKeys(userid, callback)List SSH keys from authorized_keys file for node user{base_path}/{version}/node/users/{pathv1}/ssh-keys?{query}Yes
postNodeservicessearchactionstart(callback)Restart, start or stop the NSX Search service{base_path}/{version}/node/services/search?{query}Yes
postNodeservicessearchactionrestart(callback)Restart, start or stop the NSX Search service{base_path}/{version}/node/services/search?{query}Yes
postNodeservicesinstallUpgradeactionrestart(callback)Restart, start or stop the NSX install-upgrade service{base_path}/{version}/node/services/install-upgrade?{query}Yes
getNodeservicesmanagerstatus(callback)Read service status{base_path}/{version}/node/services/manager/status?{query}Yes
postNodeservicesliagentactionrestart(callback)Restart, start or stop the liagent service{base_path}/{version}/node/services/liagent?{query}Yes
getNodeservicesnsxMessageBus(callback)Read NSX Message Bus service properties{base_path}/{version}/node/services/nsx-message-bus?{query}Yes
postNodeservicesinstallUpgradeactionstop(callback)Restart, start or stop the NSX install-upgrade service{base_path}/{version}/node/services/install-upgrade?{query}Yes
postNodeservicesnsxUpgradeAgentactionstop(callback)Restart, start or stop the NSX upgrade agent service{base_path}/{version}/node/services/nsx-upgrade-agent?{query}Yes
putNodehardeningPolicymandatoryAccessControl(MandatoryAccessControlProperties, callback)Enable or disable Mandatory Access Control{base_path}/{version}/node/hardening-policy/mandatory-access-control?{query}Yes
getNodehardeningPolicymandatoryAccessControl(callback)Gets the enable status for Mandatory Access Control{base_path}/{version}/node/hardening-policy/mandatory-access-control?{query}Yes
putNode(NodeProperties, callback)Update node properties{base_path}/{version}/node?{query}Yes
getNode(callback)Read node properties{base_path}/{version}/node?{query}Yes
putNodeserviceshttp(NodeHttpServiceProperties, callback)Update http service properties{base_path}/{version}/node/services/http?{query}Yes
getNodeserviceshttp(callback)Read http service properties{base_path}/{version}/node/services/http?{query}Yes
getNodeprocessesprocessId(processid, callback)Read node process{base_path}/{version}/node/processes/{pathv1}?{query}Yes
postNodeservicesliagentactionstart(callback)Restart, start or stop the liagent service{base_path}/{version}/node/services/liagent?{query}Yes
getNodeservicesmgmtPlaneBus(callback)Read Rabbit MQ service properties{base_path}/{version}/node/services/mgmt-plane-bus?{query}Yes
postNodenetworkroutes(NodeRouteProperties, callback)Create node network route{base_path}/{version}/node/network/routes?{query}Yes
getNodenetworkroutes(callback)List node network routes{base_path}/{version}/node/network/routes?{query}Yes
getUpgradenodesSummary(callback)Get summary of nodes{base_path}/{version}/upgrade/nodes-summary?{query}Yes
postUpgradeupgradeUnitGroups(UpgradeUnitGroup, callback)Create a group{base_path}/{version}/upgrade/upgrade-unit-groups?{query}Yes
getUpgradeupgradeUnitGroups(componentType, cursor, includedFields, pageSize, sortAscending, sortBy, summary, sync, callback)Return information of all upgrade unit groups{base_path}/{version}/upgrade/upgrade-unit-groups?{query}Yes
putUpgradeupgradeUnitGroupsgroupId(groupid, UpgradeUnitGroup, callback)Update the upgrade unit group{base_path}/{version}/upgrade/upgrade-unit-groups/{pathv1}?{query}Yes
deleteUpgradeupgradeUnitGroupsgroupId(groupid, callback)Delete the upgrade unit group{base_path}/{version}/upgrade/upgrade-unit-groups/{pathv1}?{query}Yes
getUpgradeupgradeUnitGroupsgroupId(groupid, summary, callback)Return upgrade unit group information{base_path}/{version}/upgrade/upgrade-unit-groups/{pathv1}?{query}Yes
getUpgradeversionWhitelist(callback)Get the version whitelist{base_path}/{version}/upgrade/version-whitelist?{query}Yes
getUpgradeupgradeUnitsStats(cursor, includedFields, pageSize, sortAscending, sortBy, sync, callback)Get upgrade units stats{base_path}/{version}/upgrade/upgrade-units-stats?{query}Yes
postUpgradeplanactionstart(callback)Start upgrade{base_path}/{version}/upgrade/plan?{query}Yes
putUpgradeversionWhitelistcomponentType(componentType, VersionList, callback)Update the version whitelist for the specified component type{base_path}/{version}/upgrade/version-whitelist/{pathv1}?{query}Yes
getUpgradeversionWhitelistcomponentType(componentType, callback)Get the version whitelist for the specified component{base_path}/{version}/upgrade/version-whitelist/{pathv1}?{query}Yes
postUpgradeplanactionpause(callback)Pause upgrade{base_path}/{version}/upgrade/plan?{query}Yes
postUpgradeupgradeUnitGroupsgroupIdupgradeUnitupgradeUnitIdactionreorder(groupid, upgradeunitid, ReorderRequest, callback)Reorder an upgrade unit within the upgrade unit group{base_path}/{version}/upgrade/upgrade-unit-groups/{pathv1}/upgrade-unit/{pathv2}?{query}Yes
getUpgradeupgradeUnitGroupsaggregateInfo(componentType, cursor, includedFields, pageSize, sortAscending, sortBy, summary, sync, callback)Return aggregate information of all upgrade unit groups{base_path}/{version}/upgrade/upgrade-unit-groups/aggregate-info?{query}Yes
getUpgradeupgradeUnitsupgradeUnitId(upgradeunitid, callback)Get a specific upgrade unit{base_path}/{version}/upgrade/upgrade-units/{pathv1}?{query}Yes
postUpgradeupgradeUnitGroupsgroupIdactionreorder(groupid, ReorderRequest, callback)Reorder upgrade unit group{base_path}/{version}/upgrade/upgrade-unit-groups/{pathv1}?{query}Yes
postUpgradeplanactioncontinue(skip, callback)Continue upgrade{base_path}/{version}/upgrade/plan?{query}Yes
getUpgradeupgradeUnitsaggregateInfo(componentType, cursor, groupId, hasErrors, includedFields, metadata, pageSize, selectionStatus, sortAscending, sortBy, callback)Get upgrade units aggregate-info{base_path}/{version}/upgrade/upgrade-units/aggregate-info?{query}Yes
postUpgradeupgradeUnitGroupsgroupIdactionaddUpgradeUnits(groupid, UpgradeUnitList, callback)Add upgrade units to specified upgrade unit group{base_path}/{version}/upgrade/upgrade-unit-groups/{pathv1}?{query}Yes
getUpgradeupgradeUnits(componentType, currentVersion, cursor, groupId, hasWarnings, includedFields, metadata, pageSize, sortAscending, sortBy, upgradeUnitType, callback)Get upgrade units{base_path}/{version}/upgrade/upgrade-units?{query}Yes
getUpgradestatusSummary(componentType, selectionStatus, callback)Get upgrade status summary{base_path}/{version}/upgrade/status-summary?{query}Yes
getUpgradeupgradeUnitGroupsgroupIdstatus(groupid, cursor, hasErrors, includedFields, pageSize, sortAscending, sortBy, callback)Get upgrade status for group{base_path}/{version}/upgrade/upgrade-unit-groups/{pathv1}/status?{query}Yes
postUpgradeplanactionupgradeSelectedUnits(UpgradeUnitList, callback)Upgrade selected units{base_path}/{version}/upgrade/plan?{query}Yes
getUpgradeupgradeUnitGroupsStatus(componentType, cursor, includedFields, pageSize, sortAscending, sortBy, callback)Get upgrade status for upgrade unit groups{base_path}/{version}/upgrade/upgrade-unit-groups-status?{query}Yes
getUpgradesummary(callback)Get upgrade summary{base_path}/{version}/upgrade/summary?{query}Yes
getUpgradenodes(componentType, componentVersion, cursor, includedFields, pageSize, sortAscending, sortBy, callback)Get list of nodes across all types{base_path}/{version}/upgrade/nodes?{query}Yes
postUpgradeactionupgradeUc(callback)Upgrade the upgrade coordinator.{base_path}/{version}/upgrade?{query}Yes
getUpgradehistory(callback)Get upgrade history{base_path}/{version}/upgrade/history?{query}Yes
putUpgradeplancomponentTypesettings(componentType, UpgradePlanSettings, callback)Update upgrade plan settings for the component{base_path}/{version}/upgrade/plan/{pathv1}/settings?{query}Yes
getUpgradeplancomponentTypesettings(componentType, callback)Get upgrade plan settings for the component{base_path}/{version}/upgrade/plan/{pathv1}/settings?{query}Yes
postUpgradeplanactionreset(componentType, callback)Reset upgrade plan to default plan{base_path}/{version}/upgrade/plan?{query}Yes
postDhcpserversserverIdipPools(serverid, DhcpIpPool, callback)Create an IP pool for a DHCP server{base_path}/{version}/dhcp/servers/{pathv1}/ip-pools?{query}Yes
getDhcpserversserverIdipPools(serverid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)Get a paginated list of a DHCP server's IP pools{base_path}/{version}/dhcp/servers/{pathv1}/ip-pools?{query}Yes
postDhcpserverProfiles(DhcpProfile, callback)Create a DHCP server profile{base_path}/{version}/dhcp/server-profiles?{query}Yes
getDhcpserverProfiles(cursor, includedFields, pageSize, sortAscending, sortBy, callback)Get a paginated list of DHCP server profiles{base_path}/{version}/dhcp/server-profiles?{query}Yes
getNetworkEncryptionkeyPolicieskeyPolicyIdstats(keypolicyid, source, callback)Get the statistics for a network encryption key policy{base_path}/{version}/network-encryption/key-policies/{pathv1}/stats?{query}Yes
putLoadbalancerapplicationProfilesapplicationProfileId(applicationprofileid, LbAppProfile, callback)Update a load balancer application profile{base_path}/{version}/loadbalancer/application-profiles/{pathv1}?{query}Yes
deleteLoadbalancerapplicationProfilesapplicationProfileId(applicationprofileid, callback)Delete a load balancer application profile{base_path}/{version}/loadbalancer/application-profiles/{pathv1}?{query}Yes
getLoadbalancerapplicationProfilesapplicationProfileId(applicationprofileid, callback)Retrieve a load balancer application profile{base_path}/{version}/loadbalancer/application-profiles/{pathv1}?{query}Yes
postFirewallsections(FirewallSection, id, operation, callback)Create a New Empty Section{base_path}/{version}/firewall/sections?{query}Yes
getFirewallsections(appliedTos, cursor, destinations, excludeAppliedToType, filterType, includeAppliedToType, includedFields, pageSize, services, sortAscending, sortBy, sources, type, callback)List All Firewall Sections{base_path}/{version}/firewall/sections?{query}Yes
postLoadbalancerserverSslProfiles(LbServerSslProfile, callback)Create a load balancer server-ssl profile{base_path}/{version}/loadbalancer/server-ssl-profiles?{query}Yes
getLoadbalancerserverSslProfiles(cursor, includedFields, pageSize, sortAscending, sortBy, callback)Retrieve a paginated list of load balancer server-ssl profiles{base_path}/{version}/loadbalancer/server-ssl-profiles?{query}Yes
putLoadbalancerservicesserviceId(serviceid, LbService, callback)Update a load balancer service{base_path}/{version}/loadbalancer/services/{pathv1}?{query}Yes
deleteLoadbalancerservicesserviceId(serviceid, callback)Delete a load balancer service{base_path}/{version}/loadbalancer/services/{pathv1}?{query}Yes
getLoadbalancerservicesserviceId(serviceid, callback)Retrieve a load balancer service{base_path}/{version}/loadbalancer/services/{pathv1}?{query}Yes
putLoadbalancerrulesruleId(ruleid, LbRule, callback)Update a load balancer rule{base_path}/{version}/loadbalancer/rules/{pathv1}?{query}Yes
getLoadbalancerrulesruleId(ruleid, callback)Retrieve a load balancer rule{base_path}/{version}/loadbalancer/rules/{pathv1}?{query}Yes
deleteLoadbalancerrulesruleId(ruleid, callback)Delete a load balancer rule{base_path}/{version}/loadbalancer/rules/{pathv1}?{query}Yes
getDhcpserversserverIdstatus(serverid, callback)Get DHCP service status with given dhcp server id{base_path}/{version}/dhcp/servers/{pathv1}/status?{query}Yes
postDhcpservers(LogicalDhcpServer, callback)Create a DHCP server{base_path}/{version}/dhcp/servers?{query}Yes
getDhcpservers(cursor, includedFields, pageSize, sortAscending, sortBy, callback)Get a paginated list of DHCP servers{base_path}/{version}/dhcp/servers?{query}Yes
putDhcpserversserverIdipPoolspoolId(serverid, poolid, DhcpIpPool, callback)Update a DHCP server's IP pool{base_path}/{version}/dhcp/servers/{pathv1}/ip-pools/{pathv2}?{query}Yes
getDhcpserversserverIdipPoolspoolId(serverid, poolid, callback)Get a DHCP server's IP pool with the specified pool ID{base_path}/{version}/dhcp/servers/{pathv1}/ip-pools/{pathv2}?{query}Yes
deleteDhcpserversserverIdipPoolspoolId(serverid, poolid, callback)Delete a DHCP server's IP pool{base_path}/{version}/dhcp/servers/{pathv1}/ip-pools/{pathv2}?{query}Yes
postFirewallsectionssectionIdactionreviseWithRules(sectionid, FirewallSectionRuleList, id, operation, callback)Update an Existing Section with Rules{base_path}/{version}/firewall/sections/{pathv1}?{query}Yes
postDhcpserversserverIdstaticBindings(serverid, DhcpStaticBinding, callback)Create a static binding for a DHCP server{base_path}/{version}/dhcp/servers/{pathv1}/static-bindings?{query}Yes
getDhcpserversserverIdstaticBindings(serverid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)Get a paginated list of a DHCP server's static bindings{base_path}/{version}/dhcp/servers/{pathv1}/static-bindings?{query}Yes
postNetworkEncryptionsectionssectionIdrules(sectionid, DneRule, id, operation, callback)Add a network encryption rule in a section{base_path}/{version}/network-encryption/sections/{pathv1}/rules?{query}Yes
getNetworkEncryptionsectionssectionIdrules(sectionid, appliedTos, cursor, destinations, filterType, includedFields, keyPolicyId, pageSize, services, sortAscending, sortBy, sources, callback)Get the rules of a network encryption section{base_path}/{version}/network-encryption/sections/{pathv1}/rules?{query}Yes
putFirewallstatuscontextType(contexttype, FirewallStatus, callback)Update global firewall status for dfw context{base_path}/{version}/firewall/status/{pathv1}?{query}Yes
getFirewallstatuscontextType(contexttype, callback)Get firewall global status for dfw context{base_path}/{version}/firewall/status/{pathv1}?{query}Yes
postNetworkEncryptionsectionssectionIdactionreviseWithRules(sectionid, DneSectionRuleList, id, operation, callback)Update a network encryption section, its rules or position{base_path}/{version}/network-encryption/sections/{pathv1}?{query}Yes
putLoadbalancerpoolspoolId(poolid, LbPool, callback)Update a load balancer pool{base_path}/{version}/loadbalancer/pools/{pathv1}?{query}Yes
postLoadbalancerpoolspoolId(poolid, PoolMemberSettingList, action, callback)Add, remove, or modify load balancer pool members{base_path}/{version}/loadbalancer/pools/{pathv1}?{query}Yes
deleteLoadbalancerpoolspoolId(poolid, callback)Delete a load balancer pool{base_path}/{version}/loadbalancer/pools/{pathv1}?{query}Yes
getLoadbalancerpoolspoolId(poolid, callback)Retrieve a load balancer pool{base_path}/{version}/loadbalancer/pools/{pathv1}?{query}Yes
postFirewallsectionssectionIdactionupdateWithRules(sectionid, FirewallSectionRuleList, callback)Update an Existing Section, Including Its Rules{base_path}/{version}/firewall/sections/{pathv1}?{query}Yes
postFirewallsectionssectionIdactionlistWithRules(sectionid, callback)Get an Existing Section, Including Rules{base_path}/{version}/firewall/sections/{pathv1}?{query}Yes
getLoadbalancerservicesserviceIdpoolspoolIdstatus(serviceid, poolid, source, callback)Get the status of load balancer pool{base_path}/{version}/loadbalancer/services/{pathv1}/pools/{pathv2}/status?{query}Yes
getNetworkEncryptionstatus(callback)Get the network encryption status for a given context{base_path}/{version}/network-encryption/status?{query}Yes
putDhcpserversserverId(serverid, LogicalDhcpServer, callback)Update a DHCP server{base_path}/{version}/dhcp/servers/{pathv1}?{query}Yes
deleteDhcpserversserverId(serverid, callback)Delete a DHCP server{base_path}/{version}/dhcp/servers/{pathv1}?{query}Yes
getDhcpserversserverId(serverid, callback)Get a DHCP server{base_path}/{version}/dhcp/servers/{pathv1}?{query}Yes
postFirewallsectionssectionIdrulesactioncreateMultiple(sectionid, FirewallRuleList, id, operation, callback)Add Multiple Rules in a Section{base_path}/{version}/firewall/sections/{pathv1}/rules?{query}Yes
putNetworkEncryptionkeyPolicieskeyPolicyId(keypolicyid, DneKeyPolicy, callback)Update a network encryption key policy{base_path}/{version}/network-encryption/key-policies/{pathv1}?{query}Yes
deleteNetworkEncryptionkeyPolicieskeyPolicyId(keypolicyid, callback)Delete a specific network encryption key policy{base_path}/{version}/network-encryption/key-policies/{pathv1}?{query}Yes
getNetworkEncryptionkeyPolicieskeyPolicyId(keypolicyid, callback)Get a specific network encryption key policy{base_path}/{version}/network-encryption/key-policies/{pathv1}?{query}Yes
postNetworkEncryptionsectionsactioncreateWithRules(DneSectionRuleList, id, operation, callback)Create a network encryption section with rules{base_path}/{version}/network-encryption/sections?{query}Yes
postLoadbalancerrules(LbRule, callback)Create a load balancer rule{base_path}/{version}/loadbalancer/rules?{query}Yes
getLoadbalancerrules(cursor, includedFields, pageSize, sortAscending, sortBy, callback)Retrieve a paginated list of load balancer rules{base_path}/{version}/loadbalancer/rules?{query}Yes
putNetworkEncryptionsectionssectionId(sectionid, DneSection, callback)Update a network encryption section{base_path}/{version}/network-encryption/sections/{pathv1}?{query}Yes
getNetworkEncryptionsectionssectionId(sectionid, callback)Get a specific network encryption section{base_path}/{version}/network-encryption/sections/{pathv1}?{query}Yes
deleteNetworkEncryptionsectionssectionId(sectionid, cascade, id, operation, callback)Delete a network encryption section and its rules{base_path}/{version}/network-encryption/sections/{pathv1}?{query}Yes
getDhcpserversserverIdstatistics(serverid, callback)Get DHCP statistics with given dhcp server id{base_path}/{version}/dhcp/servers/{pathv1}/statistics?{query}Yes
postLoadbalancerpools(LbPool, callback)Create a load balancer pool{base_path}/{version}/loadbalancer/pools?{query}Yes
getLoadbalancerpools(cursor, includedFields, pageSize, sortAscending, sortBy, callback)Retrieve a paginated list of load balancer pools{base_path}/{version}/loadbalancer/pools?{query}Yes
postNetworkEncryptionsections(DneSection, id, operation, callback)Create a network encryption section without rules{base_path}/{version}/network-encryption/sections?{query}Yes
getNetworkEncryptionsections(appliedTos, cursor, destinations, filterType, includedFields, keyPolicyId, pageSize, services, sortAscending, sortBy, sources, type, callback)Get network encryption sections{base_path}/{version}/network-encryption/sections?{query}Yes
postFirewallexcludelistactionremoveMember(objectId, callback)Remove an existing object from the exclude list{base_path}/{version}/firewall/excludelist?{query}Yes
postLoadbalancerpersistenceProfiles(LbPersistenceProfile, callback)Create a load balancer persistence profile{base_path}/{version}/loadbalancer/persistence-profiles?{query}Yes
getLoadbalancerpersistenceProfiles(cursor, includedFields, pageSize, sortAscending, sortBy, type, callback)Retrieve a paginated list of load balancer persistence profiles{base_path}/{version}/loadbalancer/persistence-profiles?{query}Yes
putLoadbalancerserverSslProfilesserverSslProfileId(serversslprofileid, LbServerSslProfile, callback)Update a load balancer server-ssl profile{base_path}/{version}/loadbalancer/server-ssl-profiles/{pathv1}?{query}Yes
deleteLoadbalancerserverSslProfilesserverSslProfileId(serversslprofileid, callback)Delete a load balancer server-ssl profile{base_path}/{version}/loadbalancer/server-ssl-profiles/{pathv1}?{query}Yes
getLoadbalancerserverSslProfilesserverSslProfileId(serversslprofileid, callback)Retrieve a load balancer server-ssl profile{base_path}/{version}/loadbalancer/server-ssl-profiles/{pathv1}?{query}Yes
putFirewallexcludelist(ExcludeList, callback)Modify exclude list{base_path}/{version}/firewall/excludelist?{query}Yes
getFirewallexcludelist(callback)Get list of entities in exclude list{base_path}/{version}/firewall/excludelist?{query}Yes
postNetworkEncryptionsectionssectionIdactionrevise(sectionid, DneSection, id, operation, callback)Update a network encryption section and/or its position{base_path}/{version}/network-encryption/sections/{pathv1}?{query}Yes
postFirewallsectionsactioncreateWithRules(FirewallSectionRuleList, id, operation, callback)Create a Section with Rules{base_path}/{version}/firewall/sections?{query}Yes
postNetworkEncryptionsectionssectionIdrulesruleIdactionrevise(sectionid, ruleid, DneRule, id, operation, callback)Update or reorder a rule in a network encryption section{base_path}/{version}/network-encryption/sections/{pathv1}/rules/{pathv2}?{query}Yes
putMdProxiesproxyId(proxyid, MetadataProxy, callback)Update a metadata proxy{base_path}/{version}/md-proxies/{pathv1}?{query}Yes
getMdProxiesproxyId(proxyid, callback)Get a metadata proxy{base_path}/{version}/md-proxies/{pathv1}?{query}Yes
deleteMdProxiesproxyId(proxyid, callback)Delete a metadata proxy{base_path}/{version}/md-proxies/{pathv1}?{query}Yes
postNetworkEncryptionkeyPolicies(DneKeyPolicy, callback)Create a network encryption key policy{base_path}/{version}/network-encryption/key-policies?{query}Yes
getNetworkEncryptionkeyPolicies(cursor, encryptAlgorithm, encryptType, includedFields, macAlgorithm, pageSize, sortAscending, sortBy, callback)Get all network encryption key policies{base_path}/{version}/network-encryption/key-policies?{query}Yes
putDhcpserversserverIdstaticBindingsbindingId(serverid, bindingid, DhcpStaticBinding, callback)Update a DHCP server's static binding{base_path}/{version}/dhcp/servers/{pathv1}/static-bindings/{pathv2}?{query}Yes
deleteDhcpserversserverIdstaticBindingsbindingId(serverid, bindingid, callback)Delete a static binding{base_path}/{version}/dhcp/servers/{pathv1}/static-bindings/{pathv2}?{query}Yes
getDhcpserversserverIdstaticBindingsbindingId(serverid, bindingid, callback)Get a DHCP server's static binding with the specified binding ID{base_path}/{version}/dhcp/servers/{pathv1}/static-bindings/{pathv2}?{query}Yes
putNetworkEncryptionkeyManagerskeyManagerId(keymanagerid, DneKeyManager, callback)Update a specific network encryption key manager configuration{base_path}/{version}/network-encryption/key-managers/{pathv1}?{query}Yes
getNetworkEncryptionkeyManagerskeyManagerId(keymanagerid, callback)Get configuration for a specific network encryption key manager{base_path}/{version}/network-encryption/key-managers/{pathv1}?{query}Yes
deleteNetworkEncryptionkeyManagerskeyManagerId(keymanagerid, callback)Delete an attached network encryption key manager{base_path}/{version}/network-encryption/key-managers/{pathv1}?{query}Yes
postNetworkEncryptionkeyManagers(DneKeyManager, callback)Add a network encryption key manager configuration{base_path}/{version}/network-encryption/key-managers?{query}Yes
getNetworkEncryptionkeyManagers(callback)Get all configured instances of network encryption key managers{base_path}/{version}/network-encryption/key-managers?{query}Yes
getLoadbalancerservicesserviceIdvirtualServersstatus(serviceid, source, callback)Get the status list of virtual servers in given load balancer service{base_path}/{version}/loadbalancer/services/{pathv1}/virtual-servers/status?{query}Yes
putDhcpserverProfilesprofileId(profileid, DhcpProfile, callback)Update a DHCP server profile{base_path}/{version}/dhcp/server-profiles/{pathv1}?{query}Yes
getDhcpserverProfilesprofileId(profileid, callback)Get a DHCP server profile{base_path}/{version}/dhcp/server-profiles/{pathv1}?{query}Yes
deleteDhcpserverProfilesprofileId(profileid, callback)Delete a DHCP server profile{base_path}/{version}/dhcp/server-profiles/{pathv1}?{query}Yes
postNetworkEncryptionsectionssectionIdactionlistWithRules(sectionid, callback)Get a specific network encryption section and its rules{base_path}/{version}/network-encryption/sections/{pathv1}?{query}Yes
getLoadbalancersslciphersAndProtocols(cursor, includedFields, pageSize, sortAscending, sortBy, callback)Retrieve a list of supported SSL ciphers and protocols{base_path}/{version}/loadbalancer/ssl/ciphers-and-protocols?{query}Yes
postFirewallsectionssectionIdactionrevise(sectionid, FirewallSection, id, operation, callback)Update an Existing Section, Including Its Position{base_path}/{version}/firewall/sections/{pathv1}?{query}Yes
postFirewallexcludelistactionaddMember(ResourceReference, callback)Add a new object in the exclude list{base_path}/{version}/firewall/excludelist?{query}Yes
getFirewallsectionssectionIdrulesstats(sectionid, source, callback)Get Firewall section level statistics section{base_path}/{version}/firewall/sections/{pathv1}/rules/stats?{query}Yes
postLoadbalancerapplicationProfiles(LbAppProfile, callback)Create a load balancer application profile{base_path}/{version}/loadbalancer/application-profiles?{query}Yes
getLoadbalancerapplicationProfiles(cursor, includedFields, pageSize, sortAscending, sortBy, type, callback)Retrieve a paginated list of load balancer application profiles{base_path}/{version}/loadbalancer/application-profiles?{query}Yes
putLoadbalancermonitorsmonitorId(monitorid, LbMonitor, callback)Update a load balancer monitor{base_path}/{version}/loadbalancer/monitors/{pathv1}?{query}Yes
getLoadbalancermonitorsmonitorId(monitorid, callback)Retrieve a load balancer monitor{base_path}/{version}/loadbalancer/monitors/{pathv1}?{query}Yes
deleteLoadbalancermonitorsmonitorId(monitorid, callback)Delete a load balancer monitor{base_path}/{version}/loadbalancer/monitors/{pathv1}?{query}Yes
postNetworkEncryptionstatusactionupdateStatus(context, status, callback)Update the firewall status for a given context{base_path}/{version}/network-encryption/status?{query}Yes
putLoadbalancerclientSslProfilesclientSslProfileId(clientsslprofileid, LbClientSslProfile, callback)Update a load balancer client-ssl profile{base_path}/{version}/loadbalancer/client-ssl-profiles/{pathv1}?{query}Yes
getLoadbalancerclientSslProfilesclientSslProfileId(clientsslprofileid, callback)Retrieve a load balancer client-ssl profile{base_path}/{version}/loadbalancer/client-ssl-profiles/{pathv1}?{query}Yes
deleteLoadbalancerclientSslProfilesclientSslProfileId(clientsslprofileid, callback)Delete a load balancer client-ssl profile{base_path}/{version}/loadbalancer/client-ssl-profiles/{pathv1}?{query}Yes
putNetworkEncryptionsectionssectionIdrulesruleId(sectionid, ruleid, DneRule, callback)Update a specific rule in a network encryption section{base_path}/{version}/network-encryption/sections/{pathv1}/rules/{pathv2}?{query}Yes
deleteNetworkEncryptionsectionssectionIdrulesruleId(sectionid, ruleid, callback)Delete a specific network encryption rule{base_path}/{version}/network-encryption/sections/{pathv1}/rules/{pathv2}?{query}Yes
getNetworkEncryptionsectionssectionIdrulesruleId(sectionid, ruleid, callback)Get a specific rule in a network encryption section{base_path}/{version}/network-encryption/sections/{pathv1}/rules/{pathv2}?{query}Yes
getLoadbalancerservicesserviceIdpoolsstatistics(serviceid, source, callback)Get the statistics list of load balancer pools{base_path}/{version}/loadbalancer/services/{pathv1}/pools/statistics?{query}Yes
getLoadbalancerservicesserviceIdvirtualServersvirtualServerIdstatus(serviceid, virtualserverid, source, callback)Get the status of the load balancer virtual server{base_path}/{version}/loadbalancer/services/{pathv1}/virtual-servers/{pathv2}/status?{query}Yes
getLoadbalancerservicesserviceIdvirtualServersvirtualServerIdstatistics(serviceid, virtualserverid, source, callback)Get the statistics of the given load balancer virtual server{base_path}/{version}/loadbalancer/services/{pathv1}/virtual-servers/{pathv2}/statistics?{query}Yes
postFirewallsectionssectionIdrulesruleIdactionrevise(sectionid, ruleid, FirewallRule, id, operation, callback)Update an Existing Rule and Reorder the Rule{base_path}/{version}/firewall/sections/{pathv1}/rules/{pathv2}?{query}Yes
getNetworkEncryptionsectionssectionIdstate(sectionid, barrierId, callback)Get the realized state of a network encryption section{base_path}/{version}/network-encryption/sections/{pathv1}/state?{query}Yes
postMdProxies(MetadataProxy, callback)Create a metadata proxy{base_path}/{version}/md-proxies?{query}Yes
getMdProxies(cursor, includedFields, pageSize, sortAscending, sortBy, callback)Get a paginated list of metadata proxies{base_path}/{version}/md-proxies?{query}Yes
postFirewallsectionssectionIdrules(sectionid, FirewallRule, id, operation, callback)Add a Single Rule in a Section{base_path}/{version}/firewall/sections/{pathv1}/rules?{query}Yes
getFirewallsectionssectionIdrules(sectionid, appliedTos, cursor, destinations, filterType, includedFields, pageSize, services, sortAscending, sortBy, sources, callback)Get All the Rules for a Section{base_path}/{version}/firewall/sections/{pathv1}/rules?{query}Yes
getLoadbalancerservicesserviceIdvirtualServersstatistics(serviceid, source, callback)Get the statistics list of virtual servers{base_path}/{version}/loadbalancer/services/{pathv1}/virtual-servers/statistics?{query}Yes
postNetworkEncryptionkeyPolicieskeyPolicyIdactionrotate(keypolicyid, callback)Manually rotate a network encryption key policy for graceful re-key{base_path}/{version}/network-encryption/key-policies/{pathv1}?{query}Yes
putFirewallsectionssectionId(sectionid, FirewallSection, callback)Update an Existing Section{base_path}/{version}/firewall/sections/{pathv1}?{query}Yes
getFirewallsectionssectionId(sectionid, callback)Get an Existing Section{base_path}/{version}/firewall/sections/{pathv1}?{query}Yes
deleteFirewallsectionssectionId(sectionid, cascade, callback)Delete an Existing Section and Its Associated Rules{base_path}/{version}/firewall/sections/{pathv1}?{query}Yes
putFirewallsectionssectionIdrulesruleId(sectionid, ruleid, FirewallRule, callback)Update an Existing Rule{base_path}/{version}/firewall/sections/{pathv1}/rules/{pathv2}?{query}Yes
deleteFirewallsectionssectionIdrulesruleId(sectionid, ruleid, callback)Delete an Existing Rule{base_path}/{version}/firewall/sections/{pathv1}/rules/{pathv2}?{query}Yes
getFirewallsectionssectionIdrulesruleId(sectionid, ruleid, callback)Read an Existing Rule{base_path}/{version}/firewall/sections/{pathv1}/rules/{pathv2}?{query}Yes
getMdProxiesproxyIdlogicalSwitchIdstatus(proxyid, logicalswitchid, callback)Get Metadata Proxy status with given proxy id and attached logical switch.{base_path}/{version}/md-proxies/{pathv1}/{pathv2}/status?{query}Yes
getFirewallsectionssectionIdstate(sectionid, barrierId, callback)Get the Realized State of a Firewall Section{base_path}/{version}/firewall/sections/{pathv1}/state?{query}Yes
getMdProxiesproxyIdstatistics(proxyid, logicalSwitchId, source, callback)Get Metadata Proxy statistics with given proxy id{base_path}/{version}/md-proxies/{pathv1}/statistics?{query}Yes
getLoadbalancerservicesserviceIdstatistics(serviceid, source, callback)Get the statistics of load balancer service{base_path}/{version}/loadbalancer/services/{pathv1}/statistics?{query}Yes
putNetworkEncryptionkeyPoliciesresetencryptType(encrypttype, callback)Reset default network encryption key policy to system default for a specific encryption type{base_path}/{version}/network-encryption/key-policies/reset/{pathv1}?{query}Yes
getLoadbalancerservicesserviceIdpoolsstatus(serviceid, source, callback)Get the status list of load balancer pools{base_path}/{version}/loadbalancer/services/{pathv1}/pools/status?{query}Yes
getFirewallsectionssectionIdrulesruleIdstats(sectionid, ruleid, source, callback)Get Firewall rule level statistics{base_path}/{version}/firewall/sections/{pathv1}/rules/{pathv2}/stats?{query}Yes
getFirewallrulesruleIdstate(ruleid, barrierId, callback)Get the Realized State of a Firewall Rule{base_path}/{version}/firewall/rules/{pathv1}/state?{query}Yes
postFirewallexcludelistactioncheckIfExists(objectId, callback)Check if the object a member of the exclude list{base_path}/{version}/firewall/excludelist?{query}Yes
postNetworkEncryptionkeyPolicieskeyPolicyIdactionrevoke(keypolicyid, callback)Manually revoke a network encryption key policy for ungraceful re-key{base_path}/{version}/network-encryption/key-policies/{pathv1}?{query}Yes
postLoadbalancerclientSslProfiles(LbClientSslProfile, callback)Create a load balancer client-ssl profile{base_path}/{version}/loadbalancer/client-ssl-profiles?{query}Yes
getLoadbalancerclientSslProfiles(cursor, includedFields, pageSize, sortAscending, sortBy, callback)Retrieve a paginated list of load balancer client-ssl profiles{base_path}/{version}/loadbalancer/client-ssl-profiles?{query}Yes
postFirewallstatsactionreset(category, callback)Reset firewall rule statistics{base_path}/{version}/firewall/stats?{query}Yes
postNetworkEncryptionsectionssectionIdrulesactioncreateMultiple(sectionid, DneRuleList, id, operation, callback)Add multiple rules to a network encryption section{base_path}/{version}/network-encryption/sections/{pathv1}/rules?{query}Yes
getDhcpserversserverIdleases(serverid, address, poolId, source, callback)Get lease info of a given dhcp server id{base_path}/{version}/dhcp/servers/{pathv1}/leases?{query}Yes
postLoadbalancermonitors(LbMonitor, callback)Create a load balancer monitor{base_path}/{version}/loadbalancer/monitors?{query}Yes
getLoadbalancermonitors(cursor, includedFields, pageSize, sortAscending, sortBy, type, callback)Retrieve a paginated list of load balancer monitors{base_path}/{version}/loadbalancer/monitors?{query}Yes
postLoadbalancerservices(LbService, callback)Create a load balancer service{base_path}/{version}/loadbalancer/services?{query}Yes
getLoadbalancerservices(cursor, includedFields, pageSize, sortAscending, sortBy, callback)Retrieve a paginated list of load balancer services{base_path}/{version}/loadbalancer/services?{query}Yes
putNetworkEncryptionconfig(DneGlobalConfig, callback)Update the global configuration of network encryption service{base_path}/{version}/network-encryption/config?{query}Yes
getNetworkEncryptionconfig(callback)Get the global configuration of network encryption service{base_path}/{version}/network-encryption/config?{query}Yes
getNetworkEncryptionsectionssectionIdrulesruleIdstate(sectionid, ruleid, barrierId, callback)Get the realized State of a network encryption rule{base_path}/{version}/network-encryption/sections/{pathv1}/rules/{pathv2}/state?{query}Yes
getLoadbalancerservicesserviceIdstatus(serviceid, source, callback)Get the status of the given load balancer service{base_path}/{version}/loadbalancer/services/{pathv1}/status?{query}Yes
getFirewallstatus(callback)List all firewall status for supported contexts{base_path}/{version}/firewall/status?{query}Yes
putLoadbalancervirtualServersvirtualServerId(virtualserverid, LbVirtualServer, callback)Update a load balancer virtual server{base_path}/{version}/loadbalancer/virtual-servers/{pathv1}?{query}Yes
deleteLoadbalancervirtualServersvirtualServerId(virtualserverid, deleteAssociatedRules, callback)Delete a load balancer virtual server{base_path}/{version}/loadbalancer/virtual-servers/{pathv1}?{query}Yes
getLoadbalancervirtualServersvirtualServerId(virtualserverid, callback)Retrieve a load balancer virtual server{base_path}/{version}/loadbalancer/virtual-servers/{pathv1}?{query}Yes
postNetworkEncryptionsectionssectionIdactionupdateWithRules(sectionid, DneSectionRuleList, callback)Update a network encryption section and its rules{base_path}/{version}/network-encryption/sections/{pathv1}?{query}Yes
getNetworkEncryptionsectionssectionIdrulesruleIdstats(sectionid, ruleid, source, callback)Get the statistics for a network encryption rule{base_path}/{version}/network-encryption/sections/{pathv1}/rules/{pathv2}/stats?{query}Yes
putLoadbalancerpersistenceProfilespersistenceProfileId(persistenceprofileid, LbPersistenceProfile, callback)Update a load balancer persistence profile{base_path}/{version}/loadbalancer/persistence-profiles/{pathv1}?{query}Yes
getLoadbalancerpersistenceProfilespersistenceProfileId(persistenceprofileid, callback)Retrieve a load balancer persistence profile{base_path}/{version}/loadbalancer/persistence-profiles/{pathv1}?{query}Yes
deleteLoadbalancerpersistenceProfilespersistenceProfileId(persistenceprofileid, callback)Delete a load balancer persistence profile{base_path}/{version}/loadbalancer/persistence-profiles/{pathv1}?{query}Yes
getNetworkEncryptionkeyPolicieskeypolicyIdrules(keypolicyid, appliedTos, cursor, destinations, filterType, includedFields, keyPolicyId, pageSize, services, sortAscending, sortBy, sources, callback)Get all network encryption rules attached to a specific key policy{base_path}/{version}/network-encryption/key-policies/{pathv1}/rules?{query}Yes
getLoadbalancerservicesserviceIdpoolspoolIdstatistics(serviceid, poolid, source, callback)Get the statistics of load balancer pool{base_path}/{version}/loadbalancer/services/{pathv1}/pools/{pathv2}/statistics?{query}Yes
postLoadbalancervirtualServers(LbVirtualServer, callback)Create a load balancer virtual server{base_path}/{version}/loadbalancer/virtual-servers?{query}Yes
getLoadbalancervirtualServers(cursor, includedFields, pageSize, sortAscending, sortBy, callback)Retrieve a paginated list of load balancer virtual servers{base_path}/{version}/loadbalancer/virtual-servers?{query}Yes
getEulacontent(cursor, format, includedFields, pageSize, sortAscending, sortBy, callback)Return the content of end user license agreement{base_path}/{version}/eula/content?{query}Yes
putLicense(License, callback)Deprecated. Assign an Updated Enterprise License Key{base_path}/{version}/license?{query}Yes
getLicense(callback)Deprecated. Return the Enterprise License{base_path}/{version}/license?{query}Yes
getEulaacceptance(callback)Return the acceptance status of end user license agreement{base_path}/{version}/eula/acceptance?{query}Yes
postUpgradeeulaaccept(callback)Accept end user license agreement{base_path}/{version}/upgrade/eula/accept?{query}Yes
getLicenseslicensesUsage(callback)Get usage report of all registered modules{base_path}/{version}/licenses/licenses-usage?{query}Yes
getLicenseslicenseKey(licensekey, callback)Deprecated. Get license properties for license identified by the license-key{base_path}/{version}/licenses/{pathv1}?{query}Yes
deleteLicenseslicenseKey(licensekey, callback)Deprecated. Remove a license identified by the license-key{base_path}/{version}/licenses/{pathv1}?{query}Yes
postEulaaccept(callback)Accept end user license agreement{base_path}/{version}/eula/accept?{query}Yes
getLicenseslicensesUsageformatcsv(callback)Get usage report of all registred modules in CSV format{base_path}/{version}/licenses/licenses-usage?{query}Yes
getUpgradeeulacontent(cursor, format, includedFields, pageSize, sortAscending, sortBy, callback)Return the content of end user license agreement{base_path}/{version}/upgrade/eula/content?{query}Yes
postLicensesactiondelete(License, callback)Remove a license{base_path}/{version}/licenses?{query}Yes
postLicenses(License, callback)Add a new license key{base_path}/{version}/licenses?{query}Yes
getLicenses(callback)Get all licenses{base_path}/{version}/licenses?{query}Yes
getUpgradeeulaacceptance(callback)Return the acceptance status of end user license agreement{base_path}/{version}/upgrade/eula/acceptance?{query}Yes
getInfrarealizedStateenforcementPointsenforcementPointNameservicesnsservicesnsserviceName(enforcementpointname, nsservicename, callback)Read NSService{base_path}/{version}/infra/realized-state/enforcement-points/{pathv1}/services/nsservices/{pathv2}?{query}Yes
getInfrarealizedStateenforcementPointsenforcementPointNameipSetsipSetsNsxt(enforcementpointname, cursor, includedFields, pageSize, sortAscending, sortBy, callback)List IPSets{base_path}/{version}/infra/realized-state/enforcement-points/{pathv1}/ip-sets/ip-sets-nsxt?{query}Yes
getInfradeploymentZonesdeploymentZoneIdenforcementPoints(deploymentzoneid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)List enforcementpoints for infra{base_path}/{version}/infra/deployment-zones/{pathv1}/enforcement-points?{query}Yes
getInfrarealizedStateenforcementPointsenforcementPointNamefirewallsfirewallSectionsfirewallSectionId(enforcementpointname, firewallsectionid, callback)Read Firewall{base_path}/{version}/infra/realized-state/enforcement-points/{pathv1}/firewalls/firewall-sections/{pathv2}?{query}Yes
getInfrarealizedStateenforcementPointsenforcementPointNamegroupsnsgroups(enforcementpointname, cursor, includedFields, pageSize, sortAscending, sortBy, callback)List NS Groups{base_path}/{version}/infra/realized-state/enforcement-points/{pathv1}/groups/nsgroups?{query}Yes
postInfraservicesserviceIdserviceEntriesserviceEntryId(serviceid, serviceentryid, ServiceEntry, callback)Create or update a ServiceEntry{base_path}/{version}/infra/services/{pathv1}/service-entries/{pathv2}?{query}Yes
deleteInfraservicesserviceIdserviceEntriesserviceEntryId(serviceid, serviceentryid, callback)Delete Service entry{base_path}/{version}/infra/services/{pathv1}/service-entries/{pathv2}?{query}Yes
getInfraservicesserviceIdserviceEntriesserviceEntryId(serviceid, serviceentryid, callback)Service entry{base_path}/{version}/infra/services/{pathv1}/service-entries/{pathv2}?{query}Yes
getInfrarealizedStateenforcementPointsenforcementPointNamegroupssecuritygroups(enforcementpointname, cursor, includedFields, pageSize, sortAscending, sortBy, callback)List Security Groups{base_path}/{version}/infra/realized-state/enforcement-points/{pathv1}/groups/securitygroups?{query}Yes
getTemplates(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List Policy Templates{base_path}/{version}/templates?{query}Yes
postInfradomainsdomainIddomainDeploymentMapsdomainDeploymentMapId(domainid, domaindeploymentmapid, DomainDeploymentMap, callback)Create a new Domain Deployment Map under infra{base_path}/{version}/infra/domains/{pathv1}/domain-deployment-maps/{pathv2}?{query}Yes
getInfradomainsdomainIddomainDeploymentMapsdomainDeploymentMapId(domainid, domaindeploymentmapid, callback)Read a DomainDeploymentMap{base_path}/{version}/infra/domains/{pathv1}/domain-deployment-maps/{pathv2}?{query}Yes
deleteInfradomainsdomainIddomainDeploymentMapsdomainDeploymentMapId(domainid, domaindeploymentmapid, callback)Delete Domain Deployment Map{base_path}/{version}/infra/domains/{pathv1}/domain-deployment-maps/{pathv2}?{query}Yes
getInfradeploymentZones(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List Deployment Zones for infra{base_path}/{version}/infra/deployment-zones?{query}Yes
getInfradomainsdomainIdcommunicationMapcommunicationEntries(domainid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)List CommunicationEntries{base_path}/{version}/infra/domains/{pathv1}/communication-map/communication-entries?{query}Yes
postInfradomainsdomainIdcommunicationMapactionrevise(domainid, CommunicationMap, anchorPath, operation, callback)Revise the positioninng of communication maps{base_path}/{version}/infra/domains/{pathv1}/communication-map?{query}Yes
getInfrarealizedStateenforcementPointsenforcementPointNamemacSetsmacSetsNsxtmacSetName(enforcementpointname, macsetname, callback)Read MACSet Realized state{base_path}/{version}/infra/realized-state/enforcement-points/{pathv1}/mac-sets/mac-sets-nsxt/{pathv2}?{query}Yes
getInfrarealizedStateenforcementPointsenforcementPointNamegroupssecuritygroupssecuritygroupName(enforcementpointname, securitygroupname, callback)Read Group{base_path}/{version}/infra/realized-state/enforcement-points/{pathv1}/groups/securitygroups/{pathv2}?{query}Yes
postInfraservicesserviceId(serviceid, Service, callback)Create or update a Service{base_path}/{version}/infra/services/{pathv1}?{query}Yes
getInfraservicesserviceId(serviceid, callback)Read a service{base_path}/{version}/infra/services/{pathv1}?{query}Yes
deleteInfraservicesserviceId(serviceid, callback)Delete Service{base_path}/{version}/infra/services/{pathv1}?{query}Yes
postInfradeploymentZonesdeploymentZoneIdenforcementPointsenforcementpointId(deploymentzoneid, enforcementpointid, EnforcementPoint, callback)Create/update a new Enforcement Point under infra{base_path}/{version}/infra/deployment-zones/{pathv1}/enforcement-points/{pathv2}?{query}Yes
getInfradeploymentZonesdeploymentZoneIdenforcementPointsenforcementpointId(deploymentzoneid, enforcementpointid, callback)Read an Enforcement Point{base_path}/{version}/infra/deployment-zones/{pathv1}/enforcement-points/{pathv2}?{query}Yes
deleteInfradeploymentZonesdeploymentZoneIdenforcementPointsenforcementpointId(deploymentzoneid, enforcementpointid, callback)Delete EnforcementPoint{base_path}/{version}/infra/deployment-zones/{pathv1}/enforcement-points/{pathv2}?{query}Yes
postInfradomainsdomainIdgroupsgroupId(domainid, groupid, Group, callback)Create or update a group{base_path}/{version}/infra/domains/{pathv1}/groups/{pathv2}?{query}Yes
deleteInfradomainsdomainIdgroupsgroupId(domainid, groupid, force, callback)Delete Group{base_path}/{version}/infra/domains/{pathv1}/groups/{pathv2}?{query}Yes
getInfradomainsdomainIdgroupsgroupId(domainid, groupid, callback)Read group{base_path}/{version}/infra/domains/{pathv1}/groups/{pathv2}?{query}Yes
getInfracommunicationProfiles(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List CommunicationProfiles{base_path}/{version}/infra/communication-profiles?{query}Yes
getInfrarealizedStateenforcementPointsenforcementPointNameipSetsipSetsNsxtipSetName(enforcementpointname, ipsetname, callback)Read IPSet Realized state{base_path}/{version}/infra/realized-state/enforcement-points/{pathv1}/ip-sets/ip-sets-nsxt/{pathv2}?{query}Yes
getInfracommunicationProfilescommunicationProfileIdcommunicationProfileEntries(communicationprofileid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)List CommunicationProfileEntries for CommunicationProfile{base_path}/{version}/infra/communication-profiles/{pathv1}/communication-profile-entries?{query}Yes
postInfra(Infra, callback)Update the infra including all the nested entities{base_path}/{version}/infra?{query}Yes
getInfra(callback)Read infra{base_path}/{version}/infra?{query}Yes
postInfracommunicationProfilescommunicationProfileId(communicationprofileid, CommunicationProfile, callback)Create or update a CommunicationProfile{base_path}/{version}/infra/communication-profiles/{pathv1}?{query}Yes
getInfracommunicationProfilescommunicationProfileId(communicationprofileid, callback)Read CommunicationProfile{base_path}/{version}/infra/communication-profiles/{pathv1}?{query}Yes
deleteInfracommunicationProfilescommunicationProfileId(communicationprofileid, callback)Delete CommunicationProfile{base_path}/{version}/infra/communication-profiles/{pathv1}?{query}Yes
postInfracommunicationProfilescommunicationProfileIdcommunicationProfileEntriescommunicationProfileEntryId(communicationprofileid, communicationprofileentryid, CommunicationProfileEntry, callback)Create or update a CommunicationProfileEntry{base_path}/{version}/infra/communication-profiles/{pathv1}/communication-profile-entries/{pathv2}?{query}Yes
deleteInfracommunicationProfilescommunicationProfileIdcommunicationProfileEntriescommunicationProfileEntryId(communicationprofileid, communicationprofileentryid, callback)Delete CommunicationProfileEntry{base_path}/{version}/infra/communication-profiles/{pathv1}/communication-profile-entries/{pathv2}?{query}Yes
getInfracommunicationProfilescommunicationProfileIdcommunicationProfileEntriescommunicationProfileEntryId(communicationprofileid, communicationprofileentryid, callback)Read CommunicationProfileEntry{base_path}/{version}/infra/communication-profiles/{pathv1}/communication-profile-entries/{pathv2}?{query}Yes
getInfrarealizedStateenforcementPointsenforcementPointNameservicesnsservices(enforcementpointname, cursor, includedFields, pageSize, sortAscending, sortBy, callback)List Realized NSServices{base_path}/{version}/infra/realized-state/enforcement-points/{pathv1}/services/nsservices?{query}Yes
postTemplatestemplateId(templateid, PolicyTemplate, callback)Create or update a template.{base_path}/{version}/templates/{pathv1}?{query}Yes
getTemplatestemplateId(templateid, callback)Read template.{base_path}/{version}/templates/{pathv1}?{query}Yes
deleteTemplatestemplateId(templateid, callback)Delete template.{base_path}/{version}/templates/{pathv1}?{query}Yes
getInfraservicesserviceIdserviceEntries(serviceid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)List Service entries for the given service{base_path}/{version}/infra/services/{pathv1}/service-entries?{query}Yes
getInfrarealizedStateenforcementPointsenforcementPointNamefirewallsfirewallSections(enforcementpointname, cursor, includedFields, pageSize, sortAscending, sortBy, callback)List Firewall Sections{base_path}/{version}/infra/realized-state/enforcement-points/{pathv1}/firewalls/firewall-sections?{query}Yes
getInfraservices(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List Services for infra{base_path}/{version}/infra/services?{query}Yes
postInfradomainsdomainId(domainid, Domain, callback)Create or update a domain{base_path}/{version}/infra/domains/{pathv1}?{query}Yes
getInfradomainsdomainId(domainid, callback)Read domain{base_path}/{version}/infra/domains/{pathv1}?{query}Yes
deleteInfradomainsdomainId(domainid, callback)Delete Domain and all the entities contained by this domain{base_path}/{version}/infra/domains/{pathv1}?{query}Yes
getInfrarealizedStateenforcementPoints(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List Enforcement Points{base_path}/{version}/infra/realized-state/enforcement-points?{query}Yes
getInfradeploymentZonesdeploymentZoneId(deploymentzoneid, callback)Read a DeploymentZone{base_path}/{version}/infra/deployment-zones/{pathv1}?{query}Yes
getInfrarealizedStateenforcementPointsenforcementPointNamegroupsnsgroupsnsgroupName(enforcementpointname, nsgroupname, callback)Read Group{base_path}/{version}/infra/realized-state/enforcement-points/{pathv1}/groups/nsgroups/{pathv2}?{query}Yes
getInfrarealizedStateenforcementPointsenforcementPointNamemacSetsmacSetsNsxt(enforcementpointname, cursor, includedFields, pageSize, sortAscending, sortBy, callback)List MACSets{base_path}/{version}/infra/realized-state/enforcement-points/{pathv1}/mac-sets/mac-sets-nsxt?{query}Yes
getInfradomainsdomainIddomainDeploymentMaps(domainid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)List Domain Deployment maps for infra{base_path}/{version}/infra/domains/{pathv1}/domain-deployment-maps?{query}Yes
getInfrarealizedStateenforcementPointsenforcementPointName(enforcementpointname, callback)Read Enforcement Point{base_path}/{version}/infra/realized-state/enforcement-points/{pathv1}?{query}Yes
postInfradomainsdomainIdcommunicationMapcommunicationEntriescommunicationEntryId(domainid, communicationentryid, CommunicationEntry, callback)Create or update a CommunicationEntry{base_path}/{version}/infra/domains/{pathv1}/communication-map/communication-entries/{pathv2}?{query}Yes
deleteInfradomainsdomainIdcommunicationMapcommunicationEntriescommunicationEntryId(domainid, communicationentryid, callback)Delete CommunicationEntry{base_path}/{version}/infra/domains/{pathv1}/communication-map/communication-entries/{pathv2}?{query}Yes
getInfradomainsdomainIdcommunicationMapcommunicationEntriescommunicationEntryId(domainid, communicationentryid, callback)Read CommunicationEntry{base_path}/{version}/infra/domains/{pathv1}/communication-map/communication-entries/{pathv2}?{query}Yes
getInfradomains(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List domains for infra{base_path}/{version}/infra/domains?{query}Yes
postInfradomainsdomainIdcommunicationMap(domainid, CommunicationMap, callback)Update communication map{base_path}/{version}/infra/domains/{pathv1}/communication-map?{query}Yes
getInfradomainsdomainIdcommunicationMap(domainid, callback)Read communication-map{base_path}/{version}/infra/domains/{pathv1}/communication-map?{query}Yes
postTemplatestemplateIdactiondeploy(templateid, PolicyTemplateParameters, callback)Deploy template.{base_path}/{version}/templates/{pathv1}?{query}Yes
getInfradomainsdomainIdgroups(domainid, cursor, includedFields, pageSize, sortAscending, sortBy, callback)List Groups for a domain{base_path}/{version}/infra/domains/{pathv1}/groups?{query}Yes
getAaarolesrole(role, callback)Get role information{base_path}/{version}/aaa/roles/{pathv1}?{query}Yes
getAaauserInfo(callback)Get information about logged-in user{base_path}/{version}/aaa/user-info?{query}Yes
getAaavidmgroups(cursor, includedFields, pageSize, searchString, sortAscending, sortBy, callback)Get all the User Groups where vIDM display name matches the search key case insensitively. The search key is checked to be a substring of display name.{base_path}/{version}/aaa/vidm/groups?{query}Yes
getAaavidmusers(cursor, includedFields, pageSize, searchString, sortAscending, sortBy, callback)Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively. The search key is checked to be a substring of name or given name or family name.{base_path}/{version}/aaa/vidm/users?{query}Yes
putAaaroleBindingsbindingId(bindingid, RoleBinding, callback)Update User or Group's roles{base_path}/{version}/aaa/role-bindings/{pathv1}?{query}Yes
deleteAaaroleBindingsbindingId(bindingid, callback)Delete user/group's roles assignment{base_path}/{version}/aaa/role-bindings/{pathv1}?{query}Yes
getAaaroleBindingsbindingId(bindingid, callback)Get user/group's role information{base_path}/{version}/aaa/role-bindings/{pathv1}?{query}Yes
postAaaregistrationToken(callback)Create registration access token{base_path}/{version}/aaa/registration-token?{query}Yes
getAaaroles(callback)Get information about all roles{base_path}/{version}/aaa/roles?{query}Yes
postAaavidmsearch(cursor, includedFields, pageSize, searchString, sortAscending, sortBy, callback)Get all the users and groups from vIDM matching the search key case insensitively. The search key is checked to be a substring of name or given name or family name of user and display name of group.{base_path}/{version}/aaa/vidm/search?{query}Yes
deleteAaaregistrationTokentoken(token, callback)Delete registration access token{base_path}/{version}/aaa/registration-token/{pathv1}?{query}Yes
getAaaregistrationTokentoken(token, callback)Get registration access token{base_path}/{version}/aaa/registration-token/{pathv1}?{query}Yes
postAaaroleBindings(RoleBinding, callback)Assign roles to User or Group{base_path}/{version}/aaa/role-bindings?{query}Yes
getAaaroleBindings(cursor, includedFields, name, pageSize, sortAscending, sortBy, type, callback)Get all users and groups with their roles{base_path}/{version}/aaa/role-bindings?{query}Yes
getPoolsvniPools(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List VNI Pools{base_path}/{version}/pools/vni-pools?{query}Yes
getPoolsmacPools(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List MAC Pools{base_path}/{version}/pools/mac-pools?{query}Yes
postPoolsipSubnets(IpBlockSubnet, callback)Create subnet of specified size within an IP block{base_path}/{version}/pools/ip-subnets?{query}Yes
getPoolsipSubnets(blockId, cursor, includedFields, pageSize, sortAscending, sortBy, callback)List subnets within an IP block{base_path}/{version}/pools/ip-subnets?{query}Yes
getPoolsvtepLabelPools(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List virtual tunnel endpoint Label Pools{base_path}/{version}/pools/vtep-label-pools?{query}Yes
putPoolsipBlocksblockId(blockid, IpBlock, callback)Update an IP Address Block{base_path}/{version}/pools/ip-blocks/{pathv1}?{query}Yes
getPoolsipBlocksblockId(blockid, callback)Get IP address block information.{base_path}/{version}/pools/ip-blocks/{pathv1}?{query}Yes
deletePoolsipBlocksblockId(blockid, callback)Delete an IP Address Block{base_path}/{version}/pools/ip-blocks/{pathv1}?{query}Yes
getPoolsmacPoolspoolId(poolid, callback)Read MAC Pool{base_path}/{version}/pools/mac-pools/{pathv1}?{query}Yes
postPoolsipBlocks(IpBlock, callback)Create a new IP address block.{base_path}/{version}/pools/ip-blocks?{query}Yes
getPoolsipBlocks(cursor, includedFields, pageSize, sortAscending, sortBy, callback)Returns list of configured IP address blocks.{base_path}/{version}/pools/ip-blocks?{query}Yes
putPoolsvniPoolspoolId(poolid, VniPool, callback)Update a VNI Pool{base_path}/{version}/pools/vni-pools/{pathv1}?{query}Yes
getPoolsvniPoolspoolId(poolid, callback)Read VNI Pool{base_path}/{version}/pools/vni-pools/{pathv1}?{query}Yes
postPoolsipSubnetssubnetId(subnetid, AllocationIpAddress, action, callback)Allocate or Release an IP Address from a Ip Subnet{base_path}/{version}/pools/ip-subnets/{pathv1}?{query}Yes
deletePoolsipSubnetssubnetId(subnetid, callback)Delete subnet within an IP block{base_path}/{version}/pools/ip-subnets/{pathv1}?{query}Yes
getPoolsipSubnetssubnetId(subnetid, callback)Get the subnet within an IP block{base_path}/{version}/pools/ip-subnets/{pathv1}?{query}Yes
postPoolsipPools(IpPool, callback)Create an IP Pool{base_path}/{version}/pools/ip-pools?{query}Yes
getPoolsipPools(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List IP Pools{base_path}/{version}/pools/ip-pools?{query}Yes
putPoolsipPoolspoolId(poolid, IpPool, callback)Update an IP Pool{base_path}/{version}/pools/ip-pools/{pathv1}?{query}Yes
postPoolsipPoolspoolId(poolid, AllocationIpAddress, action, callback)Allocate or Release an IP Address from a Pool{base_path}/{version}/pools/ip-pools/{pathv1}?{query}Yes
getPoolsipPoolspoolId(poolid, callback)Read IP Pool{base_path}/{version}/pools/ip-pools/{pathv1}?{query}Yes
deletePoolsipPoolspoolId(poolid, force, callback)Delete an IP Pool{base_path}/{version}/pools/ip-pools/{pathv1}?{query}Yes
getPoolsvtepLabelPoolspoolId(poolid, callback)Read a virtual tunnel endpoint label pool{base_path}/{version}/pools/vtep-label-pools/{pathv1}?{query}Yes
getPoolsipPoolspoolIdallocations(poolid, callback)List IP Pool Allocations{base_path}/{version}/pools/ip-pools/{pathv1}/allocations?{query}Yes
postCsmawsgatewayAmis(AwsGatewayAmiInfo, callback)Registers a AWS Gateway AMI for the region specified in the body. One can register only one gateway AMI ID per region. If a gateway AMI is already registered with a region, user is expected to use update API to overwrite the registerd AMI for a region.{base_path}/{version}/csm/aws/gateway-amis?{query}Yes
getCsmawsgatewayAmis(cursor, includedFields, pageSize, regionId, sortAscending, sortBy, callback)Returns a list of Aws Gateway Amis{base_path}/{version}/csm/aws/gateway-amis?{query}Yes
getCsmawskeyPairs(accountId, cursor, includedFields, pageSize, regionId, sortAscending, sortBy, callback)Returns a list of Aws Key Pairs{base_path}/{version}/csm/aws/key-pairs?{query}Yes
getCsmawsgatewaysvpcIdstatus(vpcid, callback)Returns status information for primary gateway and secondary gateway for the vpc, if exists.{base_path}/{version}/csm/aws/gateways/{pathv1}/status?{query}Yes
putCsmawsgatewaysvpcId(vpcid, AwsGatewayDeployConfig, callback)Updates configuration for primary gateway and secondary gateway for the vpc, if exists.{base_path}/{version}/csm/aws/gateways/{pathv1}?{query}Yes
getCsmawsgatewaysvpcId(vpcid, callback)Returns configuration for primary gateway and secondary gateway for the vpc,if exists.{base_path}/{version}/csm/aws/gateways/{pathv1}?{query}Yes
getCsmawsregionsregionId(regionid, callback)Returns information about the particual Aws Region{base_path}/{version}/csm/aws/regions/{pathv1}?{query}Yes
postCsmawsgatewaysactiondeploy(AwsGatewayDeployConfig, callback)All the required configuration to deploy Aws gateways will be absorbed as a part of request body in this api and gateway deployment will be triggered.{base_path}/{version}/csm/aws/gateways?{query}Yes
getCsmcsmstatus(cursor, includedFields, pageSize, sortAscending, sortBy, callback)Return Csm status information{base_path}/{version}/csm/csmstatus?{query}Yes
getCsmawsvpcs(accountId, cidr, cursor, includedFields, opStatus, pageSize, regionId, sortAscending, sortBy, vpcId, callback)Returns a list of Vpcs. Support optional query parameters like account_id, region_id, cidr and/or op_status{base_path}/{version}/csm/aws/vpcs?{query}Yes
postCsmnsxManagerAccounts(NsxManagerAccount, callback)Create a NSX Manager account{base_path}/{version}/csm/nsx-manager-accounts?{query}Yes
getCsmnsxManagerAccounts(callback)Returns a list of NSX Manager accounts{base_path}/{version}/csm/nsx-manager-accounts?{query}Yes
getCsmawsregions(accountId, cursor, includedFields, pageSize, regionId, sortAscending, sortBy, callback)Returns a list of Aws regions{base_path}/{version}/csm/aws/regions?{query}Yes
getCsmvirtualMachinesvirtualMachineId(virtualmachineid, callback)Returns information about the particular virtual machine{base_path}/{version}/csm/virtual-machines/{pathv1}?{query}Yes
putCsmawsgatewayAmisregionId(regionid, AwsGatewayAmiInfo, callback)Update a AWS Gateway AMI{base_path}/{version}/csm/aws/gateway-amis/{pathv1}?{query}Yes
deleteCsmawsgatewayAmisregionId(regionid, callback)Delete a AWS Gateway AMI{base_path}/{version}/csm/aws/gateway-amis/{pathv1}?{query}Yes
getCsmawsgatewayAmisregionId(regionid, callback)Returns AWS Gateway AMI for a particular region{base_path}/{version}/csm/aws/gateway-amis/{pathv1}?{query}Yes
putCsmnsxManagerAccountsaccountId(accountid, NsxManagerAccount, callback)Update a NSX Manager account{base_path}/{version}/csm/nsx-manager-accounts/{pathv1}?{query}Yes
deleteCsmnsxManagerAccountsaccountId(accountid, callback)Delete a NSX Manager account{base_path}/{version}/csm/nsx-manager-accounts/{pathv1}?{query}Yes
getCsmnsxManagerAccountsaccountId(accountid, callback)Returns the particular NSX Manager account information{base_path}/{version}/csm/nsx-manager-accounts/{pathv1}?{query}Yes
postCsmawsaccountsaccountIdactionsyncInventory(accountid, callback)Synchronizes Aws account related inventory like Regions, Vpcs, Instances Status of inventory synchronization can be known from Aws account status api{base_path}/{version}/csm/aws/accounts/{pathv1}?{query}Yes
putCsmawsaccountsaccountId(accountid, AwsAccount, callback)Update a AWS account information{base_path}/{version}/csm/aws/accounts/{pathv1}?{query}Yes
deleteCsmawsaccountsaccountId(accountid, callback)Delete AWS account information{base_path}/{version}/csm/aws/accounts/{pathv1}?{query}Yes
getCsmawsaccountsaccountId(accountid, callback)Returns the details of the particular AWS account{base_path}/{version}/csm/aws/accounts/{pathv1}?{query}Yes
postCsmawsaccounts(AwsAccount, callback)Add a AWS account to cloud serivce manager{base_path}/{version}/csm/aws/accounts?{query}Yes
getCsmawsaccounts(cursor, includedFields, pageSize, regionId, sortAscending, sortBy, callback)Return a list of all AWS accounts{base_path}/{version}/csm/aws/accounts?{query}Yes
getCsmvirtualMachines(accountId, cursor, includedFields, instanceId, isGateway, logicalSwitchId, pageSize, publicIp, quarantineState, regionId, resourceType, sortAscending, sortBy, vpcId, callback)Returns the list of all virtual machines created or imported under a particular account id. Supports optional query parameters like region id, vpc id, public_ip, is_gateway.{base_path}/{version}/csm/virtual-machines?{query}Yes
postCsmawsgatewaysactionundeploy(AwsGatewayUndeployConfig, callback)All the required configuration to undeploy Aws gateways will be absorbed as a part of request body in this api and gateway undeployment will be triggered.{base_path}/{version}/csm/aws/gateways?{query}Yes
getCsmawsvpcsvpcId(vpcid, callback)Returns Vpc information{base_path}/{version}/csm/aws/vpcs/{pathv1}?{query}Yes
getCsmawssubnets(accountId, availabilityZoneName, cursor, includedFields, pageSize, regionName, sortAscending, sortBy, vpcId, callback)Returns a list of subnets{base_path}/{version}/csm/aws/subnets?{query}Yes
getCsmawsgateways(accountId, cursor, includedFields, pageSize, regionId, sortAscending, sortBy, vpcId, callback)Returns configuration information for all gateways{base_path}/{version}/csm/aws/gateways?{query}Yes
getCsmawsaccountsaccountIdstatus(accountid, callback)Return status of the account like credentails validity, inventory synchronization status and inventory synchronization state{base_path}/{version}/csm/aws/accounts/{pathv1}/status?{query}Yes
getFabricnodesnodeIdmodules(nodeid, callback)Get the module details of a Fabric Node{base_path}/{version}/fabric/nodes/{pathv1}/modules?{query}Yes
postFabricvirtualMachinesactionupdateTags(VirtualMachineTagUpdate, callback)Update tags applied to a virtual machine{base_path}/{version}/fabric/virtual-machines?{query}Yes
getFabriccomputeManagerscomputeManagerIdstatus(computemanagerid, callback)Return runtime status information for a compute manager{base_path}/{version}/fabric/compute-managers/{pathv1}/status?{query}Yes
getFabricnodesstatus(ReadNodesStatusRequestParameters, callback)Return Runtime Status Information for given Nodes{base_path}/{version}/fabric/nodes/status?{query}Yes
getFabriccomputeCollections(cmLocalId, cursor, discoveredNodeId, displayName, externalId, includedFields, nodeId, originId, originType, ownerId, pageSize, sortAscending, sortBy, callback)Return the List of Compute Collections{base_path}/{version}/fabric/compute-collections?{query}Yes
postFabricnodesnodeIdactionrestartInventorySync(nodeid, callback)Restart the inventory sync for the node if it is paused currently.{base_path}/{version}/fabric/nodes/{pathv1}?{query}Yes
postFabriccomputeCollectionFabricTemplates(ComputeCollectionFabricTemplate, callback)Create a compute collection fabric template{base_path}/{version}/fabric/compute-collection-fabric-templates?{query}Yes
getFabriccomputeCollectionFabricTemplates(computeCollectionId, callback)Get compute collection fabric templates{base_path}/{version}/fabric/compute-collection-fabric-templates?{query}Yes
getFabricvifs(cursor, hostId, includedFields, lportAttachmentId, ownerVmId, pageSize, sortAscending, sortBy, vmId, callback)Return the List of Virtual Network Interfaces (VIFs){base_path}/{version}/fabric/vifs?{query}Yes
getFabricnodesnodeIdnetworkinterfacesinterfaceId(nodeid, interfaceid, source, callback)Read the node's Network Interface{base_path}/{version}/fabric/nodes/{pathv1}/network/interfaces/{pathv2}?{query}Yes
getFabricdiscoveredNodesnodeExtId(nodeextid, callback)Return Discovered Node Information{base_path}/{version}/fabric/discovered-nodes/{pathv1}?{query}Yes
getFabricdiscoveredNodes(cmLocalId, cursor, displayName, externalId, hasParent, includedFields, ipAddress, nodeId, nodeType, originId, pageSize, parentComputeCollection, sortAscending, sortBy, callback)Return the List of Discovered Nodes{base_path}/{version}/fabric/discovered-nodes?{query}Yes
getFabriccomputeCollectionsccExtId(ccextid, callback)Return Compute Collection Information{base_path}/{version}/fabric/compute-collections/{pathv1}?{query}Yes
getFabricvirtualMachines(cursor, displayName, externalId, hostId, includedFields, pageSize, sortAscending, sortBy, callback)Return the List of Virtual Machines{base_path}/{version}/fabric/virtual-machines?{query}Yes
getFabricnodesnodeIdnetworkinterfaces(nodeid, source, callback)List the specified node's Network Interfaces{base_path}/{version}/fabric/nodes/{pathv1}/network/interfaces?{query}Yes
postFabricnodesnodeIdactionupgradeInfra(nodeid, disableVmMigration, callback)Perform a service deployment upgrade on a host node{base_path}/{version}/fabric/nodes/{pathv1}?{query}Yes
postFabriccomputeManagers(ComputeManager, callback)Register compute manager with NSX{base_path}/{version}/fabric/compute-managers?{query}Yes
getFabriccomputeManagers(cursor, includedFields, originType, pageSize, server, sortAscending, sortBy, callback)Return the List of Compute managers{base_path}/{version}/fabric/compute-managers?{query}Yes
getFabricnodesnodeIdstate(nodeid, callback)Get the Realized State of a Fabric Node{base_path}/{version}/fabric/nodes/{pathv1}/state?{query}Yes
postFabricdiscoveredNodesnodeExtIdactionhostprep(nodeextid, callback)Prepares discovered Node for NSX{base_path}/{version}/fabric/discovered-nodes/{pathv1}?{query}Yes
getFabriccomputeManagerscomputeManagerIdstate(computemanagerid, callback)Get the realized state of a compute manager{base_path}/{version}/fabric/compute-managers/{pathv1}/state?{query}Yes
getFabricnodesnodeIdcapabilities(nodeid, callback)Return the List of Capabilities of a Single Node{base_path}/{version}/fabric/nodes/{pathv1}/capabilities?{query}Yes
postFabricnodes(Node, callback)Register and Install NSX Components on a Node{base_path}/{version}/fabric/nodes?{query}Yes
getFabricnodes(cursor, discoveredNodeId, displayName, externalId, hypervisorOsType, includedFields, ipAddress, pageSize, resourceType, sortAscending, sortBy, callback)Return the List of Nodes{base_path}/{version}/fabric/nodes?{query}Yes
getFabricnodesnodeIdstatus(nodeid, source, callback)Return Runtime Status Information for a Node{base_path}/{version}/fabric/nodes/{pathv1}/status?{query}Yes
putFabriccomputeCollectionFabricTemplatesfabricTemplateId(fabrictemplateid, ComputeCollectionFabricTemplate, callback)Updates compute collection fabric template{base_path}/{version}/fabric/compute-collection-fabric-templates/{pathv1}?{query}Yes
getFabriccomputeCollectionFabricTemplatesfabricTemplateId(fabrictemplateid, callback)Get compute collection fabric template by id{base_path}/{version}/fabric/compute-collection-fabric-templates/{pathv1}?{query}Yes
deleteFabriccomputeCollectionFabricTemplatesfabricTemplateId(fabrictemplateid, callback)Deletes compute collection fabric template{base_path}/{version}/fabric/compute-collection-fabric-templates/{pathv1}?{query}Yes
putFabriccomputeManagerscomputeManagerId(computemanagerid, ComputeManager, callback)Update compute manager{base_path}/{version}/fabric/compute-managers/{pathv1}?{query}Yes
deleteFabriccomputeManagerscomputeManagerId(computemanagerid, callback)Unregister a compute manager{base_path}/{version}/fabric/compute-managers/{pathv1}?{query}Yes
getFabriccomputeManagerscomputeManagerId(computemanagerid, callback)Return compute manager Information{base_path}/{version}/fabric/compute-managers/{pathv1}?{query}Yes
putFabricnodesnodeId(nodeid, Node, callback)Update a Node{base_path}/{version}/fabric/nodes/{pathv1}?{query}Yes
postFabricnodesnodeId(nodeid, action, callback)Perform an Action on Fabric Node{base_path}/{version}/fabric/nodes/{pathv1}?{query}Yes
getFabricnodesnodeId(nodeid, callback)Return Node Information{base_path}/{version}/fabric/nodes/{pathv1}?{query}Yes
deleteFabricnodesnodeId(nodeid, unprepareHost, callback)Delete a Node{base_path}/{version}/fabric/nodes/{pathv1}?{query}Yes
getFabricnodesnodeIdnetworkinterfacesinterfaceIdstats(nodeid, interfaceid, source, callback)Read the NSX Manager's Network Interface Statistics{base_path}/{version}/fabric/nodes/{pathv1}/network/interfaces/{pathv2}/stats?{query}Yes
putTransportNodestransportnodeId(transportnodeid, TransportNode, esxMgmtIfMigrationDest, ifId, callback)Update a Transport Node{base_path}/{version}/transport-nodes/{pathv1}?{query}Yes
postTransportNodestransportnodeId(transportnodeid, action, callback)Update transport node maintenance mode{base_path}/{version}/transport-nodes/{pathv1}?{query}Yes
deleteTransportNodestransportnodeId(transportnodeid, callback)Delete a Transport Node{base_path}/{version}/transport-nodes/{pathv1}?{query}Yes
getTransportNodestransportnodeId(transportnodeid, callback)Get a Transport Node{base_path}/{version}/transport-nodes/{pathv1}?{query}Yes
postComputeCollectionTransportNodeTemplates(ComputeCollectionTransportNodeTemplate, callback)Create transport node template for compute collection.{base_path}/{version}/compute-collection-transport-node-templates?{query}Yes
getComputeCollectionTransportNodeTemplates(computeCollectionId, callback)List compute collection transportnode templates{base_path}/{version}/compute-collection-transport-node-templates?{query}Yes
postBridgeEndpoints(BridgeEndpoint, callback)Create a Bridge Endpoint{base_path}/{version}/bridge-endpoints?{query}Yes
getBridgeEndpoints(bridgeClusterId, cursor, includedFields, logicalSwitchId, pageSize, sortAscending, sortBy, callback)List All Bridge Endpoints{base_path}/{version}/bridge-endpoints?{query}Yes
getTransportZoneszoneIdsummary(zoneid, callback)Get a Transport Zone's Current Runtime Status Information{base_path}/{version}/transport-zones/{pathv1}/summary?{query}Yes
putEdgeClustersedgeClusterId(edgeclusterid, EdgeCluster, callback)Update Edge Cluster{base_path}/{version}/edge-clusters/{pathv1}?{query}Yes
deleteEdgeClustersedgeClusterId(edgeclusterid, callback)Delete Edge Cluster{base_path}/{version}/edge-clusters/{pathv1}?{query}Yes
getEdgeClustersedgeClusterId(edgeclusterid, callback)Read Edge Cluster{base_path}/{version}/edge-clusters/{pathv1}?{query}Yes
putHostSwitchProfileshostSwitchProfileId(hostswitchprofileid, BaseHostSwitchProfile, callback)Update a Hostswitch Profile{base_path}/{version}/host-switch-profiles/{pathv1}?{query}Yes
getHostSwitchProfileshostSwitchProfileId(hostswitchprofileid, callback)Get a Hostswitch Profile by ID{base_path}/{version}/host-switch-profiles/{pathv1}?{query}Yes
deleteHostSwitchProfileshostSwitchProfileId(hostswitchprofileid, callback)Delete a Hostswitch Profile{base_path}/{version}/host-switch-profiles/{pathv1}?{query}Yes
getBridgeEndpointsendpointIdstatus(endpointid, source, callback)Returns status of a specified Bridge Endpoint{base_path}/{version}/bridge-endpoints/{pathv1}/status?{query}Yes
putBridgeEndpointsbridgeendpointId(bridgeendpointid, BridgeEndpoint, callback)Update a Bridge Endpoint{base_path}/{version}/bridge-endpoints/{pathv1}?{query}Yes
getBridgeEndpointsbridgeendpointId(bridgeendpointid, callback)Get Information about a bridge endpoint{base_path}/{version}/bridge-endpoints/{pathv1}?{query}Yes
deleteBridgeEndpointsbridgeendpointId(bridgeendpointid, callback)Delete a Bridge Endpoint{base_path}/{version}/bridge-endpoints/{pathv1}?{query}Yes
postEdgeClusters(EdgeCluster, callback)Create Edge Cluster{base_path}/{version}/edge-clusters?{query}Yes
getEdgeClusters(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List Edge Clusters{base_path}/{version}/edge-clusters?{query}Yes
postTransportNodestransportnodeIdactionresyncHostConfig(transportnodeid, callback)Resync a Transport Node{base_path}/{version}/transport-nodes/{pathv1}?{query}Yes
postBridgeClusters(BridgeCluster, callback)Create a Bridge Cluster{base_path}/{version}/bridge-clusters?{query}Yes
getBridgeClusters(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List All Bridge Clusters{base_path}/{version}/bridge-clusters?{query}Yes
putClusterProfilesclusterProfileId(clusterprofileid, ClusterProfile, callback)Update a cluster profile{base_path}/{version}/cluster-profiles/{pathv1}?{query}Yes
deleteClusterProfilesclusterProfileId(clusterprofileid, callback)Delete a cluster profile{base_path}/{version}/cluster-profiles/{pathv1}?{query}Yes
getClusterProfilesclusterProfileId(clusterprofileid, callback)Get cluster profile by Id{base_path}/{version}/cluster-profiles/{pathv1}?{query}Yes
getLldptransportNodesnodeIdinterfacesinterfaceName(nodeid, interfacename, callback)Read LLDP Neighbor Properties{base_path}/{version}/lldp/transport-nodes/{pathv1}/interfaces/{pathv2}?{query}Yes
postEdgeClustersedgeClusterIdactionreplaceTransportNode(edgeclusterid, EdgeClusterMemberTransportNode, callback)Replace the transport node in the specified member of the edge-cluster{base_path}/{version}/edge-clusters/{pathv1}?{query}Yes
getBridgeClustersclusterIdstatus(clusterid, source, callback)Returns status of a specified Bridge Cluster{base_path}/{version}/bridge-clusters/{pathv1}/status?{query}Yes
getComputeCollectionTransportNodeTemplatestemplateIdstate(templateid, computeCollectionId, cursor, includedFields, pageSize, sortAscending, sortBy, callback)Get compute collection transportnode template application states{base_path}/{version}/compute-collection-transport-node-templates/{pathv1}/state?{query}Yes
postHostSwitchProfiles(BaseHostSwitchProfile, callback)Create a Hostswitch Profile{base_path}/{version}/host-switch-profiles?{query}Yes
getHostSwitchProfiles(cursor, hostswitchProfileType, includeSystemOwned, includedFields, pageSize, sortAscending, sortBy, callback)List Hostswitch Profiles{base_path}/{version}/host-switch-profiles?{query}Yes
postTransportZones(TransportZone, callback)Create a Transport Zone{base_path}/{version}/transport-zones?{query}Yes
getTransportZones(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List Transport Zones{base_path}/{version}/transport-zones?{query}Yes
putTransportZoneszoneId(zoneid, TransportZone, callback)Update a Transport Zone{base_path}/{version}/transport-zones/{pathv1}?{query}Yes
getTransportZoneszoneId(zoneid, callback)Get a Transport Zone{base_path}/{version}/transport-zones/{pathv1}?{query}Yes
deleteTransportZoneszoneId(zoneid, callback)Delete a Transport Zone{base_path}/{version}/transport-zones/{pathv1}?{query}Yes
getTransportNodestransportnodeIdstate(transportnodeid, callback)Get a Transport Node's State{base_path}/{version}/transport-nodes/{pathv1}/state?{query}Yes
postTransportNodes(TransportNode, callback)Create a Transport Node{base_path}/{version}/transport-nodes?{query}Yes
getTransportNodes(cursor, inMaintenanceMode, includedFields, nodeId, nodeIp, nodeTypes, pageSize, sortAscending, sortBy, transportZoneId, callback)List Transport Nodes{base_path}/{version}/transport-nodes?{query}Yes
postClusterProfiles(ClusterProfile, callback)Create a Cluster Profile{base_path}/{version}/cluster-profiles?{query}Yes
getClusterProfiles(cursor, includeSystemOwned, includedFields, pageSize, resourceType, sortAscending, sortBy, callback)List Cluster Profiles{base_path}/{version}/cluster-profiles?{query}Yes
getLldptransportNodesnodeIdinterfaces(nodeid, callback)List LLDP Neighbor Properties{base_path}/{version}/lldp/transport-nodes/{pathv1}/interfaces?{query}Yes
putBridgeClustersbridgeclusterId(bridgeclusterid, BridgeCluster, callback)Update a Bridge Cluster{base_path}/{version}/bridge-clusters/{pathv1}?{query}Yes
deleteBridgeClustersbridgeclusterId(bridgeclusterid, callback)Delete a Bridge Cluster{base_path}/{version}/bridge-clusters/{pathv1}?{query}Yes
getBridgeClustersbridgeclusterId(bridgeclusterid, callback)Get Information about a bridge cluster{base_path}/{version}/bridge-clusters/{pathv1}?{query}Yes
putComputeCollectionTransportNodeTemplatestemplateId(templateid, ComputeCollectionTransportNodeTemplate, callback)Update compute collection transportnode template{base_path}/{version}/compute-collection-transport-node-templates/{pathv1}?{query}Yes
getComputeCollectionTransportNodeTemplatestemplateId(templateid, callback)Get compute collection transportnode template by id{base_path}/{version}/compute-collection-transport-node-templates/{pathv1}?{query}Yes
deleteComputeCollectionTransportNodeTemplatestemplateId(templateid, callback)Delete a compute collection transport node template{base_path}/{version}/compute-collection-transport-node-templates/{pathv1}?{query}Yes
getBridgeEndpointsendpointIdstatistics(endpointid, source, callback)Returns statistics of a specified Bridge Endpoint{base_path}/{version}/bridge-endpoints/{pathv1}/statistics?{query}Yes
putTransportzoneProfilestransportzoneProfileId(transportzoneprofileid, TransportZoneProfile, callback)Update a transport zone profile{base_path}/{version}/transportzone-profiles/{pathv1}?{query}Yes
deleteTransportzoneProfilestransportzoneProfileId(transportzoneprofileid, callback)Delete a transport zone Profile{base_path}/{version}/transportzone-profiles/{pathv1}?{query}Yes
getTransportzoneProfilestransportzoneProfileId(transportzoneprofileid, callback)Get transport zone profile by identifier{base_path}/{version}/transportzone-profiles/{pathv1}?{query}Yes
getTransportNodesstate(mmState, status, vtepIp, callback)List transport nodes by realized state{base_path}/{version}/transport-nodes/state?{query}Yes
postTransportzoneProfiles(TransportZoneProfile, callback)Create a transport zone Profile{base_path}/{version}/transportzone-profiles?{query}Yes
getTransportzoneProfiles(cursor, includeSystemOwned, includedFields, pageSize, resourceType, sortAscending, sortBy, callback)List transport zone profiles{base_path}/{version}/transportzone-profiles?{query}Yes
putIpfixconfigsconfigId(configid, IpfixConfig, callback)Update an existing IPFIX configuration{base_path}/{version}/ipfix/configs/{pathv1}?{query}Yes
deleteIpfixconfigsconfigId(configid, callback)Delete an existing IPFIX configuration{base_path}/{version}/ipfix/configs/{pathv1}?{query}Yes
getIpfixconfigsconfigId(configid, callback)Get an existing IPFIX configuration{base_path}/{version}/ipfix/configs/{pathv1}?{query}Yes
postIpfixconfigs(IpfixConfig, callback)Create a new IPFIX configuration{base_path}/{version}/ipfix/configs?{query}Yes
getIpfixconfigs(appliedTo, cursor, includedFields, ipfixConfigType, pageSize, sortAscending, sortBy, callback)List IPFIX configuration{base_path}/{version}/ipfix/configs?{query}Yes
postIpfixcollectorconfigs(IpfixCollectorConfig, callback)Create a new IPFIX collector configuration{base_path}/{version}/ipfix/collectorconfigs?{query}Yes
getIpfixcollectorconfigs(cursor, includedFields, pageSize, sortAscending, sortBy, callback)List IPFIX collector configurations{base_path}/{version}/ipfix/collectorconfigs?{query}Yes
putIpfixcollectorconfigscollectorConfigId(collectorconfigid, IpfixCollectorConfig, callback)Update an existing IPFIX collector configuration{base_path}/{version}/ipfix/collectorconfigs/{pathv1}?{query}Yes
deleteIpfixcollectorconfigscollectorConfigId(collectorconfigid, callback)Delete an existing IPFIX collector configuration{base_path}/{version}/ipfix/collectorconfigs/{pathv1}?{query}Yes
getIpfixcollectorconfigscollectorConfigId(collectorconfigid, callback)Get an existing IPFIX collector configuration{base_path}/{version}/ipfix/collectorconfigs/{pathv1}?{query}Yes
getNormalizations(cursor, includedFields, pageSize, preferredNormalizationType, resourceId, resourceType, sortAscending, sortBy, callback)Get normalizations based on the query parameters{base_path}/{version}/normalizations?{query}Yes
getRealizationStateBarriercurrent(callback)Gets the current barrier number{base_path}/{version}/realization-state-barrier/current?{query}Yes
postRealizationStateBarriercurrentactionincrement(callback)Increments the barrier count by 1{base_path}/{version}/realization-state-barrier/current?{query}Yes
putRealizationStateBarrierconfig(RealizationStateBarrierConfig, callback)Updates the barrier configuration{base_path}/{version}/realization-state-barrier/config?{query}Yes
getRealizationStateBarrierconfig(callback)Gets the realization state barrier configuration{base_path}/{version}/realization-state-barrier/config?{query}Yes
getTransportNodesnodeIdtunnels(nodeid, bfdDiagnosticCode, cursor, includedFields, pageSize, remoteNodeId, sortAscending, sortBy, source, status, callback)List of tunnels{base_path}/{version}/transport-nodes/{pathv1}/tunnels?{query}Yes
getTransportNodesnodeIdtunnelstunnelName(nodeid, tunnelname, source, callback)Tunnel properties{base_path}/{version}/transport-nodes/{pathv1}/tunnels/{pathv2}?{query}Yes
getAssociations(associatedResourceType, cursor, fetchAncestors, includedFields, pageSize, resourceId, resourceType, sortAscending, sortBy, callback)Get ResourceReference objects to which the given resource belongs to{base_path}/{version}/associations?{query}Yes
putUiViewsdashboardwidgetconfigurationswidgetconfigurationId(widgetconfigurationid, WidgetConfiguration, callback)Update Widget Configuration{base_path}/{version}/ui-views/dashboard/widgetconfigurations/{pathv1}?{query}Yes
getUiViewsdashboardwidgetconfigurationswidgetconfigurationId(widgetconfigurationid, callback)Returns Widget Configuration Information{base_path}/{version}/ui-views/dashboard/widgetconfigurations/{pathv1}?{query}Yes
deleteUiViewsdashboardwidgetconfigurationswidgetconfigurationId(widgetconfigurationid, callback)Delete Widget Configuration{base_path}/{version}/ui-views/dashboard/widgetconfigurations/{pathv1}?{query}Yes
postUiViewsdashboardwidgetconfigurations(WidgetConfiguration, callback)Creates a new Widget Configuration.{base_path}/{version}/ui-views/dashboard/widgetconfigurations?{query}Yes
getUiViewsdashboardwidgetconfigurations(container, widgetIds, callback)Returns the Widget Configurations based on query criteria defined in WidgetQueryParameters.{base_path}/{version}/ui-views/dashboard/widgetconfigurations?{query}Yes
getErrorResolvererrorId(errorId, callback)Fetches metadata about the given error_id{base_path}/{version}/error-resolver/{pathv1}?{query}Yes
getErrorResolver(callback)Fetches a list of metadata for all the registered error resolvers{base_path}/{version}/error-resolver?{query}Yes
postErrorResolveractionresolveError(ErrorResolverMetadataList, callback)Resolves the error{base_path}/{version}/error-resolver?{query}Yes
putNodeaaaauthPolicy(AuthenticationPolicyProperties, callback)Update node authentication policy configuration{base_path}/{version}/node/aaa/auth-policy?{query}Yes
getNodeaaaauthPolicy(callback)Read node authentication policy configuration{base_path}/{version}/node/aaa/auth-policy?{query}Yes
getTaskstaskId(taskid, callback)Get information about the specified task{base_path}/{version}/tasks/{pathv1}?{query}Yes
postBatch(BatchRequest, atomic, callback)Register a Collection of API Calls at a Single End Point{base_path}/{version}/batch?{query}Yes
getTasks(cursor, includedFields, pageSize, requestUri, sortAscending, sortBy, status, user, callback)Get information about all tasks{base_path}/{version}/tasks?{query}Yes
getTaskstaskIdresponse(taskid, callback)Get the response of a task{base_path}/{version}/tasks/{pathv1}/response?{query}Yes

Authentication

This document will go through the steps for authenticating the VMware NSX-T adapter with Basic Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication HERE.

Basic Authentication

The VMware NSX-T adapter requires Basic Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.

STEPS

  1. Ensure you have access to a VMware NSX-T 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": "basic user_password",
    "username": "<username>",
    "password": "<password>",
    "token": "",
    "token_timeout": 1800000,
    "token_cache": "local",
    "invalid_token_error": 401,
    "auth_field": "header.headers.Authorization",
    "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
    "auth_logging": false,
    "client_id": "",
    "client_secret": "",
    "grant_type": ""
    }
  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.
  • 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-vmware_nsx_t
cd adapter-vmware_nsx_t
npm run adapter:update

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

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

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

Adding Adapter Properties

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

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

Changing Adapter Authentication

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

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

Enhancing Adapter Integration Tests

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

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

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

Contributing

First off, thanks for taking the time to contribute!

The following is a set of rules for contributing.

Code of Conduct

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

How to Contribute

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

Helpful Links

Adapter Technical Resources

Node Scripts

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

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

Troubleshoot

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

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

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

Connectivity Issues

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