[{"label":"Latest (v1.0)","version":"latest"}]
nsx-intelligence-and-application-platform

Manage Feature Deployment

Description

Perform one of the deployment related actions for the given feature. Possible actions on feature include DEPLOY, UNDEPLOY, or UPDATE.

NOTE: typical end-user driven actions are DEPLOY and/or UNDEPLOY. UPDATE is reserved for internal operations and may have unexpected consequences when executed directly by end-user.

Request

Request

URL

URL


post
https://{api_host}/napp/api/v1/platform/features/{feature}
Copy

Path Parameters

Path Parameters

string
feature Required

Name of the feature for which deployment action is to be performed. Please refer Feature enum for precise name.


Request Body

Request Body

FeatureDeploymentRequest of mimetype application/json Required

Information required to install helm chart.

{
	"action": "DEPLOY"
}
action Required

The deployment action to be performed for the given feature.

Possible values are: DEPLOYUNDEPLOYUPDATE


boolean
disable_hooks Optional

If set to true, will perform deployment action witout running hooks. This option only applies to undeploy action. Undeploy with this option without proper cleanup, may leave the system in inconsistent state.

Authentication

Authentication

This operation uses the following authentication methods.

x_nsx_roles

Scopes: enterprise_admin

Response

Response

Response Body

Response Body

202 Accepted returns FeatureDeploymentStatus of type application/json

Feature (un)deployment action completed successfully.

{
	"feature": "malware-prevention",
	"reason": "string",
	"status": "DEPLOYMENT_IN_PROGRESS"
}
feature Required

Possible values are: malware-preventioncloud-connectorintelligenceintelligence-migrationmetricsndrreputation-service


status Required

Deployment status of the given feature.

Possible values are: DEPLOYMENT_IN_PROGRESSDEPLOYMENT_SUCCESSFULDEPLOYMENT_FAILEDUNDEPLOYMENT_IN_PROGRESSUNDEPLOYMENT_FAILEDNOT_DEPLOYEDUNKNOWN


string
reason Optional

Detailed reason for the status, if available.

Errors

Errors

default

An error occurred while executing the deployment related action. Since the deployment is handled by an external process in an asynchronous manner, precise error may not be available via API response. Please inspect logs for cluster-api pod to identify the error. Check the troubleshooting guide for more information and recovery steps.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"action":"DEPLOY","disable_hooks":false}' https://{api_host}/napp/api/v1/platform/features/{feature}


Feedback

Was this page helpful?