File: //snap/google-cloud-cli/396/help/man/man1/gcloud_alpha_resource-config_bulk-export.1
.TH "GCLOUD_ALPHA_RESOURCE\-CONFIG_BULK\-EXPORT" 1
.SH "NAME"
.HP
gcloud alpha resource\-config bulk\-export \- export configurations for all assets within the specified project, organization, or folder
.SH "SYNOPSIS"
.HP
\f5gcloud alpha resource\-config bulk\-export\fR [\fB\-\-on\-error\fR=\fION_ERROR\fR;\ default="ignore"] [\fB\-\-path\fR=\fIPATH\fR;\ default="\-"] [\fB\-\-resource\-format\fR=\fIRESOURCE_FORMAT\fR] [\fB\-\-folder\fR=\fIFOLDER\fR\ |\ \fB\-\-organization\fR=\fIORGANIZATION\fR\ |\ \fB\-\-project\fR=\fIPROJECT\fR] [\fB\-\-storage\-path\fR=\fISTORAGE_PATH\fR\ |\ \fB\-\-resource\-types\fR=[\fIRESOURCE_TYPE\fR,...]\ |\ \fB\-\-resource\-types\-file\fR=\fIRESOURCE_TYPE_FILE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fB(ALPHA)\fR Export configurations for all assets within the specified project,
organization, or folder.
.SH "EXAMPLES"
To export all resources in a project to a local directory, run:
.RS 2m
$ gcloud alpha resource\-config bulk\-export \-\-path=/path/to/dir/
.RE
To export all resources in a organization to stdout, run:
.RS 2m
$ gcloud alpha resource\-config bulk\-export \-\-organization=12345 \e
\-\-path=\-
.RE
To export all resources in a folder to stdout in Terraform format, run:
.RS 2m
$ gcloud alpha resource\-config bulk\-export \-\-folder=12345 \e
\-\-resource\-format=terraform
.RE
To export all resources in a project to stdout, using a custom Google Storage
bucket for interim results, run:
.RS 2m
$ gcloud alpha resource\-config bulk\-export \-\-project=my\-project \e
\-\-storage\-path='gs://your\-bucket\-name/your/prefix/path'
.RE
To export all Storage Bucket and Compute Instances resources in project
my\-project to stdout, run:
.RS 2m
$ gcloud alpha resource\-config bulk\-export \-\-project=my\-project \e
\-\-resource\-types=storage.cnrm.cloud.google.com/StorageBucket,\e
ComputeInstance
.RE
To export all resource types in file 'types\-file.txt' in project my\-project to
stdout, run:
.RS 2m
$ gcloud alpha resource\-config bulk\-export \-\-project=my\-project \e
\-\-resource\-types\-file=types\-file.txt
.RE
.SH "FLAGS"
.RS 2m
.TP 2m
\fB\-\-on\-error\fR=\fION_ERROR\fR; default="ignore"
Determines behavior when a recoverable error is encountered while exporting a
resource. To stop execution when encountering an error, specify "halt". To log
errors when encountered and continue the export, specify "continue". To continue
when errors are encountered without logging, specify "ignore". \fION_ERROR\fR
must be one of: \fBcontinue\fR, \fBhalt\fR, \fBignore\fR.
.TP 2m
\fB\-\-path\fR=\fIPATH\fR; default="\-"
Path of the directory or file to output configuration(s). To output
configurations to stdout, specify "\-\-path=\-".
.TP 2m
\fB\-\-resource\-format\fR=\fIRESOURCE_FORMAT\fR
Format of the configuration to export. Available configuration formats are
Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command
defaults to "krm". \fIRESOURCE_FORMAT\fR must be one of: \fBkrm\fR,
\fBterraform\fR.
.TP 2m
\f5RESOURCE PARENT FLAG\fR \- specify one of the following to determine the
scope of exported resources.
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-folder\fR=\fIFOLDER\fR
Folder ID
.TP 2m
\fB\-\-organization\fR=\fIORGANIZATION\fR
Organization ID
.TP 2m
\fB\-\-project\fR=\fIPROJECT\fR
Project ID
.RE
.sp
.TP 2m
Select \f5storage\-path\fR if you want to specify the Google Cloud Storage
bucket bulk\-export should use for Cloud Asset Inventory Export. Alternatively,
you can provide a \f5RESOURCE TYPE FILTER\fR to filter resources. Filtering
resources \fIdoes not\fR use Google Cloud Storage to export resources.
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-storage\-path\fR=\fISTORAGE_PATH\fR
Google Cloud Storage path where a Cloud Asset Inventory export will be stored,
example: \f5gs://your\-bucket\-name/your/prefix/path\fR
.TP 2m
\f5RESOURCE TYPE FILTERS\fR \- specify resource types to export.
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-resource\-types\fR=[\fIRESOURCE_TYPE\fR,...]
List of Config Connector KRM Kinds to export. For a full list of supported
resource types for a given parent scope run:
.RS 2m
$ gcloud alpha resource\-config list\-resource\-types \e
\-\-[project|organization|folder]=<PARENT>
.RE
.TP 2m
\fB\-\-resource\-types\-file\fR=\fIRESOURCE_TYPE_FILE\fR
A comma (',') or newline ('\en') separated file containing the list of Config
Connector KRM Kinds to export. For a full list of supported resource types for a
given parent scope run:
.RS 2m
$ gcloud alpha resource\-config list\-resource\-types \e
\-\-[project|organization|folder]=<PARENT>
.RE
Use a full or relative path to a local file containing the value of
resource_types_file.
.RE
.RE
.RE
.sp
.SH "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 \fB$ gcloud help\fR for details.
.SH "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. This variant is also available:
.RS 2m
$ gcloud beta resource\-config bulk\-export
.RE