|
| 1 | +--- |
| 2 | +mapped_pages: |
| 3 | + - https://www.elastic.co/guide/en/security/current/endpoint-command-ref.html |
| 4 | + - https://www.elastic.co/guide/en/serverless/current/security-endpoint-command-ref.html |
| 5 | +--- |
| 6 | + |
| 7 | +# Endpoint command reference [endpoint-command-ref] |
| 8 | + |
| 9 | +This page lists the commands for managing and troubleshooting {{elastic-endpoint}}, the installed component that performs {{elastic-defend}}'s threat monitoring and prevention. |
| 10 | + |
| 11 | +::::{note} |
| 12 | +* {{elastic-endpoint}} is not added to the `PATH` system variable, so you must prepend the commands with the full OS-dependent path: |
| 13 | + |
| 14 | + * On Windows: `"C:\Program Files\Elastic\Endpoint\elastic-endpoint.exe"` |
| 15 | + * On macOS: `/Library/Elastic/Endpoint/elastic-endpoint` |
| 16 | + * On Linux: `/opt/Elastic/Endpoint/elastic-endpoint` |
| 17 | + |
| 18 | +* You must run the commands with elevated privileges—using `sudo` to run as the root user on Linux and macOS, or running as Administrator on Windows. |
| 19 | + |
| 20 | +:::: |
| 21 | + |
| 22 | + |
| 23 | +The following {{elastic-endpoint}} commands are available: |
| 24 | + |
| 25 | +* [diagnostics](#elastic-endpoint-diagnostics-command) |
| 26 | +* [help](#elastic-endpoint-help-command) |
| 27 | +* [inspect](#elastic-endpoint-inspect-command) |
| 28 | +* [install](#elastic-endpoint-install-command) |
| 29 | +* [memorydump](#elastic-endpoint-memorydump-command) |
| 30 | +* [run](#elastic-endpoint-run-command) |
| 31 | +* [send](#elastic-endpoint-send-command) |
| 32 | +* [status](#elastic-endpoint-status-command) |
| 33 | +* [test](#elastic-endpoint-test-command) |
| 34 | +* [top](#elastic-endpoint-top-command) |
| 35 | +* [uninstall](#elastic-endpoint-uninstall-command) |
| 36 | +* [version](#elastic-endpoint-version-command) |
| 37 | + |
| 38 | +Each of the commands accepts the following logging options: |
| 39 | + |
| 40 | +* `--log [stdout,stderr,debugview,file]` |
| 41 | +* `--log-level [error,info,debug]` |
| 42 | + |
| 43 | + |
| 44 | +## elastic-endpoint diagnostics [elastic-endpoint-diagnostics-command] |
| 45 | + |
| 46 | +Gather diagnostics information from {{elastic-endpoint}}. This command produces an archive that contains: |
| 47 | + |
| 48 | +* `version.txt`: Version information |
| 49 | +* `elastic-endpoint.yaml`: Current policy |
| 50 | +* `metrics.json`: Metrics document |
| 51 | +* `policy_response.json`: Last policy response |
| 52 | +* `system_info.txt`: System information |
| 53 | +* `analysis.txt`: Diagnostic analysis report |
| 54 | +* `logs` directory: Copy of {{elastic-endpoint}} log files |
| 55 | + |
| 56 | + |
| 57 | +### Example [_example] |
| 58 | + |
| 59 | +```shell |
| 60 | +elastic-endpoint diagnostics |
| 61 | +``` |
| 62 | + |
| 63 | + |
| 64 | +## elastic-endpoint help [elastic-endpoint-help-command] |
| 65 | + |
| 66 | +Show help for the available commands. |
| 67 | + |
| 68 | + |
| 69 | +### Example [_example_2] |
| 70 | + |
| 71 | +```shell |
| 72 | +elastic-endpoint help |
| 73 | +``` |
| 74 | + |
| 75 | + |
| 76 | +## elastic-endpoint inspect [elastic-endpoint-inspect-command] |
| 77 | + |
| 78 | +Show the current {{elastic-endpoint}} configuration. |
| 79 | + |
| 80 | + |
| 81 | +### Example [_example_3] |
| 82 | + |
| 83 | +```shell |
| 84 | +elastic-endpoint inspect |
| 85 | +``` |
| 86 | + |
| 87 | + |
| 88 | +## elastic-endpoint install [elastic-endpoint-install-command] |
| 89 | + |
| 90 | +Install {{elastic-endpoint}} as a system service. |
| 91 | + |
| 92 | +::::{note} |
| 93 | +We do not recommend installing {{elastic-endpoint}} using this command. {{elastic-endpoint}} is managed by {{agent}} and cannot function as a standalone service. Therefore, there is no separate installation package for {{elastic-endpoint}}, and it should not be installed independently. |
| 94 | +:::: |
| 95 | + |
| 96 | + |
| 97 | + |
| 98 | +### Options [_options] |
| 99 | + |
| 100 | +`--resources <string>` |
| 101 | +: Specify a resources `.zip` file to be used during the installation. This option is required. |
| 102 | + |
| 103 | +`--upgrade` |
| 104 | +: Upgrade the existing installation. |
| 105 | + |
| 106 | + |
| 107 | +### Example [_example_4] |
| 108 | + |
| 109 | +```shell |
| 110 | +elastic-endpoint install --upgrade --resources endpoint-security-resources.zip |
| 111 | +``` |
| 112 | + |
| 113 | + |
| 114 | +## elastic-endpoint memorydump [elastic-endpoint-memorydump-command] |
| 115 | + |
| 116 | +Save a memory dump of the {{elastic-endpoint}} service. |
| 117 | + |
| 118 | + |
| 119 | +### Options [_options_2] |
| 120 | + |
| 121 | +`--compress` |
| 122 | +: Compress the saved memory dump. |
| 123 | + |
| 124 | +`--timeout <duration>` |
| 125 | +: Specify the memory collection timeout, in seconds; the default is 60 seconds. |
| 126 | + |
| 127 | + |
| 128 | +### Example [_example_5] |
| 129 | + |
| 130 | +```shell |
| 131 | +elastic-endpoint memorydump --timeout 120 |
| 132 | +``` |
| 133 | + |
| 134 | + |
| 135 | +## elastic-endpoint run [elastic-endpoint-run-command] |
| 136 | + |
| 137 | +Run `elastic-endpoint` as a foreground process if no other instance is already running. |
| 138 | + |
| 139 | + |
| 140 | +### Example [_example_6] |
| 141 | + |
| 142 | +```shell |
| 143 | +elastic-endpoint run |
| 144 | +``` |
| 145 | + |
| 146 | + |
| 147 | +## elastic-endpoint send [elastic-endpoint-send-command] |
| 148 | + |
| 149 | +Send the requested document to the {{stack}}. |
| 150 | + |
| 151 | + |
| 152 | +### Subcommands [_subcommands] |
| 153 | + |
| 154 | +`metadata` |
| 155 | +: Send an off-schedule metrics document to the {{stack}}. |
| 156 | + |
| 157 | + |
| 158 | +### Example [_example_7] |
| 159 | + |
| 160 | +```shell |
| 161 | +elastic-endpoint send metadata |
| 162 | +``` |
| 163 | + |
| 164 | + |
| 165 | +## elastic-endpoint status [elastic-endpoint-status-command] |
| 166 | + |
| 167 | +Retrieve the current status of the running {{elastic-endpoint}} service. The command also returns the last known status of {{agent}}. |
| 168 | + |
| 169 | + |
| 170 | +### Options [_options_3] |
| 171 | + |
| 172 | +`--output` |
| 173 | +: Control the level of detail and formatting of the information. Valid values are: |
| 174 | + |
| 175 | + * `human`: Returns limited information when {{elastic-endpoint}}'s status is `Healthy`. If any policy actions weren’t successfully applied, the relevant details are displayed. |
| 176 | + * `full`: Always returns the full status information. |
| 177 | + * `json`: Always returns the full status information. |
| 178 | + |
| 179 | + |
| 180 | + |
| 181 | +### Example [_example_8] |
| 182 | + |
| 183 | +```shell |
| 184 | +elastic-endpoint status --output json |
| 185 | +``` |
| 186 | + |
| 187 | + |
| 188 | +## elastic-endpoint test [elastic-endpoint-test-command] |
| 189 | + |
| 190 | +Perform the requested test. |
| 191 | + |
| 192 | + |
| 193 | +### Subcommands [_subcommands_2] |
| 194 | + |
| 195 | +`output` |
| 196 | +: Test whether {{elastic-endpoint}} can connect to remote resources. |
| 197 | + |
| 198 | + |
| 199 | +### Example [_example_9] |
| 200 | + |
| 201 | +```shell |
| 202 | +elastic-endpoint test output |
| 203 | +``` |
| 204 | + |
| 205 | + |
| 206 | +### Example output [_example_output] |
| 207 | + |
| 208 | +```txt |
| 209 | +Testing output connections |
| 210 | +
|
| 211 | +Using proxy: |
| 212 | +
|
| 213 | +Elasticsearch server: https://example.elastic.co:443 |
| 214 | + Status: Success |
| 215 | +
|
| 216 | +Global artifact server: https://artifacts.security.elastic.co |
| 217 | + Status: Success |
| 218 | +
|
| 219 | +Fleet server: https://fleet.example.elastic.co:443 |
| 220 | + Status: Success |
| 221 | +``` |
| 222 | + |
| 223 | + |
| 224 | +## elastic-endpoint top [elastic-endpoint-top-command] |
| 225 | + |
| 226 | +Show a breakdown of the executables that triggered {{elastic-endpoint}} CPU usage within the last interval. This displays which {{elastic-endpoint}} features are resource-intensive for a particular executable. |
| 227 | + |
| 228 | +::::{note} |
| 229 | +The meaning and output of this command are similar, but not identical, to the POSIX `top` command. The `elastic-endpoint top` command aggregates multiple processes by executable. The utilization values aren’t measured by the OS scheduler but by a wall clock in user mode. The output helps identify outliers causing excessive CPU utilization, allowing you to fine-tune the {{elastic-defend}} policy and exception lists in your deployment. |
| 230 | +:::: |
| 231 | + |
| 232 | + |
| 233 | + |
| 234 | +### Options [_options_4] |
| 235 | + |
| 236 | +`--interval <duration>` |
| 237 | +: Specify the data collection interval, in seconds; the default is 5 seconds. |
| 238 | + |
| 239 | +`--limit <number>` |
| 240 | +: Specify the number of updates to collect; by default, data is collected until interrupted by **Ctrl+C**. |
| 241 | + |
| 242 | +`--normalized` |
| 243 | +: Normalize CPU usage values to a total of 100% across all CPUs on multi-CPU systems. |
| 244 | + |
| 245 | + |
| 246 | +### Example [_example_10] |
| 247 | + |
| 248 | +```shell |
| 249 | +elastic-endpoint top --interval 10 --limit 5 |
| 250 | +``` |
| 251 | + |
| 252 | + |
| 253 | +### Example output [_example_output_2] |
| 254 | + |
| 255 | +```txt |
| 256 | +| PROCESS | OVERALL | API | BHVR | DIAG BHVR | DNS | FILE | LIB | MEM SCAN | MLWR | NET | PROC | RANSOM | REG | |
| 257 | +============================================================================================================================================================= |
| 258 | +| MSBuild.exe | 3146.0 | 0.0 | 0.8 | 0.7 | 0.0 | 2330.9 | 0.0 | 226.2 | 586.9 | 0.0 | 0.0 | 0.4 | 0.0 | |
| 259 | +| Microsoft.Management.Services.IntuneWindowsAgen... | 30.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.2 | 29.8 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 260 | +| svchost.exe | 27.3 | 0.0 | 0.1 | 0.1 | 0.0 | 0.4 | 0.2 | 0.0 | 26.6 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 261 | +| LenovoVantage-(LenovoServiceBridgeAddin).exe | 0.1 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.1 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 262 | +| Lenovo.Modern.ImController.PluginHost.Device.exe | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 263 | +| msedgewebview2.exe | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 264 | +| msedge.exe | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 265 | +| powershell.exe | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 266 | +| WmiPrvSE.exe | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 267 | +| Lenovo.Modern.ImController.PluginHost.Device.exe | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 268 | +| Slack.exe | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 269 | +| uhssvc.exe | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 270 | +| explorer.exe | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 271 | +| taskhostw.exe | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 272 | +| Widgets.exe | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 273 | +| elastic-endpoint.exe | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 274 | +| sppsvc.exe | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | |
| 275 | +
|
| 276 | +Endpoint service (16 CPU): 113.0% out of 1600% |
| 277 | +
|
| 278 | +Collecting data. Press Ctrl-C to cancel |
| 279 | +``` |
| 280 | + |
| 281 | + |
| 282 | +#### Column abbreviations [_column_abbreviations] |
| 283 | + |
| 284 | +* `API`: Event Tracing for Windows (ETW) API events |
| 285 | +* `AUTH`: Authentication events |
| 286 | +* `BHVR`: Malicious behavior protection |
| 287 | +* `CRED`: Credential access events |
| 288 | +* `DIAG BHVR`: Diagnostic malicious behavior protection |
| 289 | +* `DNS`: DNS events |
| 290 | +* `FILE`: File events |
| 291 | +* `LIB`: Library load events |
| 292 | +* `MEM SCAN`: Memory scanning |
| 293 | +* `MLWR`: Malware protection |
| 294 | +* `NET`: Network events |
| 295 | +* `PROC`: Process events |
| 296 | +* `PROC INJ`: Process injection |
| 297 | +* `RANSOM`: Ransomware protection |
| 298 | +* `REG`: Registry events |
| 299 | + |
| 300 | + |
| 301 | +## elastic-endpoint uninstall [elastic-endpoint-uninstall-command] |
| 302 | + |
| 303 | +Uninstall {{elastic-endpoint}}. |
| 304 | + |
| 305 | +::::{note} |
| 306 | +{{elastic-endpoint}} is managed by {{agent}}. To remove {{elastic-endpoint}} from the target machine permanently, remove the {{elastic-defend}} integration from the {{fleet}} policy. The [elastic-agent uninstall](../../solutions/security/configure-elastic-defend/uninstall-elastic-agent.md) command also uninstalls {{elastic-endpoint}}; therefore, in practice, the `elastic-endpoint uninstall` command is used only to troubleshoot broken installations. |
| 307 | +:::: |
| 308 | + |
| 309 | + |
| 310 | +### Options [_options_5] |
| 311 | + |
| 312 | +`--uninstall-token <string>` |
| 313 | +: Provide the uninstall token. The token is required if [agent tamper protection](../../solutions/security/configure-elastic-defend/prevent-elastic-agent-uninstallation.md) is enabled. |
| 314 | + |
| 315 | + |
| 316 | +### Example [_example_11] |
| 317 | + |
| 318 | +```shell |
| 319 | +elastic-endpoint uninstall --uninstall-token 12345678901234567890123456789012 |
| 320 | +``` |
| 321 | + |
| 322 | + |
| 323 | +## elastic-endpoint version [elastic-endpoint-version-command] |
| 324 | + |
| 325 | +Show the version of {{elastic-endpoint}}. |
| 326 | + |
| 327 | + |
| 328 | +### Example [_example_12] |
| 329 | + |
| 330 | +```shell |
| 331 | +elastic-endpoint version |
| 332 | +``` |
0 commit comments