Provides the WazuhAgentConfiguration Literal type and the WazuhAgentConfigurationConstants which provides constants and validation methods regarding the wazuh component’s configuration sections and their mapping.

class WazuhAgentConfigurationConstants

Bases: object

Collection of wazuh Agent configuration constants.

ACTIVE: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'active'

Wazuh agent active configuration section constant.

ACTIVE_RESPONSE: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'active_response'

Wazuh agent active_response configuration section constant.

AGENTLESS: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'agentless'

Wazuh agent agentless configuration section constant.

ALERTS: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'alerts'

Wazuh agent alerts configuration section constant.

ANTI_TAMPERING: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'anti_tampering'

Wazuh agent anti_tampering configuration section constant.

AUTH: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'auth'

Wazuh agent auth configuration section constant.

BUFFER: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'buffer'

Wazuh agent buffer configuration section constant.

CLIENT: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'client'

Wazuh agent client configuration section constant.

CLUSTER: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'cluster'

Wazuh agent cluster configuration section constant.

COMMAND: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'command'

Wazuh agent command configuration section constant.

CONFIGURATION_MAPPING: dict[slice(Literal['agent', 'agentless', 'analysis', 'auth', 'com', 'csyslog', 'integrator', 'logcollector', 'mail', 'monitor', 'request', 'syscheck', 'wazuh-db', 'wmodules'], list[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']], None)] = {'agent': ['client', 'buffer', 'labels', 'internal', 'anti_tampering'], 'agentless': ['agentless'], 'analysis': ['global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'internal', 'rule_test'], 'auth': ['auth'], 'com': ['active_response', 'logging', 'internal', 'cluster'], 'csyslog': ['csyslog'], 'integrator': ['integration'], 'logcollector': ['localfile', 'socket', 'internal'], 'mail': ['global', 'alerts', 'internal'], 'monitor': ['global', 'internal', 'reports'], 'request': ['global', 'remote', 'internal'], 'syscheck': ['syscheck', 'rootcheck', 'internal'], 'wazuh-db': ['internal', 'wdb'], 'wmodules': ['wmodules']}

WazuhAgentComponent to WazuhAgentConfiguration mapping.

CSYSLOG: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'csyslog'

Wazuh agent csyslog configuration section constant.

DECODERS: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'decoders'

Wazuh agent decoders configuration section constant.

GLOBAL: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'global'

Wazuh agent global configuration section constant.

INTEGRATION: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'integration'

Wazuh agent integration configuration section constant.

INTERNAL: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'internal'

Wazuh agent internal configuration section constant.

LABELS: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'labels'

Wazuh agent labels configuration section constant.

LOCALFILE: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'localfile'

Wazuh agent localfile configuration section constant.

LOGGING: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'logging'

Wazuh agent logging configuration section constant.

REMOTE: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'remote'

Wazuh agent remote configuration section constant.

REPORTS: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'reports'

Wazuh agent reports configuration section constant.

ROOTCHECK: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'rootcheck'

Wazuh agent rootcheck configuration section constant.

RULES: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'rules'

Wazuh agent rules configuration section constant.

RULE_TEST: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'rule_test'

Wazuh agent rule_test configuration section constant.

SOCKET: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'socket'

Wazuh agent socket configuration section constant.

SYSCHECK: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'syscheck'

Wazuh agent syscheck configuration section constant.

WDB: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'wdb'

Wazuh agent wdb configuration section constant.

WMODULES: Final[Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test']] = 'wmodules'

Wazuh agent wmodules configuration section constant.

static is_configuration_available_for_component(configuration: Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test'], component: Literal['agent', 'agentless', 'analysis', 'auth', 'com', 'csyslog', 'integrator', 'logcollector', 'mail', 'monitor', 'request', 'syscheck', 'wazuh-db', 'wmodules']) → bool

Validates a component|configuration combination.

Returns:

Indicates whether the passed component|configuration combination is valid or not.

Return type:

bool

static raise_if_configuration_is_not_available_for_component(configuration: Literal['client', 'buffer', 'labels', 'internal', 'anti_tampering', 'agentless', 'global', 'active_response', 'alerts', 'command', 'rules', 'decoders', 'auth', 'logging', 'reports', 'active-response', 'cluster', 'csyslog', 'integration', 'localfile', 'socket', 'remote', 'syscheck', 'rootcheck', 'wdb', 'wmodules', 'rule_test'], component: Literal['agent', 'agentless', 'analysis', 'auth', 'com', 'csyslog', 'integrator', 'logcollector', 'mail', 'monitor', 'request', 'syscheck', 'wazuh-db', 'wmodules'])

Validates a component|configuration combination and raises a ValueError for invalid combinations.

Raises:

ValueError – The passed component|configuration combination is invalid.

On this page