Skip to content

elasticsearch get-cluster-settings

Get elastic search cluster wide settings

Description

Get elastic search cluster wide settings

Synopsis

elasticsearch get-cluster-settings
    [--site <site>]
    [--cluster <cluster>]
    [--filter_path <filter_path>]
    [--include_defaults]

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

filter_path - (string)

     Path in the response. Filters and returns only parts of response matching this path
     Example: --filter_path "index.mappings.properties.*"
     Default: _None_      Attributes: optional, multiple allowed

include_defaults - (bool)

     Parameter to decide whether default settings are to be retrieved
     Example: --include_defaults
     Default: _None_      Attributes: optional

Examples

Input:

! elasticsearch get-cluster-settings --cluster "elastic-1"
Output:
{
  "persistent": {
    "indices": {
      "recovery": {
        "max_bytes_per_sec": "20mb"
      }
    }
  },
  "transient": {}
}

Access Control

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

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

Please see Access Control for details.