Managing integration settings with KATA Central Node component
13 September 2022
ID 197185
This Help provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To manage the integration settings of Kaspersky Endpoint Agent with the KATA Central Node component using the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, you can type the following command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Run the following command and press ENTER:
agent.exe --message-broker=<enable|disable|show> --type=<kata> --use-proxy={yes|no} --compression=<yes|no> --partitioning-strategy=<automatic|user> [--message-key=<
message key> --topic=<
topic> --partition=<user specific partition>] --tls=<yes|no> --servers=<
address>:<
port> [--timeout=<
maximum response timeout of KATA server] [--pinned-certificate=<
full path to the TLS certificate file>] [--client-certificate=<
full path to the certificate file>] --client-password=<
password for the PFX archive> --sync-period=<
interval for sending synchronization requests>
The
--message-broker
command parameters when managing the integration settings between Kaspersky Endpoint Agent and the KATA Central Node componentParameter
Description
--message-broker=<enable|disable|show>
Required parameter.
Allows you to enable, disable, and view status of the integration between Kaspersky Endpoint Agent and the KATA Central Node component.
--message-broker=<enable>
– enables integration.--message-broker=<disable>
– disables integration.--message-broker=<show>
– displays integration status of Kaspersky Endpoint Agent with the KATA Central Node component.
--type=<kata>
Required parameter.
Allows you to specify the KATA Central Node component for managing the integration settings of Kaspersky Endpoint Agent with this component.
--use-proxy={yes|no}
Required parameter.
Allows you to enable or disable proxy server usage in the message broker to send messages to KATA.
--compression=<yes|no>
Optional parameter.
Allows you to enable or disable compression of data transferred between Kaspersky Endpoint Agent and KATA Central Node.
Enabled by default.
---tls=<yes|no>
Optional parameter.
Allows you to enable or disable trusted connection between Kaspersky Endpoint Agent and the KATA Central Node component.
--tls=<yes>
– enables trusted connection.--tls=<no>
– disables trusted connection.
--servers=<
address>:<
port>
Required parameter.
Allows you to add a KATA server.
--timeout=<
maximum response timeout of KATA server>
Optional parameter.
Allows you to set the maximum response timeout of KATA server in milliseconds.
--pinned-certificate=<
full path to the TLS certificate file>
Required parameter, if the
--tls
parameter is passed with the<yes>
value.Allows you to add a TLS certificate for connecting Kaspersky Endpoint Agent with KATA server.
--client-certificate=<
full path to the certificate file>
Allows you to add a user certificate for connecting Kaspersky Endpoint Agent with KATA server.
--client-password=
<password for the PFX archive>Allows you to enter the password for the PFX archive, containing a user certificate for connecting Kaspersky Endpoint Agent with KATA server.
--sync-period=<
interval for sending synchronization requests>
Allows you to specify the time interval for sending requests for synchronization Kaspersky Endpoint Agent settings and tasks with KATA Central Node.
--throttling=
<yes|no>Allows you to enable or disable request throttling. The request throttling feature allows restricting the flow of events with low importance from Kaspersky Endpoint Agent to the Central Node component.
--event-limit=
<number of events per hour>Allows you to specify the maximum number of events per hour. The application analyzes telemetry data flow and restricts transmission of events with low importance if the number of transmitted events tends to exceed the specified value.
--exceed-limit=
<threshold value>Allows you to specify the threshold for exceeding the limit of events. If the flow of events of the same type with low importance exceeds the threshold value specified as a percentage of the total number of events, transmission of events of this type is restricted. You can specify a value from 5 to 100 (without
%
character).