NSX-T Data Center REST API

Patch NSX-Intelligence host configuration (Deprecated)

Deprecated - Please use the intelligence API /napp/api/v1/intelligence/data-collection/host-config
instead, after installing NSX Intelligence.
Patch the current NSX-Intelligence host configuration.
Return error if NSX-Intelligence is not registered with NSX.

Request:

Method:

PATCH

URI Path(s):

/api/v1/intelligence/host-config

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

IntelligenceHostConfigurationInfo+

IntelligenceHostConfigurationInfo (schema)

(Deprecated)

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
broker_bootstrap_servers	List of NSX-Intelligence broker endpoints List of NSX-Intelligence broker endpoints that host nodes contact initially.	array of IntelligenceBrokerEndpointInfo
broker_certificate	Broker certificate A broker certificate to verify the identity of brokers.	string
broker_truststore	Broker truststore A truststore to establish the trust between NSX and NSX-Intelligence brokers.	string
context_data_collection_interval	VM guest context data collection interval Interval in minute of reporting VM guest context data to NSX-Intelligence. Recommend to keep this value the same as flow_data_collection_interval.	integer	Minimum: 2 Maximum: 30 Default: "5"
context_process_hashes	List of hashes of processes to collect context data List of hashes of processes to collect context data. Empty implies all processes.	array of string
context_process_names	List of processes to collect context data List of processes to collect context data. Empty implies all processes.	array of string
context_user_sids	List of windows user sid to collect context data List of windows user sid to collect context data. Empty implies all users.	array of string
context_user_uids	List of linux user uid to collect context data List of linux user uid to collect context data. Empty implies all users.	array of string
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
enable_context_data_collection	Enable context data collection Enable NSX-Intelligence context data collection in host nodes.	boolean	Default: "True"
enable_data_collection	Enable data collection Enable NSX-Intelligence data collection in host nodes. This property has been deprecated. To enable flow data collection, use property enable_flow_data_collection instead. To enable context data collection, use property enable_context_data_collection instead. When this property is set to false, no data collection is performed even if enable_flow_data_collection or enable_context_data_collection is set to true. When this property is set to true, property enable_flow_data_collection and enable_context_data_collection control whether to collect flow data and context data separately.	boolean	Deprecated Default: "True"
enable_deep_packet_inspection	Enable deep packet inspection Enable NSX-Intelligence deep packet inspection in host nodes.	boolean	Default: "True"
enable_external_ip_aggregation	Enable external IP aggregation When this property is set to true, if the source or destination of network traffic uses an IP address that is not included in property private_ip_prefix, it is reported as ANY (255.255.255.255) to NSX-Intelligence. When this property is set to false, the original IP addresses of network traffic are reported to NSX-Intelligence, regardless whether they are included in property private_ip_prefix.	boolean	Default: "False"
enable_flow_data_collection	Enable flow data collection Enable NSX-Intelligence flow data collection in host nodes.	boolean	Default: "True"
flow_data_collection_interval	Network flow data collection interval Interval in minute of reporting network flow data to NSX-Intelligence. Recommend to keep this value the same as context_data_collection_interval.	integer	Minimum: 2 Maximum: 30 Default: "5"
id	Unique identifier of this resource	string	Sortable
max_active_flow_count	Maximum active network flow Maximum active network flow to collect in collection interval.	integer	Minimum: 1 Maximum: 5000000 Default: "25000"
max_active_flow_count_bm	Maximum active network flow for Bare Metal server Maximum active network flow to collect in collection interval for Bare Metal server.	integer	Minimum: 1 Maximum: 5000000 Default: "12500"
max_inactive_flow_count	Maximum inactive network flow Maximum inactive network flow to collect in collection interval.	integer	Minimum: 1 Maximum: 5000000 Default: "50000"
max_inactive_flow_count_bm	Maximum inactive network flow for Bare Metal server Maximum inactive network flow to collect in collection interval for Bare Metal server.	integer	Minimum: 1 Maximum: 5000000 Default: "25000"
private_ip_prefix	List of private IP prefix List of private IP prefix that NSX-Intelligence network flow is collected from.	array of IntelligenceFlowPrivateIpPrefixInfo
resource_type	Must be set to the value IntelligenceHostConfigurationInfo	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PATCH https://<nsx-mgr>/napp/api/v1/intelligence/data-collection/host-config { "flow_data_collection_interval": 2, "context_data_collection_interval": 2 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IntelligenceHostConfigurationInfo+

IntelligenceHostConfigurationInfo (schema)

(Deprecated)

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
broker_bootstrap_servers	List of NSX-Intelligence broker endpoints List of NSX-Intelligence broker endpoints that host nodes contact initially.	array of IntelligenceBrokerEndpointInfo
broker_certificate	Broker certificate A broker certificate to verify the identity of brokers.	string
broker_truststore	Broker truststore A truststore to establish the trust between NSX and NSX-Intelligence brokers.	string
context_data_collection_interval	VM guest context data collection interval Interval in minute of reporting VM guest context data to NSX-Intelligence. Recommend to keep this value the same as flow_data_collection_interval.	integer	Minimum: 2 Maximum: 30 Default: "5"
context_process_hashes	List of hashes of processes to collect context data List of hashes of processes to collect context data. Empty implies all processes.	array of string
context_process_names	List of processes to collect context data List of processes to collect context data. Empty implies all processes.	array of string
context_user_sids	List of windows user sid to collect context data List of windows user sid to collect context data. Empty implies all users.	array of string
context_user_uids	List of linux user uid to collect context data List of linux user uid to collect context data. Empty implies all users.	array of string
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
enable_context_data_collection	Enable context data collection Enable NSX-Intelligence context data collection in host nodes.	boolean	Default: "True"
enable_data_collection	Enable data collection Enable NSX-Intelligence data collection in host nodes. This property has been deprecated. To enable flow data collection, use property enable_flow_data_collection instead. To enable context data collection, use property enable_context_data_collection instead. When this property is set to false, no data collection is performed even if enable_flow_data_collection or enable_context_data_collection is set to true. When this property is set to true, property enable_flow_data_collection and enable_context_data_collection control whether to collect flow data and context data separately.	boolean	Deprecated Default: "True"
enable_deep_packet_inspection	Enable deep packet inspection Enable NSX-Intelligence deep packet inspection in host nodes.	boolean	Default: "True"
enable_external_ip_aggregation	Enable external IP aggregation When this property is set to true, if the source or destination of network traffic uses an IP address that is not included in property private_ip_prefix, it is reported as ANY (255.255.255.255) to NSX-Intelligence. When this property is set to false, the original IP addresses of network traffic are reported to NSX-Intelligence, regardless whether they are included in property private_ip_prefix.	boolean	Default: "False"
enable_flow_data_collection	Enable flow data collection Enable NSX-Intelligence flow data collection in host nodes.	boolean	Default: "True"
flow_data_collection_interval	Network flow data collection interval Interval in minute of reporting network flow data to NSX-Intelligence. Recommend to keep this value the same as context_data_collection_interval.	integer	Minimum: 2 Maximum: 30 Default: "5"
id	Unique identifier of this resource	string	Sortable
max_active_flow_count	Maximum active network flow Maximum active network flow to collect in collection interval.	integer	Minimum: 1 Maximum: 5000000 Default: "25000"
max_active_flow_count_bm	Maximum active network flow for Bare Metal server Maximum active network flow to collect in collection interval for Bare Metal server.	integer	Minimum: 1 Maximum: 5000000 Default: "12500"
max_inactive_flow_count	Maximum inactive network flow Maximum inactive network flow to collect in collection interval.	integer	Minimum: 1 Maximum: 5000000 Default: "50000"
max_inactive_flow_count_bm	Maximum inactive network flow for Bare Metal server Maximum inactive network flow to collect in collection interval for Bare Metal server.	integer	Minimum: 1 Maximum: 5000000 Default: "25000"
private_ip_prefix	List of private IP prefix List of private IP prefix that NSX-Intelligence network flow is collected from.	array of IntelligenceFlowPrivateIpPrefixInfo
resource_type	Must be set to the value IntelligenceHostConfigurationInfo	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "enable_data_collection": true, "enable_flow_data_collection": true, "enable_context_data_collection": false, "enable_deep_packet_inspection": false, "enable_external_ip_aggregation": false, "broker_bootstrap_servers": [ { "address": "127.0.0.1", "port": 9092 } ], "flow_data_collection_interval": 2, "max_active_flow_count": 25000, "max_inactive_flow_count": 50000, "private_ip_prefix": [ { "address_type": "IPV4", "address": "10.0.0.0", "prefix_length": 8 }, { "address_type": "IPV4", "address": "172.16.0.0", "prefix_length": 12 }, { "address_type": "IPV4", "address": "192.168.0.0", "prefix_length": 16 } ], "context_data_collection_interval": 2 }

Required Permissions:

crud

Feature:

nsx_intelligence_host_configuration

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable