Update Cloud Connector Feature Configurations

Update feature configurations.

NOTE: Once a Cloud Connector instance has been deployed, configuration updates are accepted for staging but do not affect any deployed instance until the Cloud Connector is removed and re-deployed. Unlike most verticals, the Cloud Connector cannot be deployed directly; instead it is deployed automatically as dependency of other verticals (e.g., NDR or Malware Prevention).

If no Cloud Connector configuration has been staged, deploying verticals requiring a Cloud Connector will fail with an appropriate error.

Request

URI

PATCH

https://{api_host}/napp/api/v1/platform/features/cloud-connector/config

COPY

Request Body

Feature configurations

CloudConnectorRegion of type(s) application/json

Required

{
    "fqdn": "nsx.west.us.lastline.com",
    "region": "west.us",
    "region_name": "US 1"
}

string

fqdn

Required

FQDN of the Cloud Connector region

string

region

Required

Cloud Connector region identifier

string

region_name

Required

Human-readable name of the Cloud Connector region

Authentication

This operation uses the following authentication methods.

x_nsx_roles

Responses

200

Patch operation completed successfully.

Returns FeatureConfigurationCloudConnector of type(s) application/json

This response body class contains all of the following: CommonFeatureConfiguration , CloudConnectorRegion , InlineFeatureConfigurationCloudConnector2

{
    "feature_name": "string",
    "chart_repo": "string",
    "docker_registry": "string",
    "precheck_chart_name": "string",
    "precheck_chart_version": "string",
    "deployment_chart_name": "string",
    "deployment_chart_version": "string",
    "storage_class": "string",
    "fqdn": "nsx.west.us.lastline.com",
    "region": "west.us",
    "region_name": "US 1",
    "configurable": false
}

default

error

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

Request Body

Authentication

Response

200 Response Body

Errors