1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-10 11:21:48 +00:00
gcloud-help/gcloud/alpha/compute/instances/config/export
2023-01-19 00:56:33 +00:00

100 lines
3.9 KiB
Text

NAME
gcloud alpha compute instances config export - export the configuration for
a Compute Engine instance
SYNOPSIS
gcloud alpha compute instances config export
([INSTANCE : --zone=ZONE] --all) [--path=PATH; default="-"]
[--resource-format=RESOURCE_FORMAT] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha compute instances config export exports the
configuration for a Compute Engine instance.
Instance configurations can be exported in Kubernetes Resource Model (krm)
or Terraform HCL formats. The default format is krm.
Specifying --all allows you to export the configurations for all instances
within the project.
Specifying --path allows you to export the configuration(s) to a local
directory.
EXAMPLES
To export the configuration for an instance, run:
$ gcloud alpha compute instances config export my-instance
To export the configuration for an instance to a file, run:
$ gcloud alpha compute instances config export my-instance \
--path=/path/to/dir/
To export the configuration for an instance in Terraform HCL format, run:
$ gcloud alpha compute instances config export my-instance \
--resource-format=terraform
To export the configurations for all instances within a project, run:
$ gcloud alpha compute instances config export --all
POSITIONAL ARGUMENTS
Exactly one of these must be specified:
Instance resource - Instance to export the configuration for. The
arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group
but can be set in other ways. To set the project attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ set the property core/project;
▸ provide the argument --project on the command line.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▫ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--zone=ZONE
The name of the Google Compute Engine zone. To set the zone
attribute:
▫ provide the argument instance on the command line with a fully
specified name;
▫ provide the argument --zone on the command line;
▫ set the property compute/zone.
--all
Retrieve all resources within the project. If --path is specified and
is a valid directory, resources will be output as individual files
based on resource name and scope. If --path is not specified,
resources will be streamed to stdout.
FLAGS
--path=PATH; default="-"
Path of the directory or file to output configuration(s). To output
configurations to stdout, specify "--path=-".
--resource-format=RESOURCE_FORMAT
Format of the configuration to export. Available configuration formats
are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform).
Command defaults to "krm". RESOURCE_FORMAT must be one of: krm,
terraform.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist.