cloud hosted deployments get-deployment cli command

elastic cloud hosted deployments get-deployment \
  --deployment-id <deployment-id> \
  [options]

Get Deployment

Behaviour flags:

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

--deployment-id string required

Identifier for the Deployment

--show-security

Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials

--show-metadata

Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials

--show-plans

Whether to include the full current and pending plan information in the response - can be large per cluster

--show-plan-logs

Whether to include with the current and pending plan information the attempt log - can be very large per cluster

--show-plan-history

Whether to include the plan history with the current and pending plan information. The results can be very large per cluster. By default, if a given resource kind (e.g. Elasticsearch, Kibana, etc.) has more than 100 plans (which should be very rare, most likely caused by a bug) only 100 plans are returned for the given resource type: The first 10 plans, and the last 90 plans for that resource type. If ALL of the plans are desired, pass the force_all_plan_history parameter with a value of true.

--show-plan-defaults

If showing plans, whether to show values that are left at their default value (less readable but more informative)

--convert-legacy-plans

If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true')

--show-system-alerts number

Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field.

--show-settings

Whether to show cluster settings in the response.

--show-instance-metrics

Whether to show resources instance metrics in the response.

--show-instance-configurations

If true, will return details for each instance configuration referenced by the deployment.

--enrich-with-template

If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on

--force-all-plan-history

Force show the entire plan history no matter how long. As noted in the show_plan_history parameter description, by default, a maximum of 100 plans are shown per resource. If true, this parameter overrides the default, and ALL plans are returned. Use with care as the plan history can be VERY large. Consider pairing with show_plan_logs=false.

--clear-transient

If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update

--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