Load the Elasticsearch index template [winlogbeat-template]

{{es}} uses index templates to define:

• Settings that control the behavior of your data stream and backing indices. The settings include the lifecycle policy used to manage backing indices as they grow and age.
• Mappings that determine how fields are analyzed. Each mapping sets the {{es}} datatype to use for a specific data field.

The recommended index template file for Winlogbeat is installed by the Winlogbeat packages. If you accept the default configuration in the winlogbeat.yml config file, Winlogbeat loads the template automatically after successfully connecting to {{es}}. If the template already exists, it’s not overwritten unless you configure Winlogbeat to do so.

::::{note} A connection to {{es}} is required to load the index template. If the output is not {{es}} (or {{ech}}), you must load the template manually. ::::

This page shows how to change the default template loading behavior to:

• Load your own index template
• Overwrite an existing index template
• Disable automatic index template loading
• Load the index template manually

For a full list of template setup options, see Elasticsearch index template.

Load your own index template [load-custom-template]

To load your own index template, set the following options:

setup.template.name: "your_template_name"
setup.template.fields: "path/to/fields.yml"

If the template already exists, it’s not overwritten unless you configure Winlogbeat to do so.

You can load templates for both data streams and indices.

Overwrite an existing index template [overwrite-template]

::::{warning} Do not enable this option for more than one instance of Winlogbeat. If you start multiple instances at the same time, it can overload your {{es}} with too many template update requests. ::::

To overwrite a template that’s already loaded into {{es}}, set:

setup.template.overwrite: true

Disable automatic index template loading [disable-template-loading]

You may want to disable automatic template loading if you’re using an output other than {{es}} and need to load the template manually. To disable automatic template loading, set:

setup.template.enabled: false

If you disable automatic template loading, you must load the index template manually.

Load the index template manually [load-template-manually]

To load the index template manually, run the setup command. A connection to {{es}} is required. If another output is enabled, you need to temporarily disable that output and enable {{es}} by using the -E option. The examples here assume that Logstash output is enabled. You can omit the -E flags if {{es}} output is already enabled.

If you are connecting to a secured {{es}} cluster, make sure you’ve configured credentials as described in the Quick start: installation and configuration.

If the host running Winlogbeat does not have direct connectivity to {{es}}, see Load the index template manually (alternate method).

To load the template:

Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select Run As Administrator).

From the PowerShell prompt, change to the directory where you installed Winlogbeat, and run:

PS > .\winlogbeat.exe setup --index-management -E output.logstash.enabled=false -E 'output.elasticsearch.hosts=["localhost:9200"]'

Load the index template manually (alternate method) [load-template-manually-alternate]

If the host running Winlogbeat does not have direct connectivity to {{es}}, you can export the index template to a file, move it to a machine that does have connectivity, and then install the template manually.

To export the index template, run:

PS > .\winlogbeat.exe export template --es.version {{version.stack}} | Out-File -Encoding UTF8 winlogbeat.template.json

To install the template, run:

PS > Invoke-RestMethod -Method Put -ContentType "application/json" -InFile winlogbeat.template.json -Uri http://localhost:9200/_index_template/winlogbeat-{{version.stack}}

Once you have loaded the index template, load the data stream as well. If you do not load it, you have to give the publisher user manage permission on winlogbeat-{{version.stack}} index.

PS > Invoke-RestMethod -Method Put -Uri http://localhost:9200/_data_stream/winlogbeat-{{version.stack}}