Elasticsearch

Updated
  • Updated on May 22, 2025
  • Published on Mar 8, 2022
  • 4 minute(s) read
Prev Next

The Elasticsearch adapter imports device information from an Elasticsearch database.

Prerequisite:

Metricbeats must be setup and running in order to generate and format the ElasticSearch information in the way this adapter requires.

Types of Assets Fetched

This adapter fetches the following types of assets:

  • Devices

Parameters

  1. Host Name or IP Address (required) - The hostname or IP address of the Elasticsearch server that Axonius can communicate with.
  2. Port (required, default: 9200) - Specify the port of the Elasticsearch system.
  3. User Name and Password (optional) - The credentials for a user account that has the permissions to fetch assets.
    Note:

    When API Key ID and API Key are not supplied, User Name and Password are required.

  4. API Key ID and API Key (optional) - An API Key ID and API key associated with a user account that has the permissions to fetch assets. API Key ID and API Key can be used instead of user name and password. For details see Elasticsearch Create API Key.
    Note:

    When User Name and Password are not supplied, API Key ID and API Key are required.

  5. Data Streams Search Target (optional, Recommended) - The target path search to fetch from. Enter a Comma-separated list of data streams, indices, and aliases to search. Supports Elastic wildcard (*) expressions.
    • Make sure you Choose sources which return ECS Host or winlog fields(See Note below)
      • Examples:
        .ds-logstash-dhcpd-*
        logs-*
        filebeat-*

To search all data streams and indices, omit this parameter or use * or _all. Please see data below as this may return unexpected results.

Note:

Axonus fetches data structured in the Elastic Common Schema that has some of the Host fields listed in the Host Structure. Refer to:

* Common Elastic Structure
* Host Structure
Wildcard indexes may search large amounts of records which do not contain Host Details and are not parsed as devices.

Specifying a Data Stream is recommended.
For further information see:

* An introduction to the Elastic data stream naming scheme
* Set up a data stream

  1. Verify SSL - Select whether to verify the SSL certificate offered by the value supplied in Host Name or IP Address. For more details, see SSL Trust & CA Settings.

  2. HTTPS Proxy (optional) - A proxy to use when connecting to the value supplied in Host Name or IP Address.

  3. HTTPS Proxy User Name (optional) - The user name to use when connecting to the value supplied in Host Name or IP Address via the value supplied in HTTPS Proxy.

  4. HTTPS Proxy Password (optional) - The password to use when connecting to the value supplied in Host Name or IP Address via the value supplied in HTTPS Proxy.

  5. To learn more about common adapter connection parameters and buttons, see Adding a New Adapter Connection.

params


Advanced Settings

Note:

Advanced settings can either apply for all connections for this adapter, or you can set different advanced settings and/or different scheduling for a specific connection, refer to ​Advanced Configuration for Adapters.

  1. Hour range filter (required, default: 10) - Inspect all logs within the last specified hours and extract devices from all data received. Minimum value is 1; Maximum value is 72.
  2. Page size (required, default 500, max 500) - Enter a page size to control the number of items to return per request to the Search API. Decreasing this number may improve fetch stability.
  3. Fetch devices without hostname - Select whether to fetch devices from Elasticsearch that do not have a hostname.
  4. Parse dynamic fields - Select this option to parse all the fields fetched from the API as dynamic fields. These are fields created during the fetch process. They can be queried, and their names and types are defined by the field name and value parsed.
  5. Use fetch time for Last Seen - Select this option to set that all entities (devices and users) fetched by this adapter have their Last Seen set to the time the entity was fetched (fetch_time).
  6. Custom query (optional) - Enter a JSON-formatted object name that refers to the additional fields you want to parse for each asset. You need to define this custom object on your Elasticsearch environment. The adapter can parse data for Installed Software, Vulnerabilities, BIOS, and Hardware Serial.

Custom Object Fields
The custom object you define in Elasticsearch needs to include the following fields:

  • For Installed Software:
    • 'identifying_number' - Software ID
    • 'name' - Software name
    • 'publisher' - Software publisher
    • 'version' - Software version
    • 'install_source' - Where the software is installed on the host
    • 'install_date' - When the software was installed on the host
  • For Vulnerabilities:
    • 'vulnerable_software' - Vulnerable Software name
    • 'cve_id' - Vulnerability ID
    • 'cve_description' - Vulnerability description
    • 'cvss_base_score' - Vulnerability score
    • 'cv_updated_at' - When the CVE's information was last modified
  • For BIOS data:
    • 'bios_manufacturer' - The manufacturer of the BIOS software
    • 'bios_release_date' - The release data of this BIOS' version
    • 'bios_serial' - The serial number of the BIOS release
    • 'bios_version' - BIOS version
  • For Hardware Serial, include the 'hardware_serial' field, representing the hardware's serial number.


Note:

To learn more about Adapter Configuration tab advanced settings, see Adapter Advanced Settings.


APIs

Axonius uses the Elasticsearch 7.10 API.

Permissions

You must have the read index privilege for the target data stream, index, or alias

Version Matrix

This adapter has only been tested with the versions marked as supported, but may work with other versions. Please contact Axonius Support if you have a version that is not listed and it is not functioning as expected.

Version Supported Notes
Elasticsearch 7.10 Yes


Related articles