gcloud alpha compute vpn-gateways config export - export the configuration for a Compute Engine vpn gateway
gcloud alpha compute vpn-gateways config export ([VPN_GATEWAY : --region=REGION] --all) [--path=PATH; default="-"] [--resource-format=RESOURCE_FORMAT] [GCLOUD_WIDE_FLAG ...]
(ALPHA) gcloud alpha compute vpn-gateways config export exports the configuration for a Compute Engine vpn gateway.
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 vpn gateways within the project.
Specifying --path allows you to export the configuration(s) to a local directory.
To export the configuration for a vpn gateway, run:
$ gcloud alpha compute vpn-gateways config export my-vpn-gateway
To export the configuration for a vpn gateway to a file, run:
$ gcloud alpha compute vpn-gateways config export my-vpn-gateway \ --path=/path/to/dir/
To export the configuration for a vpn gateway in Terraform HCL format, run:
$ gcloud alpha compute vpn-gateways config export my-vpn-gateway \ --resource-format=terraform
To export the configurations for all vpn gateways within a project, run:
$ gcloud alpha compute vpn-gateways config export --all
- Exactly one of these must be specified:
- VPN gateway resource - 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 vpn_gateway on the command line with a fully specified name;
set the property core/project;
provide the argument --project on the command line.
- VPN_GATEWAY
ID of the VPN gateway or fully qualified identifier for the VPN gateway. To set the vpn_gateway attribute:
- —
provide the argument 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 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.
- --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.
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.
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.