1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 14:56:05 +00:00

gcloud: Wed Mar 19 10:42:21 UTC 2025

This commit is contained in:
Automated 2025-03-19 10:42:21 +00:00
parent a459a88a5f
commit e555fef0aa
170 changed files with 6428 additions and 659 deletions

View file

@ -2,13 +2,15 @@ NAME
gcloud alpha memorystore instances create - create a Memorystore instance
SYNOPSIS
gcloud alpha memorystore instances create (INSTANCE : --location=LOCATION)
[--async] [--async-instance-endpoints-deletion-enabled]
gcloud alpha memorystore instances create INSTANCE [--async]
[--async-instance-endpoints-deletion-enabled]
[--authorization-mode=AUTHORIZATION_MODE]
[--deletion-protection-enabled] [--endpoints=[connections=CONNECTIONS]]
[--engine-configs=[ENGINE_CONFIGS,...]]
[--engine-version=ENGINE_VERSION] [--labels=[LABELS,...]] [--mode=MODE]
[--node-type=NODE_TYPE] [--ondemand-maintenance]
[--engine-version=ENGINE_VERSION] [--labels=[LABELS,...]]
[--location=LOCATION]
[--maintenance-policy-weekly-window=[day=DAY],[startTime=STARTTIME]]
[--mode=MODE] [--node-type=NODE_TYPE] [--ondemand-maintenance]
[--psc-auto-connections=[network=NETWORK],
[port=PORT],[projectId=PROJECTID]] [--replica-count=REPLICA_COUNT]
[--request-id=REQUEST_ID] [--shard-count=SHARD_COUNT]
@ -17,6 +19,7 @@ SYNOPSIS
--persistence-config-mode=PERSISTENCE_CONFIG_MODE
--rdb-config-snapshot-period=RDB_CONFIG_SNAPSHOT_PERIOD
--rdb-config-snapshot-start-time=RDB_CONFIG_SNAPSHOT_START_TIME]
[--cross-instance-replication-config-role=CROSS_INSTANCE_REPLICATION_CONFIG_ROLE : --cross-instance-replication-config-secondary-instances=[instance=INSTANCE] --primary-instance=PRIMARY_INSTANCE]
[--zone-distribution-config=ZONE_DISTRIBUTION_CONFIG
--zone-distribution-config-mode=ZONE_DISTRIBUTION_CONFIG_MODE]
[GCLOUD_WIDE_FLAG ...]
@ -49,10 +52,9 @@ EXAMPLES
POSITIONAL ARGUMENTS
Instance resource - Identifier. Unique name of the instance. Format:
projects/{project}/locations/{location}/instances/{instance} 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.
projects/{project}/locations/{location}/instances/{instance} 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 instance on the command line with a fully
@ -60,6 +62,11 @@ POSITIONAL ARGUMENTS
◆ provide the argument --project on the command line;
◆ set the property core/project.
To set the location attribute:
◆ provide the argument instance on the command line with a fully
specified name;
◆ provide the argument --location on the command line.
This must be specified.
INSTANCE
@ -68,17 +75,6 @@ POSITIONAL ARGUMENTS
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the instance resource.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
@ -188,6 +184,55 @@ FLAGS
--labels=path_to_file.(yaml|json)
--location=LOCATION
For resources [instance], provides fallback value for resource location
attribute. When the resource's full URI path is not provided, location
will fallback to this flag value.
Maintenance policy per instance.
--maintenance-policy-weekly-window=[day=DAY],[startTime=STARTTIME]
Maintenance window that is applied to resources covered by this
policy. Minimum 1. For the current version, the maximum number of
weekly_window is expected to be one.
day
Allows to define schedule that runs specified day of the week.
startTime
Start time of the window in UTC.
hours
Hours of a day in 24 hour format. Must be greater than or
equal to 0 and typically must be less than or equal to 23. An
API may choose to allow the value "24:00:00" for scenarios
like business closing time.
minutes
Minutes of an hour. Must be greater than or equal to 0 and
less than or equal to 59.
nanos
Fractions of seconds, in nanoseconds. Must be greater than or
equal to 0 and less than or equal to 999,999,999.
seconds
Seconds of a minute. Must be greater than or equal to 0 and
typically must be less than or equal to 59. An API may allow
the value 60 if it allows leap-seconds.
Shorthand Example:
--maintenance-policy-weekly-window=day=string,startTime={hours=int,minutes=int,nanos=int,seconds=int} --maintenance-policy-weekly-window=day=string,startTime={hours=int,minutes=int,nanos=int,seconds=int}
JSON Example:
--maintenance-policy-weekly-window='[{"day": "string", "startTime": {"hours": int, "minutes": int, "nanos": int, "seconds": int}}]'
File Example:
--maintenance-policy-weekly-window=path_to_file.(yaml|json)
--mode=MODE
The mode config for the instance. MODE must be one of:
@ -324,6 +369,76 @@ FLAGS
future snapshots will be aligned. If not provided, the current time
will be used.
Cross instance replication config.
--cross-instance-replication-config-role=CROSS_INSTANCE_REPLICATION_CONFIG_ROLE
The role of the instance in cross instance replication.
CROSS_INSTANCE_REPLICATION_CONFIG_ROLE must be one of:
none
This instance does not participate in cross instance replication.
It is an independent instance and does not replicate to or from
any other instances.
primary
A instance that allows both reads and writes. Any data written to
this instance is also replicated to the attached secondary
instances.
secondary
A instance that allows only reads and replicates data from a
primary instance.
This flag argument must be specified if any of the other arguments in
this group are specified.
--cross-instance-replication-config-secondary-instances=[instance=INSTANCE]
List of secondary instances that are replicating from this primary
instance.
This field is only set for a primary instance.
instance
The full resource path of the remote instance in the format:
projects/<project>/locations/<region>/instances/<instance-id>.
Shorthand Example:
--cross-instance-replication-config-secondary-instances=instance=string --cross-instance-replication-config-secondary-instances=instance=string
JSON Example:
--cross-instance-replication-config-secondary-instances='[{"instance": "string"}]'
File Example:
--cross-instance-replication-config-secondary-instances=path_to_file.(yaml|json)
Details of the remote instance associated with this instance in a cross
instance replication setup.
Instance resource - The full resource path of the remote instance in
the format:
projects/<project>/locations/<region>/instances/<instance-id> 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 --primary-instance on the command line with
a fully specified name;
▫ provide the argument --project on the command line;
▫ set the property core/project.
To set the location attribute:
▫ provide the argument --primary-instance on the command line with
a fully specified name;
▫ provide the argument --location on the command line.
--primary-instance=PRIMARY_INSTANCE
ID of the instance or fully qualified identifier for the
instance.
To set the instance attribute:
◇ provide the argument --primary-instance on the command line.
Zone distribution configuration for allocation of instance resources.
--zone-distribution-config=ZONE_DISTRIBUTION_CONFIG

View file

@ -31,6 +31,9 @@ COMMANDS
(ALPHA) List all Memorystore instances in a specified project and
location.
reschedule-maintenance
(ALPHA) Reschedule maintenance window for an instance.
update
(ALPHA) Update the configuration of a Memorystore instance.

View file

@ -0,0 +1,94 @@
NAME
gcloud alpha memorystore instances reschedule-maintenance - reschedule
maintenance window for an instance
SYNOPSIS
gcloud alpha memorystore instances reschedule-maintenance
(INSTANCE : --location=LOCATION) --reschedule-type=RESCHEDULE_TYPE
[--async] [--schedule-time=SCHEDULE_TIME] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Reschedule maintenance window for an instance.
EXAMPLES
To reschedule maintenance window for an instance with the name my-instance
in region us-central-1 with immediate, run:
$ gcloud alpha memorystore instances reschedule-maintenance \
`my-instance` --project=my-project --location=us-central1 \
--reschedule-type=IMMEDIATE
POSITIONAL ARGUMENTS
Instance resource - Name of the instance to reschedule maintenance for:
projects/{project}/locations/{location_id}/instances/{instance} 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 instance 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.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the instance resource.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
REQUIRED FLAGS
--reschedule-type=RESCHEDULE_TYPE
If reschedule type is SPECIFIC_TIME, schedule_time must be set.
RESCHEDULE_TYPE must be one of:
immediate
If the user wants to schedule the maintenance to happen now.
specific-time
If the user wants to reschedule the maintenance to a specific time.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--schedule-time=SCHEDULE_TIME
Timestamp when the maintenance shall be rescheduled to if
reschedule_type=SPECIFIC_TIME, in RFC 3339 format. Example:
2012-11-15T16:19:00.094Z.
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 memorystore/v1alpha API. The full documentation for
this API can be found at: https://cloud.google.com/memorystore/
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. These variants are also available:
$ gcloud memorystore instances reschedule-maintenance
$ gcloud beta memorystore instances reschedule-maintenance

View file

@ -3,17 +3,25 @@ NAME
Memorystore instance
SYNOPSIS
gcloud alpha memorystore instances update (INSTANCE : --location=LOCATION)
[--async] [--[no-]async-instance-endpoints-deletion-enabled]
gcloud alpha memorystore instances update INSTANCE [--async]
[--[no-]async-instance-endpoints-deletion-enabled]
[--[no-]deletion-protection-enabled] [--engine-version=ENGINE_VERSION]
[--mode=MODE] [--node-type=NODE_TYPE] [--[no-]ondemand-maintenance]
[--replica-count=REPLICA_COUNT] [--request-id=REQUEST_ID]
[--shard-count=SHARD_COUNT]
[--location=LOCATION] [--mode=MODE] [--node-type=NODE_TYPE]
[--[no-]ondemand-maintenance] [--replica-count=REPLICA_COUNT]
[--request-id=REQUEST_ID] [--shard-count=SHARD_COUNT]
[--aof-config-append-fsync=AOF_CONFIG_APPEND_FSYNC
--clear-persistence-config
--persistence-config-mode=PERSISTENCE_CONFIG_MODE
--rdb-config-snapshot-period=RDB_CONFIG_SNAPSHOT_PERIOD
--rdb-config-snapshot-start-time=RDB_CONFIG_SNAPSHOT_START_TIME]
[--clear-cross-instance-replication-config
--cross-instance-replication-config-role=CROSS_INSTANCE_REPLICATION_CONFIG_ROLE --clear-primary-instance | --primary-instance=PRIMARY_INSTANCE --cross-instance-replication-config-secondary-instances=[instance=INSTANCE] | --add-cross-instance-replication-config-secondary-instances=[instance=INSTANCE] --clear-cross-instance-replication-config-secondary-instances | --remove-cross-instance-replication-config-secondary-instances=[instance=INSTANCE]]
[--clear-maintenance-policy
--maintenance-policy-weekly-window=[day=DAY],[startTime=STARTTIME]
| --add-maintenance-policy-weekly-window=[day=DAY],
[startTime=STARTTIME] --clear-maintenance-policy-weekly-window
| --remove-maintenance-policy-weekly-window=[day=DAY],
[startTime=STARTTIME]]
[--endpoints=[connections=CONNECTIONS]
| --add-endpoints=[connections=CONNECTIONS] --clear-endpoints
| --remove-endpoints=[connections=CONNECTIONS]]
@ -44,10 +52,9 @@ EXAMPLES
POSITIONAL ARGUMENTS
Instance resource - Identifier. Unique name of the instance. Format:
projects/{project}/locations/{location}/instances/{instance} 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.
projects/{project}/locations/{location}/instances/{instance} 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 instance on the command line with a fully
@ -55,6 +62,11 @@ POSITIONAL ARGUMENTS
◆ provide the argument --project on the command line;
◆ set the property core/project.
To set the location attribute:
◆ provide the argument instance on the command line with a fully
specified name;
◆ provide the argument --location on the command line.
This must be specified.
INSTANCE
@ -63,17 +75,6 @@ POSITIONAL ARGUMENTS
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the instance resource.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
@ -99,6 +100,11 @@ FLAGS
--engine-version=ENGINE_VERSION
Engine version of the instance.
--location=LOCATION
For resources [instance], provides fallback value for resource location
attribute. When the resource's full URI path is not provided, location
will fallback to this flag value.
--mode=MODE
The mode config for the instance. MODE must be one of:
@ -203,6 +209,289 @@ FLAGS
future snapshots will be aligned. If not provided, the current time
will be used.
Cross instance replication config.
--clear-cross-instance-replication-config
Set instance.crossInstanceReplicationConfig back to default value.
--cross-instance-replication-config-role=CROSS_INSTANCE_REPLICATION_CONFIG_ROLE
The role of the instance in cross instance replication.
CROSS_INSTANCE_REPLICATION_CONFIG_ROLE must be one of:
none
This instance does not participate in cross instance replication.
It is an independent instance and does not replicate to or from
any other instances.
primary
A instance that allows both reads and writes. Any data written to
this instance is also replicated to the attached secondary
instances.
secondary
A instance that allows only reads and replicates data from a
primary instance.
Details of the remote instance associated with this instance in a cross
instance replication setup.
Update primary_instance.
At most one of these can be specified:
--clear-primary-instance
Clear primary_instance value and set to null.
Instance resource - Set primary_instance to new value.
The full resource path of the remote instance in the format:
projects/<project>/locations/<region>/instances/<instance-id> 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 --primary-instance on the command line
with a fully specified name;
◇ provide the argument --project on the command line;
◇ set the property core/project.
To set the location attribute:
◇ provide the argument --primary-instance on the command line
with a fully specified name;
◇ provide the argument --location on the command line.
--primary-instance=PRIMARY_INSTANCE
ID of the instance or fully qualified identifier for the
instance.
To set the instance attribute:
▹ provide the argument --primary-instance on the command
line.
Update cross_instance_replication_config_secondary_instances.
At most one of these can be specified:
--cross-instance-replication-config-secondary-instances=[instance=INSTANCE]
Set cross_instance_replication_config_secondary_instances to new
value. List of secondary instances that are replicating from this
primary instance.
This field is only set for a primary instance.
instance
The full resource path of the remote instance in the format:
projects/<project>/locations/<region>/instances/<instance-id>.
Shorthand Example:
--cross-instance-replication-config-secondary-instances=instance=string --cross-instance-replication-config-secondary-instances=instance=string
JSON Example:
--cross-instance-replication-config-secondary-instances='[{"instance": "string"}]'
File Example:
--cross-instance-replication-config-secondary-instances=path_to_file.(yaml|json)
--add-cross-instance-replication-config-secondary-instances=[instance=INSTANCE]
Add new value to
cross_instance_replication_config_secondary_instances list. List of
secondary instances that are replicating from this primary
instance.
This field is only set for a primary instance.
instance
The full resource path of the remote instance in the format:
projects/<project>/locations/<region>/instances/<instance-id>.
Shorthand Example:
--add-cross-instance-replication-config-secondary-instances=instance=string --add-cross-instance-replication-config-secondary-instances=instance=string
JSON Example:
--add-cross-instance-replication-config-secondary-instances='[{"instance": "string"}]'
File Example:
--add-cross-instance-replication-config-secondary-instances=path_to_file.(yaml|json)
At most one of these can be specified:
--clear-cross-instance-replication-config-secondary-instances
Clear cross_instance_replication_config_secondary_instances value
and set to empty list.
--remove-cross-instance-replication-config-secondary-instances=[instance=INSTANCE]
Remove existing value from
cross_instance_replication_config_secondary_instances list. List
of secondary instances that are replicating from this primary
instance.
This field is only set for a primary instance.
instance
The full resource path of the remote instance in the format:
projects/<project>/locations/<region>/instances/<instance-id>.
Shorthand Example:
--remove-cross-instance-replication-config-secondary-instances=instance=string --remove-cross-instance-replication-config-secondary-instances=instance=string
JSON Example:
--remove-cross-instance-replication-config-secondary-instances='[{"instance": "string"}]'
File Example:
--remove-cross-instance-replication-config-secondary-instances=path_to_file.(yaml|json)
Maintenance policy per instance.
--clear-maintenance-policy
Set instance.maintenancePolicy back to default value.
Update maintenance_policy_weekly_window.
At most one of these can be specified:
--maintenance-policy-weekly-window=[day=DAY],[startTime=STARTTIME]
Set maintenance_policy_weekly_window to new value. Maintenance
window that is applied to resources covered by this policy. Minimum
1. For the current version, the maximum number of weekly_window is
expected to be one.
day
Allows to define schedule that runs specified day of the week.
startTime
Start time of the window in UTC.
hours
Hours of a day in 24 hour format. Must be greater than or
equal to 0 and typically must be less than or equal to 23.
An API may choose to allow the value "24:00:00" for
scenarios like business closing time.
minutes
Minutes of an hour. Must be greater than or equal to 0 and
less than or equal to 59.
nanos
Fractions of seconds, in nanoseconds. Must be greater than
or equal to 0 and less than or equal to 999,999,999.
seconds
Seconds of a minute. Must be greater than or equal to 0 and
typically must be less than or equal to 59. An API may
allow the value 60 if it allows leap-seconds.
Shorthand Example:
--maintenance-policy-weekly-window=day=string,startTime={hours=int,minutes=int,nanos=int,seconds=int} --maintenance-policy-weekly-window=day=string,startTime={hours=int,minutes=int,nanos=int,seconds=int}
JSON Example:
--maintenance-policy-weekly-window='[{"day": "string", "startTime": {"hours": int, "minutes": int, "nanos": int, "seconds": int}}]'
File Example:
--maintenance-policy-weekly-window=path_to_file.(yaml|json)
--add-maintenance-policy-weekly-window=[day=DAY],[startTime=STARTTIME]
Add new value to maintenance_policy_weekly_window list. Maintenance
window that is applied to resources covered by this policy. Minimum
1. For the current version, the maximum number of weekly_window is
expected to be one.
day
Allows to define schedule that runs specified day of the week.
startTime
Start time of the window in UTC.
hours
Hours of a day in 24 hour format. Must be greater than or
equal to 0 and typically must be less than or equal to 23.
An API may choose to allow the value "24:00:00" for
scenarios like business closing time.
minutes
Minutes of an hour. Must be greater than or equal to 0 and
less than or equal to 59.
nanos
Fractions of seconds, in nanoseconds. Must be greater than
or equal to 0 and less than or equal to 999,999,999.
seconds
Seconds of a minute. Must be greater than or equal to 0 and
typically must be less than or equal to 59. An API may
allow the value 60 if it allows leap-seconds.
Shorthand Example:
--add-maintenance-policy-weekly-window=day=string,startTime={hours=int,minutes=int,nanos=int,seconds=int} --add-maintenance-policy-weekly-window=day=string,startTime={hours=int,minutes=int,nanos=int,seconds=int}
JSON Example:
--add-maintenance-policy-weekly-window='[{"day": "string", "startTime": {"hours": int, "minutes": int, "nanos": int, "seconds": int}}]'
File Example:
--add-maintenance-policy-weekly-window=path_to_file.(yaml|json)
At most one of these can be specified:
--clear-maintenance-policy-weekly-window
Clear maintenance_policy_weekly_window value and set to empty
list.
--remove-maintenance-policy-weekly-window=[day=DAY],[startTime=STARTTIME]
Remove existing value from maintenance_policy_weekly_window list.
Maintenance window that is applied to resources covered by this
policy. Minimum 1. For the current version, the maximum number of
weekly_window is expected to be one.
day
Allows to define schedule that runs specified day of the
week.
startTime
Start time of the window in UTC.
hours
Hours of a day in 24 hour format. Must be greater than or
equal to 0 and typically must be less than or equal to
23. An API may choose to allow the value "24:00:00" for
scenarios like business closing time.
minutes
Minutes of an hour. Must be greater than or equal to 0
and less than or equal to 59.
nanos
Fractions of seconds, in nanoseconds. Must be greater
than or equal to 0 and less than or equal to 999,999,999.
seconds
Seconds of a minute. Must be greater than or equal to 0
and typically must be less than or equal to 59. An API
may allow the value 60 if it allows leap-seconds.
Shorthand Example:
--remove-maintenance-policy-weekly-window=day=string,startTime={hours=int,minutes=int,nanos=int,seconds=int} --remove-maintenance-policy-weekly-window=day=string,startTime={hours=int,minutes=int,nanos=int,seconds=int}
JSON Example:
--remove-maintenance-policy-weekly-window='[{"day": "string", "startTime": {"hours": int, "minutes": int, "nanos": int, "seconds": int}}]'
File Example:
--remove-maintenance-policy-weekly-window=path_to_file.(yaml|json)
Update endpoints.
At most one of these can be specified: