Skip to content

elasticsearch update-index-settings

update elastic search index settings

Description

Changes settings for indices

Synopsis

elasticsearch update-index-settings
    [--site <site>]
    [--cluster <cluster>]
    [<index>]
    [--settings <settings>]

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

index - (string)

     Name of indices (supports wild card expression)
     Example: "students,class or _all or log_2099_*"
     Default: _all      Attributes: optional, multiple allowed

settings - (string)

     Map of settings to update in indices. Set a property to null to revert it to default setting
     Example: --settings "{ "index.refresh_interval" : null, "index.number_of_replicas" : 1 }"
     Default: _None_      Attributes: optional

Examples

Input:

! elasticsearch update-index-settings --cluster "elastic-1" "class" "test" --settings `{"index.number_of_replicas": 1}`
Output:
{
  "acknowledged": true
}

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 "index"
Object ID index

Please see Access Control for details.