Type to search.

cloud hosted deployments restart-deployment-es-resource 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.

Destructive Auth required
Shell 
elastic cloud hosted deployments restart-deployment-es-resource \
  --deployment-id <deployment-id> \
  --ref-id <ref-id> \
  [options]

Restart Deployment Elasticsearch Resource

Behaviour flags:

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

--deployment-id string required
Identifier for the Deployment.
--ref-id string required
User-specified RefId for the Resource (or '_main' if there is only one).
--restore-snapshot
When set to true and restoring from shutdown, then will restore the cluster from the last snapshot (if available).
--skip-snapshot
If true, will not take a snapshot of the cluster before restarting.
--cancel-pending
If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error.
--group-attribute string
Indicates the property or properties used to divide the list of instances to restart in groups. Valid options are: '__all__' (restart all at once), '__zone__' by logical zone, '__name__' one instance at a time, or a comma-separated list of attributes of the instances
--shard-init-wait-time number
The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes)
--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
--yes
confirm destructive action without prompting
--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