HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/396/help/man/man1/gcloud_redis_clusters_backup-collections_describe.1
.TH "GCLOUD_REDIS_CLUSTERS_BACKUP\-COLLECTIONS_DESCRIBE" 1



.SH "NAME"
.HP
gcloud redis clusters backup\-collections describe \- show metadata for a backup collection



.SH "SYNOPSIS"
.HP
\f5gcloud redis clusters backup\-collections describe\fR (\fIBACKUP_COLLECTION\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Show metadata for a backup collection.

Displays all metadata associated with a backup collection.

This command can fail for the following reasons:
.RS 2m
.IP "\(bu" 2m
The backup collection specified does not exist.
.IP "\(bu" 2m
The active account does not have permission to access the given backup
collection.
.RE
.sp



.SH "EXAMPLES"

To display the metadata for a backup collection with the name
\f5my\-backup\-collection\fR in the us\-central1 region, run:

.RS 2m
$ {commmand} my\-backup\-collection \-\-region=us\-central1
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Backup collection resource \- Arguments and flags that specify the backup
collection you want to describe. 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5backup_collection\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIBACKUP_COLLECTION\fR

ID of the backup collection or fully qualified identifier for the backup
collection.

To set the \f5backup_collection\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5backup_collection\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

The name of the Redis region of the backup collection. Overrides the default
redis/region property value for this command invocation.


To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5backup_collection\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-region\fR on the command line;
.IP "\(bu" 2m
set the property \f5redis/region\fR.
.RE
.sp


.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 "API REFERENCE"

This command uses the \fBredis/v1\fR API. The full documentation for this API
can be found at: https://cloud.google.com/memorystore/docs/redis/



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha redis clusters backup\-collections describe
.RE

.RS 2m
$ gcloud beta redis clusters backup\-collections describe
.RE