diff --git a/docs/manual/ar/ar-unix.rst b/docs/manual/ar/ar-unix.rst index 46132699..68ee8b22 100644 --- a/docs/manual/ar/ar-unix.rst +++ b/docs/manual/ar/ar-unix.rst @@ -55,7 +55,7 @@ figurations>`_. -- **disabled**: Disables the active response capabilities if set to yes. If this is set, active response will not work. +- **disabled**: When set to ``yes``, skips this active-response binding only. See :ref:`ossec_config.active-response` and :ref:`manual-ar`. - **command**: Used to link the response to the command - **location**: Where the command should be executed. You have four options: diff --git a/docs/manual/ar/index.rst b/docs/manual/ar/index.rst index ea6cd233..5cd87fc4 100644 --- a/docs/manual/ar/index.rst +++ b/docs/manual/ar/index.rst @@ -1,3 +1,4 @@ +.. _manual-ar: ############### Active Response @@ -8,6 +9,19 @@ These triggers can be specific alerts, alert levels, or rule groups. The active response framework is also what allows an OSSEC administrator to start a syscheck scan or restart OSSEC on a remote agent. +Disabling active response +------------------------- + +Different configuration elements disable active response at different scopes: + +```` with ``yes`` + Skips **one** command binding; other bindings still run. + +```` with ``yes`` + Stops **all** active-response execution on that agent. + +See :ref:`ossec_config.active-response` and :ref:`ossec_config.client` for syntax. + Bundled active-response scripts are documented in :ref:`manual-ar-scripts`. .. toctree:: diff --git a/docs/syntax/ossec_config.active-response.trst b/docs/syntax/ossec_config.active-response.trst index d1ebbfa2..daabdf8f 100644 --- a/docs/syntax/ossec_config.active-response.trst +++ b/docs/syntax/ossec_config.active-response.trst @@ -39,10 +39,15 @@ Active-response Options - disabled - Disables active response if set to yes. If this is not defined active response is enabled on unix systems, and disabled on Windows systems. - This option is available on server, local, and agent installations. - Setting it to ``yes`` on an agent will disable active-response for that agent only, - while setting it on the server will disable all active-response. + When set to ``yes``, **this** ```` binding is skipped and its + command is not registered. Other active-response blocks without ``disabled`` are + unaffected. If ``disabled`` is omitted, active response is enabled on Unix + systems and disabled on Windows by default. + + This option is available on server, local, and agent installations. To disable + all active-response execution on a single agent, use + ```` in the agent ```` section instead (see + :ref:`ossec_config.client`). - command diff --git a/docs/syntax/ossec_config.client.trst b/docs/syntax/ossec_config.client.trst index 45640262..28a458d6 100644 --- a/docs/syntax/ossec_config.client.trst +++ b/docs/syntax/ossec_config.client.trst @@ -50,3 +50,19 @@ **Allowed:** aes, blowfish +- disable-active-response + + When set to ``yes``, disables **all** active-response execution on this agent. + The agent will not run any active-response scripts locally, regardless of + individual ```` blocks. + + **Default:** no + + **Allowed:** yes, no + + .. note:: + + This is an agent-only option inside ````. To disable a single + active-response binding, use ``yes`` inside that + ```` block instead (see :ref:`ossec_config.active-response`). +