This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
ecctl platform allocator list
editecctl platform allocator list
editReturns all allocators that have instances or are connected to the platform. Use --all flag or --output json to show all. Use --query to match any of the allocators properties. (Available for ECE only)
Synopsis
editReturns all allocators that have instances or are connected to the platform. Use --all flag or --output json to show all. Use --query to match any of the allocators properties.
Query examples:
* Allocators set to maintenance mode: --query status.maintenance_mode:true * Allocators with more than 10GB of capacity: --query capacity.memory.total:\>10240
Read all the simple query string syntax in https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax
Filter examples:
* Allocators with instance type i3.large : --filter instanceType:i3.large * Allocators with instance type i3.large AND instance family gcp.highcpu.1 : --filter instanceType:i3.large --filter instanceFamily:gcp.highcpu.1
Filter is a post-query action and doesn’t support OR. All filter arguments are applied as AND.
Filter and query flags can be used in combination.
ecctl platform allocator list [flags]
Options
edit--all Shows all allocators, including those with no instances or not connected, this is relative to the --size flag. -f, --filter stringArray Post-query filter out allocators based on metadata tags, for instance 'instanceType:i3.large' -h, --help help for list --metadata Shows allocators metadata --query string Searches allocators using an Elasticsearch search query string query --size int Defines the maximum number of allocators to return (default 100) --unhealthy Searches for unhealthy allocators
Options inherited from parent commands
edit--api-key string API key to use to authenticate (If empty will look for EC_API_KEY environment variable) --config string Config name, used to have multiple configs in $HOME/.ecctl/<env> (default "config") --force Do not ask for confirmation --format string Formats the output using a Go template --host string Base URL to use --insecure Skips all TLS validation --message string A message to set on cluster operation --output string Output format [text|json] (default "text") --pass string Password to use to authenticate (If empty will look for EC_PASS environment variable) --pprof Enables pprofing and saves the profile to pprof-20060102150405 -q, --quiet Suppresses the configuration file used for the run, if any --region string Elasticsearch Service region --timeout duration Timeout to use on all HTTP calls (default 30s) --trace Enables tracing saves the trace to trace-20060102150405 --user string Username to use to authenticate (If empty will look for EC_USER environment variable) --verbose Enable verbose mode --verbose-credentials When set, Authorization headers on the request/response trail will be displayed as plain text --verbose-file string When set, the verbose request/response trail will be written to the defined file
SEE ALSO
edit- ecctl platform allocator - Manages allocators (Available for ECE only)