Wazuh manager class
class wazuh::manager
This contains variables that can be used to configure the Wazuh manager.
Alerts
Parameter |
Description |
Default value |
Data type |
|---|---|---|---|
|
Sets the minimum severity level for alerts stored in |
|
Integer |
|
The threshold defines the minimum severity for a rule to fire an email alert. Some rules circumvent this
threshold ( |
|
Integer |
Authd configuration variables
Parameter |
Description |
Default value |
Data type |
|---|---|---|---|
|
Toggles the execution of the Auth daemon on or off. |
|
String |
|
Defines the TCP port number for listening to connections. |
|
Integer |
|
Toggles the use of the client's source IP address or the use of "any" to add an agent. |
|
String |
|
Toggles the deletion of client keys on or off when agents are removed. |
|
String |
|
Toggles shared password authentication on or off. |
|
String |
|
Sets the list of ciphers for network communication using SSL. |
|
String |
|
Toggles source host verification on and off when a CA certificate is specified. This means that the client source IP address will be validated using the Common Name field. |
|
String |
|
Specifies the full path to the server SSL certificate. |
|
String |
|
Specifies the full path to the server's SSL key. |
|
String |
|
Toggles whether or not to auto select the SSL/TLS method. |
|
String |
Cluster variables
Parameter |
Description |
Default value |
Data type |
|---|---|---|---|
|
Specifies the name of the cluster this node belongs to. |
|
String |
|
Specifies the name of the current node of the cluster. |
|
String |
|
Specifies the role of the node. |
|
String |
|
Defines the key used to encrypt the communication between the nodes. This key must be |
|
String |
|
Specifies the port to use for the cluster communications. |
|
String |
|
Specifies which IP address will communicate with the cluster when the node has multiple network interfaces. |
|
String |
|
Lists all master nodes in the cluster using the |
|
String |
|
Toggles whether or not to show information about the cluster that generated an alert. If this is set to |
|
String |
|
Toggles whether the cluster is enabled or not. If this value is set to |
|
String |
Global variables
Parameter |
Description |
Default value |
Data type |
|---|---|---|---|
|
Whether or not to send email notifications. If this variable is not set to |
|
Boolean |
|
Email to address. Depends on |
|
List |
|
SMTP mail server. Depends on |
|
String |
|
Email from address. Depends on |
|
String |
|
Global Configuration with the maximum number of emails per hour. Depends on |
|
Integer |
|
This selects the alert file to be read from. Depends on |
|
String |
|
Define email ID name |
|
String |
|
Allow white-listing of IP addresses. |
|
List |
|
Specifies a type of incoming connection to accept: secure or syslog. |
|
String |
|
Specifies the port to use to listen for events. |
|
Integer |
|
Specifies the protocol to use. It is available for secure connections and syslog events. |
|
String |
|
Local IP address to use to listen for connections. |
|
String |
|
IP address that is allowed to send syslog messages to the server. Needed if |
|
String |
|
Sets the capacity of the remote daemon queue in number of agent events. Added if |
|
String |
Localfile variables
Parameter |
Description |
Default value |
Data type |
|---|---|---|---|
|
Files list for log analysis These files are listed in |
n/a |
List |
Rootcheck variables
Parameter |
Description |
Default value |
Data type |
|---|---|---|---|
|
Enables rootcheck section render on this host. |
|
Boolean |
|
Disable rootcheck on this host (Linux). |
|
String |
|
Enable the rootcheck checkfiles option. |
|
String |
|
Enable rootcheck checktrojans option. |
|
String |
|
Enable rootcheck checkdev option. |
|
String |
|
Enable the rootcheck checksys option. |
|
String |
|
Enable rootcheck checkpids option. |
|
String |
|
Enable the rootcheck checkports option. |
|
String |
|
Enable rootcheck checkif option. |
|
String |
|
Specifies how often the rootcheck scan will run (in seconds). |
|
String |
|
List of files or directories to be ignored. These files and directories will be ignored during scans. |
|
String |
|
Change the location of the rootkit files database. |
|
String |
|
Change the location of the rootkit trojan's database. |
|
String |
|
Enable or disable the scanning of network-mounted filesystems (Works on Linux and FreeBSD). Currently, |
|
String |
|
Specifies the path to an audit definition file for Unix-like systems. |
|
String |
Syscheck variables
Parameter |
Description |
Default value |
Data type |
|---|---|---|---|
|
Enables syscheck section rendering on this host. If this variable is not set to true, the complete syscheck tag will not
be added to |
|
Boolean |
|
Disable syscheck on this host. |
|
String |
|
Enables the syscheck section render on this host. |
|
String |
|
Specifies if syscheck scans immediately when started. |
|
String |
|
Specifies whether or not syscheck will ignore files that change too many times (manager only). |
|
String |
|
List of directories to be monitored. The directories should be comma-separated |
|
String |
|
This will enable real-time/continuous monitoring on directories listed on |
|
String |
|
This will enable who-data monitoring on directories listed on |
|
String |
|
List of directories to be monitored. The directories should be comma-separated |
|
String |
|
This will enable real-time/continuous monitoring on directories listed on |
|
String |
|
This will enable who-data monitoring on directories listed on |
|
String |
|
Report file changes. This is limited to text files at this time. |
|
String |
|
List of files or directories to be ignored. Ignored files and directories are still scanned, but the results are not reported. |
|
List |
|
Simple regex pattern to filter out files. |
|
String |
|
Another simple regex pattern to filter out files. |
|
String |
|
Sets the maximum event reporting throughput. Events are messages that will produce an alert. |
|
String |
|
Sets the nice value for the syscheck process. The nice value determines how a process should be with CPU time; higher values make it wait more, lower values make it run faster. |
|
String |
|
Specifies whether there will be periodic inventory synchronizations or not. |
|
String |
|
Specifies the initial number of seconds between every inventory synchronization. If synchronization fails, the value will be duplicated until it reaches the value of max_interval. |
|
String |
|
Sets the maximum synchronization message throughput. |
|
String |
|
Specifies the maximum number of seconds between every inventory synchronization. |
|
String |
|
Specifies if syscheck should scan mounted filesystems. This option works on Linux and FreeBSD systems. Currently, skip_nfs will exclude checking files on CIFS or NFS mounts. |
|
String |
Syslog output variables
Parameter |
Description |
Default value |
Data type |
|---|---|---|---|
|
Allows a Wazuh manager to send the OSSEC alerts to one or more syslog servers. If this variable is not set to true, the
complete |
|
Boolean |
|
The minimum level of the alerts to be forwarded. Depends on |
|
Integer |
|
The port to forward alerts to. Depends on |
|
Integer |
|
The IP address of the syslog server. Depends on Required if |
|
String |
|
Format of alert output. Depends on |
|
String |
Vulnerability Detection variables
Parameter |
Description |
Default value |
Data type |
|
|---|---|---|---|---|
|
Enables Vulnerability detection section rendering on this host. If this variable is not set to true, the complete
vulnerability-detection tag will not be added to |
|
String |
|
|
Enables the vulnerability detection module. Depends on |
|
String |
|
|
Enables indexing of vulnerability inventory data. Depends on |
|
String |
|
Depends on |
||||
|
Time interval for periodic feed updates. Depends on |
|
String |
|
|
Enables rendering of the Vulnerability detection indexer section on the specified host. If this variable is not true,
the vulnerability-indexer tag will not be added to |
|
String |
|
|
Enables the Vulnerability detection indexer module. Depends on Depends on |
|
String |
|
|
Host or IP of Wazuh indexer nodes. Depends on |
|
String |
|
|
Port of Wazuh indexer. Depends on |
|
String |
|
|
Path of CA certificate. Depends on |
|
String |
|
Depends on |
||||
|
Path of Filebeat certificate. Depends on |
|
String |
|
|
Path of Filebeat key. Depends on Depends on |
|
String |
|
Wazuh API variables
Parameter |
Description |
Default value | Data type |
||
|---|---|---|---|---|
|
IP address or hostname of the Wazuh manager where the Wazuh API is running. |
|
||
|
Port where the Wazuh API will listen. |
|
String |
|
|
Enable or disable SSL (https) in the Wazuh API. |
|
String |
|
|
File with the private key. |
|
String |
|
|
File with the certificate. |
|
String |
|
|
Whether to use a certificate from a Certificate Authority. |
|
String |
|
|
Certificate of the Certificate Authority (CA). |
|
String |
|
|
Sets the verbosity level of the Wazuh API logs. |
|
String |
|
|
Set the format of the Wazuh API logs. |
|
String |
|
|
Enable or disable the use of CORS in the Wazuh API. |
|
Boolean |
|
|
Sources for which the resources will be available. For example, |
|
String |
|
|
Specifies which headers can be exposed as part of the response. |
|
String |
|
|
Specifies which HTTP headers can be used during the actual request. |
|
String |
|
|
Tells browsers whether to expose the response to frontend JavaScript. |
|
String |
|
|
Enables or disables caching for certain API responses (currently, all |
|
String |
|
|
Time in seconds the cache lasts before expiring. |
|
String |
|
|
Set a maximum number of login attempts during a specified |
|
Integer |
|
|
Established period of time (in seconds) to attempt login requests. If the established number of requests
( |
|
Integer |
|
|
Establish a maximum number of requests the Wazuh API can handle per minute (does not include authentication requests). If the number of requests for a given minute is exceeded, all incoming requests (from any user) will be blocked. This feature can be disabled by setting its value to 0. |
|
Integer |
|
|
Run wazuh-api process as wazuh user |
|
String |
|
|
Enable features under development |
|
String |
|
Wodle osquery variables
Parameter |
Description |
Default value |
Data type |
|---|---|---|---|
|
Enables the Wodle osquery section rendering on this host. If this variable is not set to |
|
Boolean |
|
Disable the osquery wodle. Depends on |
|
String |
|
Makes the module run osqueryd as a subprocess or lets the module monitor the results log without running Osquery. Depends on |
|
String |
|
Full path to the results log written by Osquery. Depends on |
|
String |
|
Path to the Osquery configuration file. This path can be relative to the folder where the Wazuh agent is running. Depends on |
|
String |
|
Add the agent labels defined as decorators. Depends on |
|
String |
Wodle Syscollector variables
Parameter |
Description |
Default value |
Data type |
|---|---|---|---|
|
Disable the Syscollector wodle. |
|
String |
|
Time between system scans. |
|
String |
|
Run a system scan immediately when the service is started. |
|
String |
|
Enables the hardware scan. |
|
String |
|
Enables the OS scan. |
|
String |
|
Enables the network scan. |
|
String |
|
Enables the scan of the packages. |
|
String |
|
Enables the port scan. |
|
String |
|
Enables the scan of the processes. |
|
String |
Misc Variables
Parameter |
Description |
Default value |
Data type |
|---|---|---|---|
|
Modifies the |
|
String |
|
Install Wazuh through Wazuh repositories. |
|
Boolean |
|
Manage client keys option. |
|
String |
|
Allow using a custom |
|
String |
|
Allow using a custom |
|
String |
|
Enable the configuration to deploy through |
|
String |
function wazuh::email_alert
Parameter |
Description |
Default value |
Data type |
|---|---|---|---|
|
Email to send to. |
n/a |
String |
|
An array of rule group names. |
n/a |
List |
Note
No email will be sent for alerts with a severity below the global $ossec_email_alert_level, unless the rule has alert_email set.
function wazuh::command
Parameter |
Description |
Default value | Data type |
|
|---|---|---|---|
|
Human-readable name for |
n/a |
String |
|
Name of the executable. WAZUH comes preloaded with disable-account, host-deny, ipfw, pf, route-null, firewall-drop, wazuh-slack, restart-wazuh executables. |
n/a |
String |
|
Specifies whether Active response commands should timeout or not. |
|
Boolean |
function wazuh::activeresponse
Parameter |
Description |
Default value |
Data type |
|---|---|---|---|
|
Human readable name for |
n/a |
String |
|
Toggles the active-response capability on and off. |
n/a |
String |
|
Links the active-response to the command. |
n/a |
String |
|
It can be set to |
local |
String |
|
Can take values between |
n/a |
Integer |
|
Specifies the ID of the agent on which to execute the active response command (used when defined-agent is set). |
n/a |
Integrer |
|
List of rule IDs. |
[] |
List |
|
Active Response block for a certain amount of time. |
undef |
Integer |
|
Sets timeouts in minutes for repeat offenders. This list of increasing timeouts can contain a maximum of 5 entries. |
empty |
List |