Skip to content

elasticsearch list-cluster-allocation

Get compact and aligned text explanation for shards

Description

Get compact and aligned text explanation for shards current allocation.

Synopsis

elasticsearch list-cluster-allocation
    [--site <site>]
    [--cluster <cluster>]
    [--filter_path <filter_path>]
    [--nodes <nodes>]

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

nodes - (string)

     List of node IDs or names used to limit returned information.
     Example: --nodes "node-1"
     Default: _None_      Attributes: optional, multiple allowed

Examples

Input:

! elasticsearch list-cluster-allocation
Output:
[
  {
    "shards": "81",
    "disk.indices": null,
    "disk.used": null,
    "disk.avail": null,
    "disk.total": null,
    "disk.percent": null,
    "host": null,
    "ip": null,
    "node": "UNASSIGNED"
  }
]

Access Control

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

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

Please see Access Control for details.