-
Notifications
You must be signed in to change notification settings - Fork 206
[DOCS] Response console UI for endpoint actions #2289
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
2fe7c2f
187dff5
bcbe6d5
e4e7a13
f8a8175
97969a5
c615b5e
28d489a
549b46e
749cdbe
870d361
6211841
b3b0fd3
1738cf3
f9552f6
d596d0a
67a63b4
682a7b4
30a5f9c
4876621
c08bd82
8c70a29
d837a77
4cf5472
05f99c6
45f8dad
0b75807
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,124 @@ | ||
| [[response-actions]] | ||
| = Endpoint response actions | ||
|
|
||
| This page is a placeholder for future documentation. | ||
| The response console allows you to perform response actions on an endpoint using a terminal-like interface. You can enter action commands and get near-instant feedback on them. Actions are also recorded in the endpoint's <<actions-log,actions log>> for reference. | ||
|
|
||
| Response actions are supported on all endpoint platforms (Linux, macOS, and Windows). | ||
|
|
||
| [NOTE] | ||
| ===== | ||
| Response actions and the response console UI are https://www.elastic.co/pricing[Enterprise subscription] features. | ||
|
|
||
| Endpoints must have {agent} version 8.4 or higher installed with the {endpoint-cloud-sec} integration to receive response actions. | ||
| ===== | ||
|
|
||
| [role="screenshot"] | ||
| image::images/response-console.png[Response console UI] | ||
|
|
||
| Launch the response console from any of the following places in {elastic-sec}: | ||
|
|
||
| * *Endpoints* page -> *Actions* menu (*...*) -> *Respond* | ||
| * Endpoint details flyout -> *Take action* -> *Respond* | ||
| * Alert details flyout -> *Take action* -> *Respond* | ||
|
|
||
| To perform an action on the endpoint, enter a <<response-action-commands,response action command>> in the input area at the bottom of the console, then press *Return*. Output from the action is displayed in the console. | ||
|
|
||
| If a host is unavailable, pending actions will execute once the host comes online. Pending actions expire after two weeks and can be tracked in the actions log. | ||
|
|
||
| NOTE: Some response actions may take a few seconds to complete. Once you enter a command, you can immediately enter another command while the previous action is running. | ||
|
|
||
| Activity in the response console is persistent, so you can navigate away from the page and any pending actions you've submitted will continue to run. To confirm that an action completed, return to the response console to view the console output or check the <<actions-log,actions log>>. | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do you need a [[discrete]] tag here?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe? But the preview isn't breaking into a new topic/page on this heading, so it seems to be working OK without it. And when I tried adding it, I got a bunch of errors. So maybe it's OK without the tag? |
||
| IMPORTANT: Once you submit a response action, you can't cancel it, even if the action is pending for an offline host. | ||
|
|
||
| [[response-action-commands]] | ||
| == Response action commands | ||
|
|
||
| The following response action commands are available in the response console. | ||
|
|
||
| === `isolate` | ||
| <<host-isolation-ov,Isolate the host>>, blocking communication with other hosts on the network. | ||
|
|
||
| Example: `isolate --comment "Isolate host related to detection alerts"` | ||
|
|
||
| === `release` | ||
| Release an isolated host, allowing it to communicate with the network again. | ||
|
|
||
| Example: `release --comment "Release host, everything looks OK"` | ||
|
|
||
| === `status` | ||
| Show information about the host's status, including: {agent} status and version, the {endpoint-cloud-sec} integration's policy status, and when the host was last active. | ||
|
|
||
| === `processes` | ||
| Show a list of all processes running on the host. This action may take a minute or so to complete. | ||
|
|
||
| [TIP] | ||
| ==== | ||
| Use this command to get current PID or entity ID values, which are required for other response actions such as `kill-process` and `suspend-process`. | ||
|
|
||
| Entity IDs may be more reliable than PIDs, because entity IDs are unique values on the host, while PID values can be reused by the operating system. | ||
| ==== | ||
|
|
||
| === `kill-process` | ||
|
|
||
| Terminate a process. You must include one of the following parameters to identify the process to terminate: | ||
|
|
||
| * `--pid` : A process ID (PID) representing the process to terminate. | ||
| * `--entityId` : An entity ID representing the process to terminate. | ||
|
|
||
| Example: `kill-process --pid 123 --comment "Terminate suspicious process"` | ||
|
|
||
| === `suspend-process` | ||
|
|
||
| Suspend a process. You must include one of the following parameters to identify the process to suspend: | ||
|
|
||
| * `--pid` : A process ID (PID) representing the process to suspend. | ||
| * `--entityId` : An entity ID representing the process to suspend. | ||
|
|
||
| Example: `suspend-process --pid 123 --comment "Suspend suspicious process"` | ||
|
|
||
| [[supporting-commands-parameters]] | ||
| == Supporting commands and parameters | ||
|
|
||
| === `--comment` | ||
|
|
||
| Add to a command to include a comment explaining or describing the action. Comments are included in the actions log. | ||
|
|
||
| === `--help` | ||
|
|
||
| Add to a command to get help for that command. | ||
|
|
||
| Example: `isolate --help` | ||
|
|
||
| === `clear` | ||
|
|
||
| Clear all output from the response console. | ||
|
|
||
| === `help` | ||
|
|
||
| List supported commands in the console output area. | ||
|
|
||
| TIP: You can also get a list of commands in the <<help-panel,Help panel>>, which stays on the screen independently of the output area. | ||
|
|
||
| [[help-panel]] | ||
| == Help panel | ||
|
|
||
| Click image:images/help-icon.png[Help icon,17,18] *Help* in the upper-right to open the *Help* panel, which lists available response action commands and parameters as a reference. | ||
|
|
||
| You can use this panel to build commands with less typing. Click the add icon (image:images/add-command-icon.png[Add icon,17,17]) to add a command to the input area, enter any additional parameters or a comment, then press *Return* to run the command. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/response-console-help-panel.png[Help panel,60%] | ||
|
|
||
| [[actions-log]] | ||
| == Actions log | ||
|
|
||
| Click *Actions log* to display a history of response actions performed on the host, such as isolating the host or terminating a process. The actions log includes when each command was performed, the user who performed the action, any comments added to the action, and the action's current status. | ||
|
|
||
| * Click the expand arrow on the right to display more details about an action. | ||
| * Use the date and time picker to display actions within a specific time range. | ||
|
|
||
| TIP: You can also access the actions log from the Endpoints page (*Manage* -> *Endpoints* -> *_Endpoint name_* -> *Actions Log*). | ||
|
|
||
| [role="screenshot"] | ||
| image::images/response-console-actions-log.png[Actions log with a few past actions,75%] | ||
Uh oh!
There was an error while loading. Please reload this page.