Type to search.

stack kb elastic-agents get-fleet-agents cli command

Serverless Preview

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Serverless interfaces and procedures might differ from classic Elastic Stack deployments.

Stack Preview

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Auth required Idempotent Scope: global
Shell
elastic stack kb elastic-agents get-fleet-agents [options]

Get agents

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--page number
Page number
--per-page number
Number of results per page
--kuery string
A KQL query string to filter results
--show-agentless
When true, include agentless agents in the results
--show-inactive
When true, include inactive agents in the results
--with-metrics
When true, include CPU and memory metrics in the response
--show-upgradeable
When true, only return agents that are upgradeable
--get-status-summary
When true, return a summary of agent statuses in the response
--sort-field string
Field to sort results by
--sort-order enum

Sort order, ascending or descending

Values: asc, desc

--search-after string
JSON-encoded array of sort values for search_after pagination
--open-pit
When true, opens a new point-in-time for pagination
--pit-id string
Point-in-time ID for pagination
--pit-keep-alive string
Duration to keep the point-in-time alive, for example, 1m
--input-file string
path to a JSON file to use as command input
--dry-run
validate all inputs and exit without performing any action (preview changes without applying them)
--no-validate
skip input validation and send the request as-is
--output-fields string
comma-separated list of fields to include in output (dot-notation supported)
--output-template string
Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")
--json

output as JSON