NSX-T Data Center REST API

CommonAgentHostConfigurationInfo (schema)

NSX Application Platform Common Agent host configuration

NSX Application Platform Common Agent configuration that can be applied to host nodes.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
int
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
Sortable
id Unique identifier of this resource string Sortable
ingress_certificate Broker certificate

A ingress certificate to verify the identity of brokers.
string
ingress_endpoint List of NSX Application Platform ingress endpoints

List of NSX Application Platform ingress endpoints that host nodes contact initially.
array of CommonAgentEndpointInfo
kafka_certificate Broker certificate

A Kafka broker certificate to verify the identity of brokers.
string
kafka_endpoint List of NSX Application Platform Kafka broker endpoints

List of NSX Application Platform broker endpoints that host nodes contact initially.
array of CommonAgentEndpointInfo
nsx_cluster_id Cluster id of the NSX Manager cluster

Cluster id of the NSX Manager cluster.
string
private_ip_range List of private IP prefix

List of private IP prefix that NSX Application Platform Common Agent network flow
is collected from.
array of CommonAgentPrivateIpRangeInfo
resource_type Must be set to the value CommonAgentHostConfigurationInfo string
site_id Site id of the local manager

Site id of the local manager.
string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
truststore truststore

A truststore to establish the trust between NSX and NSX Application Platform.
string