Creating a set of resources for an agent

In the KUMA web interface, an agent service is created based on the set of resources for an agent that unites connectors and destinations.

To create a set of resources for an agent in the KUMA web interface:

1. In the KUMA web interface, under Resources → Agents, click Add agent.

   This opens a window for creating an agent with the Base settings tab active.

2. Fill in the settings on the Base settings tab.
   • In the Agent name field, enter a unique name for the created service. The name must contain from 1 to 128 Unicode characters.
   • In the Tenant drop-down list, select the tenant that will own the storage.
   • If you want, select the Debug check box to log service operations.
   • You can optionally add up to 256 Unicode characters describing the service in the Description field.
3. Create a connection for the agent by using the button and switch to the added Connection <number> tab.

   You can delete tabs by using the button.

4. In the Connector settings block, add a connector resource:
   • If you want to select an existing resource, select it from the drop-down list.
   • If you want to create a new resource, select it in the Create new drop-down list and define its settings:
     • Specify the connector name in the Name field. The name must contain from 1 to 128 Unicode characters.
     • In the Type drop-down list, select the connector type and define its settings on the Basic settings and Advanced settings tabs. The available settings depend on the selected type of connector:
       • tcp
       • udp
       • nats
       • kafka
       • http
       • file
       • ftp
       • nfs
       • wmi
       • wec
       • snmp

       The agent type is determined by the connector that is used in the agent.

       When using the tcp or upd connector type at the normalization stage, IP addresses of the assets from which the events were received will be written in the DeviceAddress event field if it is empty.

   • You can optionally add up to 256 Unicode characters describing the resource in the Description field.

   The connector resource is added to the selected connection of the agent's set of resources. The created resource is only available in this resource set and is not displayed in the web interface Resources → Connectors section.

5. In the Destinations settings block, add resources of destinations. Agents can forward data only to collectors.
   • If you want to select an existing resource, select it from the drop-down list.
   • If you want to create a new resource, select it in the Create new drop-down list and define its settings.

     Destination settings

     1. Specify the settings on the Basic settings tab:
        • In the Name field, enter a unique name for the destination resource. The name must contain from 1 to 128 Unicode characters.
        • Use the Disabled toggle button to specify whether events will be sent to this destination. By default, sending events is enabled.
        • Select the Type of destination: nats, tcp, http, kafka or file.
        • Indicate the URL where events should be sent.

          You can specify multiple destination URLs using the URL button for all types except nats and file, if your KUMA license includes High Level Availability module.

        • For the nats and kafka types, use the Topic field to specify which topic the data should be written to. The topic name must contain from 1 to 255 Unicode characters.
        • You can optionally add up to 256 Unicode characters describing the resource in the Description field.
     2. If required, define the settings on the Advanced settings tab. The available settings vary based on the selected destination resource type.
        • Compression is a drop-down list where you can enable Snappy compression. By default, compression is disabled.
        • Proxy is a drop-down list for proxy server resource selection.
        • Buffer size field is used to set buffer size (in bytes) for the destination resource. The default value is 1 MB, and the maximum value is 64 MB.
        • Timeout field is used to set the timeout (in seconds) for another service or component response. The default value is 30.
        • Disk buffer size limit field is used to specify the size of the disk buffer in bytes. The default size is 10 GB.
        • Storage ID is a NATS storage identifier.
        • TLS mode is a drop-down list where you can specify the conditions for using TLS encryption:
          • Disabled (default)—do not use TLS encryption.
          • Enabled—encryption is enabled, but without verification.
          • With verification—use encryption with verification that the certificate was signed with the KUMA root certificate. The root certificate and key of KUMA are created automatically during program installation and are stored on the KUMA Core server in the folder /opt/kaspersky/kuma/core/certificates/.

          When using TLS, it is impossible to specify an IP address as a URL.

        • URL selection policy is a drop-down list in which you can select a method for determining which URL to send events to if several URLs have been specified:
          • Any
          • Prefer first
          • Round robin
        • Delimiter is used to specify the character delimiting the events. By default, \n is used.
        • Path—the file path if the file destination type is selected.
        • Flush interval sets the time (in seconds) between sending data to the destination resource. The default value is 100.
        • Workers—this field is used to set the number of services processing the queue. By default, this value is equal to the number of vCPUs of the KUMA Core server.
        • You can set health checks using the Health check path and Health check timeout fields. You can also disable health checks by selecting the Health Check Disabled check box.
        • Debug—a drop-down list where you can specify whether resource logging should be enabled. By default it is Disabled.
        • The Disk buffer disabled drop-down list is used to enable or disable the use of a disk buffer. By default, the disk buffer is disabled.
        • In the Filter section you can specify conditions to identify events that will be processed by the aggregation rule resource. You can select an existing filter resource from the drop-down list, or select Create new to create a new filter.

          Creating a filter in resources

          1. In the Filter drop-down list, select Create new.
          2. If you want to keep the filter as a separate resource, set the Save filter toggle switch.

             In this case, you will be able to use the created filter in various services.

             The toggle switch is turned off by default.

          3. If you toggle the Save filter switch on, enter a name for the created filter resource in the Name field. The name must contain from 1 to 128 Unicode characters.
          4. In the Conditions settings block, specify the conditions that the events must meet:
             1. Click the Add condition button.
             2. In the Left operand and Right operand drop-down lists, specify the search parameters.

                Depending on the data source selected in the Right operand field, you may see fields of additional parameters that you need to use to define the value that will be passed to the filter. For example, when choosing active list you will need to specify the name of the active list, the entry key, and the entry key field.

             3. In the operator drop-down list, select the relevant operator.

                Filter operators

                • = – the left operand equals the right operand.
                • <—the left operand is less than the right operand.
                • <=—the left operand is less than or equal to the right operand.
                • >—the left operand is greater than the right operand.
                • >=—the left operand is greater than or equal to the right operand.
                • inSubnet—the left operand (IP address) is in the subnet of the right operand (subnet).
                • contains—the left operand contains values of the right operand.
                • startsWith—the left operand starts with one of the values of the right operand.
                • endsWith—the left operand ends with one of the values of the right operand.
                • match—the left operand matches the regular expression of the right operand. The RE2 regular expressions are used.
                • inActiveList—this operator has only one operand. Its values are selected in the Key fields field and are compared with the entries in the active list selected from the Active List drop-down list.
                • inCategory—the asset in the left operand is assigned at least one of the asset categories of the right operand.
                • inActiveDirectoryGroup—the Active Directory account in the left operand belongs to one of the Active Directory groups in the right operand.
                • TIDetect—this operator is used to find events using CyberTrace Threat Intelligence (TI) data. This operator can be used only on events that have completed enrichment with data from CyberTrace Threat Intelligence. In other words, it can only be used in collectors at the destination selection stage and in correlators.
             4. If necessary, select the do not match case check box. When this check box is selected, the operator ignores the case of the values.

                The selection of this check box does not apply to the InSubnet, InActiveList, InCategory or InActiveDirectoryGroup operators.

                This check box is cleared by default.

             5. If you want to add a negative condition, select If not from the If drop-down list.
             6. You can add multiple conditions or a group of conditions.
          5. If you have added multiple conditions or groups of conditions, choose a search condition (and, or, not) by clicking the AND button.
          6. If you want to add existing filters that are selected from the Select filter drop-down list, click the Add filter button.

             You can view the nested filter settings by clicking the button.

     The advanced settings for an agent destination (such as TLS mode and compression) must match the advanced destination settings for the collector that you want to link to the agent.

   There can be more than one destination point. You can add them by clicking the Add destination button and can remove them by clicking the button.

6. Repeat steps 3–5 for each agent connection that you want to create.
7. Click Save.

The set of resources for the agent is created and displayed under Resources → Agents. Now you can create an agent service in KUMA.

Page top