Skip to content

elasticsearch update-cluster-settings

update elastic search cluster settings

Description

Update cluster-wide settings. Settings can be persistent(apply across restarts) or transient(don’t survive a full cluster restart)

Synopsis

elasticsearch update-cluster-settings
    [--site <site>]
    [--cluster <cluster>]
    [--transient <transient>]
    [--persistent <persistent>]

Arguments

site - (string)

     Site where this command will be executed
     Example: --site "site-1"
     Default: input.site      Attributes: optional

cluster - (string)

     Name of elastic search cluster
     Example: --cluster "elastic-default"
     Default: elastic-default      Attributes: optional

transient - (string)

     Transient settings to be updated
     Example: --transient "{"indices.recovery.max_bytes_per_sec" : "20mb"}"
     Default: _None_      Attributes: optional

persistent - (string)

     Persistent settings to be updated
     Example: --persistent "{"indices.recovery.max_bytes_per_sec" : "20mb"}"
     Default: _None_      Attributes: optional

Examples

Input:

! elasticsearch update-cluster-settings --cluster "elastic-1" --persistent `{"indices.recovery.max_bytes_per_sec" : "20mb"}`
Output:
{
  "acknowledged": true,
  "persistent": {
    "indices": {
      "recovery": {
        "max_bytes_per_sec": "20mb"
      }
    }
  },
  "transient": {}
}

Access Control

To use this command, you need access to the following:

Field Value
Action "update"
Service Type "elasticsearch"
Service Instance cluster
Namespace
Object Type "cluster"
Object ID

Please see Access Control for details.