[{"label":"Latest (v1.0)","version":"latest"}]
nsx-intelligence-and-application-platform

Patch Data Collection Host Config Profile

Description

Patch data collection host configuration profile.

Request

Request

URL

URL


patch
https://api_host/napp/api/v1/intelligence/data-collection/host-config
Copy

Request Body

Request Body

DataCollectionHostConfigurationProfile of type(s) application/json Required

Host configuration profile definition that is used as the request body.

{
	"context_data_collection_interval": 0,
	"context_process_hashes": [
		"string"
	],
	"context_process_names": [
		"string"
	],
	"context_user_sids": [
		"string"
	],
	"context_user_uids": [
		"string"
	],
	"enable_context_data_collection": false,
	"enable_data_collection": false,
	"enable_deep_packet_inspection": false,
	"enable_external_ip_aggregation": false,
	"enable_flow_data_collection": false,
	"flow_data_collection_interval": 0,
	"max_active_flow_count": 0,
	"max_active_flow_count_bm": 0,
	"max_inactive_flow_count": 0,
	"max_inactive_flow_count_bm": 0
}
integer
context_data_collection_interval Optional

Interval in minute of reporting VM guest context data to Intelligence. Recommend to keep this value the same as flow_data_collection_interval.


array of string
context_process_hashes Optional

List of hashes of processes to collect context data. Empty implies all processes.


array of string
context_process_names Optional

List of processes to collect context data. Empty implies all processes.


array of string
context_user_sids Optional

List of windows user sid to collect context data. Empty implies all users.


array of string
context_user_uids Optional

List of linux user uid to collect context data. Empty implies all users.


boolean
enable_context_data_collection Optional

Enable data collection of context.


boolean
enable_data_collection Optional

A global switch to control data collection. When set to false, data collection on all the nodes is disabled. When set to true, data collection is enabled based on granular data collection settings.

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
enable_deep_packet_inspection Optional

Enable deep packet inspection.


boolean
enable_external_ip_aggregation Optional

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 Intelligence.

When this property is set to false, the original IP addresses of network traffic are reported to Intelligence, regardless whether they are included in property private_ip_prefix.


boolean
enable_flow_data_collection Optional

Enable data collection of network flows.


integer
flow_data_collection_interval Optional

Interval in minute of reporting network flow data to Intelligence. Recommend to keep this value the same as context_data_collection_interval.


integer
max_active_flow_count Optional

Maximum active network flow to collect in collection interval.


integer
max_active_flow_count_bm Optional

Maximum active network flow to collect in collection interval for Bare Metal server.


integer
max_inactive_flow_count Optional

Maximum inactive network flow to collect in collection interval.


integer
max_inactive_flow_count_bm Optional

Maximum inactive network flow to collect in collection interval for Bare Metal server.

Authentication

Authentication

This operation uses the following authentication methods.


Response

Response

Response Body

Response Body

200 OK

Returns DataCollectionHostConfigurationProfile of type(s) application/json

Patch operation on host config profile successful.

{
	"context_data_collection_interval": 0,
	"context_process_hashes": [
		"string"
	],
	"context_process_names": [
		"string"
	],
	"context_user_sids": [
		"string"
	],
	"context_user_uids": [
		"string"
	],
	"enable_context_data_collection": false,
	"enable_data_collection": false,
	"enable_deep_packet_inspection": false,
	"enable_external_ip_aggregation": false,
	"enable_flow_data_collection": false,
	"flow_data_collection_interval": 0,
	"max_active_flow_count": 0,
	"max_active_flow_count_bm": 0,
	"max_inactive_flow_count": 0,
	"max_inactive_flow_count_bm": 0
}
integer
context_data_collection_interval Optional

Interval in minute of reporting VM guest context data to Intelligence. Recommend to keep this value the same as flow_data_collection_interval.


array of string
context_process_hashes Optional

List of hashes of processes to collect context data. Empty implies all processes.


array of string
context_process_names Optional

List of processes to collect context data. Empty implies all processes.


array of string
context_user_sids Optional

List of windows user sid to collect context data. Empty implies all users.


array of string
context_user_uids Optional

List of linux user uid to collect context data. Empty implies all users.


boolean
enable_context_data_collection Optional

Enable data collection of context.


boolean
enable_data_collection Optional

A global switch to control data collection. When set to false, data collection on all the nodes is disabled. When set to true, data collection is enabled based on granular data collection settings.

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
enable_deep_packet_inspection Optional

Enable deep packet inspection.


boolean
enable_external_ip_aggregation Optional

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 Intelligence.

When this property is set to false, the original IP addresses of network traffic are reported to Intelligence, regardless whether they are included in property private_ip_prefix.


boolean
enable_flow_data_collection Optional

Enable data collection of network flows.


integer
flow_data_collection_interval Optional

Interval in minute of reporting network flow data to Intelligence. Recommend to keep this value the same as context_data_collection_interval.


integer
max_active_flow_count Optional

Maximum active network flow to collect in collection interval.


integer
max_active_flow_count_bm Optional

Maximum active network flow to collect in collection interval for Bare Metal server.


integer
max_inactive_flow_count Optional

Maximum inactive network flow to collect in collection interval.


integer
max_inactive_flow_count_bm Optional

Maximum inactive network flow to collect in collection interval for Bare Metal server.

Errors

Errors

400

Backend error. Please check the data collection pod for more information.

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"context_data_collection_interval":0,"context_process_hashes":["string"],"context_process_names":["string"],"context_user_sids":["string"],"context_user_uids":["string"],"enable_context_data_collection":false,"enable_data_collection":false,"enable_deep_packet_inspection":false,"enable_external_ip_aggregation":false,"enable_flow_data_collection":false,"flow_data_collection_interval":0,"max_active_flow_count":0,"max_active_flow_count_bm":0,"max_inactive_flow_count":0,"max_inactive_flow_count_bm":0}' https://api_host/napp/api/v1/intelligence/data-collection/host-config


Feedback

Was this page helpful?