| API Description | API Path |
|---|---|
Get NSX-Intelligence host configurationGet 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
|
Patch NSX-Intelligence host configurationPatch the current NSX-Intelligence host configuration. Return error if NSX-Intelligence is not registered with NSX. |
PATCH /api/v1/intelligence/host-config
|
Reset NSX-Intelligence host configurationReset 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
|
Returns info for all cluster node VM auto-deployment attemptsReturns request information for every attempted deployment of a cluster node VM. |
GET /api/v1/intelligence/nodes/deployments
|
Deploy and register a Intelligence cluster node VMDeploys a Intelligence cluster node VM as specified by the deployment config. |
POST /api/v1/intelligence/nodes/deployments
|
Returns info for a Intelligence cluster node VM auto-deployment attemptReturns 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 VMAttempts 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/deletionReturns 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 NSX Intelligence appliance form factorsReturns information about all form factors available for intelligence nodes |
GET /api/v1/node/intelligence/form-factors
GET /api/v1/transport-nodes/<transport-node-id>/node/intelligence/form-factors GET /api/v1/cluster/<cluster-node-id>/node/intelligence/form-factors |
Update the async_replicator service properties |
PUT /api/v1/node/services/async_replicator
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/async_replicator PUT /api/v1/cluster/<cluster-node-id>/node/services/async_replicator |
Read intelligence upgrade coordinator service properties |
GET /api/v1/node/services/intelligence-upgrade-coordinator
GET /api/v1/transport-nodes/<transport-node-id>/node/services/intelligence-upgrade-coordinator GET /api/v1/cluster/<cluster-node-id>/node/services/intelligence-upgrade-coordinator |
Restart, start or stop the intelligence upgrade coordinator service |
POST /api/v1/node/services/intelligence-upgrade-coordinator?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/intelligence-upgrade-coordinator?action=start|stop|restart POST /api/v1/cluster/<cluster-node-id>/node/services/intelligence-upgrade-coordinator?action=start|stop|restart |
Read intelligence upgrade coordinator service status |
GET /api/v1/node/services/intelligence-upgrade-coordinator/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/intelligence-upgrade-coordinator/status GET /api/v1/cluster/<cluster-node-id>/node/services/intelligence-upgrade-coordinator/status |
Get list of bundle-ids which are available in repository or in-progressGet list of bundle-ids which are available in repository or in-progress |
GET /api/v1/repository/bundles
|
Upload bundleUpload 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
|
Upload bundle using remote fileUpload 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/ The upload is complete when the status is SUCCESS. |
POST /api/v1/repository/bundles
|
Cancel bundle uploadCancel 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 statusGet 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 product which is present in repository and will be used to deploy new VM. |
GET /api/v1/repository/bundles/ovf-deploy-info
|
Checks bundle upload permissionsChecks whether bundle upload is allowed on given node for given product. There are different kinds of checks for different products. Some of the checks for Intelligence product are as follows: 1. Is bundle upload-allowed on given node 2. Is bundle upload already in-progress 3. Is Intelliegnce node deployment in-progress 4. Is Intelliegnce node upgrade in-progress |
GET /api/v1/repository/bundles/upload-allowed
|