1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-19 07:15:23 +00:00

gcloud: Wed Nov 20 10:03:22 UTC 2024

This commit is contained in:
Automated 2024-11-20 10:03:22 +00:00
parent a63704a3af
commit ad2752c6c9
198 changed files with 7874 additions and 336 deletions

View file

@ -0,0 +1,78 @@
NAME
gcloud alpha redis clusters backup-collections describe - show metadata for
a backup collection
SYNOPSIS
gcloud alpha redis clusters backup-collections describe
(BACKUP_COLLECTION : --region=REGION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Show metadata for a backup collection.
Displays all metadata associated with a backup collection.
This command can fail for the following reasons:
▪ The backup collection specified does not exist.
▪ The active account does not have permission to access the given
backup collection.
EXAMPLES
To display the metadata for a backup collection with the name
my-backup-collection in the us-central1 region, run:
$ {commmand} my-backup-collection --region=us-central1
POSITIONAL ARGUMENTS
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 project attribute:
◆ provide the argument backup_collection on the command line with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
BACKUP_COLLECTION
ID of the backup collection or fully qualified identifier for the
backup collection.
To set the backup_collection attribute:
▸ provide the argument backup_collection 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 Redis region of the backup collection. Overrides the
default redis/region property value for this command invocation.
To set the region attribute:
▸ provide the argument backup_collection on the command line with a
fully specified name;
▸ provide the argument --region on the command line;
▸ set the property redis/region.
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.
API REFERENCE
This command uses the redis/v1alpha1 API. The full documentation for this
API can be found at: https://cloud.google.com/memorystore/docs/redis/
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:
$ gcloud beta redis clusters backup-collections describe

View file

@ -0,0 +1,34 @@
NAME
gcloud alpha redis clusters backup-collections - manage backup collections
of Memorystore for Redis Cluster instances
SYNOPSIS
gcloud alpha redis clusters backup-collections COMMAND
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage backup collections of Memorystore for Redis Cluster
instances.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
(ALPHA) Show metadata for a backup collection.
list
(ALPHA) List backup collections in a region.
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:
$ gcloud beta redis clusters backup-collections

View file

@ -0,0 +1,91 @@
NAME
gcloud alpha redis clusters backup-collections list - list backup
collections in a region
SYNOPSIS
gcloud alpha redis clusters backup-collections list [--region=REGION]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List all backup collections under the specified project and region.
To specify the maximum number of results, use the --limit flag.
EXAMPLES
To list up to 5 backup collections in the us-central1 region, run:
$ gcloud alpha redis clusters backup-collections list \
--region=us-central1 --limit=5
FLAGS
Region resource - The region of the backup collections to display. This
represents a Cloud 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 --region on the command line with a fully
specified name;
◆ set the property redis/region with a fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
--region=REGION
ID of the region or fully qualified identifier for the region.
To set the region attribute:
▸ provide the argument --region on the command line;
▸ set the property redis/region.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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.
API REFERENCE
This command uses the redis/v1alpha1 API. The full documentation for this
API can be found at: https://cloud.google.com/memorystore/docs/redis/
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:
$ gcloud beta redis clusters backup-collections list

View file

@ -0,0 +1,90 @@
NAME
gcloud alpha redis clusters backups delete - delete a Memorystore for Redis
Cluster backup
SYNOPSIS
gcloud alpha redis clusters backups delete
(BACKUP : --backup-collection=BACKUP_COLLECTION --region=REGION)
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Delete a Memorystore for Redis Cluster backup.
This command can fail for the following reasons:
▪ The backup specified does not exist.
▪ The active account does not have permission to access the given
backup.
EXAMPLES
To delete a backup with the name my-backup under backup collection
my-backup-collection in us-central1 region, run:
$ gcloud alpha redis clusters backups delete my-backup \
--backup-collection=my-backup-collection --region=us-central1
POSITIONAL ARGUMENTS
Backup resource - Arguments and flags that specify the Redis backup you
want to delete. 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 backup on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
BACKUP
ID of the backup or fully qualified identifier for the backup.
To set the backup attribute:
▸ provide the argument backup on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--backup-collection=BACKUP_COLLECTION
The name of the Redis cluster backup collection.
To set the backup-collection attribute:
▸ provide the argument backup on the command line with a fully
specified name;
▸ provide the argument --backup-collection on the command line.
--region=REGION
The name of the Redis region of the backup. Overrides the default
redis/region property value for this command invocation.
To set the region attribute:
▸ provide the argument backup on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property redis/region.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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.
API REFERENCE
This command uses the redis/v1alpha1 API. The full documentation for this
API can be found at: https://cloud.google.com/memorystore/docs/redis/
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:
$ gcloud beta redis clusters backups delete

View file

@ -0,0 +1,87 @@
NAME
gcloud alpha redis clusters backups describe - show metadata for a
Memorystore for Redis Cluster backup
SYNOPSIS
gcloud alpha redis clusters backups describe
(BACKUP : --backup-collection=BACKUP_COLLECTION --region=REGION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Show metadata for a Memorystore for Redis Cluster backup.
Displays all metadata associated with a backup given a valid backup name.
This command can fail for the following reasons:
▪ The backup specified does not exist.
▪ The active account does not have permission to access the given
backup.
EXAMPLES
To display the metadata for a backup named my-backup, under my-collection
backup collection, in us-central1 region, run:
$ gcloud alpha redis clusters backups describe my-backup \
--backup_collection=my-collection --region=us-central1
POSITIONAL ARGUMENTS
Backup resource - Arguments and flags that specify the backup 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 project attribute:
◆ provide the argument backup on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
BACKUP
ID of the backup or fully qualified identifier for the backup.
To set the backup attribute:
▸ provide the argument backup on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--backup-collection=BACKUP_COLLECTION
The name of the Redis cluster backup collection.
To set the backup-collection attribute:
▸ provide the argument backup on the command line with a fully
specified name;
▸ provide the argument --backup-collection on the command line.
--region=REGION
The name of the Redis region of the backup. Overrides the default
redis/region property value for this command invocation.
To set the region attribute:
▸ provide the argument backup on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property redis/region.
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.
API REFERENCE
This command uses the redis/v1alpha1 API. The full documentation for this
API can be found at: https://cloud.google.com/memorystore/docs/redis/
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:
$ gcloud beta redis clusters backups describe

View file

@ -0,0 +1,93 @@
NAME
gcloud alpha redis clusters backups export - export a Redis cluster backup
to a Google Cloud Storage bucket
SYNOPSIS
gcloud alpha redis clusters backups export
(BACKUP : --backup-collection=BACKUP_COLLECTION --region=REGION)
--gcs-bucket=GCS_BUCKET [--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) This command exports a Redis cluster backup to a Google Cloud
Storage bucket. A new folder will be created in the bucket with the backup
name. And the backup files will be stored in the folder.
EXAMPLES
To export a backup with name my-backup under backup collection
my-collection in us-central region to my-bucket Google Cloud Storage
bucket, run:
$ gcloud alpha redis clusters backups export my-backup \
--backup-collection=my-collection --region=us-central1 \
--bucket-name=my-bucket
POSITIONAL ARGUMENTS
Backup resource - Arguments and flags that specify the Redis backup you
want to export. 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 backup on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
BACKUP
ID of the backup or fully qualified identifier for the backup.
To set the backup attribute:
▸ provide the argument backup on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--backup-collection=BACKUP_COLLECTION
The name of the Redis cluster backup collection.
To set the backup-collection attribute:
▸ provide the argument backup on the command line with a fully
specified name;
▸ provide the argument --backup-collection on the command line.
--region=REGION
The name of the Redis region of the backup. Overrides the default
redis/region property value for this command invocation.
To set the region attribute:
▸ provide the argument backup on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property redis/region.
REQUIRED FLAGS
--gcs-bucket=GCS_BUCKET
The name of the Google Cloud Storage bucket to export the backup to.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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.
API REFERENCE
This command uses the redis/v1alpha1 API. The full documentation for this
API can be found at: https://cloud.google.com/memorystore/docs/redis/
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:
$ gcloud beta redis clusters backups export

View file

@ -0,0 +1,38 @@
NAME
gcloud alpha redis clusters backups - manage backups of Memorystore for
Redis Cluster instances
SYNOPSIS
gcloud alpha redis clusters backups COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage backups of Memorystore for Redis Cluster instances.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
delete
(ALPHA) Delete a Memorystore for Redis Cluster backup.
describe
(ALPHA) Show metadata for a Memorystore for Redis Cluster backup.
export
(ALPHA) Export a Redis cluster backup to a Google Cloud Storage bucket.
list
(ALPHA) List backups under a backup collection in a region.
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:
$ gcloud beta redis clusters backups

View file

@ -0,0 +1,107 @@
NAME
gcloud alpha redis clusters backups list - list backups under a backup
collection in a region
SYNOPSIS
gcloud alpha redis clusters backups list
(--backup_collection=BACKUP_COLLECTION : --region=REGION)
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List backups under a backup collection in a region.
To specify the maximum number of results, use the --limit flag.
EXAMPLES
To list up to 5 backups in the us-central1 region, run:
$ gcloud alpha redis clusters backups list \
--backup_collection=my-collection --region=us-central1 --limit=5
REQUIRED FLAGS
Backup collection resource - The backup collection of the backups to
display. 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 --backup_collection on the command line with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
--backup_collection=BACKUP_COLLECTION
ID of the backup collection or fully qualified identifier for the
backup collection.
To set the backup_collection attribute:
▸ provide the argument --backup_collection on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--region=REGION
The name of the Redis region of the backup collection. Overrides the
default redis/region property value for this command invocation.
To set the region attribute:
▸ provide the argument --backup_collection on the command line with
a fully specified name;
▸ provide the argument --region on the command line;
▸ set the property redis/region.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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.
API REFERENCE
This command uses the redis/v1alpha1 API. The full documentation for this
API can be found at: https://cloud.google.com/memorystore/docs/redis/
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:
$ gcloud beta redis clusters backups list

View file

@ -17,6 +17,8 @@ SYNOPSIS
[--shard-count=SHARD_COUNT]
[--transit-encryption-mode=TRANSIT_ENCRYPTION_MODE] [--zone=ZONE]
[--zone-distribution-mode=ZONE_DISTRIBUTION_MODE]
[--import-gcs-object-uris=[IMPORT_GCS_OBJECT_URIS,...]
| --import-managed-backup=IMPORT_MANAGED_BACKUP]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
@ -214,6 +216,16 @@ FLAGS
single-zone
Allocate cluster nodes in a single zone.
At most one of these can be specified:
--import-gcs-object-uris=[IMPORT_GCS_OBJECT_URIS,...]
The URIs of Google Cloud Storage objects to import from. For example,
gs://bucket/folder/file1.rdb,gs://bucket/folder/file2.rdb.
--import-managed-backup=IMPORT_MANAGED_BACKUP
The managed backup to import from. For example,
projects/PROJECT_ID/locations/REGION/backupCollections/BACKUP_COLLECTION_ID/backups/BACKUP_ID.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,

View file

@ -0,0 +1,82 @@
NAME
gcloud alpha redis clusters create-backup - create a backup of a Redis
cluster
SYNOPSIS
gcloud alpha redis clusters create-backup (CLUSTER : --region=REGION)
[--async] [--backup-id=BACKUP_ID] [--ttl=TTL] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create a backup of a Redis cluster. The backup can be used to seed
a new cluster or exported to a Google Cloud Storage bucket.
The created backup will be added into the backup collection associated with
the cluster. Describe the cluster to get the backup collection name.
POSITIONAL ARGUMENTS
Cluster resource - Arguments and flags that specify the Memorystore Redis
cluster to create a backup 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 cluster on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
CLUSTER
ID of the cluster or fully qualified identifier for the cluster.
To set the cluster attribute:
▸ provide the argument cluster 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 Redis region of the cluster. Overrides the default
redis/region property value for this command invocation.
To set the region attribute:
▸ provide the argument cluster on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property redis/region.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--backup-id=BACKUP_ID
The ID of the backup.
--ttl=TTL
The time to live for the backup. The backup will be deleted
automatically after the TTL is reached. For example, "10d" for 10 days.
The minimum value is 1 day. If not specified, the default value is 100
years.
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.
API REFERENCE
This command uses the redis/v1alpha1 API. The full documentation for this
API can be found at: https://cloud.google.com/memorystore/docs/redis/
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:
$ gcloud beta redis clusters create-backup

View file

@ -3,7 +3,7 @@ NAME
instances
SYNOPSIS
gcloud alpha redis clusters COMMAND [GCLOUD_WIDE_FLAG ...]
gcloud alpha redis clusters GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage Memorystore for Redis Cluster instances.
@ -13,6 +13,16 @@ GCLOUD WIDE FLAGS
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
backup-collections
(ALPHA) Manage backup collections of Memorystore for Redis Cluster
instances.
backups
(ALPHA) Manage backups of Memorystore for Redis Cluster instances.
COMMANDS
COMMAND is one of the following:
@ -22,6 +32,9 @@ COMMANDS
create
(ALPHA) Create a new Memorystore for Redis Cluster instance.
create-backup
(ALPHA) Create a backup of a Redis cluster.
delete
(ALPHA) Delete a Memorystore for Redis Cluster instance.