Manage Feature Deployment | NSX Application Platform Cluster API

Manage Feature Deployment

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

URI

POST

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

COPY

Path Parameters

Feature

feature

Required

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

Request Body

Information required to install helm chart.

FeatureDeploymentRequest of type(s) application/json

Required

{
    "action": "string",
    "disable_hooks": false
}

DeploymentAction

action

Required

The deployment action to be performed for the given feature.

boolean

disable_hooks

Optional

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

Authentication

This operation uses the following authentication methods.

x_nsx_roles

Responses

202

Feature (un)deployment action completed successfully.

Returns FeatureDeploymentStatus of type(s) application/json

{
    "feature": "string",
    "status": "string",
    "reason": "string"
}

Feature

feature

Required

feature

DeploymentStatus

status

Required

Deployment status of the given feature.

string

reason

Optional

Detailed reason for the status, if available.

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.

Returns Error of type(s) application/json

{
    "code": 0,
    "message": "string"
}

integer As int32 As int32

code

Required

Error code refers to either HTTP status code OR a unique code identifying the internal error - which can be referenced in VMware documents for more information.

string

message

Required

Descriptive user understandable error message to help identify root cause of the error.

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

202 Response Body