- Fleet and Elastic Agent Guide: other versions:
- Fleet and Elastic Agent overview
- Beats and Elastic Agent capabilities
- Quick starts
- Migrate from Beats to Elastic Agent
- Deployment models
- Install Elastic Agents
- Install Fleet-managed Elastic Agents
- Install standalone Elastic Agents
- Install Elastic Agents in a containerized environment
- Run Elastic Agent in a container
- Run Elastic Agent on Kubernetes managed by Fleet
- Install Elastic Agent on Kubernetes using Helm
- Example: Install standalone Elastic Agent on Kubernetes using Helm
- Example: Install Fleet-managed Elastic Agent on Kubernetes using Helm
- Advanced Elastic Agent configuration managed by Fleet
- Configuring Kubernetes metadata enrichment on Elastic Agent
- Run Elastic Agent on GKE managed by Fleet
- Run Elastic Agent on Amazon EKS managed by Fleet
- Run Elastic Agent on Azure AKS managed by Fleet
- Run Elastic Agent Standalone on Kubernetes
- Scaling Elastic Agent on Kubernetes
- Using a custom ingest pipeline with the Kubernetes Integration
- Environment variables
- Run Elastic Agent as an OTel Collector
- Run Elastic Agent without administrative privileges
- Install Elastic Agent from an MSI package
- Installation layout
- Air-gapped environments
- Using a proxy server with Elastic Agent and Fleet
- Uninstall Elastic Agents from edge hosts
- Start and stop Elastic Agents on edge hosts
- Elastic Agent configuration encryption
- Secure connections
- Manage Elastic Agents in Fleet
- Configure standalone Elastic Agents
- Create a standalone Elastic Agent policy
- Structure of a config file
- Inputs
- Providers
- Outputs
- SSL/TLS
- Logging
- Feature flags
- Agent download
- Config file examples
- Grant standalone Elastic Agents access to Elasticsearch
- Example: Use standalone Elastic Agent with Elastic Cloud Serverless to monitor nginx
- Example: Use standalone Elastic Agent with Elasticsearch Service to monitor nginx
- Debug standalone Elastic Agents
- Kubernetes autodiscovery with Elastic Agent
- Monitoring
- Reference YAML
- Manage integrations
- Package signatures
- Add an integration to an Elastic Agent policy
- View integration policies
- Edit or delete an integration policy
- Install and uninstall integration assets
- View integration assets
- Set integration-level outputs
- Upgrade an integration
- Managed integrations content
- Best practices for integration assets
- Data streams
- Define processors
- Processor syntax
- add_cloud_metadata
- add_cloudfoundry_metadata
- add_docker_metadata
- add_fields
- add_host_metadata
- add_id
- add_kubernetes_metadata
- add_labels
- add_locale
- add_network_direction
- add_nomad_metadata
- add_observer_metadata
- add_process_metadata
- add_tags
- community_id
- convert
- copy_fields
- decode_base64_field
- decode_cef
- decode_csv_fields
- decode_duration
- decode_json_fields
- decode_xml
- decode_xml_wineventlog
- decompress_gzip_field
- detect_mime_type
- dissect
- dns
- drop_event
- drop_fields
- extract_array
- fingerprint
- include_fields
- move_fields
- parse_aws_vpc_flow_log
- rate_limit
- registered_domain
- rename
- replace
- script
- syslog
- timestamp
- translate_sid
- truncate_fields
- urldecode
- Command reference
- Troubleshoot
- Release notes
Install Elastic Agent from an MSI package
editInstall Elastic Agent from an MSI package
editMSI is the file format and command line utility for the Windows Installer. Windows Installer (previously known as Microsoft Installer) is an interface for Microsoft Windows that’s used to install and manage software on Windows systems. This section covers installing Elastic Agent through the MSI package repository.
The MSI package installer must be run by an administrator account. The installer won’t start without Windows admin permissions.
Install Elastic Agent
edit- Download the latest Elastic Agent MSI binary from the Elastic Agent download page.
-
Run the installer. The command varies slightly depending on whether you’re using the default Windows command prompt or PowerShell.
-
Using the default command prompt:
elastic-agent-<VERSION>-windows-x86_64.msi INSTALLARGS="--url=<URL> --enrollment-token=<TOKEN>"
-
Using PowerShell:
./elastic-agent-<VERSION>-windows-x86_64.msi --% INSTALLARGS="--url=<URL> --enrollment-token=<TOKEN>"
Where:
-
VERSION
is the Elastic Stack version you’re installing, indicated in the MSI package name. For example,8.13.2
. -
URL
is the Fleet Server URL used to enroll the Elastic Agent into Fleet. You can find this on the Fleet Settings tab in Kibana. -
TOKEN
is the authentication token used to enroll the Elastic Agent into Fleet. You can find this on the Fleet Enrollment tokens tab.
When you run the command, the value set for
INSTALLARGS
will be passed to theelastic-agent install
command verbatim. -
-
If you need to troubleshoot, you can install using
msiexec
with the-L*V "log.txt"
option to create installation logs:msiexec -i elastic-agent-<VERSION>-windows-x86_64.msi INSTALLARGS="--url=<URL> --enrollment-token=<TOKEN>" -L*V "log.txt"
Installation notes
editInstalling using an MSI package has the following behaviors:
-
If
INSTALLARGS
are not provided, the MSI will copy the files to a temporary folder and finish. -
If
INSTALLARGS
are provided, the MSI will copy the files to a temporary folder and then run theelastic-agent install
command with the provided parameters. If the install flow is successful, the temporary folder is deleted. -
If
INSTALLARGS
are provided but theelastic-agent install
command fails, the top-level folder is NOT deleted, in order to allow for further troubleshooting. -
If the
elastic-agent install
command fails for any reason, the MSI will rollback all changes. -
If the Elastic Agent enrollment fails, the install will fail as well. To avoid this behavior you can add the
--delay-enroll
option to the install command.
Upgrading
editThe Elastic Agent version can be upgraded via Fleet, but the registered MSI version will display the initially installed version (this shortcoming will be addressed in future releases). Attempts to upgrade outside of Fleet via the MSI will require an uninstall and reinstall procedure to upgrade. Also note that this MSI implementation relies on the tar Elastic Agent binary to upgrade the installation. Therefore if the Elastic Agent is installed in an air-gapped environment, you must ensure that the tar image is available before an upgrade request is issued.
Installing in a custom location
editStarting in version 8.13, it’s also possible to override the default installation folder by running the MSI from the command line, as shown:
elastic-agent-<VERSION>-windows-x86_64.msi INSTALLARGS="--url=<URL> --enrollment-token=<TOKEN>" INSTALLDIR="<path of custom folder>"