Loading

stack es cluster put-component-template cli command

Auth required Idempotent Scope: global
elastic stack es cluster put-component-template \
  --name <name> \
  --template <template> \
  [options]
		

Create or update a component template.

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--name string required
Name of the component template to create. Elasticsearch includes the following built-in component templates: logs-mappings; logs-settings; metrics-mappings; metrics-settings;synthetics-mapping; synthetics-settings. Elastic Agent uses these templates to configure backing indices for its data streams. If you use Elastic Agent and want to overwrite one of these templates, set the version for your replacement template higher than the current version. If you don’t use Elastic Agent and want to disable all built-in component and index templates, set stack.templates.enabled to false using the cluster update settings API.
--template string required
The template to be applied which includes mappings, settings, or aliases configuration.
--[no-]create
If true, this request cannot replace or update existing component templates.
--cause string
User defined reason for create the component template.
--master-timeout string
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
--version number
Version number used to manage component templates externally. This number isn't automatically generated or incremented by Elasticsearch. To unset a version, replace the template without specifying a version.
--meta string
Optional user metadata about the component template. It may have any contents. This map is not automatically generated by Elasticsearch. This information is stored in the cluster state, so keeping it short is preferable. To unset _meta, replace the template without specifying this information.
--[no-]deprecated
Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.
--input-file string
path to a JSON file to use as command input
--[no-]dry-run
validate all inputs and exit without performing any action (preview changes without applying them)
--[no-]json

output as JSON