NSX-T Data Center REST API

Patch NSX Application Platform Common Agent host configuration

Patch the current NSX Application Platform Common Agent host configuration.
Return error if NSX Application Platform Common Agent is not registered with NSX.
"private_ip_range" is the only field allowed to patch.

Request:

Method:
PATCH
URI Path(s):
/policy/api/v1/infra/napp/common-agent/host-config
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
CommonAgentHostConfigurationInfo+

Example Request:

PATCH https://<policy-mgt>/api/v1/infra/napp/common-agent/host-config { "private_ip_range": [ { "address_type": "IPV4", "address": "10.10.0.0", "prefix_length": 8 }, { "address_type": "IPV4", "address": "172.18.0.0", "prefix_length": 12 }, { "address_type": "IPV4", "address": "192.169.0.0", "prefix_length": 16 } ] }

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
CommonAgentHostConfigurationInfo+

Example Response:

{ "kafka_endpoint": [ { "address": "127.0.0.1", "port": 9092 } ], "kafka_certificate": "pem-encoded-cert-value", "ingress_endpoint": [ { "address": "127.0.0.1", "port": 9092 } ], "ingress_certificate": "pem-encoded-cert-value", "truststore": "pem-encoded-cert-value", "nsx_cluster_id": "cluster-id-string", "private_ip_range": [ { "address_type": "IPV4", "address": "10.10.0.0", "prefix_length": 8 }, { "address_type": "IPV4", "address": "172.18.0.0", "prefix_length": 12 }, { "address_type": "IPV4", "address": "192.169.0.0", "prefix_length": 16 } ] }

Required Permissions:

crud

Feature:

policy_napp

Additional Errors: