-
Notifications
You must be signed in to change notification settings - Fork 188
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* First draft - Creates new page for feature - Reorganizes related pages in nav - Adds section to What's New * Li'l edit * Add content for uninstall page * Add item to release notes * Add Agent version rerquirement * Apply suggestions from Nastasha's review Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> --------- Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
- Loading branch information
1 parent
cc72336
commit 2229f98
Showing
8 changed files
with
74 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
[[agent-tamper-protection]] | ||
= Prevent {agent} uninstallation | ||
|
||
For hosts enrolled in {elastic-defend}, you can prevent unauthorized attempts to uninstall {agent} and {elastic-endpoint} by enabling *Agent tamper protection* on the Agent policy. This offers an additional layer of security by preventing users from bypassing or disabling {elastic-defend}'s endpoint protections. | ||
|
||
When enabled, {agent} and {elastic-endpoint} can only be uninstalled on the host by including an uninstall token in the uninstall CLI command. One unique uninstall token is generated per Agent policy, and you can retrieve uninstall tokens in an Agent policy's settings or in the {fleet} UI. | ||
|
||
.Requirements | ||
[sidebar] | ||
-- | ||
* Agent tamper protection requires a https://www.elastic.co/pricing[Platinum or higher subscription]. | ||
|
||
* Hosts must be enrolled in the {elastic-defend} integration. | ||
|
||
* {agent}s must be version 8.11.0 or later. | ||
-- | ||
|
||
[role="screenshot"] | ||
image::images/agent-tamper-protection.png[Agent tamper protection setting highlighted on Agent policy settings page] | ||
|
||
[discrete] | ||
[[enable-agent-tamper-protection]] | ||
== Enable Agent tamper protection | ||
|
||
You can enable Agent tamper protection by configuring the {agent} policy. | ||
|
||
. Go to *{fleet}* -> *Agent policies*, then select the Agent policy you want to configure. | ||
. Select the *Settings* tab on the policy details page. | ||
. In the *Agent tamper protection* section, turn on the *Prevent agent tampering* setting. | ||
+ | ||
This makes the *Get uninstall command* link available, which you can follow to get the uninstall token and CLI command if you need to <<uninstall-agent,uninstall an Agent>> on this policy. | ||
+ | ||
TIP: You can also access an Agent policy's uninstall tokens on the *Uninstall tokens* tab on the *{fleet}* page. Refer to <<fleet-uninstall-tokens>> for more information. | ||
. Select *Save changes*. | ||
|
||
[discrete] | ||
[[fleet-uninstall-tokens]] | ||
== Access uninstall tokens | ||
|
||
If you need the uninstall token to remove {agent} from a endpoint, you can find it in several ways: | ||
|
||
* *On the Agent policy* — Go to the Agent policy's *Settings* tab, then click the *Get uninstall command* link. The *Uninstall agent* flyout opens, containing the full uninstall command with the token. | ||
|
||
* *On the {fleet} page* — Go to *{fleet}* -> *Uninstall tokens* for a list of the uninstall tokens generated for your Agent policies. You can: | ||
|
||
** Click the *Show token* icon in the *Token* column to reveal a specific token. | ||
** Click the *View uninstall command* icon in the *Actions* column to open the *Uninstall agent* flyout, containing the full uninstall command with the token. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,13 @@ | ||
[[uninstall-agent]] | ||
= Uninstall {agent} | ||
|
||
This page is a placeholder for future documentation. | ||
To uninstall {agent} from a host, run the `uninstall` command from the directory where it's running. Refer to the {fleet-guide}/uninstall-elastic-agent.html[{fleet} and {agent} documentation] for more information. | ||
|
||
If <<agent-tamper-protection,Agent tamper protection>> is enabled on the Agent policy for the host, you'll need to include the uninstall token in the command, using the `--uninstall-token` flag. You can <<fleet-uninstall-tokens,find the uninstall token>> on the Agent policy or at *{fleet}* -> *Uninstall tokens*. | ||
|
||
For example, to uninstall {agent} on a macOS or Linux host: | ||
|
||
[source,shell] | ||
---------------------------------- | ||
sudo elastic-agent uninstall --uninstall-token 12345678901234567890123456789012 | ||
---------------------------------- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.