nodeattrs.asciidoc 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. [[cat-nodeattrs]]
  2. == cat nodeattrs
  3. The `nodeattrs` command shows custom node attributes.
  4. ["source","sh",subs="attributes,callouts"]
  5. --------------------------------------------------
  6. % curl 192.168.56.10:9200/_cat/nodeattrs
  7. node host ip attr value
  8. Black Bolt epsilon 192.168.1.8 rack rack314
  9. Black Bolt epsilon 192.168.1.8 azone us-east-1
  10. --------------------------------------------------
  11. The first few columns give you basic info per node.
  12. ["source","sh",subs="attributes,callouts"]
  13. --------------------------------------------------
  14. node host ip
  15. Black Bolt epsilon 192.168.1.8
  16. Black Bolt epsilon 192.168.1.8
  17. --------------------------------------------------
  18. The attr and value columns can give you a picture of custom node attributes.
  19. [source,sh]
  20. --------------------------------------------------
  21. attr value
  22. rack rack314
  23. azone us-east-1
  24. --------------------------------------------------
  25. [float]
  26. === Columns
  27. Below is an exhaustive list of the existing headers that can be
  28. passed to `nodeattrs?h=` to retrieve the relevant details in ordered
  29. columns. If no headers are specified, then those marked to Appear
  30. by Default will appear. If any header is specified, then the defaults
  31. are not used.
  32. Aliases can be used in place of the full header name for brevity.
  33. Columns appear in the order that they are listed below unless a
  34. different order is specified (e.g., `h=attr,value` versus `h=value,attr`).
  35. When specifying headers, the headers are not placed in the output
  36. by default. To have the headers appear in the output, use verbose
  37. mode (`v`). The header name will match the supplied value (e.g.,
  38. `pid` versus `p`). For example:
  39. ["source","sh",subs="attributes,callouts"]
  40. --------------------------------------------------
  41. % curl 192.168.56.10:9200/_cat/nodeattrs?v&h=name,pid,attr,value
  42. name pid attr value
  43. Black Bolt 28000 rack rack314
  44. Black Bolt 28000 azone us-east-1
  45. --------------------------------------------------
  46. [cols="<,<,<,<,<",options="header",subs="normal"]
  47. |=======================================================================
  48. |Header |Alias |Appear by Default |Description |Example
  49. |`node`|`name`|Yes|Name of the node|Black Bolt
  50. |`id` |`nodeId` |No |Unique node ID |k0zy
  51. |`pid` |`p` |No |Process ID |13061
  52. |`host` |`h` |Yes |Host name |n1
  53. |`ip` |`i` |Yes |IP address |127.0.1.1
  54. |`port` |`po` |No |Bound transport port |9300
  55. |`attr` | `attr.name` | Yes | Attribute name | rack
  56. |`value` | `attr.value` | Yes | Attribute value | rack123
  57. |=======================================================================