System Administration > Configuration > NSX Intelligence

Associated URIs:

API Description API Path

Get NSX-Intelligence host configuration


Deprecated - Please use the intelligence API /napp/api/v1/intelligence/data-collection/host-config
instead, after installing NSX Intelligence.
Get the current NSX-Intelligence host configuration.
Recommend to keep the value same for flow_data_collection_interval
and context_data_collection_interval.
GET /api/v1/intelligence/host-config (Deprecated)

Patch NSX-Intelligence host configuration


Deprecated - Please use the intelligence API /napp/api/v1/intelligence/data-collection/host-config
instead, after installing NSX Intelligence.
Patch the current NSX-Intelligence host configuration.
Return error if NSX-Intelligence is not registered with NSX.
PATCH /api/v1/intelligence/host-config (Deprecated)

Reset NSX-Intelligence host configuration


Deprecated - Please use the intelligence API /napp/api/v1/intelligence/data-collection/host-config?action=reset
instead, after installing NSX Intelligence.
Reset NSX-Intelligence host configuration to the default setting.
Clear NSX-Intelligence host configuration if NSX-Intelligence is not registered with NSX.
Return the NSX-Intelligence host configuration after reset operation.
POST /api/v1/intelligence/host-config?action=reset (Deprecated)

Returns info for all cluster node VM auto-deployment attempts


Returns request information for every attempted deployment of a cluster
node VM.
GET /api/v1/intelligence/nodes/deployments

Deploy and register a Intelligence cluster node VM


Deploys a Intelligence cluster node VM as specified by the deployment config.
POST /api/v1/intelligence/nodes/deployments (Deprecated)

Returns info for a Intelligence cluster node VM auto-deployment attempt


Returns deployment request information for a specific attempted
deployment of a cluster node VM.
GET /api/v1/intelligence/nodes/deployments/<node-id>

Attempt to delete an auto-deployed cluster node VM


Attempts to unregister and undeploy a specified auto-deployed cluster
node VM. If it is a member of a cluster, then the VM will be automatically
detached from the cluster before being unregistered and undeployed.
Alternatively, if the original deployment attempt failed or the VM is
not found, cleans up the deployment information associated with the
deployment attempt.
Note: If a VM has been successfully auto-deployed, then the associated
deployment information will not be deleted unless and until the VM is
successfully deleted.
POST /api/v1/intelligence/nodes/deployments/<node-id>?action=delete

Returns the status of the VM creation/deletion


Returns the current deployment or undeployment status for a VM along with
any other relevant current information, such as error messages.
GET /api/v1/intelligence/nodes/deployments/<node-id>/status

List available Napp appliance form factors


Returns information about all form factors available for Napp cluster
GET /api/v1/node/intelligence/form-factors (Deprecated)
GET /api/v1/cluster/<cluster-node-id>/node/intelligence/form-factors (Deprecated)

Get list of bundle-ids which are available in repository or in-progress


Get list of bundle-ids which are available in repository or in-progress
GET /api/v1/repository/bundles

Upload bundle using remote file


Upload the bundle from remote bundle URL. The call returns after fetch is initiated.
Check status by periodically retrieving bundle upload status
using GET /repository/bundles/<bundle-id>/upload-status.
The upload is complete when the status is SUCCESS.
POST /api/v1/repository/bundles

Upload bundle


Upload the bundle. This call returns after upload is completed.
You can check bundle processing status periodically by retrieving
bundle upload-status to find out if the upload and processing is completed.
POST /api/v1/repository/bundles?action=upload

Cancel bundle upload


Cancel upload of bundle. This API works only when bundle upload is
in-progress and will not work during post-processing of bundle. If
bundle upload is in-progress, then the API call returns http OK response
after cancelling the upload and deleting partially uploaded bundle.
POST /api/v1/repository/bundles/<bundle-id>?action=cancel_upload

Get bundle upload status


Get uploaded bundle upload status
GET /api/v1/repository/bundles/<bundle-id>/upload-status

Get information of the OVF which will be getting deployed.


Get information of the OVF for specified appliance which is
present in repository and will be used to deploy new VM.
GET /api/v1/repository/bundles/ovf-deploy-info

Checks bundle upload permissions


Checks whether bundle upload is allowed on given node for given appliance.
There are different kinds of checks for different appliances. Some of the
checks for Intelligence appliance are as follows:
1. Is bundle upload-allowed on given node
2. Is bundle upload already in-progress
GET /api/v1/repository/bundles/upload-allowed