OutputSettings

Contains output settings for a tenant.

Defines the address and port of the target software to send the outgoing detection alerts to, and the format of the outgoing alerts.

Path

Domains > Domain > OutputSettings

Attributes

This element has no attributes.

Nested elements

To specify values for RecordFieldContextFormat, you may need to learn more about alert format patterns.

This element is a container for the following nested elements:

• ConnectionString

  Specifies the IP address and port (or the Windows-named pipe) to which the service will send outgoing alerts.

  This element is mandatory.

  For more information about this element, see the "OutputSettings > ConnectionString" subsection below.

• EventSettings

  Contains settings of the outgoing alerts sent by Kaspersky CyberTrace.

• RecordFieldContextFormat

  Specifies how context fields must be added to an alert.

  This element is mandatory.

• AlertConnectionString

  Specifies the IP address (or host) and port to which the service will send outgoing alerts.

  This element is optional.

  For more information about this element, see the "OutputSettings > AlertConnectionString" subsection below.

• AlertFormat

  Specifies the format for outgoing alerts.

  This element is optional. If it is absent from the configuration file, no notification is made.

OutputSettings > ConnectionString

Specifies the IP address (or host) and port to which the service will send service alerts.

The string is formatted as <ip_address>:<port> (if an IP address and port are used) or as \\.\pipe\<pipe_name> (if a Windows-named pipe is used).

You can use an IPv4 or an IPv6 address.

OutputSettings > AlertConnectionString

Specifies the IP address (or host) and port to which the service will send service alerts.

The value of this element is formatted as <ip_address>:<port> (if an IP address and port are used) or as \\.\pipe\<pipe_name> (if a Windows-named pipe is used). The IP address must consist of four decimal octets, each separated by a dot. The value in each octet must be less than 256.

This element is optional. If the element is omitted, the enabled attribute with the false value is used for this element.

This element has the following attributes:

AlertConnectionString element attributes

Attribute

Description

enabled

Defines whether Kaspersky CyberTrace Service sends service alerts to the specified IP address and port. Possible values: true, false. If the value is true, Kaspersky CyberTrace Service will send service alerts to the IP address and port that are specified in this element. If the value is false, Kaspersky CyberTrace Service will send service alerts to the IP address and port that are specified in the OutputSettings > ConnectionString element.

Example

The following is an example of this element.

<OutputSettings> <ConnectionString>127.0.0.1:9998</ConnectionString> <EventSettings> ... </EventSettings> <RecordFieldContextFormat><![CDATA[ %ParamName%=%ParamValue%]]></RecordFieldContextFormat> <AlertConnectionString enabled="false">127.0.0.1:9998</AlertConnectionString> <AlertFormat>%Date% alert=%Alert%%RecordContext%</AlertFormat> </OutputSettings>

Page top