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_bigtable_backups_create.1
.TH "GCLOUD_BIGTABLE_BACKUPS_CREATE" 1



.SH "NAME"
.HP
gcloud bigtable backups create \- creates a backup of a Cloud Bigtable table



.SH "SYNOPSIS"
.HP
\f5gcloud bigtable backups create\fR (\fIBACKUP\fR\ :\ \fB\-\-cluster\fR=\fICLUSTER\fR\ \fB\-\-instance\fR=\fIINSTANCE\fR) \fB\-\-table\fR=\fITABLE\fR (\fB\-\-expiration\-date\fR=\fIEXPIRATION_DATE\fR\ |\ \fB\-\-retention\-period\fR=\fIRETENTION_PERIOD\fR) [\fB\-\-async\fR] [\fB\-\-backup\-type\fR=\fIBACKUP_TYPE\fR] [\fB\-\-hot\-to\-standard\-time\fR=\fIHOT_TO_STANDARD_TIME\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Creates a backup of a Cloud Bigtable table.



.SH "EXAMPLES"

To create a backup \f5BACKUP_NAME\fR asyncronously from table \f5TABLE_NAME\fR
which expires at \f52019\-03\-30T10:49:41Z\fR, run:

.RS 2m
$ gcloud bigtable backups create BACKUP_NAME \e
    \-\-instance=INSTANCE_NAME \-\-cluster=CLUSTER_NAME \e
    \-\-table=TABLE_NAME \-\-expiration\-date=2019\-03\-30T10:49:41Z \e
    \-\-async
.RE

To create a backup \f5BACKUP_NAME\fR syncronously from table \f5TABLE_NAME\fR
which expires in 2 weeks from now, run:

.RS 2m
$ gcloud bigtable backups create BACKUP_NAME \e
    \-\-instance=INSTANCE_NAME \-\-cluster=CLUSTER_NAME \e
    \-\-table=TABLE_NAME \-\-retention\-period=2w
.RE

To create a hot backup \f5BACKUP_NAME\fR from table \f5TABLE_NAME\fR which
expires in 2 weeks from now, run:

.RS 2m
$ gcloud bigtable backups create BACKUP_NAME \e
    \-\-instance=INSTANCE_NAME \-\-cluster=CLUSTER_NAME \e
    \-\-table=TABLE_NAME \-\-retention\-period=2w \-\-backup\-type=HOT
.RE

To create a hot backup \f5BACKUP_NAME\fR from table \f5TABLE_NAME\fR which will
be converted to a standard backup at \f52019\-03\-31T10:49:41Z\fR and expires in
2 weeks from now, run:

.RS 2m
$ gcloud bigtable backups create BACKUP_NAME \e
    \-\-instance=INSTANCE_NAME \-\-cluster=CLUSTER_NAME \e
    \-\-table=TABLE_NAME \-\-retention\-period=2w \-\-backup\-type=HOT \e
    \-\-hot\-to\-standard\-time=2019\-03\-31T10:49:41Z
.RE

To create a hot backup \f5BACKUP_NAME\fR from table \f5TABLE_NAME\fR which will
be converted to a standard backup in 1 week from now and expires in 2 weeks from
now, run:

.RS 2m
$ gcloud bigtable backups create BACKUP_NAME \e
    \-\-instance=INSTANCE_NAME \-\-cluster=CLUSTER_NAME \e
    \-\-table=TABLE_NAME \-\-retention\-period=2w \-\-backup\-type=HOT \e
    \-\-hot\-to\-standard\-time=+P1w
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Backup resource \- The Cloud Bigtable backup to create. 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\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\fR

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

To set the \f5backup\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5backup\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\-\-cluster\fR=\fICLUSTER\fR

Name of the Bigtable cluster.

To set the \f5cluster\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5backup\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-cluster\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-instance\fR=\fIINSTANCE\fR

Name of the Bigtable instance.

To set the \f5instance\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5backup\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-instance\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-table\fR=\fITABLE\fR

ID of the table from which the backup will be created.

.TP 2m

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-expiration\-date\fR=\fIEXPIRATION_DATE\fR

Absolute expiration time of the backup. From the time the request is received,
must be:
.RS 2m
.IP "\(bu" 2m
At least 6 hours in the future
.IP "\(bu" 2m
At most 90 days in the future
.RE
.sp

See \f5$ gcloud topic datetimes\fR for information on date/time formats.

.TP 2m
\fB\-\-retention\-period\fR=\fIRETENTION_PERIOD\fR

Retention period of the backup relative from now; must be:
.RS 2m
.IP "\(bu" 2m
At least 6 hours
.IP "\(bu" 2m
At most 90 days
.RE
.sp

See \f5$ gcloud topic datetimes\fR for information on duration formats.


.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-backup\-type\fR=\fIBACKUP_TYPE\fR

Type of the backup; whether the backup is a standard backup or a hot backup.
\fIBACKUP_TYPE\fR must be one of: \fBbackup\-type\-unspecified\fR, \fBhot\fR,
\fBstandard\fR.

.TP 2m
\fB\-\-hot\-to\-standard\-time\fR=\fIHOT_TO_STANDARD_TIME\fR

Time at which a hot backup will be converted to a standard backup relative from
now; must be:
.RS 2m
.IP "\(em" 2m
At least 24 hours
.RE
.sp

Only applies for hot backups. See \f5$ gcloud topic datetimes\fR for information
on date/time formats.


.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 \fBbigtableadmin/v2\fR API. The full documentation for
this API can be found at: https://cloud.google.com/bigtable/



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha bigtable backups create
.RE

.RS 2m
$ gcloud beta bigtable backups create
.RE