1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-13 00:18:35 +00:00
gcloud-help/gcloud/alpha/compute/target-vpn-gateways/config/export
2024-07-31 09:35:16 +00:00

109 lines
4.2 KiB
Text

NAME
gcloud alpha compute target-vpn-gateways config export - export the
configuration for a Compute Engine target vpn gateway
SYNOPSIS
gcloud alpha compute target-vpn-gateways config export
([TARGET_VPN_GATEWAY : --region=REGION] --all)
[--path=PATH; default="-"] [--resource-format=RESOURCE_FORMAT]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha compute target-vpn-gateways config export exports the
configuration for a Compute Engine target vpn gateway.
Target vpn gateway 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 target vpn
gateways within the project.
Specifying --path allows you to export the configuration(s) to a local
directory.
EXAMPLES
To export the configuration for a target vpn gateway, run:
$ gcloud alpha compute target-vpn-gateways config export \
my-target-vpn-gateway
To export the configuration for a target vpn gateway to a file, run:
$ gcloud alpha compute target-vpn-gateways config export \
my-target-vpn-gateway --path=/path/to/dir/
To export the configuration for a target vpn gateway in Terraform HCL
format, run:
$ gcloud alpha compute target-vpn-gateways config export \
my-target-vpn-gateway --resource-format=terraform
To export the configurations for all target vpn gateways within a project,
run:
$ gcloud alpha compute target-vpn-gateways config export --all
POSITIONAL ARGUMENTS
Exactly one of these must be specified:
Target VPN gateway resource - Target vpn gateway 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 target_vpn_gateway on the command line with a
fully specified name;
▸ provide the argument --project on the command line;
▸ set the property core/project.
TARGET_VPN_GATEWAY
ID of the target VPN gateway or fully qualified identifier for the
target VPN gateway.
To set the target_vpn_gateway attribute:
▫ provide the argument target_vpn_gateway on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
The name of the Google Compute Engine region.
To set the region attribute:
▫ provide the argument target_vpn_gateway on the command line
with a fully specified name;
▫ provide the argument --region on the command line;
▫ set the property compute/region.
--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.