diff --git a/gcloud/_version b/gcloud/_version index 0a31b12c9..8fb7c69b1 100644 --- a/gcloud/_version +++ b/gcloud/_version @@ -1,8 +1,8 @@ -Google Cloud SDK 501.0.0 -alpha 2024.11.08 -beta 2024.11.08 +Google Cloud SDK 502.0.0 +alpha 2024.11.15 +beta 2024.11.15 bq 2.1.9 bundled-python3-unix 3.11.9 -core 2024.11.08 +core 2024.11.15 gcloud-crc32c 1.0.0 gsutil 5.31 diff --git a/gcloud/ai/index-endpoints/deploy-index b/gcloud/ai/index-endpoints/deploy-index index c7073a329..d623ba7f4 100644 --- a/gcloud/ai/index-endpoints/deploy-index +++ b/gcloud/ai/index-endpoints/deploy-index @@ -10,6 +10,7 @@ SYNOPSIS [--enable-access-logging] [--machine-type=MACHINE_TYPE] [--max-replica-count=MAX_REPLICA_COUNT] [--min-replica-count=MIN_REPLICA_COUNT] + [--psc-automation-configs=[network=NETWORK],[project-id=PROJECT-ID]] [--reserved-ip-ranges=[RESERVED_IP_RANGES,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -113,6 +114,14 @@ OPTIONAL FLAGS Minimum number of machine replicas the deployed index will be always deployed on. If specified, the value must be equal to or larger than 1. + --psc-automation-configs=[network=NETWORK],[project-id=PROJECT-ID] + A pair of project-id and network the PSC index will be deployed to. For + example: + --psc-automation-configs=project-id=my-project,network=my-network. For + multiple networks, this flag can be repeated: + --psc-automation-configs=project-id=my-project,network=my-network + --psc-automation-configs=project-id=my-project2,network=my-network2 + --reserved-ip-ranges=[RESERVED_IP_RANGES,...] List of reserved IP ranges deployed index will be deployed to. diff --git a/gcloud/ai/index-endpoints/mutate-deployed-index b/gcloud/ai/index-endpoints/mutate-deployed-index index 7c67df15b..4e42f4b6d 100644 --- a/gcloud/ai/index-endpoints/mutate-deployed-index +++ b/gcloud/ai/index-endpoints/mutate-deployed-index @@ -8,7 +8,7 @@ SYNOPSIS --deployed-index-id=DEPLOYED_INDEX_ID [--allowed-issuers=[ALLOWED_ISSUERS,...]] [--audiences=[AUDIENCES,...]] [--deployment-group=DEPLOYMENT_GROUP] [--enable-access-logging] - [--max-replica-count=MAX_REPLICA_COUNT] + [--machine-type=MACHINE_TYPE] [--max-replica-count=MAX_REPLICA_COUNT] [--min-replica-count=MIN_REPLICA_COUNT] [--reserved-ip-ranges=[RESERVED_IP_RANGES,...]] [GCLOUD_WIDE_FLAG ...] @@ -98,6 +98,11 @@ OPTIONAL FLAGS These logs are standard server access logs, containing information like timestamp and latency for each prediction request. + --machine-type=MACHINE_TYPE + The machine resources to be used for each node of this deployment. For + available machine types, see + https://cloud.google.com/ai-platform-unified/docs/predictions/machine-types. + --max-replica-count=MAX_REPLICA_COUNT Maximum number of machine replicas the deployed index will be always deployed on. diff --git a/gcloud/alpha/ai/index-endpoints/deploy-index b/gcloud/alpha/ai/index-endpoints/deploy-index index 92d60cf9a..928b7eeb1 100644 --- a/gcloud/alpha/ai/index-endpoints/deploy-index +++ b/gcloud/alpha/ai/index-endpoints/deploy-index @@ -11,6 +11,7 @@ SYNOPSIS [--enable-access-logging] [--machine-type=MACHINE_TYPE] [--max-replica-count=MAX_REPLICA_COUNT] [--min-replica-count=MIN_REPLICA_COUNT] + [--psc-automation-configs=[network=NETWORK],[project-id=PROJECT-ID]] [--reserved-ip-ranges=[RESERVED_IP_RANGES,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -114,6 +115,14 @@ OPTIONAL FLAGS Minimum number of machine replicas the deployed index will be always deployed on. If specified, the value must be equal to or larger than 1. + --psc-automation-configs=[network=NETWORK],[project-id=PROJECT-ID] + A pair of project-id and network the PSC index will be deployed to. For + example: + --psc-automation-configs=project-id=my-project,network=my-network. For + multiple networks, this flag can be repeated: + --psc-automation-configs=project-id=my-project,network=my-network + --psc-automation-configs=project-id=my-project2,network=my-network2 + --reserved-ip-ranges=[RESERVED_IP_RANGES,...] List of reserved IP ranges deployed index will be deployed to. diff --git a/gcloud/alpha/ai/index-endpoints/mutate-deployed-index b/gcloud/alpha/ai/index-endpoints/mutate-deployed-index index 5104c97b6..f11231005 100644 --- a/gcloud/alpha/ai/index-endpoints/mutate-deployed-index +++ b/gcloud/alpha/ai/index-endpoints/mutate-deployed-index @@ -8,7 +8,7 @@ SYNOPSIS --deployed-index-id=DEPLOYED_INDEX_ID [--allowed-issuers=[ALLOWED_ISSUERS,...]] [--audiences=[AUDIENCES,...]] [--deployment-group=DEPLOYMENT_GROUP] [--enable-access-logging] - [--max-replica-count=MAX_REPLICA_COUNT] + [--machine-type=MACHINE_TYPE] [--max-replica-count=MAX_REPLICA_COUNT] [--min-replica-count=MIN_REPLICA_COUNT] [--reserved-ip-ranges=[RESERVED_IP_RANGES,...]] [GCLOUD_WIDE_FLAG ...] @@ -98,6 +98,11 @@ OPTIONAL FLAGS These logs are standard server access logs, containing information like timestamp and latency for each prediction request. + --machine-type=MACHINE_TYPE + The machine resources to be used for each node of this deployment. For + available machine types, see + https://cloud.google.com/ai-platform-unified/docs/predictions/machine-types. + --max-replica-count=MAX_REPLICA_COUNT Maximum number of machine replicas the deployed index will be always deployed on. diff --git a/gcloud/alpha/alloydb/clusters/export b/gcloud/alpha/alloydb/clusters/export new file mode 100644 index 000000000..e55fcef36 --- /dev/null +++ b/gcloud/alpha/alloydb/clusters/export @@ -0,0 +1,119 @@ +NAME + gcloud alpha alloydb clusters export - export data from an AlloyDB cluster + to Google Cloud Storage + +SYNOPSIS + gcloud alpha alloydb clusters export CLUSTER --database=DATABASE + --gcs-uri=GCS_URI --region=REGION + ([--csv --select-query=SELECT_QUERY + : --escape-character=ESCAPE_CHARACTER + --field-delimiter=FIELD_DELIMITER --quote-character=QUOTE_CHARACTER] + | [--sql : --schema-only --tables=TABLES [--clean-target-objects + : --if-exist-target-objects]]) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Export data from an AlloyDB cluster to Google Cloud Storage. + +EXAMPLES + To export a cluster, run: + + $ gcloud alpha alloydb clusters export my-cluster \ + --region=us-central1 --database=my-database \ + --gcs-uri=gs://my-bucket/my-export-file-path \ + --select-query="SELECT * FROM my-table" + +POSITIONAL ARGUMENTS + CLUSTER + AlloyDB cluster ID + +REQUIRED FLAGS + --database=DATABASE + Database name from which export has to be done. + + Destination URI where the file needs to be exported. + + This must be specified. + + --gcs-uri=GCS_URI + Path to the Google Cloud Storage file to which export has to be done. + + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + + Export options for the cluster. + + Exactly one of these must be specified: + + CSV export options for the cluster. + + --csv + Specifies destination file type. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --select-query=SELECT_QUERY + Select query to be used for export. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --escape-character=ESCAPE_CHARACTER + Escape character to be used for export. + + --field-delimiter=FIELD_DELIMITER + Field delimiter to be used for export. + + --quote-character=QUOTE_CHARACTER + Quote character to be used for export. + + SQL export options for the cluster. + + --sql + Specifies destination file type. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --schema-only + Export only schema of the database. + + --tables=TABLES + Comma-separated list of table names which need to be exported. + + SQL export options to clean target objects. + + --clean-target-objects + If true, output commands to DROP all the dumped database objects + prior to outputting the commands for creating them. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --if-exist-target-objects + If true, use DROP ... IF EXISTS commands to check for the + object's existence before dropping it in clean_target_objects + mode. + +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. + +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 alloydb clusters export + diff --git a/gcloud/alpha/alloydb/clusters/help b/gcloud/alpha/alloydb/clusters/help index 1cdbac411..3716eed47 100644 --- a/gcloud/alpha/alloydb/clusters/help +++ b/gcloud/alpha/alloydb/clusters/help @@ -29,6 +29,9 @@ COMMANDS describe (ALPHA) Describe an AlloyDB cluster in a given project and region. + export + (ALPHA) Export data from an AlloyDB cluster to Google Cloud Storage. + list (ALPHA) List AlloyDB clusters in a given project and region. diff --git a/gcloud/alpha/backup-dr/backup-plan-associations/create b/gcloud/alpha/backup-dr/backup-plan-associations/create index 8bec84431..2503095b8 100644 --- a/gcloud/alpha/backup-dr/backup-plan-associations/create +++ b/gcloud/alpha/backup-dr/backup-plan-associations/create @@ -116,5 +116,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-plan-associations create diff --git a/gcloud/alpha/backup-dr/backup-plan-associations/delete b/gcloud/alpha/backup-dr/backup-plan-associations/delete index a11455c6c..66f58775f 100644 --- a/gcloud/alpha/backup-dr/backup-plan-associations/delete +++ b/gcloud/alpha/backup-dr/backup-plan-associations/delete @@ -74,5 +74,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-plan-associations delete diff --git a/gcloud/alpha/backup-dr/backup-plan-associations/describe b/gcloud/alpha/backup-dr/backup-plan-associations/describe index bf6541860..c54cbbca9 100644 --- a/gcloud/alpha/backup-dr/backup-plan-associations/describe +++ b/gcloud/alpha/backup-dr/backup-plan-associations/describe @@ -64,5 +64,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-plan-associations describe diff --git a/gcloud/alpha/backup-dr/backup-plan-associations/help b/gcloud/alpha/backup-dr/backup-plan-associations/help index bd39ff2eb..88579383c 100644 --- a/gcloud/alpha/backup-dr/backup-plan-associations/help +++ b/gcloud/alpha/backup-dr/backup-plan-associations/help @@ -36,5 +36,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-plan-associations diff --git a/gcloud/alpha/backup-dr/backup-plan-associations/list b/gcloud/alpha/backup-dr/backup-plan-associations/list index 8b9682a6b..6110a49d8 100644 --- a/gcloud/alpha/backup-dr/backup-plan-associations/list +++ b/gcloud/alpha/backup-dr/backup-plan-associations/list @@ -88,5 +88,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-plan-associations list diff --git a/gcloud/alpha/backup-dr/backup-plan-associations/trigger-backup b/gcloud/alpha/backup-dr/backup-plan-associations/trigger-backup index cbfdb4a5b..dd2cd35c5 100644 --- a/gcloud/alpha/backup-dr/backup-plan-associations/trigger-backup +++ b/gcloud/alpha/backup-dr/backup-plan-associations/trigger-backup @@ -82,5 +82,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-plan-associations trigger-backup diff --git a/gcloud/alpha/backup-dr/backup-plans/create b/gcloud/alpha/backup-dr/backup-plans/create index 346449fa3..6235b4b21 100644 --- a/gcloud/alpha/backup-dr/backup-plans/create +++ b/gcloud/alpha/backup-dr/backup-plans/create @@ -244,5 +244,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-plans create diff --git a/gcloud/alpha/backup-dr/backup-plans/delete b/gcloud/alpha/backup-dr/backup-plans/delete index aeef7be17..9c199e99f 100644 --- a/gcloud/alpha/backup-dr/backup-plans/delete +++ b/gcloud/alpha/backup-dr/backup-plans/delete @@ -68,5 +68,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-plans delete diff --git a/gcloud/alpha/backup-dr/backup-plans/describe b/gcloud/alpha/backup-dr/backup-plans/describe index 95d9c9537..f7977e24d 100644 --- a/gcloud/alpha/backup-dr/backup-plans/describe +++ b/gcloud/alpha/backup-dr/backup-plans/describe @@ -62,5 +62,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-plans describe diff --git a/gcloud/alpha/backup-dr/backup-plans/help b/gcloud/alpha/backup-dr/backup-plans/help index 7eb85865b..1298795f6 100644 --- a/gcloud/alpha/backup-dr/backup-plans/help +++ b/gcloud/alpha/backup-dr/backup-plans/help @@ -31,5 +31,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-plans diff --git a/gcloud/alpha/backup-dr/backup-plans/list b/gcloud/alpha/backup-dr/backup-plans/list index aa54b9850..659ab03df 100644 --- a/gcloud/alpha/backup-dr/backup-plans/list +++ b/gcloud/alpha/backup-dr/backup-plans/list @@ -85,5 +85,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-plans list diff --git a/gcloud/alpha/backup-dr/backup-vaults/create b/gcloud/alpha/backup-dr/backup-vaults/create index 3425da34b..012ccf9ef 100644 --- a/gcloud/alpha/backup-dr/backup-vaults/create +++ b/gcloud/alpha/backup-dr/backup-vaults/create @@ -130,5 +130,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-vaults create diff --git a/gcloud/alpha/backup-dr/backup-vaults/delete b/gcloud/alpha/backup-dr/backup-vaults/delete index d42cbcfc8..06d213e49 100644 --- a/gcloud/alpha/backup-dr/backup-vaults/delete +++ b/gcloud/alpha/backup-dr/backup-vaults/delete @@ -101,5 +101,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-vaults delete diff --git a/gcloud/alpha/backup-dr/backup-vaults/describe b/gcloud/alpha/backup-dr/backup-vaults/describe index 2902fb5d1..491d1fe6e 100644 --- a/gcloud/alpha/backup-dr/backup-vaults/describe +++ b/gcloud/alpha/backup-dr/backup-vaults/describe @@ -65,5 +65,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-vaults describe diff --git a/gcloud/alpha/backup-dr/backup-vaults/help b/gcloud/alpha/backup-dr/backup-vaults/help index 6bee153c1..2e3ada38f 100644 --- a/gcloud/alpha/backup-dr/backup-vaults/help +++ b/gcloud/alpha/backup-dr/backup-vaults/help @@ -34,5 +34,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-vaults diff --git a/gcloud/alpha/backup-dr/backup-vaults/list b/gcloud/alpha/backup-dr/backup-vaults/list index 10e6d9c10..933efac59 100644 --- a/gcloud/alpha/backup-dr/backup-vaults/list +++ b/gcloud/alpha/backup-dr/backup-vaults/list @@ -89,5 +89,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-vaults list diff --git a/gcloud/alpha/backup-dr/backup-vaults/update b/gcloud/alpha/backup-dr/backup-vaults/update index a529565d8..76cc258d6 100644 --- a/gcloud/alpha/backup-dr/backup-vaults/update +++ b/gcloud/alpha/backup-dr/backup-vaults/update @@ -109,5 +109,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backup-vaults update diff --git a/gcloud/alpha/backup-dr/backups/delete b/gcloud/alpha/backup-dr/backups/delete index a7ef32438..28b4a042a 100644 --- a/gcloud/alpha/backup-dr/backups/delete +++ b/gcloud/alpha/backup-dr/backups/delete @@ -86,5 +86,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backups delete diff --git a/gcloud/alpha/backup-dr/backups/describe b/gcloud/alpha/backup-dr/backups/describe index b6ad045e2..44282f3f9 100644 --- a/gcloud/alpha/backup-dr/backups/describe +++ b/gcloud/alpha/backup-dr/backups/describe @@ -77,5 +77,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backups describe diff --git a/gcloud/alpha/backup-dr/backups/help b/gcloud/alpha/backup-dr/backups/help index c7e4eab07..585e425a0 100644 --- a/gcloud/alpha/backup-dr/backups/help +++ b/gcloud/alpha/backup-dr/backups/help @@ -34,5 +34,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backups diff --git a/gcloud/alpha/backup-dr/backups/list b/gcloud/alpha/backup-dr/backups/list index 2871d52dd..1d16e5adc 100644 --- a/gcloud/alpha/backup-dr/backups/list +++ b/gcloud/alpha/backup-dr/backups/list @@ -111,5 +111,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backups list diff --git a/gcloud/alpha/backup-dr/backups/restore/compute b/gcloud/alpha/backup-dr/backups/restore/compute index ac938c1c0..93396f04e 100644 --- a/gcloud/alpha/backup-dr/backups/restore/compute +++ b/gcloud/alpha/backup-dr/backups/restore/compute @@ -418,5 +418,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backups restore compute diff --git a/gcloud/alpha/backup-dr/backups/restore/help b/gcloud/alpha/backup-dr/backups/restore/help index 61ccc1c51..5281399a7 100644 --- a/gcloud/alpha/backup-dr/backups/restore/help +++ b/gcloud/alpha/backup-dr/backups/restore/help @@ -23,5 +23,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr backups restore diff --git a/gcloud/alpha/backup-dr/data-sources/describe b/gcloud/alpha/backup-dr/data-sources/describe index 9e89526f9..55b4c9c0f 100644 --- a/gcloud/alpha/backup-dr/data-sources/describe +++ b/gcloud/alpha/backup-dr/data-sources/describe @@ -72,5 +72,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr data-sources describe diff --git a/gcloud/alpha/backup-dr/data-sources/help b/gcloud/alpha/backup-dr/data-sources/help index c4da108a4..0327450dd 100644 --- a/gcloud/alpha/backup-dr/data-sources/help +++ b/gcloud/alpha/backup-dr/data-sources/help @@ -25,5 +25,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr data-sources diff --git a/gcloud/alpha/backup-dr/data-sources/list b/gcloud/alpha/backup-dr/data-sources/list index c82bb4a7a..403c891c6 100644 --- a/gcloud/alpha/backup-dr/data-sources/list +++ b/gcloud/alpha/backup-dr/data-sources/list @@ -95,5 +95,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud backup-dr data-sources list diff --git a/gcloud/alpha/compute/disks/convert b/gcloud/alpha/compute/disks/convert index 66216b10f..5f3a62a3e 100644 --- a/gcloud/alpha/compute/disks/convert +++ b/gcloud/alpha/compute/disks/convert @@ -1,6 +1,6 @@ NAME - gcloud alpha compute disks convert - convert a Compute Engine disk into a - new disk type or new format + gcloud alpha compute disks convert - convert a Compute Engine Persistent + Disk volume to a Hyperdisk volume SYNOPSIS gcloud alpha compute disks convert DISK_NAME @@ -30,8 +30,9 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --target-disk-type=TARGET_DISK_TYPE - Specifies the type of disk to convert to. To get a list of available - disk types, run gcloud compute disk-types list. + Specifies the type of Hyperdisk to convert to, for example, to convert + a Hyperdisk Balanced volume, specify hyperdisk-balanced. To get a list + of available disk types, run gcloud compute disk-types list. OPTIONAL FLAGS Key resource - The Cloud KMS (Key Management Service) cryptokey that will @@ -130,5 +131,9 @@ 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. + access allowlist. These variants are also available: + + $ gcloud compute disks convert + + $ gcloud beta compute disks convert diff --git a/gcloud/alpha/compute/disks/help b/gcloud/alpha/compute/disks/help index f3a699d3c..a220126ef 100644 --- a/gcloud/alpha/compute/disks/help +++ b/gcloud/alpha/compute/disks/help @@ -41,8 +41,8 @@ COMMANDS (ALPHA) Add resource policies to a Compute Engine disk. convert - (ALPHA) Convert a Compute Engine disk into a new disk type or new - format. + (ALPHA) Convert a Compute Engine Persistent Disk volume to a Hyperdisk + volume. create (ALPHA) Create Compute Engine persistent disks. diff --git a/gcloud/alpha/compute/instance-templates/create b/gcloud/alpha/compute/instance-templates/create index 9e9fa4c90..6e4a8e527 100644 --- a/gcloud/alpha/compute/instance-templates/create +++ b/gcloud/alpha/compute/instance-templates/create @@ -781,6 +781,12 @@ FLAGS Specifies the network attachment that this interface should connect to. Mutually exclusive with --network and --subnet flags. + igmp-query + Determines if the Compute Engine Instance can receive and respond + to IGMP query packets on the specified network interface. + IGMP_QUERY must be one of: IGMP_QUERY_V2, IGMP_QUERY_DISABLED. It + is disabled by default. + --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network @@ -849,21 +855,22 @@ FLAGS the subnet or legacy network IP range. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: RESERVATION_BOUND - Reservation-bound provisioning model for VM instances which are - bound to the lifecycle of the reservation in which it is - provisioned. + The VM instances run for the entire duration of their associated + reservation. You can only specify this provisioning model if you + want your VM instances to consume a specific reservation with + either a calendar reservation mode or a dense deployment type. SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --region=REGION Region of the subnetwork to attach. If not specified, you might be diff --git a/gcloud/alpha/compute/instances/bulk/create b/gcloud/alpha/compute/instances/bulk/create index 5c2adb3e8..063b80cde 100644 --- a/gcloud/alpha/compute/instances/bulk/create +++ b/gcloud/alpha/compute/instances/bulk/create @@ -682,6 +682,12 @@ OPTIONAL FLAGS be one of: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. The default value is IPV4_ONLY. + igmp-query + Determines if the Compute Engine Instance can receive and respond + to IGMP query packets on the specified network interface. + IGMP_QUERY must be one of: IGMP_QUERY_V2, IGMP_QUERY_DISABLED. It + is disabled by default. + --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network @@ -739,21 +745,22 @@ OPTIONAL FLAGS instances can not be restarted and will not migrate. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: RESERVATION_BOUND - Reservation-bound provisioning model for VM instances which are - bound to the lifecycle of the reservation in which it is - provisioned. + The VM instances run for the entire duration of their associated + reservation. You can only specify this provisioning model if you + want your VM instances to consume a specific reservation with + either a calendar reservation mode or a dense deployment type. SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --resource-manager-tags=[KEY=VALUE,...] Specifies a list of resource manager tags to apply to the instance. diff --git a/gcloud/alpha/compute/instances/create b/gcloud/alpha/compute/instances/create index e9d8ef1d7..1057bfbf6 100644 --- a/gcloud/alpha/compute/instances/create +++ b/gcloud/alpha/compute/instances/create @@ -872,21 +872,22 @@ FLAGS the subnet or legacy network IP range. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: RESERVATION_BOUND - Reservation-bound provisioning model for VM instances which are - bound to the lifecycle of the reservation in which it is - provisioned. + The VM instances run for the entire duration of their associated + reservation. You can only specify this provisioning model if you + want your VM instances to consume a specific reservation with + either a calendar reservation mode or a dense deployment type. SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --require-csek-key-create Refuse to create resources not protected by a user managed key in the diff --git a/gcloud/alpha/compute/instances/create-with-container b/gcloud/alpha/compute/instances/create-with-container index 3f4011648..c0aca7fcc 100644 --- a/gcloud/alpha/compute/instances/create-with-container +++ b/gcloud/alpha/compute/instances/create-with-container @@ -814,21 +814,22 @@ FLAGS the subnet or legacy network IP range. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: RESERVATION_BOUND - Reservation-bound provisioning model for VM instances which are - bound to the lifecycle of the reservation in which it is - provisioned. + The VM instances run for the entire duration of their associated + reservation. You can only specify this provisioning model if you + want your VM instances to consume a specific reservation with + either a calendar reservation mode or a dense deployment type. SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --resource-policies=[RESOURCE_POLICY,...] A list of resource policy names to be added to the instance. The diff --git a/gcloud/alpha/compute/instances/set-scheduling b/gcloud/alpha/compute/instances/set-scheduling index ea2963111..8988abbfe 100644 --- a/gcloud/alpha/compute/instances/set-scheduling +++ b/gcloud/alpha/compute/instances/set-scheduling @@ -78,21 +78,22 @@ FLAGS to enable and --no-preemptible to disable. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: RESERVATION_BOUND - Reservation-bound provisioning model for VM instances which are - bound to the lifecycle of the reservation in which it is - provisioned. + The VM instances run for the entire duration of their associated + reservation. You can only specify this provisioning model if you + want your VM instances to consume a specific reservation with + either a calendar reservation mode or a dense deployment type. SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --[no-]restart-on-failure The instances will be restarted if they are terminated by Compute diff --git a/gcloud/alpha/compute/interconnects/attachments/groups/add-members b/gcloud/alpha/compute/interconnects/attachments/groups/add-members new file mode 100644 index 000000000..2bf272faa --- /dev/null +++ b/gcloud/alpha/compute/interconnects/attachments/groups/add-members @@ -0,0 +1,47 @@ +NAME + gcloud alpha compute interconnects attachments groups add-members - add + member interconnect attachments to a Compute Engine interconnect + attachment group + +SYNOPSIS + gcloud alpha compute interconnects attachments groups add-members NAME + --attachments=[INTERCONNECT_ATTACHMENT,...] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute interconnects attachments groups add-members + is used to add member interconnect attachments to an interconnect + attachment group. + + For an example, refer to the EXAMPLES section below. + +EXAMPLES + To add attachment-1 and attachment-2 to interconnect attachment group + example-attachment-group, run: + + $ gcloud alpha compute interconnects attachments groups \ + add-members example-attachment-group \ + --attachments=region-1/attachment-1,region-2/attachment-2 + +POSITIONAL ARGUMENTS + NAME + Name of the interconnect attachment group to update. + +REQUIRED FLAGS + --attachments=[INTERCONNECT_ATTACHMENT,...] + Member interconnect attachments to add to or remove from the + interconnect attachment group. + +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. + +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. + diff --git a/gcloud/alpha/compute/interconnects/attachments/groups/create b/gcloud/alpha/compute/interconnects/attachments/groups/create new file mode 100644 index 000000000..2162e349b --- /dev/null +++ b/gcloud/alpha/compute/interconnects/attachments/groups/create @@ -0,0 +1,68 @@ +NAME + gcloud alpha compute interconnects attachments groups create - create a + Compute Engine interconnect attachment group + +SYNOPSIS + gcloud alpha compute interconnects attachments groups create NAME + --intended-availability-sla=INTENDED_AVAILABILITY_SLA + [--attachments=[INTERCONNECT_ATTACHMENT,...]] + [--description=DESCRIPTION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute interconnects attachments groups create is + used to create interconnect attachment groups. An interconnect attachment + group connects a set of redundant interconnect attachments between Google + and the customer. + + For an example, refer to the EXAMPLES section below. + +EXAMPLES + To create an interconnect attachment group capable of PRODUCTION_CRITICAL, + run: + + $ gcloud alpha compute interconnects attachments groups create \ + example-attachment-group \ + --intended-availability-sla=PRODUCTION_CRITICAL \ + --description="Example interconnect attachment group" + + It is easy to add members to an existing interconnect attachment group + after creation using the add-members command. + + To create an interconnect attachment group capable of + PRODUCTION_NON_CRITICAL, with two members at creation time, run: + + $ gcloud alpha compute interconnects attachments groups create \ + example-attachment-group \ + --intended-availability-sla=PRODUCTION_NON_CRITICAL \ + --attachments=region-1/attachment-1,region-2/attachment-2 + +POSITIONAL ARGUMENTS + NAME + Name of the interconnect attachment group to create. + +REQUIRED FLAGS + --intended-availability-sla=INTENDED_AVAILABILITY_SLA + The availability SLA that the user intends this group to support. + +OPTIONAL FLAGS + --attachments=[INTERCONNECT_ATTACHMENT,...] + Member interconnect attachments to add to the interconnect attachment + group initially. + + --description=DESCRIPTION + An optional, textual description for the interconnect attachment group. + +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. + +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. + diff --git a/gcloud/alpha/compute/interconnects/attachments/groups/delete b/gcloud/alpha/compute/interconnects/attachments/groups/delete new file mode 100644 index 000000000..5b5eb8591 --- /dev/null +++ b/gcloud/alpha/compute/interconnects/attachments/groups/delete @@ -0,0 +1,33 @@ +NAME + gcloud alpha compute interconnects attachments groups delete - delete + Compute Engine interconnect attachment groups + +SYNOPSIS + gcloud alpha compute interconnects attachments groups delete NAME + [NAME ...] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute interconnects attachments groups delete + deletes Compute Engine interconnect attachment groups. Interconnect + attachment groups can be deleted even if they are referenced by + interconnect attachments. Each interconnect attachment in the group will be + updated to remove its reference to this group. + +POSITIONAL ARGUMENTS + NAME [NAME ...] + Names of the interconnect attachment groups to delete. + +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. + +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. + diff --git a/gcloud/alpha/compute/interconnects/attachments/groups/describe b/gcloud/alpha/compute/interconnects/attachments/groups/describe new file mode 100644 index 000000000..54f333271 --- /dev/null +++ b/gcloud/alpha/compute/interconnects/attachments/groups/describe @@ -0,0 +1,31 @@ +NAME + gcloud alpha compute interconnects attachments groups describe - describe a + Compute Engine interconnect attachment group + +SYNOPSIS + gcloud alpha compute interconnects attachments groups describe NAME + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute interconnects attachments groups describe + displays all data associated with Compute Engine interconnect attachment + group in a project. + +POSITIONAL ARGUMENTS + NAME + Name of the interconnect attachment group to describe. + +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. + +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. + diff --git a/gcloud/alpha/compute/interconnects/attachments/groups/help b/gcloud/alpha/compute/interconnects/attachments/groups/help new file mode 100644 index 000000000..c67da256a --- /dev/null +++ b/gcloud/alpha/compute/interconnects/attachments/groups/help @@ -0,0 +1,48 @@ +NAME + gcloud alpha compute interconnects attachments groups - create or + manipulate interconnect attachment groups + +SYNOPSIS + gcloud alpha compute interconnects attachments groups COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create or manipulate interconnect attachment groups. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + add-members + (ALPHA) Add member interconnect attachments to a Compute Engine + interconnect attachment group. + + create + (ALPHA) Create a Compute Engine interconnect attachment group. + + delete + (ALPHA) Delete Compute Engine interconnect attachment groups. + + describe + (ALPHA) Describe a Compute Engine interconnect attachment group. + + list + (ALPHA) List Google Compute Engine interconnect attachment groups. + + remove-members + (ALPHA) Remove member interconnect attachments from a Compute Engine + interconnect attachment group. + + update + (ALPHA) Update a Compute Engine interconnect attachment group. + +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. + diff --git a/gcloud/alpha/compute/interconnects/attachments/groups/list b/gcloud/alpha/compute/interconnects/attachments/groups/list new file mode 100644 index 000000000..a80644a50 --- /dev/null +++ b/gcloud/alpha/compute/interconnects/attachments/groups/list @@ -0,0 +1,68 @@ +NAME + gcloud alpha compute interconnects attachments groups list - list Google + Compute Engine interconnect attachment groups + +SYNOPSIS + gcloud alpha compute interconnects attachments groups list + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute interconnects attachments groups list displays + all Google Compute Engine interconnect attachment groups in a project. + +EXAMPLES + To list all interconnect attachment groups in a project in table form, run: + + $ gcloud alpha compute interconnects attachments groups list + + To list the URIs of all interconnect attachment groups in a project, run: + + $ gcloud alpha compute interconnects attachments groups list --uri + +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. + +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. + diff --git a/gcloud/alpha/compute/interconnects/attachments/groups/remove-members b/gcloud/alpha/compute/interconnects/attachments/groups/remove-members new file mode 100644 index 000000000..432649514 --- /dev/null +++ b/gcloud/alpha/compute/interconnects/attachments/groups/remove-members @@ -0,0 +1,47 @@ +NAME + gcloud alpha compute interconnects attachments groups remove-members - + remove member interconnect attachments from a Compute Engine + interconnect attachment group + +SYNOPSIS + gcloud alpha compute interconnects attachments groups remove-members NAME + --attachments=[INTERCONNECT_ATTACHMENT,...] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute interconnects attachments groups + remove-members is used to remove member interconnect attachments from an + interconnect attachment group. + + For an example, refer to the EXAMPLES section below. + +EXAMPLES + To remove attachment-1 and attachment-2 from interconnect attachment group + example-attachment-group, run: + + $ gcloud alpha compute interconnects attachments groups \ + remove-members example-attachment-group \ + --attachments=region-1/attachment-1,region-2/attachment-2 + +POSITIONAL ARGUMENTS + NAME + Name of the interconnect attachment group to update. + +REQUIRED FLAGS + --attachments=[INTERCONNECT_ATTACHMENT,...] + Member interconnect attachments to add to or remove from the + interconnect attachment group. + +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. + +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. + diff --git a/gcloud/alpha/compute/interconnects/attachments/groups/update b/gcloud/alpha/compute/interconnects/attachments/groups/update new file mode 100644 index 000000000..af96855da --- /dev/null +++ b/gcloud/alpha/compute/interconnects/attachments/groups/update @@ -0,0 +1,46 @@ +NAME + gcloud alpha compute interconnects attachments groups update - update a + Compute Engine interconnect attachment group + +SYNOPSIS + gcloud alpha compute interconnects attachments groups update NAME + [--attachments=[INTERCONNECT_ATTACHMENT,...]] + [--description=DESCRIPTION] + [--intended-availability-sla=INTENDED_AVAILABILITY_SLA] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute interconnects attachments groups update is + used to update interconnect attachment groups. An interconnect attachment + group connects a set of redundant interconnect attachments between Google + and the customer. + +POSITIONAL ARGUMENTS + NAME + Name of the interconnect attachment group to update. + +FLAGS + --attachments=[INTERCONNECT_ATTACHMENT,...] + Member interconnect attachments to add to the interconnect attachment + group initially. + + --description=DESCRIPTION + An optional, textual description for the interconnect attachment group. + + --intended-availability-sla=INTENDED_AVAILABILITY_SLA + The availability SLA that the user intends this group to support. + +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. + +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. + diff --git a/gcloud/alpha/compute/interconnects/attachments/help b/gcloud/alpha/compute/interconnects/attachments/help index 4ef9b6899..abd65f21a 100644 --- a/gcloud/alpha/compute/interconnects/attachments/help +++ b/gcloud/alpha/compute/interconnects/attachments/help @@ -20,6 +20,9 @@ GROUPS dedicated (ALPHA) Create or manipulate dedicated interconnect attachments. + groups + (ALPHA) Create or manipulate interconnect attachment groups. + partner (ALPHA) Create or manipulate partner interconnect attachments. diff --git a/gcloud/alpha/compute/queued-resources/create b/gcloud/alpha/compute/queued-resources/create index 8612a21ab..1c090cff7 100644 --- a/gcloud/alpha/compute/queued-resources/create +++ b/gcloud/alpha/compute/queued-resources/create @@ -655,6 +655,12 @@ OPTIONAL FLAGS be one of: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. The default value is IPV4_ONLY. + igmp-query + Determines if the Compute Engine Instance can receive and respond + to IGMP query packets on the specified network interface. + IGMP_QUERY must be one of: IGMP_QUERY_V2, IGMP_QUERY_DISABLED. It + is disabled by default. + --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network @@ -712,17 +718,17 @@ OPTIONAL FLAGS instances can not be restarted and will not migrate. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --resource-manager-tags=[KEY=VALUE,...] Specifies a list of resource manager tags to apply to the instance. diff --git a/gcloud/alpha/container/fleet/config-management/status b/gcloud/alpha/container/fleet/config-management/status index 1e6bd2d30..8c9b9d76a 100644 --- a/gcloud/alpha/container/fleet/config-management/status +++ b/gcloud/alpha/container/fleet/config-management/status @@ -8,9 +8,19 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) The Synced_to_Fleet_Default status indicates whether each - membership's configuration has been synced with the fleet-default - membership configuration + (ALPHA) The Status column indicates the status of the Config Sync + component. Status displays NOT_INSTALLED when Config Sync is not installed. + Status displays NOT_CONFIGURED when Config Sync is installed but git/oci is + not configured. Status displays SYNCED when Config Sync is installed and + git/oci is configured and the last sync was successful. Status displays + ERROR when Config Sync encounters errors. Status displays STOPPED when + Config Sync stops syncing configs to the cluster. Status displays PENDING + when Config Sync has not reached the desired state. Otherwise, Status + displays UNSPECIFIED. + + The Synced_to_Fleet_Default status indicates whether each membership's + configuration has been synced with the fleet-default membership + configuration (https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features). Synced_to_Fleet_Default displays FLEET_DEFAULT_NOT_CONFIGURED when fleet-default membership configuration is not enabled. diff --git a/gcloud/alpha/container/hub/config-management/status b/gcloud/alpha/container/hub/config-management/status index ef317c2ee..b836760fd 100644 --- a/gcloud/alpha/container/hub/config-management/status +++ b/gcloud/alpha/container/hub/config-management/status @@ -8,9 +8,19 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) The Synced_to_Fleet_Default status indicates whether each - membership's configuration has been synced with the fleet-default - membership configuration + (ALPHA) The Status column indicates the status of the Config Sync + component. Status displays NOT_INSTALLED when Config Sync is not installed. + Status displays NOT_CONFIGURED when Config Sync is installed but git/oci is + not configured. Status displays SYNCED when Config Sync is installed and + git/oci is configured and the last sync was successful. Status displays + ERROR when Config Sync encounters errors. Status displays STOPPED when + Config Sync stops syncing configs to the cluster. Status displays PENDING + when Config Sync has not reached the desired state. Otherwise, Status + displays UNSPECIFIED. + + The Synced_to_Fleet_Default status indicates whether each membership's + configuration has been synced with the fleet-default membership + configuration (https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features). Synced_to_Fleet_Default displays FLEET_DEFAULT_NOT_CONFIGURED when fleet-default membership configuration is not enabled. diff --git a/gcloud/alpha/database-migration/connection-profiles/create/mysql b/gcloud/alpha/database-migration/connection-profiles/create/mysql index 80be1d3b7..dc0eb687b 100644 --- a/gcloud/alpha/database-migration/connection-profiles/create/mysql +++ b/gcloud/alpha/database-migration/connection-profiles/create/mysql @@ -88,18 +88,28 @@ FLAGS --ca-certificate=CA_CERTIFICATE x509 PEM-encoded certificate of the CA that signed the database - server's certificate. Database Migration Service will use this - certificate to verify it's connecting to the correct host. Database - Migration Service encrypts the value when storing it. + server's certificate. The value for this flag needs to be the content + of the certificate file, not the path to the file. For example, on a + Linux machine you can use command substitution: + --ca-certificate=$(. + Database Migration Service will use this certificate to verify it's + connecting to the correct host. Database Migration Service encrypts the + value when storing it. --certificate=CERTIFICATE x509 PEM-encoded certificate that will be used by the replica to - authenticate against the database server. + authenticate against the database server. The value for this flag needs + to be the content of the certificate file, not the path to the file. + For example, on a Linux machine you can use command substitution: + --ca-certificate=$(. --private-key=PRIVATE_KEY Unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with - the Client Certificate. Database Migration Service encrypts the value - when storing it. + the Client Certificate. The value for this flag needs to be the content + of the certificate file, not the path to the file. For example, on a + Linux machine you can use command substitution: + --ca-certificate=$(. + Database Migration Service encrypts the value when storing it. --host=HOST IP or hostname of the database. When --psc-service-attachment is also diff --git a/gcloud/alpha/database-migration/connection-profiles/update b/gcloud/alpha/database-migration/connection-profiles/update index 291808043..8ea4651fd 100644 --- a/gcloud/alpha/database-migration/connection-profiles/update +++ b/gcloud/alpha/database-migration/connection-profiles/update @@ -63,13 +63,20 @@ POSITIONAL ARGUMENTS FLAGS --ca-certificate=CA_CERTIFICATE x509 PEM-encoded certificate of the CA that signed the database - server's certificate. Database Migration Service will use this - certificate to verify it's connecting to the correct host. Database - Migration Service encrypts the value when storing it. + server's certificate. The value for this flag needs to be the content + of the certificate file, not the path to the file. For example, on a + Linux machine you can use command substitution: + --ca-certificate=$(. + Database Migration Service will use this certificate to verify it's + connecting to the correct host. Database Migration Service encrypts the + value when storing it. --certificate=CERTIFICATE x509 PEM-encoded certificate that will be used by the replica to - authenticate against the database server. + authenticate against the database server. The value for this flag needs + to be the content of the certificate file, not the path to the file. + For example, on a Linux machine you can use command substitution: + --ca-certificate=$(. --display-name=DISPLAY_NAME A user-friendly name for the connection profile. The display name can @@ -91,8 +98,11 @@ FLAGS --private-key=PRIVATE_KEY Unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with - the Client Certificate. Database Migration Service encrypts the value - when storing it. + the Client Certificate. The value for this flag needs to be the content + of the certificate file, not the path to the file. For example, on a + Linux machine you can use command substitution: + --ca-certificate=$(. + Database Migration Service encrypts the value when storing it. --update-labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to update. If a label exists, its value diff --git a/gcloud/alpha/iam/help b/gcloud/alpha/iam/help index 1714458c3..10f8860cc 100644 --- a/gcloud/alpha/iam/help +++ b/gcloud/alpha/iam/help @@ -27,6 +27,9 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + oauth-clients + (ALPHA) Create and manage OAuth clients. + policies (ALPHA) Manage IAM deny policies. diff --git a/gcloud/alpha/iam/oauth-clients/create b/gcloud/alpha/iam/oauth-clients/create new file mode 100644 index 000000000..ad514300a --- /dev/null +++ b/gcloud/alpha/iam/oauth-clients/create @@ -0,0 +1,122 @@ +NAME + gcloud alpha iam oauth-clients create - create an OAuth client + +SYNOPSIS + gcloud alpha iam oauth-clients create (OAUTH_CLIENT : --location=LOCATION) + --allowed-grant-types=[ALLOWED_GRANT_TYPES,...] + --allowed-redirect-uris=[ALLOWED_REDIRECT_URIS,...] + --allowed-scopes=[ALLOWED_SCOPES,...] --client-type=CLIENT_TYPE + [--description=DESCRIPTION] [--disabled] [--display-name=DISPLAY_NAME] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a new OAuth client. + +EXAMPLES + The following command creates a disabled OAuth client with ID + my-oauth-client in the default project: + + $ gcloud alpha iam oauth-clients create my-oauth-client \ + --location="global" --client-type="confidential-client" \ + --display-name="My oauth client" \ + --description="My oauth client description" --disabled \ + --allowed-grant-types="authorization-code-grant,refresh-token-gr\ + ant" \ + --allowed-scopes="https://www.googleapis.com/auth/cloud-platform\ + ,openid" --allowed-redirect-uris="https://example.com" + +POSITIONAL ARGUMENTS + Oauth client resource - The OAuth client 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 project attribute: + ◆ provide the argument oauth_client 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. + + OAUTH_CLIENT + ID of the oauth client or fully qualified identifier for the oauth + client. + + To set the oauth_client attribute: + ▸ provide the argument oauth_client 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 name. + + To set the location attribute: + ▸ provide the argument oauth_client on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +REQUIRED FLAGS + --allowed-grant-types=[ALLOWED_GRANT_TYPES,...] + A list of OAuth grant types that are allowed for the OAuth client. + + The following grant types are currently supported: + + ◆ authorization-code-grant + + ◆ refresh-token-grant + + --allowed-redirect-uris=[ALLOWED_REDIRECT_URIS,...] + A list of redirect uris that is allowed for redirecting when the + authorization is completed. + + --allowed-scopes=[ALLOWED_SCOPES,...] + A list of scopes that the OAuth client is allowed to request during + OAuth flows. + + The following scopes are currently supported: + + ◆ https://www.googleapis.com/auth/cloud-platform: View, edit, + configure, and delete your Google Cloud data, and view the email + address for your Google Account. + + ◆ openid: Associate you with your personal info on Google Cloud. + + ◆ email: View your Google Cloud Account email address. + + --client-type=CLIENT_TYPE + The type of OAuth client. CLIENT_TYPE must be one of: + confidential-client, public-client. + +OPTIONAL FLAGS + --description=DESCRIPTION + A description of the OAuth client. Cannot exceed 256 characters. + + --disabled + Disables the OAuth client. You cannot use a disabled OAuth client for + login. Include --no-disabled to enable a disabled OAuth client. + + --display-name=DISPLAY_NAME + A display name for the OAuth client. Cannot exceed 32 characters. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam oauth-clients create + diff --git a/gcloud/alpha/iam/oauth-clients/credentials/create b/gcloud/alpha/iam/oauth-clients/credentials/create new file mode 100644 index 000000000..39565adeb --- /dev/null +++ b/gcloud/alpha/iam/oauth-clients/credentials/create @@ -0,0 +1,94 @@ +NAME + gcloud alpha iam oauth-clients credentials create - create an OAuth client + credential + +SYNOPSIS + gcloud alpha iam oauth-clients credentials create + (CREDENTIAL : --location=LOCATION --oauth-client=OAUTH_CLIENT) + [--disabled] [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a new OAuth client credential. + +EXAMPLES + To create a disabled OAuth client credential with ID + my-oauth-client-credential in the default project, run: + + $ gcloud alpha iam oauth-clients credentials create \ + my-oauth-client-credential --location="global" \ + --oauth-client="my-oauth-client" \ + --display-name="My OAuth client credential" --disabled + +POSITIONAL ARGUMENTS + Oauth client credential resource - The OAuth client credential 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 project attribute: + ◆ provide the argument credential 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. + + CREDENTIAL + ID of the oauth client credential or fully qualified identifier for + the oauth client credential. + + To set the credential attribute: + ▸ provide the argument credential 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 name. + + To set the location attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --oauth-client=OAUTH_CLIENT + ID to use for the OAuth client, which becomes the final component of + the resource name. This value should be 4-32 characters, and may + contain the characters [a-z0-9-]. The prefix gcp- is reserved for use + by Google, and may not be specified. + + To set the oauth-client attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --oauth-client on the command line. + +FLAGS + --disabled + Disables the OAuth client credential. You cannot use a disabled OAuth + client credential for OAuth. Include --no-disabled to enable a disabled + OAuth client credential. + + --display-name=DISPLAY_NAME + A display name for the OAuth client credential. Cannot exceed 32 + characters. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam oauth-clients credentials create + diff --git a/gcloud/alpha/iam/oauth-clients/credentials/delete b/gcloud/alpha/iam/oauth-clients/credentials/delete new file mode 100644 index 000000000..b586f6a3b --- /dev/null +++ b/gcloud/alpha/iam/oauth-clients/credentials/delete @@ -0,0 +1,83 @@ +NAME + gcloud alpha iam oauth-clients credentials delete - delete an OAuth client + credential + +SYNOPSIS + gcloud alpha iam oauth-clients credentials delete + (CREDENTIAL : --location=LOCATION --oauth-client=OAUTH_CLIENT) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete an OAuth client credential. + +EXAMPLES + To delete the OAuth client credential with ID my-oauth-client-credential in + the default project, run: + + $ gcloud alpha iam oauth-clients credentials delete \ + my-oauth-client-credential --location="global" \ + --oauth-client="my-oauth-client" + +POSITIONAL ARGUMENTS + Oauth client credential resource - The OAuth client credential 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 credential 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. + + CREDENTIAL + ID of the oauth client credential or fully qualified identifier for + the oauth client credential. + + To set the credential attribute: + ▸ provide the argument credential 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 name. + + To set the location attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --oauth-client=OAUTH_CLIENT + ID to use for the OAuth client, which becomes the final component of + the resource name. This value should be 4-32 characters, and may + contain the characters [a-z0-9-]. The prefix gcp- is reserved for use + by Google, and may not be specified. + + To set the oauth-client attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --oauth-client on the command line. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam oauth-clients credentials delete + diff --git a/gcloud/alpha/iam/oauth-clients/credentials/describe b/gcloud/alpha/iam/oauth-clients/credentials/describe new file mode 100644 index 000000000..e13b140f5 --- /dev/null +++ b/gcloud/alpha/iam/oauth-clients/credentials/describe @@ -0,0 +1,83 @@ +NAME + gcloud alpha iam oauth-clients credentials describe - describe an OAuth + client credential + +SYNOPSIS + gcloud alpha iam oauth-clients credentials describe + (CREDENTIAL : --location=LOCATION --oauth-client=OAUTH_CLIENT) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe an OAuth client credential. + +EXAMPLES + To describe the OAuth client credential with ID my-oauth-client-credential + in the default project, run: + + $ gcloud alpha iam oauth-clients credentials describe \ + my-oauth-client-credential --location="global" \ + --oauth-client="my-oauth-client" + +POSITIONAL ARGUMENTS + Oauth client credential resource - The OAuth client credential 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 credential 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. + + CREDENTIAL + ID of the oauth client credential or fully qualified identifier for + the oauth client credential. + + To set the credential attribute: + ▸ provide the argument credential 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 name. + + To set the location attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --oauth-client=OAUTH_CLIENT + ID to use for the OAuth client, which becomes the final component of + the resource name. This value should be 4-32 characters, and may + contain the characters [a-z0-9-]. The prefix gcp- is reserved for use + by Google, and may not be specified. + + To set the oauth-client attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --oauth-client on the command line. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam oauth-clients credentials describe + diff --git a/gcloud/alpha/iam/oauth-clients/credentials/help b/gcloud/alpha/iam/oauth-clients/credentials/help new file mode 100644 index 000000000..b7e1e4e98 --- /dev/null +++ b/gcloud/alpha/iam/oauth-clients/credentials/help @@ -0,0 +1,43 @@ +NAME + gcloud alpha iam oauth-clients credentials - create and manage OAuth client + credentials + +SYNOPSIS + gcloud alpha iam oauth-clients credentials COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) The gcloud alpha iam oauth-clients credentials group lets you + create and manage OAuth client credentials for projects on the Google Cloud + Platform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create an OAuth client credential. + + delete + (ALPHA) Delete an OAuth client credential. + + describe + (ALPHA) Describe an OAuth client credential. + + list + (ALPHA) List OAuth client credentials. + + update + (ALPHA) Update an OAuth client credential. + +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 iam oauth-clients credentials + diff --git a/gcloud/alpha/iam/oauth-clients/credentials/list b/gcloud/alpha/iam/oauth-clients/credentials/list new file mode 100644 index 000000000..57321e505 --- /dev/null +++ b/gcloud/alpha/iam/oauth-clients/credentials/list @@ -0,0 +1,90 @@ +NAME + gcloud alpha iam oauth-clients credentials list - list OAuth client + credentials + +SYNOPSIS + gcloud alpha iam oauth-clients credentials list + (--oauth-client=OAUTH_CLIENT : --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List OAuth client credentials. + +EXAMPLES + To list all OAuth client credentials in the default project, run: + + $ gcloud alpha iam oauth-clients credentials list \ + --location="global" --oauth-client="my-oauth-client" + +REQUIRED FLAGS + Oauth client resource - The OAuth client you want to list credentials 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 --oauth-client 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. + + --oauth-client=OAUTH_CLIENT + ID of the oauth client or fully qualified identifier for the oauth + client. + + To set the oauth-client attribute: + ▸ provide the argument --oauth-client on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + The location name. + + To set the location attribute: + ▸ provide the argument --oauth-client on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +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. + + --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. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam oauth-clients credentials list + diff --git a/gcloud/alpha/iam/oauth-clients/credentials/update b/gcloud/alpha/iam/oauth-clients/credentials/update new file mode 100644 index 000000000..0310057e6 --- /dev/null +++ b/gcloud/alpha/iam/oauth-clients/credentials/update @@ -0,0 +1,94 @@ +NAME + gcloud alpha iam oauth-clients credentials update - update an OAuth client + credential + +SYNOPSIS + gcloud alpha iam oauth-clients credentials update + (CREDENTIAL : --location=LOCATION --oauth-client=OAUTH_CLIENT) + [--disabled] [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update an OAuth client credential. + +EXAMPLES + To update the OAuth client credential with ID my-oauth-client-credential in + the default project, run: + + $ gcloud alpha iam oauth-clients credentials update \ + my-oauth-client-credential --location="global" \ + --oauth-client="my-oauth-client" \ + --display-name="My OAuth client credential" --disabled + +POSITIONAL ARGUMENTS + Oauth client credential resource - The OAuth client credential to update. + 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 credential 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. + + CREDENTIAL + ID of the oauth client credential or fully qualified identifier for + the oauth client credential. + + To set the credential attribute: + ▸ provide the argument credential 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 name. + + To set the location attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --oauth-client=OAUTH_CLIENT + ID to use for the OAuth client, which becomes the final component of + the resource name. This value should be 4-32 characters, and may + contain the characters [a-z0-9-]. The prefix gcp- is reserved for use + by Google, and may not be specified. + + To set the oauth-client attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --oauth-client on the command line. + +FLAGS + --disabled + Disables the OAuth client credential. You cannot use a disabled OAuth + client credential for OAuth. Include --no-disabled to enable a disabled + OAuth client credential. + + --display-name=DISPLAY_NAME + A display name for the OAuth client credential. Cannot exceed 32 + characters. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam oauth-clients credentials update + diff --git a/gcloud/alpha/iam/oauth-clients/delete b/gcloud/alpha/iam/oauth-clients/delete new file mode 100644 index 000000000..9eef8f663 --- /dev/null +++ b/gcloud/alpha/iam/oauth-clients/delete @@ -0,0 +1,69 @@ +NAME + gcloud alpha iam oauth-clients delete - delete an OAuth client + +SYNOPSIS + gcloud alpha iam oauth-clients delete (OAUTH_CLIENT : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete an OAuth client. + +EXAMPLES + The following command deletes the OAuth client with the ID my-oauth-client + in the default project: + + $ gcloud alpha iam oauth-clients delete my-oauth-client \ + --location="global" + +POSITIONAL ARGUMENTS + Oauth client resource - The OAuth client 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 oauth_client 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. + + OAUTH_CLIENT + ID of the oauth client or fully qualified identifier for the oauth + client. + + To set the oauth_client attribute: + ▸ provide the argument oauth_client 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 name. + + To set the location attribute: + ▸ provide the argument oauth_client on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam oauth-clients delete + diff --git a/gcloud/alpha/iam/oauth-clients/describe b/gcloud/alpha/iam/oauth-clients/describe new file mode 100644 index 000000000..625d65364 --- /dev/null +++ b/gcloud/alpha/iam/oauth-clients/describe @@ -0,0 +1,69 @@ +NAME + gcloud alpha iam oauth-clients describe - describe an OAuth client + +SYNOPSIS + gcloud alpha iam oauth-clients describe + (OAUTH_CLIENT : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe an OAuth client. + +EXAMPLES + The following command describes the OAuth client with the ID + my-oauth-client in the default project: + + $ gcloud alpha iam oauth-clients describe my-oauth-client \ + --location="global" + +POSITIONAL ARGUMENTS + Oauth client resource - The OAuth client 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 oauth_client 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. + + OAUTH_CLIENT + ID of the oauth client or fully qualified identifier for the oauth + client. + + To set the oauth_client attribute: + ▸ provide the argument oauth_client 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 name. + + To set the location attribute: + ▸ provide the argument oauth_client on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam oauth-clients describe + diff --git a/gcloud/alpha/iam/oauth-clients/help b/gcloud/alpha/iam/oauth-clients/help new file mode 100644 index 000000000..013f9c855 --- /dev/null +++ b/gcloud/alpha/iam/oauth-clients/help @@ -0,0 +1,50 @@ +NAME + gcloud alpha iam oauth-clients - create and manage OAuth clients + +SYNOPSIS + gcloud alpha iam oauth-clients GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) The gcloud alpha iam oauth-clients group lets you create and manage + OAuth clients for projects on the Google Cloud Platform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + credentials + (ALPHA) Create and manage OAuth client credentials. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create an OAuth client. + + delete + (ALPHA) Delete an OAuth client. + + describe + (ALPHA) Describe an OAuth client. + + list + (ALPHA) List OAuth clients. + + undelete + (ALPHA) Undelete an OAuth client. + + update + (ALPHA) Update an OAuth client. + +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 iam oauth-clients + diff --git a/gcloud/alpha/iam/oauth-clients/list b/gcloud/alpha/iam/oauth-clients/list new file mode 100644 index 000000000..21e738521 --- /dev/null +++ b/gcloud/alpha/iam/oauth-clients/list @@ -0,0 +1,87 @@ +NAME + gcloud alpha iam oauth-clients list - list OAuth clients + +SYNOPSIS + gcloud alpha iam oauth-clients list --location=LOCATION [--show-deleted] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List OAuth clients. + +EXAMPLES + The following command lists all OAuth clients in the default project, + including the soft-deleted ones: + + $ gcloud alpha iam oauth-clients list --location="global" \ + --show-deleted + +REQUIRED FLAGS + Location resource - The location you want to list OAuth clients for. 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 --location 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. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. + + To set the location attribute: + ▸ provide the argument --location on the command line. + +FLAGS + --show-deleted + Whether to return soft-deleted OAuth clients. + +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. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam oauth-clients list + diff --git a/gcloud/alpha/iam/oauth-clients/undelete b/gcloud/alpha/iam/oauth-clients/undelete new file mode 100644 index 000000000..bc92084cf --- /dev/null +++ b/gcloud/alpha/iam/oauth-clients/undelete @@ -0,0 +1,69 @@ +NAME + gcloud alpha iam oauth-clients undelete - undelete an OAuth client + +SYNOPSIS + gcloud alpha iam oauth-clients undelete + (OAUTH_CLIENT : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Undelete an OAuth client. + +EXAMPLES + The following command undeletes the OAuth client with the ID + my-oauth-client in the default project: + + $ gcloud alpha iam oauth-clients undelete my-oauth-client \ + --location="global" + +POSITIONAL ARGUMENTS + Oauth client resource - The OAuth client to undelete. 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 oauth_client 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. + + OAUTH_CLIENT + ID of the oauth client or fully qualified identifier for the oauth + client. + + To set the oauth_client attribute: + ▸ provide the argument oauth_client 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 name. + + To set the location attribute: + ▸ provide the argument oauth_client on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam oauth-clients undelete + diff --git a/gcloud/alpha/iam/oauth-clients/update b/gcloud/alpha/iam/oauth-clients/update new file mode 100644 index 000000000..64c1e01f7 --- /dev/null +++ b/gcloud/alpha/iam/oauth-clients/update @@ -0,0 +1,115 @@ +NAME + gcloud alpha iam oauth-clients update - update an OAuth client + +SYNOPSIS + gcloud alpha iam oauth-clients update (OAUTH_CLIENT : --location=LOCATION) + [--allowed-grant-types=[ALLOWED_GRANT_TYPES,...]] + [--allowed-redirect-uris=[ALLOWED_REDIRECT_URIS,...]] + [--allowed-scopes=[ALLOWED_SCOPES,...]] [--description=DESCRIPTION] + [--disabled] [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update an OAuth Client. + +EXAMPLES + The following command updates the OAuth client with ID my-oauth-client in + the default project: + + $ gcloud alpha iam oauth-clients update my-oauth-client \ + --location="global" --display-name="My oauth client" \ + --description="My oauth client description" --disabled \ + --allowed-grant-types="authorization-code-grant,refresh-token-gr\ + ant" \ + --allowed-scopes="https://www.googleapis.com/auth/cloud-platform\ + ,openid" --allowed-redirect-uris="http://localhost/" + +POSITIONAL ARGUMENTS + Oauth client resource - The OAuth client to update. 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 oauth_client 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. + + OAUTH_CLIENT + ID of the oauth client or fully qualified identifier for the oauth + client. + + To set the oauth_client attribute: + ▸ provide the argument oauth_client 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 name. + + To set the location attribute: + ▸ provide the argument oauth_client on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --allowed-grant-types=[ALLOWED_GRANT_TYPES,...] + A list of OAuth grant types that are allowed for the OAuth client. + + The following grant types are currently supported: + + ◆ authorization-code-grant + + ◆ refresh-token-grant + + --allowed-redirect-uris=[ALLOWED_REDIRECT_URIS,...] + A list of redirect uris that is allowed for redirecting when the + authorization is completed. + + --allowed-scopes=[ALLOWED_SCOPES,...] + A list of scopes that the OAuth client is allowed to request during + OAuth flows. + + The following scopes are currently supported: + + ◆ https://www.googleapis.com/auth/cloud-platform: View, edit, + configure, and delete your Google Cloud data, and view the email + address for your Google Account. + + ◆ openid: Associate you with your personal info on Google Cloud. + + ◆ email: View your Google Cloud Account email address. + + --description=DESCRIPTION + A description of the OAuth client. Cannot exceed 256 characters. + + --disabled + Disables the OAuth client. You cannot use a disabled OAuth client for + login. Include --no-disabled to enable a disabled OAuth client. + + --display-name=DISPLAY_NAME + A display name for the OAuth client. Cannot exceed 32 characters. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam oauth-clients update + diff --git a/gcloud/alpha/iap/web/disable b/gcloud/alpha/iap/web/disable index ee47a4838..2b3fc55fc 100644 --- a/gcloud/alpha/iap/web/disable +++ b/gcloud/alpha/iap/web/disable @@ -16,11 +16,16 @@ EXAMPLES $ gcloud alpha iap web disable --resource-type=app-engine - To disable IAP on a backend service, run: + To disable IAP on a global backend service, run: $ gcloud alpha iap web disable --resource-type=backend-services \ --service=SERVICE_ID + To disable IAP on a region backend service, run: + + $ gcloud alpha iap web disable --resource-type=backend-services \ + --service=SERVICE_ID --region=REGION + FLAGS --resource-type=RESOURCE_TYPE Resource type of the IAP resource. RESOURCE_TYPE must be one of: diff --git a/gcloud/alpha/iap/web/enable b/gcloud/alpha/iap/web/enable index 6f660dbf9..2d70265f1 100644 --- a/gcloud/alpha/iap/web/enable +++ b/gcloud/alpha/iap/web/enable @@ -20,12 +20,18 @@ EXAMPLES $ gcloud alpha iap web enable --resource-type=app-engine \ --oauth2-client-id=CLIENT_ID --oauth2-client-secret=SECRET - To enable IAP on a backend service, run: + To enable IAP on a global backend service, run: $ gcloud alpha iap web enable --resource-type=backend-services \ --oauth2-client-id=CLIENT_ID --oauth2-client-secret=SECRET \ --service=SERVICE_ID + To enable IAP on a region backend service, run: + + $ gcloud alpha iap web enable --resource-type=backend-services \ + --oauth2-client-id=CLIENT_ID --oauth2-client-secret=SECRET \ + --service=SERVICE_ID --region=REGION + FLAGS --oauth2-client-id=OAUTH2_CLIENT_ID OAuth 2.0 client ID to use. diff --git a/gcloud/alpha/redis/clusters/backup-collections/describe b/gcloud/alpha/redis/clusters/backup-collections/describe new file mode 100644 index 000000000..a93d763a8 --- /dev/null +++ b/gcloud/alpha/redis/clusters/backup-collections/describe @@ -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 + diff --git a/gcloud/alpha/redis/clusters/backup-collections/help b/gcloud/alpha/redis/clusters/backup-collections/help new file mode 100644 index 000000000..8db0146fb --- /dev/null +++ b/gcloud/alpha/redis/clusters/backup-collections/help @@ -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 + diff --git a/gcloud/alpha/redis/clusters/backup-collections/list b/gcloud/alpha/redis/clusters/backup-collections/list new file mode 100644 index 000000000..4ac12bb8c --- /dev/null +++ b/gcloud/alpha/redis/clusters/backup-collections/list @@ -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 + diff --git a/gcloud/alpha/redis/clusters/backups/delete b/gcloud/alpha/redis/clusters/backups/delete new file mode 100644 index 000000000..1c9dc10d4 --- /dev/null +++ b/gcloud/alpha/redis/clusters/backups/delete @@ -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 + diff --git a/gcloud/alpha/redis/clusters/backups/describe b/gcloud/alpha/redis/clusters/backups/describe new file mode 100644 index 000000000..be29b586e --- /dev/null +++ b/gcloud/alpha/redis/clusters/backups/describe @@ -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 + diff --git a/gcloud/alpha/redis/clusters/backups/export b/gcloud/alpha/redis/clusters/backups/export new file mode 100644 index 000000000..eca9ee68c --- /dev/null +++ b/gcloud/alpha/redis/clusters/backups/export @@ -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 + diff --git a/gcloud/alpha/redis/clusters/backups/help b/gcloud/alpha/redis/clusters/backups/help new file mode 100644 index 000000000..174c2364a --- /dev/null +++ b/gcloud/alpha/redis/clusters/backups/help @@ -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 + diff --git a/gcloud/alpha/redis/clusters/backups/list b/gcloud/alpha/redis/clusters/backups/list new file mode 100644 index 000000000..dc08e9966 --- /dev/null +++ b/gcloud/alpha/redis/clusters/backups/list @@ -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 + diff --git a/gcloud/alpha/redis/clusters/create b/gcloud/alpha/redis/clusters/create index d78a26ac0..617160676 100644 --- a/gcloud/alpha/redis/clusters/create +++ b/gcloud/alpha/redis/clusters/create @@ -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, diff --git a/gcloud/alpha/redis/clusters/create-backup b/gcloud/alpha/redis/clusters/create-backup new file mode 100644 index 000000000..c229c3c66 --- /dev/null +++ b/gcloud/alpha/redis/clusters/create-backup @@ -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 + diff --git a/gcloud/alpha/redis/clusters/help b/gcloud/alpha/redis/clusters/help index 2dd167e00..043dddb45 100644 --- a/gcloud/alpha/redis/clusters/help +++ b/gcloud/alpha/redis/clusters/help @@ -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. diff --git a/gcloud/alpha/sql/instances/create b/gcloud/alpha/sql/instances/create index ead6833a6..1a9b9a9f1 100644 --- a/gcloud/alpha/sql/instances/create +++ b/gcloud/alpha/sql/instances/create @@ -529,8 +529,8 @@ FLAGS established from specified consumer projects. --enable-private-service-connect - When the flag is set, a Cloud SQL instance will be created with Private - Service Connect enabled. + Enable connecting to the Cloud SQL instance with Private Service + Connect. Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the instance. The 'Compute Engine Service Agent' diff --git a/gcloud/alpha/sql/instances/patch b/gcloud/alpha/sql/instances/patch index 147a5cbb1..affbdaa7f 100644 --- a/gcloud/alpha/sql/instances/patch +++ b/gcloud/alpha/sql/instances/patch @@ -23,6 +23,7 @@ SYNOPSIS [--[no-]enable-google-ml-integration] [--[no-]enable-google-private-path] [--enable-password-policy] [--enable-point-in-time-recovery] + [--[no-]enable-private-service-connect] [--failover-dr-replica-name=FAILOVER_DR_REPLICA_NAME] [--follow-gae-app=FOLLOW_GAE_APP] [--[no-]insights-config-query-insights-enabled] @@ -129,7 +130,7 @@ FLAGS --clear-failover-dr-replica-name Clear the DR replica setting for the primary instance. Flag is only - available for MySQL. + available for MySQL and PostgreSQL database instances. --clear-password-policy Clear the existing password policy. This flag is only available for @@ -226,10 +227,16 @@ FLAGS fraction of a second, via write-ahead logs. Must have automatic backups enabled to use. Make sure storage can support at least 7 days of logs. + --[no-]enable-private-service-connect + Enable connecting to the Cloud SQL instance with Private Service + Connect. Use --enable-private-service-connect to enable and + --no-enable-private-service-connect to disable. + --failover-dr-replica-name=FAILOVER_DR_REPLICA_NAME Set a Disaster Recovery (DR) replica with the specified name for the primary instance. This must be one of the existing cross region - replicas of the primary instance. Flag is only available for MySQL. + replicas of the primary instance. Flag is only available for MySQL and + PostgreSQL database instances. --follow-gae-app=FOLLOW_GAE_APP First Generation instances only. The App Engine app this instance diff --git a/gcloud/alpha/storage/buckets/create b/gcloud/alpha/storage/buckets/create index 5910746d9..ad93a9074 100644 --- a/gcloud/alpha/storage/buckets/create +++ b/gcloud/alpha/storage/buckets/create @@ -11,7 +11,7 @@ SYNOPSIS [--enable-hierarchical-namespace] [--enable-per-object-retention] [--ip-filter-file=IP_FILTER_FILE] [--location=LOCATION, -l LOCATION] [--[no-]pap, --[no-]public-access-prevention] - [--placement=REGION,REGION] + [--placement=[REGION,...]] [--recovery-point-objective=SETTING, --rpo=SETTING] [--retention-period=RETENTION_PERIOD] [--soft-delete-duration=SOFT_DELETE_DURATION] @@ -95,9 +95,8 @@ FLAGS --public-access-prevention to enable and --no-public-access-prevention to disable. - --placement=REGION,REGION - A comma-separated list of exactly 2 regions that form the custom - [dual-region] + --placement=[REGION,...] + A comma-separated list of regions that form the custom [dual-region] (https://cloud.google.com/storage/docs/locations#location-dr). Only regions within the same continent are or will ever be valid. Invalid location pairs (such as mixed-continent, or with unsupported regions) diff --git a/gcloud/alpha/storage/buckets/help b/gcloud/alpha/storage/buckets/help index f38741c06..328898372 100644 --- a/gcloud/alpha/storage/buckets/help +++ b/gcloud/alpha/storage/buckets/help @@ -42,6 +42,9 @@ COMMANDS list (ALPHA) Lists Cloud Storage buckets. + relocate + (ALPHA) Relocates bucket between different locations. + remove-iam-policy-binding (ALPHA) Remove an IAM policy binding from a bucket. diff --git a/gcloud/alpha/storage/buckets/relocate b/gcloud/alpha/storage/buckets/relocate new file mode 100644 index 000000000..042eeeaee --- /dev/null +++ b/gcloud/alpha/storage/buckets/relocate @@ -0,0 +1,110 @@ +NAME + gcloud alpha storage buckets relocate - relocates bucket between different + locations + +SYNOPSIS + gcloud alpha storage buckets relocate + ([URL --location=LOCATION : --placement=[REGION,...] + --dry-run] [--operation=OPERATION --finalize : --ttl=TTL]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Relocates a bucket between different locations. + +EXAMPLES + To move a bucket (gs://my-bucket) to the us-central1 location, use the + following command: + + $ gcloud storage buckets relocate gs://my-bucket \ + --location=us-central1 + + To move a bucket to a custom Dual-region, use the following command: + + $ gcloud storage buckets relocate gs://my-bucket --location=us \ + --placement=us-central1,us-east1 + + To validate the operation without actually moving the bucket, use the + following command: + + $ gcloud storage buckets relocate gs://my-bucket \ + --location=us-central1 --dry-run + + To schedule a write lock for the move, with ttl for reverting the write + lock after 7h, if the relocation has not succeeded, use the following + command: + + $ gcloud storage buckets relocate \ + --operation=projects/_/buckets/my-bucket/operations/C894F35J \ + --finalize --ttl=7h + +POSITIONAL ARGUMENTS + Exactly one of these must be specified: + + Arguments for initiating the bucket relocate operation. + + URL + The URL of the bucket to relocate. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The final [location] + (https://cloud.google.com/storage/docs/locations) where the bucket + will be relocated to. If no location is provided, Cloud Storage + will use the default location, which is us. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --placement=[REGION,...] + A comma-separated list of regions that form the custom + [dual-region] + (https://cloud.google.com/storage/docs/locations#location-dr). Only + regions within the same continent are or will ever be valid. + Invalid location pairs (such as mixed-continent, or with + unsupported regions) will return an error. + + --dry-run + Prints the operations that the relocate command would perform + without actually performing relocation. This is helpful to identify + any issues that need to be detected asynchronously. + + Arguments for advancing the relocation operation. + + --operation=OPERATION + Specify the relocation operation name to advance the relocation + operation.The relocation operation name must include the Cloud + Storage bucket and operation ID. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --finalize + Schedules the write lock to occur. Once activated, no further + writes will be allowed to the associated bucket. This helps + minimize disruption to bucket usage. For certain types of + moves(between Multi Region and Custom Dual Regions), finalize is + not required. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --ttl=TTL + Time to live for the relocation operation. Defaults to 12h if not + provided. + +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. + +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. + diff --git a/gcloud/alpha/storage/management-hub/enable b/gcloud/alpha/storage/management-hub/enable index 76e4331a2..c17481dc9 100644 --- a/gcloud/alpha/storage/management-hub/enable +++ b/gcloud/alpha/storage/management-hub/enable @@ -48,8 +48,8 @@ LOCATION FLAGS --exclude-locations=[EXCLUDE_LOCATIONS,...] Comma separated list of locations - (https://cloud.google.com/storage/docs/locations#available-locations)to - exclude in Management Hub filter. To clear excluded locations, + (https://cloud.google.com/storage/docs/locations#available-locations) + to exclude in Management Hub filter. To clear excluded locations, provide flag with empty list. e.g --exclude-locations="" or --exclude-locations= . @@ -71,10 +71,10 @@ BUCKET_FILTER FLAGS --exclude-bucket-id-regexes=[EXCLUDE_BUCKET_ID_REGEXES,...] Sets filter for bucket id regexes to exclude. Accepts list of bucket id regexes in comma separated format. If the regex contains - special characters that may have a specific meaning in the shell - (like $, &, , etc.), escape them using backslashes(\). To clear - bucket id regexes list, provide flag with an empty list. e.g - --exclude-bucket-id-regexes="" or --exclude-bucket-id-regexes= . + special characters that may have a specific meaning in the shell, + escape them using backslashes(\). To clear bucket id regexes list, + provide flag with an empty list. e.g --exclude-bucket-id-regexes="" + or --exclude-bucket-id-regexes= . --exclude-bucket-ids=[EXCLUDE_BUCKET_IDS,...] Comma separated list of bucket ids to exclude in the management hub @@ -89,10 +89,10 @@ BUCKET_FILTER FLAGS --include-bucket-id-regexes=[INCLUDE_BUCKET_ID_REGEXES,...] Sets filter for bucket id regexes to include. Accepts list of bucket id regexes in comma separated format. If the regex contains - special characters that may have a specific meaning in the shell - (like $, &, , etc.), escape them using backslashes(\). To clear - bucket id regexes list, provide flag with empty list. e.g - --include-bucket-id-regexes="" or --include-bucket-id-regexes= . + special characters that may have a specific meaning in the shell, + escape them using backslashes(\). To clear bucket id regexes list, + provide flag with empty list. e.g --include-bucket-id-regexes="" or + --include-bucket-id-regexes= . --include-bucket-ids=[INCLUDE_BUCKET_IDS,...] Comma separated list of bucket ids to include in the management hub diff --git a/gcloud/alpha/storage/management-hub/update b/gcloud/alpha/storage/management-hub/update index 2b406f7a5..4ddb61208 100644 --- a/gcloud/alpha/storage/management-hub/update +++ b/gcloud/alpha/storage/management-hub/update @@ -82,10 +82,9 @@ REQUIRED FLAGS Sets filter for bucket id regexes to exclude. Accepts list of bucket id regexes in comma separated format. If the regex contains special characters that may have a specific meaning in - the shell (like $, &, , etc.), escape them using backslashes(\). - To clear bucket id regexes list, provide flag with an empty list. - e.g --exclude-bucket-id-regexes="" or - --exclude-bucket-id-regexes= . + the shell, escape them using backslashes(\). To clear bucket id + regexes list, provide flag with an empty list. e.g + --exclude-bucket-id-regexes="" or --exclude-bucket-id-regexes= . --exclude-bucket-ids=[EXCLUDE_BUCKET_IDS,...] Comma separated list of bucket ids to exclude in the management @@ -101,10 +100,9 @@ REQUIRED FLAGS Sets filter for bucket id regexes to include. Accepts list of bucket id regexes in comma separated format. If the regex contains special characters that may have a specific meaning in - the shell (like $, &, , etc.), escape them using backslashes(\). - To clear bucket id regexes list, provide flag with empty list. - e.g --include-bucket-id-regexes="" or - --include-bucket-id-regexes= . + the shell, escape them using backslashes(\). To clear bucket id + regexes list, provide flag with empty list. e.g + --include-bucket-id-regexes="" or --include-bucket-id-regexes= . --include-bucket-ids=[INCLUDE_BUCKET_IDS,...] Comma separated list of bucket ids to include in the management @@ -115,8 +113,8 @@ REQUIRED FLAGS --exclude-locations=[EXCLUDE_LOCATIONS,...] Comma separated list of locations - (https://cloud.google.com/storage/docs/locations#available-locations)to - exclude in Management Hub filter. To clear excluded locations, + (https://cloud.google.com/storage/docs/locations#available-locations) + to exclude in Management Hub filter. To clear excluded locations, provide flag with empty list. e.g --exclude-locations="" or --exclude-locations= . diff --git a/gcloud/alpha/transfer/agents/install b/gcloud/alpha/transfer/agents/install index 06e2b65d3..7d030dfb8 100644 --- a/gcloud/alpha/transfer/agents/install +++ b/gcloud/alpha/transfer/agents/install @@ -2,14 +2,15 @@ NAME gcloud alpha transfer agents install - install Transfer Service agents SYNOPSIS - gcloud alpha transfer agents install --pool=POOL [--count=COUNT] - [--creds-file=CREDS_FILE] [--docker-network=DOCKER_NETWORK] - [--[no-]enable-multipart] [--id-prefix=ID_PREFIX] + gcloud alpha transfer agents install --pool=POOL + [--container-manager=CONTAINER_MANAGER; default="docker"] + [--count=COUNT] [--creds-file=CREDS_FILE] [--[no-]enable-multipart] + [--id-prefix=ID_PREFIX] [--logs-directory=LOGS_DIRECTORY; default="/tmp"] [--max-concurrent-small-file-uploads=MAX_CONCURRENT_SMALL_FILE_UPLOADS] [--memlock-limit=MEMLOCK_LIMIT; default=64000000] - [--mount-directories=[MOUNT-DIRECTORIES,...]] [--proxy=PROXY] - [--s3-compatible-mode] + [--mount-directories=[MOUNT-DIRECTORIES,...]] [--network=NETWORK] + [--proxy=PROXY] [--s3-compatible-mode] [--hdfs-namenode-uri=HDFS_NAMENODE_URI --hdfs-username=HDFS_USERNAME --hdfs-data-transfer-protection=HDFS_DATA_TRANSFER_PROTECTION] [--kerberos-config-file=KERBEROS_CONFIG_FILE @@ -21,7 +22,8 @@ SYNOPSIS DESCRIPTION (ALPHA) Install Transfer Service agents to enable you to transfer data to or from POSIX filesystems, such as on-premises filesystems. Agents are - installed locally on your machine and run inside Docker containers. + installed locally on your machine and run inside Docker or Podman + containers. EXAMPLES To create an agent pool for your agent, see the gcloud transfer agent-pools @@ -48,6 +50,10 @@ REQUIRED FLAGS agents are activated. FLAGS + --container-manager=CONTAINER_MANAGER; default="docker" + The container manager to use for running agents. CONTAINER_MANAGER must + be one of: docker, podman. + --count=COUNT Specify the number of agents to install on your current machine. System requirements: 8 GB of memory and 4 CPUs per agent. @@ -64,14 +70,6 @@ FLAGS Note that the credentials location will be mounted to the agent container. - --docker-network=DOCKER_NETWORK - Specify the network to connect the Docker container to. This flag maps - directly to the --network flag in the underlying 'docker run' command. - - If binding directly to the Docker host's network is an option, then - setting this value to 'host' can dramatically improve transfer - performance. - --[no-]enable-multipart Split up files and transfer the resulting chunks in parallel before merging them at the destination. Can be used make transfers of large @@ -111,6 +109,14 @@ FLAGS specified, gcloud transfer will mount your entire filesystem to the agent container and give the agent root access. + --network=NETWORK + Specify the network to connect the container to. This flag maps + directly to the --network flag in the underlying '(docker or podman) + run' command. + + If binding directly to the host's network is an option, then setting + this value to 'host' can dramatically improve transfer performance. + --proxy=PROXY Specify the HTTP URL and port of a proxy server if you want to use a forward proxy. For example, to use the URL 'example.com' and port diff --git a/gcloud/alpha/transfer/jobs/create b/gcloud/alpha/transfer/jobs/create index be3152b70..9bbd37d62 100644 --- a/gcloud/alpha/transfer/jobs/create +++ b/gcloud/alpha/transfer/jobs/create @@ -34,7 +34,8 @@ SYNOPSIS --source-auth-method=SOURCE_AUTH_METHOD --source-list-api=SOURCE_LIST_API --source-network-protocol=SOURCE_NETWORK_PROTOCOL - --source-request-model=SOURCE_REQUEST_MODEL] [--no-async] + --source-request-model=SOURCE_REQUEST_MODEL + --s3-cloudfront-domain=S3_CLOUDFRONT_DOMAIN] [--no-async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -432,6 +433,13 @@ FLAGS virtual-hosted style. SOURCE_REQUEST_MODEL must be one of: PATH_STYLE, VIRTUAL_HOSTED_STYLE. + --s3-cloudfront-domain=S3_CLOUDFRONT_DOMAIN + For transfers from S3, optionally route egress traffic through a + CloudFront instance. Supply the endpoint of the CloudFront instance: + https://example.cloudfront.net. See documentation + (https://cloud.google.com/storage-transfer/docs/s3-cloudfront) for + more information. + EXECUTION OPTIONS --no-async diff --git a/gcloud/alpha/transfer/jobs/update b/gcloud/alpha/transfer/jobs/update index d20df25ed..2539364be 100644 --- a/gcloud/alpha/transfer/jobs/update +++ b/gcloud/alpha/transfer/jobs/update @@ -45,10 +45,11 @@ SYNOPSIS --source-auth-method=SOURCE_AUTH_METHOD --source-list-api=SOURCE_LIST_API --source-network-protocol=SOURCE_NETWORK_PROTOCOL - --source-request-model=SOURCE_REQUEST_MODEL --clear-source-endpoint + --source-request-model=SOURCE_REQUEST_MODEL + --s3-cloudfront-domain=S3_CLOUDFRONT_DOMAIN --clear-source-endpoint --clear-source-signing-region --clear-source-auth-method - --clear-source-list-api - --clear-source-network-protocol --clear-source-request-model] + --clear-source-list-api --clear-source-network-protocol + --clear-source-request-model --clear-s3-cloudfront-domain] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -496,6 +497,13 @@ FLAGS virtual-hosted style. SOURCE_REQUEST_MODEL must be one of: PATH_STYLE, VIRTUAL_HOSTED_STYLE. + --s3-cloudfront-domain=S3_CLOUDFRONT_DOMAIN + For transfers from S3, optionally route egress traffic through a + CloudFront instance. Supply the endpoint of the CloudFront instance: + https://example.cloudfront.net. See documentation + (https://cloud.google.com/storage-transfer/docs/s3-cloudfront) for + more information. + --clear-source-endpoint Removes source endpoint. @@ -514,6 +522,9 @@ FLAGS --clear-source-request-model Removes source request model. + --clear-s3-cloudfront-domain + Removes S3 CloudFront domain. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/backup-dr/backup-plan-associations/create b/gcloud/backup-dr/backup-plan-associations/create new file mode 100644 index 000000000..40dee5e7a --- /dev/null +++ b/gcloud/backup-dr/backup-plan-associations/create @@ -0,0 +1,119 @@ +NAME + gcloud backup-dr backup-plan-associations create - create a new backup plan + association + +SYNOPSIS + gcloud backup-dr backup-plan-associations create + (BACKUP_PLAN_ASSOCIATION + : --location=LOCATION --workload-project=WORKLOAD_PROJECT) + --backup-plan=BACKUP_PLAN --resource=RESOURCE + --resource-type=RESOURCE_TYPE [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new backup plan association in the project. It can only be created + in locations where Backup and DR is available. + +EXAMPLES + To create a new backup plan association sample-bpa in project + sample-project and location us-central1 for resource sample-resource-uri + with backup plan sample-backup-plan, run: + + $ gcloud backup-dr backup-plan-associations create sample-bpa \ + --project=sample-project --location=us-central1 \ + --backup-plan=sample-backup-plan --resource=sample-resource-uri + +POSITIONAL ARGUMENTS + Backup Plan Association resource - Name of the backup plan association to + be created. Once the backup plan association is created, this name can't + be changed. The name must be unique for a project and location. To create + backup plan associations in a project that's different from the backup + plan, use the --workload-project flag. The arguments in this group can be + used to specify the attributes of this resource. + + This must be specified. + + BACKUP_PLAN_ASSOCIATION + ID of the Backup Plan Association or fully qualified identifier for + the Backup Plan Association. + + To set the name attribute: + ▸ provide the argument BACKUP_PLAN_ASSOCIATION 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 of the Backup Plan Association. + + To set the location attribute: + ▸ provide the argument BACKUP_PLAN_ASSOCIATION on the command line + with a fully specified name; + ▸ provide the argument --location on the command line. + + --workload-project=WORKLOAD_PROJECT + Cloud project id for the Backup Plan Association. + + To set the workload-project attribute: + ▸ provide the argument BACKUP_PLAN_ASSOCIATION on the command line + with a fully specified name; + ▸ provide the argument --workload-project on the command line; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. + +REQUIRED FLAGS + Backup Plan resource - The backup plan to be applied to the resource. + E.g., + projects/sample-project/locations/us-central1/backupPlans/sample-backup-plan + 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 --backup-plan 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 --backup-plan on the command line with a fully + specified name; + ◆ provide the argument --location on the command line. + + This must be specified. + + --backup-plan=BACKUP_PLAN + ID of the Backup Plan or fully qualified identifier for the Backup + Plan. + + To set the name attribute: + ▸ provide the argument --backup-plan on the command line. + + --resource=RESOURCE + The resource to which the backup plan is to be applied. E.g., + projects/sample-project/zones/us-central1-a/instances/sample-instance + + --resource-type=RESOURCE_TYPE + Type of resource to which the backup plan should be applied. E.g., + compute..com/Instance + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + +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. + +BRIEF + Creates a new backup plan association + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-plan-associations create + diff --git a/gcloud/backup-dr/backup-plan-associations/delete b/gcloud/backup-dr/backup-plan-associations/delete new file mode 100644 index 000000000..d2adfeb27 --- /dev/null +++ b/gcloud/backup-dr/backup-plan-associations/delete @@ -0,0 +1,77 @@ +NAME + gcloud backup-dr backup-plan-associations delete - delete the specified + backup plan association + +SYNOPSIS + gcloud backup-dr backup-plan-associations delete + (BACKUP_PLAN_ASSOCIATION + : --location=LOCATION --workload-project=WORKLOAD_PROJECT) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete the specified backup plan association. + +EXAMPLES + To delete a backup plan association sample-bpa in project sample-project + and location us-central1 , run: + + $ gcloud backup-dr backup-plan-associations delete sample-bpa \ + --project=sample-project --location=us-central1 + +POSITIONAL ARGUMENTS + Backup Plan Association resource - Name of the backup plan association to + delete. The arguments in this group can be used to specify the attributes + of this resource. + + This must be specified. + + BACKUP_PLAN_ASSOCIATION + ID of the Backup Plan Association or fully qualified identifier for + the Backup Plan Association. + + To set the name attribute: + ▸ provide the argument backup_plan_association 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 of the Backup Plan Association. + + To set the location attribute: + ▸ provide the argument backup_plan_association on the command line + with a fully specified name; + ▸ provide the argument --location on the command line. + + --workload-project=WORKLOAD_PROJECT + Cloud project id for the Backup Plan Association. + + To set the workload-project attribute: + ▸ provide the argument backup_plan_association on the command line + with a fully specified name; + ▸ provide the argument --workload-project on the command line; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + +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. + +BRIEF + Delete a specific backup plan association + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-plan-associations delete + diff --git a/gcloud/backup-dr/backup-plan-associations/describe b/gcloud/backup-dr/backup-plan-associations/describe new file mode 100644 index 000000000..f119f230a --- /dev/null +++ b/gcloud/backup-dr/backup-plan-associations/describe @@ -0,0 +1,67 @@ +NAME + gcloud backup-dr backup-plan-associations describe - show details of the + backup plan association + +SYNOPSIS + gcloud backup-dr backup-plan-associations describe + (BACKUP_PLAN_ASSOCIATION : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Show all configuration data associated with the specified backup plan + association. + +EXAMPLES + To view details for backup plan association BACKUP_PLAN_ASSOCIATION, run: + + $ gcloud backup-dr backup-plan-associations describe \ + BACKUP_PLAN_ASSOCIATION + +POSITIONAL ARGUMENTS + Backup plan association resource - Name of the backup plan association 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_plan_association 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_PLAN_ASSOCIATION + ID of the backup_plan_association or fully qualified identifier for + the backup_plan_association. + + To set the backup_plan_association attribute: + ▸ provide the argument backup_plan_association on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location ID of the resource. + + To set the location attribute: + ▸ provide the argument backup_plan_association on the command line + with a fully specified name; + ▸ provide the argument --location on the command line. + +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 backupdr/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/backup-disaster-recovery + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-plan-associations describe + diff --git a/gcloud/backup-dr/backup-plan-associations/help b/gcloud/backup-dr/backup-plan-associations/help new file mode 100644 index 000000000..3ae60e763 --- /dev/null +++ b/gcloud/backup-dr/backup-plan-associations/help @@ -0,0 +1,38 @@ +NAME + gcloud backup-dr backup-plan-associations - manage Backup and DR backup + plan associations + +SYNOPSIS + gcloud backup-dr backup-plan-associations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Backup and DR backup plan associations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create a new backup plan association. + + delete + Delete the specified backup plan association. + + describe + Show details of the backup plan association. + + list + List Backup and DR backup plan associations. + + trigger-backup + Create an on-demand backup for a resource. + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-plan-associations + diff --git a/gcloud/backup-dr/backup-plan-associations/list b/gcloud/backup-dr/backup-plan-associations/list new file mode 100644 index 000000000..1d80e45e1 --- /dev/null +++ b/gcloud/backup-dr/backup-plan-associations/list @@ -0,0 +1,90 @@ +NAME + gcloud backup-dr backup-plan-associations list - list Backup and DR backup + plan associations + +SYNOPSIS + gcloud backup-dr backup-plan-associations list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List backup plan associations in the project for a specified location. + +EXAMPLES + To list backup plan associations for all locations, run: + + $ gcloud backup-dr backup-plan-associations list + + To list backup plan associations in a location my-location, run: + + $ gcloud backup-dr backup-plan-associations list \ + --location=my-location + +FLAGS + Location resource - Location for which backup plan associations should be + listed. 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 --location on the command line with a fully + specified name; + ◆ default is all locations with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. + + To set the location attribute: + ▸ provide the argument --location on the command line; + ▸ default is all locations . + +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 backupdr/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/backup-disaster-recovery + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-plan-associations list + diff --git a/gcloud/backup-dr/backup-plan-associations/trigger-backup b/gcloud/backup-dr/backup-plan-associations/trigger-backup new file mode 100644 index 000000000..38c1592f9 --- /dev/null +++ b/gcloud/backup-dr/backup-plan-associations/trigger-backup @@ -0,0 +1,85 @@ +NAME + gcloud backup-dr backup-plan-associations trigger-backup - create an + on-demand backup for a resource + +SYNOPSIS + gcloud backup-dr backup-plan-associations trigger-backup + (BACKUP_PLAN_ASSOCIATION + : --location=LOCATION --workload-project=WORKLOAD_PROJECT) + --backup-rule-id=BACKUP_RULE_ID [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create an on-demand backup for a resource. Trigger an on demand backup for + the given backup rule. + +EXAMPLES + To trigger an on demand backup for a backup plan association sample-bpa in + project sample-project and location us-central1 with backup rule + sample-backup-rule, run: + + $ gcloud backup-dr backup-plan-associations trigger-backup \ + sample-bpa --project=sample-project --location=us-central1 \ + --backup-rule-id=sample-backup-rule + +POSITIONAL ARGUMENTS + Backup Plan Association resource - Name of an existing backup plan + association to use for creating an on-demand backup. The arguments in this + group can be used to specify the attributes of this resource. + + This must be specified. + + BACKUP_PLAN_ASSOCIATION + ID of the Backup Plan Association or fully qualified identifier for + the Backup Plan Association. + + To set the name attribute: + ▸ provide the argument BACKUP_PLAN_ASSOCIATION 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 of the Backup Plan Association. + + To set the location attribute: + ▸ provide the argument BACKUP_PLAN_ASSOCIATION on the command line + with a fully specified name; + ▸ provide the argument --location on the command line. + + --workload-project=WORKLOAD_PROJECT + Cloud project id for the Backup Plan Association. + + To set the workload-project attribute: + ▸ provide the argument BACKUP_PLAN_ASSOCIATION on the command line + with a fully specified name; + ▸ provide the argument --workload-project on the command line; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. + +REQUIRED FLAGS + --backup-rule-id=BACKUP_RULE_ID + Name of an existing backup rule to use for creating an on-demand + backup. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + +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. + +BRIEF + Create an on-demand backup. + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-plan-associations trigger-backup + diff --git a/gcloud/backup-dr/backup-plans/create b/gcloud/backup-dr/backup-plans/create new file mode 100644 index 000000000..48ea0937d --- /dev/null +++ b/gcloud/backup-dr/backup-plans/create @@ -0,0 +1,246 @@ +NAME + gcloud backup-dr backup-plans create - creates a new Backup Plan + +SYNOPSIS + gcloud backup-dr backup-plans create (BACKUP_PLAN : --location=LOCATION) + --backup-rule=[PROPERTY=VALUE,...] --backup-vault=BACKUP_VAULT + --resource-type=RESOURCE_TYPE [--async] [--description=DESCRIPTION] + [--labels=[KEY=VALUE,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new backup plan in the project. It can only be created in + locations where Backup and DR is available. + +EXAMPLES + To create a new backup plan sample-backup-plan in project sample-project, + at location us-central1, with resource-type + compute..com/Instance and backup-vault backup-vault with 2 + backup-rules: + + run: + + $ gcloud backup-dr backup-plans create sample-backup-plan \ + --project=sample-project --location=us-central1 \ + --resource-type 'compute..com/Instance' \ + --backup-vault --backup-rule \ + --backup-rule + + Backup Rule Examples: + + 1. Hourly backup rule with hourly backup frequency of 6 hours and store it + for 30 days, and expect the backups to run only between 10:00 to 20:00 UTC + + : + rule-id=sample-hourly-rule,retention-days=30,recurrence=HOURLY,hourly-frequency=6,time-zone=UTC,backup-window-start=10,backup-window-end=20 + + Properties: + ▪ rule-id = "sample-hourly-rule" + ▪ retention-days = 30 + ▪ recurrence = HOURLY + ▪ hourly-frequency = 6 + ▪ time-zone = UTC + ▪ backup-window-start = 10 + ▪ backup-window-end = 20 + + 2. Daily backup rule with daily backup frequency of 6 hours and store it + for 7 days + + : + rule-id=sample-daily-rule,retention-days=7,recurrence=DAILY,backup-window-start=1,backup-window-end=14 + + Properties: + ▪ rule-id = "sample-daily-rule" + ▪ retention-days = 7 + ▪ recurrence = DAILY + ▪ backup-window-start = 1 + ▪ backup-window-end = 14 + + 3. Weekly backup rule with weekly backup frequency on every MONDAY & FRIDAY + and store it for 21 days + + : + rule-id=sample-weekly-rule,retention-days=21,recurrence=WEEKLY,days-of-week="MONDAY + FRIDAY",backup-window-start=10,backup-window-end=20 + + Properties: + ▪ rule-id = "sample-weekly-rule" + ▪ retention-days: 21 + ▪ recurrence = WEEKLY + ▪ days-of-week = "MONDAY FRIDAY" + ▪ backup-window-start = 10 + ▪ backup-window-end = 20 + +POSITIONAL ARGUMENTS + Backup Plan resource - Name of the backup plan to be created. Once the + backup plan is created, this name can't be changed. The name must be + unique for a project and location. 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_PLAN 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_PLAN + ID of the Backup Plan or fully qualified identifier for the Backup + Plan. + + To set the name attribute: + ▸ provide the argument BACKUP_PLAN 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 of the Backup Plan. + + To set the location attribute: + ▸ provide the argument BACKUP_PLAN on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + +REQUIRED FLAGS + --backup-rule=[PROPERTY=VALUE,...] + Backup rule that defines parameters for when and how a backup is + created. This flag can be repeated to create more backup rules. + + Parameters for the backup rule include: + + rule-id + Name of the backup rule. The name must be unique and start with a + lowercase letter followed by up to 62 lowercase letters, numbers, + or hyphens. + + retention-days + Duration for which backup data should be retained. It must be + defined in "days". The value should be greater than or equal to the + enforced retention period set for the backup vault. + + recurrence + Frequency for the backup schedule. It must be either: HOURLY, + DAILY, WEEKLY, MONTHLY or YEARLY. + + backup-window-start + Start time of the interval during which backup jobs should be + executed. It can be defined as backup-window-start=2, that means + backup window starts at 2 a.m. The start time and end time must + have an interval of 6 hours. + + backup-window-end + End time of the interval during which backup jobs should be + executed. It can be defined as backup-window-end=14, that means + backup window ends at 2 p.m. The start time and end time must have + an interval of 6 hours. + + Jobs are queued at the beginning of the window and will be marked + as SKIPPED if they do not start by the end time. Jobs that are in + progress will not be canceled at the end time. + + time-zone + The time zone to be used for the backup schedule. The value must + exist in the IANA tz database (https://www.iana.org/time-zones). + The default value is UTC. E.g., Europe/Paris + + Following flags are mutually exclusive: + + hourly-frequency + Frequency for hourly backups. An hourly frequency of 2 means backup + jobs will run every 2 hours from start time till the end time + defined. The hourly frequency must be between 6 and 23. The value + is needed only if recurrence type is HOURLY. + + days-of-week + Days of the week when the backup job should be executed. The value + is needed if recurrence type is WEEKLY. E.g., MONDAY,TUESDAY + + days-of-month + Days of the month when the backup job should be executed. The value + is needed only if recurrence type is YEARLY. E.g.,"1,5,14" + + months + Month for the backup schedule. The value is needed only if + recurrence type is YEARLY. E.g., JANUARY, MARCH + + week-day-of-month + Recurring day of the week in the month or year when the backup job + should be executed. E.g. FIRST-SUNDAY, THIRD-MONDAY. The value can + only be provided if the recurrence type is MONTHLY or YEARLY. + Allowed values for the number of week - FIRST, SECOND, THIRD, + FOURTH, LAST. Allowed values for days of the week - MONDAY to + SUNDAY. + + E.g., + "rule-id=sample-daily-rule,recurrence=WEEKLY,backup-window-start=2,backup-window-end=14,retention-days=20,days-of-week='SUNDAY + MONDAY'" + + Backup Vault resource - The backup vault where the backups gets stored + using this backup plan. 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 --backup-vault 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 --backup-vault on the command line with a fully + specified name; + ◆ provide the argument --location on the command line. + + This must be specified. + + --backup-vault=BACKUP_VAULT + ID of the Backup Vault or fully qualified identifier for the Backup + Vault. + + To set the name attribute: + ▸ provide the argument --backup-vault on the command line. + + --resource-type=RESOURCE_TYPE + Type of resource to which the backup plan should be applied. E.g., + compute..com/Instance + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + + --description=DESCRIPTION + Provide a description of the backup plan, such as specific use cases + and relevant details, in 2048 characters or less. + + E.g., This is a backup plan that performs a daily backup at 6 p.m. and + retains data for 3 months. + + --labels=[KEY=VALUE,...] + If you have assigned labels to your resources for grouping, you can + provide the label using this flag.A label is a key-value pair. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (), lowercase characters, and + numbers. + +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. + +BRIEF + Creates a new backup plan + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-plans create + diff --git a/gcloud/backup-dr/backup-plans/delete b/gcloud/backup-dr/backup-plans/delete new file mode 100644 index 000000000..7d1823196 --- /dev/null +++ b/gcloud/backup-dr/backup-plans/delete @@ -0,0 +1,71 @@ +NAME + gcloud backup-dr backup-plans delete - deletes a Backup Plan + +SYNOPSIS + gcloud backup-dr backup-plans delete (BACKUP_PLAN : --location=LOCATION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Deletes a Backup Plan. + +EXAMPLES + To delete a backup plan sample-backup-plan in project sample-project and + location us-central1 , run: + + $ gcloud backup-dr backup-plans delete sample-backup-plan \ + --project=sample-project --location=us-central1 + +POSITIONAL ARGUMENTS + Backup Plan resource - Name of the backup plan 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_plan 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_PLAN + ID of the Backup Plan or fully qualified identifier for the Backup + Plan. + + To set the name attribute: + ▸ provide the argument backup_plan 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 of the Backup Plan. + + To set the location attribute: + ▸ provide the argument backup_plan 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 + complete. The default is True. Enabled by default, use --no-async to + disable. + +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. + +BRIEF + Deletes a specific backup plan + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-plans delete + diff --git a/gcloud/backup-dr/backup-plans/describe b/gcloud/backup-dr/backup-plans/describe new file mode 100644 index 000000000..2f0b7165d --- /dev/null +++ b/gcloud/backup-dr/backup-plans/describe @@ -0,0 +1,64 @@ +NAME + gcloud backup-dr backup-plans describe - show details of the backup plan + +SYNOPSIS + gcloud backup-dr backup-plans describe (BACKUP_PLAN : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Show all data associated with the specified backup plan. + +EXAMPLES + To view details for backup plan 'BACKUP_PLAN', run: + + $ gcloud backup-dr backup-plans describe BACKUP_PLAN + +POSITIONAL ARGUMENTS + Backup plan resource - Name of the backup plan 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_plan 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_PLAN + ID of the backup_plan or fully qualified identifier for the + backup_plan. + + To set the backup_plan attribute: + ▸ provide the argument backup_plan on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location ID of the resource. + + To set the location attribute: + ▸ provide the argument backup_plan on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + +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 backupdr/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/backup-disaster-recovery + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-plans describe + diff --git a/gcloud/backup-dr/backup-plans/help b/gcloud/backup-dr/backup-plans/help new file mode 100644 index 000000000..281acf3db --- /dev/null +++ b/gcloud/backup-dr/backup-plans/help @@ -0,0 +1,34 @@ +NAME + gcloud backup-dr backup-plans - manage Backup and DR backup plans + +SYNOPSIS + gcloud backup-dr backup-plans COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Backup and DR backup plans. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Creates a new Backup Plan. + + delete + Deletes a Backup Plan. + + describe + Show details of the backup plan. + + list + List backup plans in the project. + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-plans + diff --git a/gcloud/backup-dr/backup-plans/list b/gcloud/backup-dr/backup-plans/list new file mode 100644 index 000000000..3d9af3ad8 --- /dev/null +++ b/gcloud/backup-dr/backup-plans/list @@ -0,0 +1,88 @@ +NAME + gcloud backup-dr backup-plans list - list backup plans in the project + +SYNOPSIS + gcloud backup-dr backup-plans list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List backup plans in the project. + +EXAMPLES + To list backup plans for all locations, run: + + $ gcloud backup-dr backup-plans list + + To list backup plans in a location "my-location", run: + + $ gcloud backup-dr backup-plans list --location=my-location + +FLAGS + Location resource - Location for which backup plans should be listed. 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 --location on the command line with a fully + specified name; + ◆ default is all locations with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. + + To set the location attribute: + ▸ provide the argument --location on the command line; + ▸ default is all locations . + +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 backupdr/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/backup-disaster-recovery + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-plans list + diff --git a/gcloud/backup-dr/backup-vaults/create b/gcloud/backup-dr/backup-vaults/create new file mode 100644 index 000000000..377a53470 --- /dev/null +++ b/gcloud/backup-dr/backup-vaults/create @@ -0,0 +1,131 @@ +NAME + gcloud backup-dr backup-vaults create - create a Backup and DR backup vault + +SYNOPSIS + gcloud backup-dr backup-vaults create (BACKUP_VAULT : --location=LOCATION) + --backup-min-enforced-retention=BACKUP_MIN_ENFORCED_RETENTION + [--access-restriction=ACCESS_RESTRICTION; default="within-org"] + [--no-async] [--description=DESCRIPTION] + [--effective-time=EFFECTIVE_TIME] [--labels=[KEY=VALUE,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a Backup and DR backup vault. + +EXAMPLES + To create a new backup vault BACKUP_VAULT in location MY_LOCATION with + minimum enforced-retention for backups of 1 month and 1 day, run: + + $ gcloud backup-dr backup-vaults create BACKUP_VAULT \ + --location=MY_LOCATION --backup-min-enforced-retention="p1m1d" + + To create a new backup vault BACKUP_VAULT in location MY_LOCATION with + minimum enforced-retention for backups of 1 day and description + DESCRIPTION, run: + + $ gcloud backup-dr backup-vaults create BACKUP_VAULT \ + --location=MY_LOCATION --backup-min-enforced-retention="1d" \ + --description=DESCRIPTION + + To create a new backup vault BACKUP_VAULT in location MY_LOCATION with + minimum enforced-retention for backups of 1 day and label key1 with value + value1, run: + + $ gcloud backup-dr backup-vaults create BACKUP_VAULT \ + --location=MY_LOCATION --backup-min-enforced-retention="1d" \ + --labels=key1=value1 + + To create a new backup vault BACKUP_VAULT in location MY_LOCATION with + minimum enforced-retention for backups of 1 day and effective-time + "2024-03-22", run: + + $ gcloud backup-dr backup-vaults create BACKUP_VAULT \ + --location=MY_LOCATION --backup-min-enforced-retention="1d" \ + --effective-time="2024-03-22" + +POSITIONAL ARGUMENTS + Backup Vault resource - Name of the backup vault to create. A vault name + cannot be changed after creation. It must be between 3-63 characters long + and must be unique within the project and location. 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_vault 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_VAULT + ID of the Backup Vault or fully qualified identifier for the Backup + Vault. + + To set the name attribute: + ▸ provide the argument backup_vault 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 of the Backup Vault. + + To set the location attribute: + ▸ provide the argument backup_vault on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +REQUIRED FLAGS + --backup-min-enforced-retention=BACKUP_MIN_ENFORCED_RETENTION + Backups will be kept for this minimum period before they can be + deleted. Once the effective time is reached, the enforced retention + period cannot be decreased or removed. The value must be specified in + relative time format (e.g. p1d, p1m, p1m1d). + +OPTIONAL FLAGS + --access-restriction=ACCESS_RESTRICTION; default="within-org" + Authorize certain sources and destinations for data being sent into, or + restored from, the backup vault being created. This choice is permanent + and determines the type of resources that can be stored. Restricting + access to within your project or organization limits the resources to + those managed through the Google Cloud console (e.g., Compute Engine + VMs). Unrestricted access is required for resources managed through the + management console (e.g., VMware Engine VMs, databases, and file + systems). ACCESS_RESTRICTION must be one of: within-project, + within-org, unrestricted, within-org-but-unrestricted-for-ba. + + --no-async + Wait for the operation in progress to complete. + + --description=DESCRIPTION + Optional description for the backup vault (2048 characters or less). + + --effective-time=EFFECTIVE_TIME + The time at which the enforced retention period becomes locked. This + flag is mutually exclusive with --unlock-backup-min-enforced-retention. + + --labels=[KEY=VALUE,...] + Optional resource labels to represent metadata provided by the user. + +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 backupdr/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/backup-disaster-recovery + +BRIEF + Creates a Backup and DR backup vault. + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-vaults create + diff --git a/gcloud/backup-dr/backup-vaults/delete b/gcloud/backup-dr/backup-vaults/delete new file mode 100644 index 000000000..2be671051 --- /dev/null +++ b/gcloud/backup-dr/backup-vaults/delete @@ -0,0 +1,102 @@ +NAME + gcloud backup-dr backup-vaults delete - delete the specified Backup Vault + +SYNOPSIS + gcloud backup-dr backup-vaults delete (BACKUP_VAULT : --location=LOCATION) + [--allow-missing] [--no-async] [--ignore-backup-plan-references] + [--ignore-inactive-datasources] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete the specified Backup Vault. + +EXAMPLES + To delete a backup vault BACKUP_VAULT in location MY_LOCATION, run: + + $ gcloud backup-dr backup-vaults delete BACKUP_VAULT \ + --location=MY_LOCATION + + To override restrictions against the deletion of a backup vault + BACKUP_VAULT containing inactive datasources in location MY_LOCATION, run: + + $ gcloud backup-dr backup-vaults delete BACKUP_VAULT \ + --location=MY_LOCATION --ignore-inactive-datasources + + To override restrictions against the deletion of a backup vault + BACKUP_VAULT containing backup plan references in location MY_LOCATION, + run: + + $ gcloud backup-dr backup-vaults delete BACKUP_VAULT \ + --location=MY_LOCATION --ignore-backup-plan-references + +POSITIONAL ARGUMENTS + Backup Vault resource - Name of the backup vault to delete. Before you + delete, take a look at the prerequisites here + (https://cloud.google.com/backup-disaster-recovery/docs/configuration/decommission). + 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_vault 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_VAULT + ID of the Backup Vault or fully qualified identifier for the Backup + Vault. + + To set the name attribute: + ▸ provide the argument backup_vault 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 of the Backup Vault. + + To set the location attribute: + ▸ provide the argument backup_vault on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --allow-missing + Allow idempotent deletion of backup vault. The request will still + succeed in case the backup vault does not exist. + + --no-async + Wait for the operation in progress to complete. + + --ignore-backup-plan-references + If set, the following restrictions against deletion of the backup vault + instance can be overridden: * deletion of a backup vault instance being + actively referenced by a backup plan. + + --ignore-inactive-datasources + If set, the following restrictions against deletion of the backup vault + instance can be overridden: * deletion of a backup vault instance + containing no backups,but still contains empty datasources. + +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 backupdr/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/backup-disaster-recovery + +BRIEF + Deletes a specific backup vault + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-vaults delete + diff --git a/gcloud/backup-dr/backup-vaults/describe b/gcloud/backup-dr/backup-vaults/describe new file mode 100644 index 000000000..5715e5e76 --- /dev/null +++ b/gcloud/backup-dr/backup-vaults/describe @@ -0,0 +1,68 @@ +NAME + gcloud backup-dr backup-vaults describe - show the metadata for a Backup + and DR backup vault + +SYNOPSIS + gcloud backup-dr backup-vaults describe + (BACKUP_VAULT : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Show the metadata for a Backup and DR backup vault. + +EXAMPLES + To view details associated with backup vault 'BACKUP_VAULT', run: + + $ gcloud backup-dr backup-vaults describe BACKUP_VAULT + +POSITIONAL ARGUMENTS + Backup Vault resource - Name of the backup vault to retreive metadata of. + 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_vault 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_VAULT + ID of the Backup Vault or fully qualified identifier for the Backup + Vault. + + To set the name attribute: + ▸ provide the argument backup_vault 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 of the Backup Vault. + + To set the location attribute: + ▸ provide the argument backup_vault on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +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 backupdr/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/backup-disaster-recovery + +BRIEF + Show the metadata for a Backup and DR backup vault. + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-vaults describe + diff --git a/gcloud/backup-dr/backup-vaults/help b/gcloud/backup-dr/backup-vaults/help new file mode 100644 index 000000000..d08915843 --- /dev/null +++ b/gcloud/backup-dr/backup-vaults/help @@ -0,0 +1,37 @@ +NAME + gcloud backup-dr backup-vaults - manage Backup and DR backup vaults + +SYNOPSIS + gcloud backup-dr backup-vaults COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Backup and DR backup vaults. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create a Backup and DR backup vault. + + delete + Delete the specified Backup Vault. + + describe + Show the metadata for a Backup and DR backup vault. + + list + List Backup and DR backup vaults. + + update + Update a Backup and DR backup vault. + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-vaults + diff --git a/gcloud/backup-dr/backup-vaults/list b/gcloud/backup-dr/backup-vaults/list new file mode 100644 index 000000000..8023a8642 --- /dev/null +++ b/gcloud/backup-dr/backup-vaults/list @@ -0,0 +1,91 @@ +NAME + gcloud backup-dr backup-vaults list - list Backup and DR backup vaults + +SYNOPSIS + gcloud backup-dr backup-vaults list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List Backup and DR backup vaults. + +EXAMPLES + To list backup vaults in all location, run: + + $ gcloud backup-dr backup-vaults list + + To list backup vaults in a location ''my-location'', run: + + $ gcloud backup-dr backup-vaults list --location=my-location + +FLAGS + Location resource - Location for which backup vaults should be listed. + 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 --location on the command line with a fully + specified name; + ◆ Defaults to all locations with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. + + To set the location attribute: + ▸ provide the argument --location on the command line; + ▸ Defaults to all locations. + +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 backupdr/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/backup-disaster-recovery + +BRIEF + List Backup and DR backup vaults. + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-vaults list + diff --git a/gcloud/backup-dr/backup-vaults/update b/gcloud/backup-dr/backup-vaults/update new file mode 100644 index 000000000..a02463dfa --- /dev/null +++ b/gcloud/backup-dr/backup-vaults/update @@ -0,0 +1,111 @@ +NAME + gcloud backup-dr backup-vaults update - update a Backup and DR backup vault + +SYNOPSIS + gcloud backup-dr backup-vaults update (BACKUP_VAULT : --location=LOCATION) + [--no-async] + [--backup-min-enforced-retention=BACKUP_MIN_ENFORCED_RETENTION] + [--description=DESCRIPTION] [--effective-time=EFFECTIVE_TIME] + [--force-update] [--unlock-backup-min-enforced-retention] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update a Backup and DR backup vault. + +EXAMPLES + To update a backup vault BACKUP_VAULT in location MY_LOCATION with one + update field, run: + + $ gcloud backup-dr backup-vaults update BACKUP_VAULT \ + --location=MY_LOCATION --effective-time="2024-03-22" + + To update a backup vault BACKUP_VAULT in location MY_LOCATION with multiple + update fields, run: + + $ gcloud backup-dr backup-vaults update BACKUP_VAULT \ + --location=MY_LOCATION \ + --backup-min-enforced-retention="400000s" \ + --description="Updated backup vault" + +POSITIONAL ARGUMENTS + Backup Vault resource - Name of the existing backup vault to update. 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_vault 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_VAULT + ID of the Backup Vault or fully qualified identifier for the Backup + Vault. + + To set the name attribute: + ▸ provide the argument backup_vault 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 of the Backup Vault. + + To set the location attribute: + ▸ provide the argument backup_vault on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --no-async + Wait for the operation in progress to complete. + + --backup-min-enforced-retention=BACKUP_MIN_ENFORCED_RETENTION + Backups will be kept for this minimum period before they can be + deleted. Once the effective time is reached, the enforced retention + period cannot be decreased or removed. The value must be specified in + relative time format (e.g. p1d, p1m, p1m1d). + + --description=DESCRIPTION + Optional description for the backup vault (2048 characters or less). + + --effective-time=EFFECTIVE_TIME + The time at which the enforced retention period becomes locked. This + flag is mutually exclusive with --unlock-backup-min-enforced-retention. + + --force-update + If set, allow update to extend the minimum enforced retention for + backup vault. This overrides the restriction against conflicting + retention periods. This conflict may occur when the expiration schedule + defined by the associated backup plan is shorter than the minimum + retention set by the backup vault. + + --unlock-backup-min-enforced-retention + Removes the lock on the backup minimum enforced retention period, and + resets the effective time. When unlocked, the enforced retention period + can be changed at any time. This flag is mutually exclusive with + --effective-time. + +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 backupdr/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/backup-disaster-recovery + +BRIEF + Updates a Backup and DR backup vault. + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backup-vaults update + diff --git a/gcloud/backup-dr/backups/delete b/gcloud/backup-dr/backups/delete new file mode 100644 index 000000000..3585dc74d --- /dev/null +++ b/gcloud/backup-dr/backups/delete @@ -0,0 +1,89 @@ +NAME + gcloud backup-dr backups delete - delete the specified Backup + +SYNOPSIS + gcloud backup-dr backups delete + (BACKUP : --backup-vault=BACKUP_VAULT + --data-source=DATA_SOURCE --location=LOCATION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete the specified Backup. + +EXAMPLES + To delete a backup sample-backup in backup vault sample-vault, data source + sample-ds, project sample-project and location us-central1 , run: + + $ gcloud backup-dr backups delete sample-backup \ + --backup-vault=sample-vault --data-source=sample-ds \ + --project=sample-project --location=us-central1 + +POSITIONAL ARGUMENTS + Backup resource - Name of the backup 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 name 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-vault=BACKUP_VAULT + The ID of the Backup Vault. + + To set the backup-vault attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --backup-vault on the command line. + + --data-source=DATA_SOURCE + The ID of the Data Source. + + To set the data-source attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --data-source on the command line. + + --location=LOCATION + The location of the Backup. + + To set the location attribute: + ▸ provide the argument backup 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 + complete. The default is True. Enabled by default, use --no-async to + disable. + +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. + +BRIEF + Deletes a specific backup + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backups delete + diff --git a/gcloud/backup-dr/backups/describe b/gcloud/backup-dr/backups/describe new file mode 100644 index 000000000..c751e8c92 --- /dev/null +++ b/gcloud/backup-dr/backups/describe @@ -0,0 +1,80 @@ +NAME + gcloud backup-dr backups describe - show details of the backup + +SYNOPSIS + gcloud backup-dr backups describe + (BACKUP : --backup-vault=BACKUP_VAULT + --data-source=DATA_SOURCE --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Show all data associated with the specified backup. + +EXAMPLES + To view details for backup 'BACKUP', run: + + $ gcloud backup-dr backups describe BACKUP + +POSITIONAL ARGUMENTS + Backup resource - Name of the backup 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-vault=BACKUP_VAULT + The ID of the Backup Vault. + + To set the backup-vault attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --backup-vault on the command line. + + --data-source=DATA_SOURCE + The ID of the Data Source. + + To set the data-source attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --data-source on the command line. + + --location=LOCATION + Location ID of the resource. + + To set the location attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + +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 backupdr/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/backup-disaster-recovery + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backups describe + diff --git a/gcloud/backup-dr/backups/help b/gcloud/backup-dr/backups/help new file mode 100644 index 000000000..0e52cde0a --- /dev/null +++ b/gcloud/backup-dr/backups/help @@ -0,0 +1,37 @@ +NAME + gcloud backup-dr backups - manage Backup and DR backups + +SYNOPSIS + gcloud backup-dr backups GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Backup and DR backups. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + restore + Manage restore operations for resources. + +COMMANDS + COMMAND is one of the following: + + delete + Delete the specified Backup. + + describe + Show details of the backup. + + list + List Backups. + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backups + diff --git a/gcloud/backup-dr/backups/list b/gcloud/backup-dr/backups/list new file mode 100644 index 000000000..80f55a983 --- /dev/null +++ b/gcloud/backup-dr/backups/list @@ -0,0 +1,114 @@ +NAME + gcloud backup-dr backups list - list Backups + +SYNOPSIS + gcloud backup-dr backups list + [--backup-vault=BACKUP_VAULT + --data-source=DATA_SOURCE --location=LOCATION] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Displays all backups in a project. + +EXAMPLES + To list backups for all data sources, backup vaults and locations, run: + + $ gcloud backup-dr backups list + + To list all backups for a data source my-data-source and a backup vault + my-vault in a location my-location, run: + + $ gcloud backup-dr backups list --data-source=my-data-source \ + --backup-vault=my-vault --location=my-location + +FLAGS + DataSource resource - Data source to list backups from. 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 --data-source on the command line with a fully + specified name; + ◆ default is all data sources with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --backup-vault=BACKUP_VAULT + The ID of the Backup Vault. + + To set the backup-vault attribute: + ▸ provide the argument --data-source on the command line with a + fully specified name; + ▸ default is all data sources with a fully specified name; + ▸ provide the argument --backup-vault on the command line; + ▸ default is all backup vaults . + + --data-source=DATA_SOURCE + ID of the dataSource or fully qualified identifier for the + dataSource. + + To set the data-source attribute: + ▸ provide the argument --data-source on the command line; + ▸ default is all data sources . + + --location=LOCATION + Location ID of the resource. + + To set the location attribute: + ▸ provide the argument --data-source on the command line with a + fully specified name; + ▸ default is all data sources with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ default is all locations . + +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 backupdr/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/backup-disaster-recovery + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backups list + diff --git a/gcloud/backup-dr/backups/restore/compute b/gcloud/backup-dr/backups/restore/compute new file mode 100644 index 000000000..ccad36909 --- /dev/null +++ b/gcloud/backup-dr/backups/restore/compute @@ -0,0 +1,421 @@ +NAME + gcloud backup-dr backups restore compute - restores a Compute Engine VM + Backup + +SYNOPSIS + gcloud backup-dr backups restore compute + (BACKUP : --backup-vault=BACKUP_VAULT + --data-source=DATA_SOURCE --location=LOCATION) --name=NAME + --target-project=TARGET_PROJECT --target-zone=TARGET_ZONE + [--accelerator=[count=COUNT],[type=TYPE]] [--async] + [--[no-]can-ip-forward] [--confidential-compute] + [--create-disk=[PROPERTY=VALUE,...]] [--[no-]deletion-protection] + [--description=DESCRIPTION] [--[no-]enable-display-device] + [--[no-]enable-uefi-networking] [--hostname=HOSTNAME] + [--instance-kms-key=INSTANCE_KMS_KEY] + [--instance-termination-action=INSTANCE_TERMINATION_ACTION] + [--key-revocation-action-type=POLICY] [--labels=[KEY=VALUE,...]] + [--local-ssd-recovery-timeout=LOCAL_SSD_RECOVERY_TIMEOUT] + [--machine-type=MACHINE_TYPE] [--maintenance-policy=MAINTENANCE_POLICY] + [--metadata=KEY=VALUE,[KEY=VALUE,...]] [--min-cpu-platform=PLATFORM] + [--min-node-cpu=MIN_NODE_CPU] + [--network-interface=[PROPERTY=VALUE,...]] + [--network-performance-configs=[PROPERTY=VALUE,...]] + [--[no-]preemptible] + [--private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE] + [--provisioning-model=PROVISIONING_MODEL] + [--resource-manager-tags=[KEY=VALUE,...]] + [--resource-policies=RESOURCE_POLICY,[...]] [--[no-]restart-on-failure] + [--service-account=SERVICE_ACCOUNT] [--tags=TAG,[TAG,...]] + [--threads-per-core=THREADS_PER_CORE] + [--visible-core-count=VISIBLE_CORE_COUNT] + [--reservation=RESERVATION --reservation-affinity=RESERVATION_AFFINITY] + [--scopes=[SCOPE,...] | --no-scopes] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Restores a Compute Engine VM Backup. + +EXAMPLES + To restore a backup sample-backup in project sample-project and location + us-central1, with sample-data-store and sample-backup-vault, and additional + target properties, run: + + $ gcloud backup-dr backups restore compute sample-backup \ + --project=sample-project --location=us-central1 \ + --backup-vault=sample-backup-vault \ + --data-source=sample-data-source -- + +POSITIONAL ARGUMENTS + Backup resource - The backup of a resource to be restored. 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 name 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-vault=BACKUP_VAULT + The ID of the Backup Vault. + + To set the backup-vault attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --backup-vault on the command line. + + --data-source=DATA_SOURCE + The ID of the Data Source. + + To set the data-source attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --data-source on the command line. + + --location=LOCATION + The location of the Backup. + + To set the location attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + +REQUIRED FLAGS + --name=NAME + Name of the restored Compute Instance. + + --target-project=TARGET_PROJECT + Project where the restore should happen. + + --target-zone=TARGET_ZONE + Zone where the target instance is restored. + +OPTIONAL FLAGS + --accelerator=[count=COUNT],[type=TYPE] + Attaches accelerators (e.g. GPUs) to the instances. + + type + The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of + accelerator to attach to the instances. Use 'gcloud compute + accelerator-types list' to learn about all available accelerator + types. + + count + Number of accelerators to attach to each instance. The default + value is 1. + + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + + --[no-]can-ip-forward + If provided, allows the restored instances to send and receive packets + with non-matching destination or source IP addresses. Use + --can-ip-forward to enable and --no-can-ip-forward to disable. + + --confidential-compute + The restored instance boots with Confidential Computing enabled. + Confidential Computing is based on Secure Encrypted Virtualization + (SEV), an AMD virtualization feature for running confidential + instances. + + --create-disk=[PROPERTY=VALUE,...] + Creates and attaches persistent disks to the instances. + + name: Specifies the name of the disk. + + replica-zones: Required for each regional disk associated with the + instance. Specify the URLs of the zones where the disk should be + replicated to. You must provide exactly two replica zones, and one zone + must be the same as the instance zone. + + device-name: Device name of the disk from the source instance. + + --[no-]deletion-protection + Enables deletion protection for the restored instance. Use + --deletion-protection to enable and --no-deletion-protection to + disable. + + --description=DESCRIPTION + Specifies a textual description of the restored instance. + + --[no-]enable-display-device + Enable a display device on the restored VM instances. Disabled by + default. Use --enable-display-device to enable and + --no-enable-display-device to disable. + + --[no-]enable-uefi-networking + If set to true, enables UEFI networking for the instance creation. Use + --enable-uefi-networking to enable and --no-enable-uefi-networking to + disable. + + --hostname=HOSTNAME + Specify the hostname of the restore instance to be created. The + specified hostname must be RFC1035 compliant. If hostname is not + specified, the default hostname is + [INSTANCE_NAME].c.[TARGET_PROJECT_ID].internal when using the global + DNS, and [INSTANCE_NAME].[ZONE].c.[TARGET_PROJECT_ID].internal when + using zonal DNS. + + --instance-kms-key=INSTANCE_KMS_KEY + The Cloud KMS (Key Management Service) cryptokey that will be used to + protect the restored instance. + + Provide the full resource name of the cryptokey in the format: + projects//locations//keyRings//cryptoKeys/ + + --instance-termination-action=INSTANCE_TERMINATION_ACTION + Specifies the termination action that will be taken upon VM preemption + (--provisioning-model=SPOT) or automatic instance termination + (--max-run-duration or --termination-time). + + INSTANCE_TERMINATION_ACTION must be one of: + + DELETE + Permanently delete the VM. + STOP + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. + + --key-revocation-action-type=POLICY + Specifies the behavior of the instance when the KMS key of one of its + attached disks is revoked. The default is none. POLICY must be one of: + ◆ none No operation is performed. + ◆ stop The instance is stopped when the KMS key of one of its + attached disks is revoked. + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (), lowercase characters, and + numbers. + + --local-ssd-recovery-timeout=LOCAL_SSD_RECOVERY_TIMEOUT + Specifies the maximum amount of time a Local SSD VM should wait while + recovery of the Local SSD state is attempted. Its value should be in + between 0 and 168 hours with hour granularity and the default value + being 1 hour. + + --machine-type=MACHINE_TYPE + Specifies the machine type used for the restored instance. To get a + list of available machine types, run 'gcloud compute machine-types + list'. If unspecified, the default type will be based on the source + instance. + + This can either be the fully qualified path or the name. For example: + ◆ --machine-type=projects/my-project/zones/us-central1-a/machineTypes/n1-standard-1 + ◆ --machine-type=n1-standard-1 + + --maintenance-policy=MAINTENANCE_POLICY + Specifies the behavior of the VMs when their host machines undergo + maintenance. The default is MIGRATE. For more information, see + https://cloud.google.com/compute/docs/instances/host-maintenance-options. + MAINTENANCE_POLICY must be one of: + + MIGRATE + The instances should be migrated to a new host. This will + temporarily impact the performance of instances during a migration + event. + TERMINATE + The instances should be terminated. + + --metadata=KEY=VALUE,[KEY=VALUE,...] + Metadata to be made available to the guest operating system running on + the instances. Each metadata entry is a key/value pair separated by an + equals sign. Each metadata key must be unique and have a max of 128 + bytes in length. Each value must have a max of 256 KB in length. + Multiple arguments can be passed to this flag, e.g., --metadata + key-1=value-1,key-2=value-2,key-3=value-3. The combined total size for + all metadata entries is 512 KB. + + In images that have Compute Engine tools installed on them, such as the + official images (https://cloud.google.com/compute/docs/images), the + following metadata keys have special meanings: + + startup-script + Specifies a script that will be executed by the instances once they + start running. For convenience, --metadata-from-file can be used to + pull the value from a file. + + startup-script-url + Same as startup-script except that the script contents are pulled + from a publicly-accessible location on the web. + + For startup scripts on Windows instances, the following metadata + keys have special meanings: windows-startup-script-url, + windows-startup-script-cmd, windows-startup-script-bat, + windows-startup-script-ps1, sysprep-specialize-script-url, + sysprep-specialize-script-cmd, sysprep-specialize-script-bat, and + sysprep-specialize-script-ps1. For more information, see Running + startup scripts + (https://cloud.google.com/compute/docs/startupscript). + + --min-cpu-platform=PLATFORM + When specified, the VM will be scheduled on host with specified CPU + architecture or a newer one. To list available CPU platforms in given + zone, run: + + $ gcloud compute zones describe ZONE \ + --format="value(availableCpuPlatforms)" + + Default setting is "AUTOMATIC". + + CPU platform selection is available only in selected zones. + + You can find more information on-line: + https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform + + --min-node-cpu=MIN_NODE_CPU + Minimum number of virtual CPUs this instance will consume when running + on a sole-tenant node. + + --network-interface=[PROPERTY=VALUE,...] + Adds a network interface to the instance. This flag can be repeated to + specify multiple network interfaces. The following keys are allowed: + network, subnet, private-network-ip, internal-ipv6-address, + internal-ipv6-prefix-length, address, external-ipv6-address, + external-ipv6-prefix-length, network-tier, aliases, stack-type, + queue-count, nic-type, network-attachment + + --network-performance-configs=[PROPERTY=VALUE,...] + Configures network performance settings for the restored instance. If + this flag is not specified, the restored instance will be created with + its source instance's network performance configuration. + + total-egress-bandwidth-tier + Total egress bandwidth is the available outbound bandwidth from a + VM, regardless of whether the traffic is going to internal IP or + external IP destinations. The following tier values are allowed: + [DEFAULT, TIER_1] + + --[no-]preemptible + If provided, instances will be preemptible and time-limited. Instances + might be preempted to free up resources for standard VM instances, and + will only be able to run for a limited amount of time. Preemptible + instances can not be restarted and will not migrate. Use --preemptible + to enable and --no-preemptible to disable. + + --private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE + The private IPv6 Google access type for the restored VM. + PRIVATE_IPV6_GOOGLE_ACCESS_TYPE must be one of: inherit-subnetwork, + enable-bidirectional-access, enable-outbound-vm-access + + --provisioning-model=PROVISIONING_MODEL + Specifies provisioning model, which determines price, obtainability, + and runtime for the restored VM instance. PROVISIONING_MODEL must be + one of: + + SPOT + Spot VMs are spare capacity; Spot VMs are discounted to have much + lower prices than standard VMs but have no guaranteed runtime. Spot + VMs are the new version of preemptible VM instances, except Spot + VMs do not have a 24-hour maximum runtime. + STANDARD + Default. Standard provisioning model for VM instances, which has + user-controlled runtime but no Spot discounts. + + --resource-manager-tags=[KEY=VALUE,...] + Specifies a list of resource manager tags to apply to the instance. + + --resource-policies=RESOURCE_POLICY,[...] + A list of resource policy names to be added to the instance. The + policies must exist in the same region as the instance. + + --[no-]restart-on-failure + The instances will be restarted if they are terminated by Compute + Engine. This does not affect terminations performed by the user. Use + --restart-on-failure to enable and --no-restart-on-failure to disable. + + --service-account=SERVICE_ACCOUNT + A service account is an identity attached to the instance. Its access + tokens can be accessed through the instance metadata server and are + used to authenticate applications on the instance. The account can be + set using an email address corresponding to the required service + account. If not provided, the instance will use the project's default + service account. + + --tags=TAG,[TAG,...] + Specifies a list of tags to apply to the instance. These tags allow + network firewall rules and routes to be applied to specified VM + instances. See gcloud compute firewall-rules create(1) for more + details. + + --threads-per-core=THREADS_PER_CORE + The number of visible threads per physical core. To disable + simultaneous multithreading (SMT) set this to 1. Valid values are: 1 or + 2. + + For more information about configuring SMT, see: + https://cloud.google.com/compute/docs/instances/configuring-simultaneous-multithreading. + + --visible-core-count=VISIBLE_CORE_COUNT + The number of physical cores to expose to the instance's guest + operating system. The number of virtual CPUs visible to the instance's + guest operating system is this number of cores multiplied by the + instance's count of visible threads per physical core. + + Specifies the reservation for the instance. + + --reservation=RESERVATION + The name of the reservation, required when + --reservation-affinity=specific. + + --reservation-affinity=RESERVATION_AFFINITY + Specifies the reservation affinity of the instance. + RESERVATION_AFFINITY must be one of: + + any + Consume any available, matching reservation. + none + Do not consume from any reserved capacity. + specific + Must consume from a specific reservation. + + At most one of these can be specified: + + --scopes=[SCOPE,...] + If not provided, the instance will be assigned the default scopes, + described below. However, if neither --scopes nor --no-scopes are + specified and the project has no default service account, then the + instance will be created with no scopes. Note that the level of + access that a service account has is determined by a combination of + access scopes and IAM roles so you must configure both access scopes + and IAM roles for the service account to work properly. SCOPE can be + either the full URI of the scope or an alias. Default scopes are + assigned to all instances. Available aliases are: + https://cloud.google.com/sdk/gcloud/reference/compute/instances/create#--scopes + + --no-scopes + Create the instance with no scopes. + +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. + +BRIEF + Restores the specified backup + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backups restore compute + diff --git a/gcloud/backup-dr/backups/restore/help b/gcloud/backup-dr/backups/restore/help new file mode 100644 index 000000000..51d091469 --- /dev/null +++ b/gcloud/backup-dr/backups/restore/help @@ -0,0 +1,25 @@ +NAME + gcloud backup-dr backups restore - manage restore operations for resources + +SYNOPSIS + gcloud backup-dr backups restore COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage restore operations for resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + compute + Restores a Compute Engine VM Backup. + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr backups restore + diff --git a/gcloud/backup-dr/data-sources/describe b/gcloud/backup-dr/data-sources/describe new file mode 100644 index 000000000..b5baaf07a --- /dev/null +++ b/gcloud/backup-dr/data-sources/describe @@ -0,0 +1,73 @@ +NAME + gcloud backup-dr data-sources describe - show details of the data source + +SYNOPSIS + gcloud backup-dr data-sources describe + (DATA_SOURCE : --backup-vault=BACKUP_VAULT --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Show all configuration data associated with the specified data source. + +EXAMPLES + To view details for data source 'DATA_SOURCE', run: + + $ gcloud backup-dr data-sources describe DATA_SOURCE + +POSITIONAL ARGUMENTS + Data source resource - Name of the data source 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 data_source 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. + + DATA_SOURCE + ID of the data_source or fully qualified identifier for the + data_source. + + To set the data_source attribute: + ▸ provide the argument data_source on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --backup-vault=BACKUP_VAULT + The ID of the Backup Vault. + + To set the backup-vault attribute: + ▸ provide the argument data_source on the command line with a fully + specified name; + ▸ provide the argument --backup-vault on the command line. + + --location=LOCATION + Location ID of the resource. + + To set the location attribute: + ▸ provide the argument data_source on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + +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 backupdr/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/backup-disaster-recovery + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr data-sources describe + diff --git a/gcloud/backup-dr/data-sources/help b/gcloud/backup-dr/data-sources/help new file mode 100644 index 000000000..74ea94ac5 --- /dev/null +++ b/gcloud/backup-dr/data-sources/help @@ -0,0 +1,28 @@ +NAME + gcloud backup-dr data-sources - view Backup and DR data sources + +SYNOPSIS + gcloud backup-dr data-sources COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + View Backup and DR data sources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + Show details of the data source. + + list + List Data Sources. + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr data-sources + diff --git a/gcloud/backup-dr/data-sources/list b/gcloud/backup-dr/data-sources/list new file mode 100644 index 000000000..e3f4d14b7 --- /dev/null +++ b/gcloud/backup-dr/data-sources/list @@ -0,0 +1,98 @@ +NAME + gcloud backup-dr data-sources list - list Data Sources + +SYNOPSIS + gcloud backup-dr data-sources list + [--backup-vault=BACKUP_VAULT --location=LOCATION] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Displays all data sources in a project. + +EXAMPLES + To list data sources for all backup vaults and locations, run: $ gcloud backup-dr data-sources list To list all data sources for \ + a backup vault `_my-vault_` in a location `_my-location_`, \ + run: $ gcloud backup-dr data-sources list \ + --backup-vault=my-vault --location=my-location + +FLAGS + Backup vault resource - Backup vault to list data sources from. 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-vault on the command line with a fully + specified name; + ◆ default is all backup vaults with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --backup-vault=BACKUP_VAULT + ID of the backup_vault or fully qualified identifier for the + backup_vault. + + To set the backup-vault attribute: + ▸ provide the argument --backup-vault on the command line; + ▸ default is all backup vaults . + + --location=LOCATION + Location ID of the resource. + + To set the location attribute: + ▸ provide the argument --backup-vault on the command line with a + fully specified name; + ▸ default is all backup vaults with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ default is all locations . + +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 backupdr/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/backup-disaster-recovery + +NOTES + This variant is also available: + + $ gcloud alpha backup-dr data-sources list + diff --git a/gcloud/backup-dr/help b/gcloud/backup-dr/help index 3d95b4b02..ab8cd697e 100644 --- a/gcloud/backup-dr/help +++ b/gcloud/backup-dr/help @@ -15,6 +15,21 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + backup-plan-associations + Manage Backup and DR backup plan associations. + + backup-plans + Manage Backup and DR backup plans. + + backup-vaults + Manage Backup and DR backup vaults. + + backups + Manage Backup and DR backups. + + data-sources + View Backup and DR data sources. + locations Manage Backup and DR locations. diff --git a/gcloud/beta/ai/index-endpoints/deploy-index b/gcloud/beta/ai/index-endpoints/deploy-index index 53f614408..80c59424c 100644 --- a/gcloud/beta/ai/index-endpoints/deploy-index +++ b/gcloud/beta/ai/index-endpoints/deploy-index @@ -11,6 +11,7 @@ SYNOPSIS [--enable-access-logging] [--machine-type=MACHINE_TYPE] [--max-replica-count=MAX_REPLICA_COUNT] [--min-replica-count=MIN_REPLICA_COUNT] + [--psc-automation-configs=[network=NETWORK],[project-id=PROJECT-ID]] [--reserved-ip-ranges=[RESERVED_IP_RANGES,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -114,6 +115,14 @@ OPTIONAL FLAGS Minimum number of machine replicas the deployed index will be always deployed on. If specified, the value must be equal to or larger than 1. + --psc-automation-configs=[network=NETWORK],[project-id=PROJECT-ID] + A pair of project-id and network the PSC index will be deployed to. For + example: + --psc-automation-configs=project-id=my-project,network=my-network. For + multiple networks, this flag can be repeated: + --psc-automation-configs=project-id=my-project,network=my-network + --psc-automation-configs=project-id=my-project2,network=my-network2 + --reserved-ip-ranges=[RESERVED_IP_RANGES,...] List of reserved IP ranges deployed index will be deployed to. diff --git a/gcloud/beta/ai/index-endpoints/mutate-deployed-index b/gcloud/beta/ai/index-endpoints/mutate-deployed-index index 4f2074136..7c91ee2a2 100644 --- a/gcloud/beta/ai/index-endpoints/mutate-deployed-index +++ b/gcloud/beta/ai/index-endpoints/mutate-deployed-index @@ -8,7 +8,7 @@ SYNOPSIS --deployed-index-id=DEPLOYED_INDEX_ID [--allowed-issuers=[ALLOWED_ISSUERS,...]] [--audiences=[AUDIENCES,...]] [--deployment-group=DEPLOYMENT_GROUP] [--enable-access-logging] - [--max-replica-count=MAX_REPLICA_COUNT] + [--machine-type=MACHINE_TYPE] [--max-replica-count=MAX_REPLICA_COUNT] [--min-replica-count=MIN_REPLICA_COUNT] [--reserved-ip-ranges=[RESERVED_IP_RANGES,...]] [GCLOUD_WIDE_FLAG ...] @@ -98,6 +98,11 @@ OPTIONAL FLAGS These logs are standard server access logs, containing information like timestamp and latency for each prediction request. + --machine-type=MACHINE_TYPE + The machine resources to be used for each node of this deployment. For + available machine types, see + https://cloud.google.com/ai-platform-unified/docs/predictions/machine-types. + --max-replica-count=MAX_REPLICA_COUNT Maximum number of machine replicas the deployed index will be always deployed on. diff --git a/gcloud/beta/alloydb/clusters/export b/gcloud/beta/alloydb/clusters/export new file mode 100644 index 000000000..3efcce6ae --- /dev/null +++ b/gcloud/beta/alloydb/clusters/export @@ -0,0 +1,117 @@ +NAME + gcloud beta alloydb clusters export - export data from an AlloyDB cluster + to Google Cloud Storage + +SYNOPSIS + gcloud beta alloydb clusters export CLUSTER --database=DATABASE + --gcs-uri=GCS_URI --region=REGION + ([--csv --select-query=SELECT_QUERY + : --escape-character=ESCAPE_CHARACTER + --field-delimiter=FIELD_DELIMITER --quote-character=QUOTE_CHARACTER] + | [--sql : --schema-only --tables=TABLES [--clean-target-objects + : --if-exist-target-objects]]) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Export data from an AlloyDB cluster to Google Cloud Storage. + +EXAMPLES + To export a cluster, run: + + $ gcloud beta alloydb clusters export my-cluster \ + --region=us-central1 --database=my-database \ + --gcs-uri=gs://my-bucket/my-export-file-path \ + --select-query="SELECT * FROM my-table" + +POSITIONAL ARGUMENTS + CLUSTER + AlloyDB cluster ID + +REQUIRED FLAGS + --database=DATABASE + Database name from which export has to be done. + + Destination URI where the file needs to be exported. + + This must be specified. + + --gcs-uri=GCS_URI + Path to the Google Cloud Storage file to which export has to be done. + + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + + Export options for the cluster. + + Exactly one of these must be specified: + + CSV export options for the cluster. + + --csv + Specifies destination file type. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --select-query=SELECT_QUERY + Select query to be used for export. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --escape-character=ESCAPE_CHARACTER + Escape character to be used for export. + + --field-delimiter=FIELD_DELIMITER + Field delimiter to be used for export. + + --quote-character=QUOTE_CHARACTER + Quote character to be used for export. + + SQL export options for the cluster. + + --sql + Specifies destination file type. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --schema-only + Export only schema of the database. + + --tables=TABLES + Comma-separated list of table names which need to be exported. + + SQL export options to clean target objects. + + --clean-target-objects + If true, output commands to DROP all the dumped database objects + prior to outputting the commands for creating them. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --if-exist-target-objects + If true, use DROP ... IF EXISTS commands to check for the + object's existence before dropping it in clean_target_objects + mode. + +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. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha alloydb clusters export + diff --git a/gcloud/beta/alloydb/clusters/help b/gcloud/beta/alloydb/clusters/help index 0701e8623..0fc9ee04a 100644 --- a/gcloud/beta/alloydb/clusters/help +++ b/gcloud/beta/alloydb/clusters/help @@ -29,6 +29,9 @@ COMMANDS describe (BETA) Describe an AlloyDB cluster in a given project and region. + export + (BETA) Export data from an AlloyDB cluster to Google Cloud Storage. + list (BETA) List AlloyDB clusters in a given project and region. diff --git a/gcloud/beta/compute/disks/convert b/gcloud/beta/compute/disks/convert new file mode 100644 index 000000000..c58d670e6 --- /dev/null +++ b/gcloud/beta/compute/disks/convert @@ -0,0 +1,136 @@ +NAME + gcloud beta compute disks convert - convert a Compute Engine Persistent + Disk volume to a Hyperdisk volume + +SYNOPSIS + gcloud beta compute disks convert DISK_NAME + --target-disk-type=TARGET_DISK_TYPE + [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING + --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] + [--region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Convert Compute Engine Persistent Disk volumes to Hyperdisk volumes. + + gcloud beta compute disks convert converts a Compute Engine Persistent Disk + volume to a Hyperdisk volume. For a comprehensive guide, refer to: + https://cloud.google.com/sdk/gcloud/reference/compute/disks/convert. + +EXAMPLES + The following command converts a PD Standard disk to a Hyperdisk + Throughput: + + $ gcloud beta compute disks convert my-disk-1 --zone=ZONE \ + --target-disk-type=hyperdisk-throughput + +POSITIONAL ARGUMENTS + DISK_NAME + Name of the disk to operate on. + +REQUIRED FLAGS + --target-disk-type=TARGET_DISK_TYPE + Specifies the type of Hyperdisk to convert to, for example, to convert + a Hyperdisk Balanced volume, specify hyperdisk-balanced. To get a list + of available disk types, run gcloud compute disk-types list. + +OPTIONAL FLAGS + Key resource - The Cloud KMS (Key Management Service) cryptokey that will + be used to protect the disk. The 'Compute Engine Service Agent' service + account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. + The arguments in this group can be used to specify the attributes of this + resource. + + --kms-key=KMS_KEY + ID of the key or fully qualified identifier for the key. + + To set the kms-key attribute: + ▸ provide the argument --kms-key on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --kms-keyring=KMS_KEYRING + The KMS keyring of the key. + + To set the kms-keyring attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-keyring on the command line. + + --kms-location=KMS_LOCATION + The Google Cloud location for the key. + + To set the kms-location attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-location on the command line; + ▸ provide the argument --region on the command line. + + --kms-project=KMS_PROJECT + The Google Cloud project for the key. + + To set the kms-project attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-project on the command line; + ▸ set the property core/project. + + At most one of these can be specified: + + --region=REGION + Region of the disk to operate on. If not specified, you might be + prompted to select a region (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/region property: + + $ gcloud config set compute/region REGION + + A list of regions can be fetched by running: + + $ gcloud compute regions list + + To unset the property, run: + + $ gcloud config unset compute/region + + Alternatively, the region can be stored in the environment variable + CLOUDSDK_COMPUTE_REGION. + + --zone=ZONE + Zone of the disk to operate on. If not specified and the compute/zone + property isn't set, you might be prompted to select a zone + (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/zone property: + + $ gcloud config set compute/zone ZONE + + A list of zones can be fetched by running: + + $ gcloud compute zones list + + To unset the property, run: + + $ gcloud config unset compute/zone + + Alternatively, the zone can be stored in the environment variable + CLOUDSDK_COMPUTE_ZONE. + +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. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute disks convert + + $ gcloud alpha compute disks convert + diff --git a/gcloud/beta/compute/disks/help b/gcloud/beta/compute/disks/help index 8787bb608..c21abb21f 100644 --- a/gcloud/beta/compute/disks/help +++ b/gcloud/beta/compute/disks/help @@ -37,6 +37,10 @@ COMMANDS add-resource-policies (BETA) Add resource policies to a Compute Engine disk. + convert + (BETA) Convert a Compute Engine Persistent Disk volume to a Hyperdisk + volume. + create (BETA) Create Compute Engine persistent disks. diff --git a/gcloud/beta/compute/future-reservations/create b/gcloud/beta/compute/future-reservations/create index c8c070956..490b50a51 100644 --- a/gcloud/beta/compute/future-reservations/create +++ b/gcloud/beta/compute/future-reservations/create @@ -11,8 +11,11 @@ SYNOPSIS --local-ssd=[count=COUNT],[interface=INTERFACE],[size=SIZE] --min-cpu-platform=MIN_CPU_PLATFORM]) (--start-time=START_TIME (--duration=DURATION | --end-time=END_TIME)) - [--description=DESCRIPTION] [--name-prefix=NAME_PREFIX] - [--planning-status=PLANNING_STATUS] [--zone=ZONE] + [--deployment-type=DEPLOYMENT_TYPE] [--description=DESCRIPTION] + [--name-prefix=NAME_PREFIX] [--planning-status=PLANNING_STATUS] + [--[no-]require-specific-reservation] + [--reservation-name=RESERVATION_NAME] + [--scheduling-type=SCHEDULING_TYPE] [--zone=ZONE] [--auto-created-reservations-delete-time=AUTO_CREATED_RESERVATIONS_DELETE_TIME | --auto-created-reservations-duration=AUTO_CREATED_RESERVATIONS_DURATION] [--share-setting=SHARE_SETTING --share-with=PROJECT,[PROJECT,...]] [GCLOUD_WIDE_FLAG ...] @@ -137,6 +140,15 @@ REQUIRED FLAGS 2021-11-20T07:00:00Z). OPTIONAL FLAGS + --deployment-type=DEPLOYMENT_TYPE + The deployment type for the reserved capacity. DEPLOYMENT_TYPE must be + one of: + + DENSE + DENSE mode is for densely deployed reservation blocks. + FLEXIBLE + FLEXIBLE mode is for highly flexible, logical reservation blocks. + --description=DESCRIPTION An optional description of the future reservation to create. @@ -159,6 +171,32 @@ OPTIONAL FLAGS SUBMITTED Planning status value to immediately submit the future reservation. + --[no-]require-specific-reservation + Indicate whether the auto-created reservations can be consumed by VMs + with "any reservation" defined. If enabled, then only VMs that target + the auto-created reservation by name using + --reservation-affinity=specific can consume from this reservation. + Auto-created reservations delivered with this flag enabled will inherit + the name of the future reservation. Use --require-specific-reservation + to enable and --no-require-specific-reservation to disable. + + --reservation-name=RESERVATION_NAME + Name of reservations where the capacity is provisioned at the time of + delivery of future reservations. If the reservation with the given name + does not exist already, it is created automatically at the time of + Approval with INACTIVE state till specified start-time. Either provide + the reservation_name or a name_prefix. + + --scheduling-type=SCHEDULING_TYPE + Maintenance for the reserved capacity. SCHEDULING_TYPE must be one of: + + GROUPED + In GROUPED mode, maintenance on all reserved instances + issynchronized. + INDEPENDENT + In INDEPENDENT mode, maintenance is not synchronized for this + reservation, and each instance has its own maintenance window. + --zone=ZONE Zone of the future reservation to create. If not specified and the compute/zone property isn't set, you might be prompted to select a zone diff --git a/gcloud/beta/compute/future-reservations/update b/gcloud/beta/compute/future-reservations/update index eb353b820..876c45e19 100644 --- a/gcloud/beta/compute/future-reservations/update +++ b/gcloud/beta/compute/future-reservations/update @@ -5,8 +5,12 @@ NAME SYNOPSIS gcloud beta compute future-reservations update FUTURE_RESERVATION [--[no-]auto-delete-auto-created-reservations] - [--description=DESCRIPTION] [--planning-status=PLANNING_STATUS] - [--total-count=TOTAL_COUNT] [--zone=ZONE] + [--deployment-type=DEPLOYMENT_TYPE] [--description=DESCRIPTION] + [--planning-status=PLANNING_STATUS] + [--[no-]require-specific-reservation] + [--reservation-name=RESERVATION_NAME] + [--scheduling-type=SCHEDULING_TYPE] [--total-count=TOTAL_COUNT] + [--zone=ZONE] [--auto-created-reservations-delete-time=AUTO_CREATED_RESERVATIONS_DELETE_TIME | --auto-created-reservations-duration=AUTO_CREATED_RESERVATIONS_DURATION] [--clear-name-prefix | --name-prefix=NAME_PREFIX] [--clear-share-settings @@ -41,6 +45,15 @@ FLAGS Use --auto-delete-auto-created-reservations to enable and --no-auto-delete-auto-created-reservations to disable. + --deployment-type=DEPLOYMENT_TYPE + The deployment type for the reserved capacity. DEPLOYMENT_TYPE must be + one of: + + DENSE + DENSE mode is for densely deployed reservation blocks. + FLEXIBLE + FLEXIBLE mode is for highly flexible, logical reservation blocks. + --description=DESCRIPTION An optional description of the future reservation to create. @@ -58,6 +71,32 @@ FLAGS SUBMITTED Planning status value to immediately submit the future reservation. + --[no-]require-specific-reservation + Indicate whether the auto-created reservations can be consumed by VMs + with "any reservation" defined. If enabled, then only VMs that target + the auto-created reservation by name using + --reservation-affinity=specific can consume from this reservation. + Auto-created reservations delivered with this flag enabled will inherit + the name of the future reservation. Use --require-specific-reservation + to enable and --no-require-specific-reservation to disable. + + --reservation-name=RESERVATION_NAME + Name of reservations where the capacity is provisioned at the time of + delivery of future reservations. If the reservation with the given name + does not exist already, it is created automatically at the time of + Approval with INACTIVE state till specified start-time. Either provide + the reservation_name or a name_prefix. + + --scheduling-type=SCHEDULING_TYPE + Maintenance for the reserved capacity. SCHEDULING_TYPE must be one of: + + GROUPED + In GROUPED mode, maintenance on all reserved instances + issynchronized. + INDEPENDENT + In INDEPENDENT mode, maintenance is not synchronized for this + reservation, and each instance has its own maintenance window. + --total-count=TOTAL_COUNT The total number of instances for which capacity assurance is requested at a future time period. diff --git a/gcloud/beta/compute/instance-templates/create b/gcloud/beta/compute/instance-templates/create index bf9e7d32c..f685762c9 100644 --- a/gcloud/beta/compute/instance-templates/create +++ b/gcloud/beta/compute/instance-templates/create @@ -819,17 +819,22 @@ FLAGS the subnet or legacy network IP range. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: + RESERVATION_BOUND + The VM instances run for the entire duration of their associated + reservation. You can only specify this provisioning model if you + want your VM instances to consume a specific reservation with + either a calendar reservation mode or a dense deployment type. SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --region=REGION Region of the subnetwork to attach. If not specified, you might be diff --git a/gcloud/beta/compute/instances/bulk/create b/gcloud/beta/compute/instances/bulk/create index 93e9fb111..1088c8b50 100644 --- a/gcloud/beta/compute/instances/bulk/create +++ b/gcloud/beta/compute/instances/bulk/create @@ -711,17 +711,22 @@ OPTIONAL FLAGS instances can not be restarted and will not migrate. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: + RESERVATION_BOUND + The VM instances run for the entire duration of their associated + reservation. You can only specify this provisioning model if you + want your VM instances to consume a specific reservation with + either a calendar reservation mode or a dense deployment type. SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --resource-manager-tags=[KEY=VALUE,...] Specifies a list of resource manager tags to apply to the instance. diff --git a/gcloud/beta/compute/instances/create b/gcloud/beta/compute/instances/create index 3719b30fc..a32d6a8ce 100644 --- a/gcloud/beta/compute/instances/create +++ b/gcloud/beta/compute/instances/create @@ -890,17 +890,22 @@ FLAGS the subnet or legacy network IP range. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: + RESERVATION_BOUND + The VM instances run for the entire duration of their associated + reservation. You can only specify this provisioning model if you + want your VM instances to consume a specific reservation with + either a calendar reservation mode or a dense deployment type. SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --require-csek-key-create Refuse to create resources not protected by a user managed key in the diff --git a/gcloud/beta/compute/instances/create-with-container b/gcloud/beta/compute/instances/create-with-container index d1fc9bd5e..6410ed86a 100644 --- a/gcloud/beta/compute/instances/create-with-container +++ b/gcloud/beta/compute/instances/create-with-container @@ -789,17 +789,22 @@ FLAGS the subnet or legacy network IP range. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: + RESERVATION_BOUND + The VM instances run for the entire duration of their associated + reservation. You can only specify this provisioning model if you + want your VM instances to consume a specific reservation with + either a calendar reservation mode or a dense deployment type. SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --resource-policies=[RESOURCE_POLICY,...] A list of resource policy names to be added to the instance. The diff --git a/gcloud/beta/compute/instances/set-scheduling b/gcloud/beta/compute/instances/set-scheduling index a6d0d6415..5c4f54d57 100644 --- a/gcloud/beta/compute/instances/set-scheduling +++ b/gcloud/beta/compute/instances/set-scheduling @@ -79,17 +79,22 @@ FLAGS to enable and --no-preemptible to disable. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: + RESERVATION_BOUND + The VM instances run for the entire duration of their associated + reservation. You can only specify this provisioning model if you + want your VM instances to consume a specific reservation with + either a calendar reservation mode or a dense deployment type. SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --[no-]restart-on-failure The instances will be restarted if they are terminated by Compute diff --git a/gcloud/beta/container/fleet/config-management/status b/gcloud/beta/container/fleet/config-management/status index 69027928e..fa50e651c 100644 --- a/gcloud/beta/container/fleet/config-management/status +++ b/gcloud/beta/container/fleet/config-management/status @@ -8,9 +8,19 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) The Synced_to_Fleet_Default status indicates whether each - membership's configuration has been synced with the fleet-default - membership configuration + (BETA) The Status column indicates the status of the Config Sync component. + Status displays NOT_INSTALLED when Config Sync is not installed. Status + displays NOT_CONFIGURED when Config Sync is installed but git/oci is not + configured. Status displays SYNCED when Config Sync is installed and + git/oci is configured and the last sync was successful. Status displays + ERROR when Config Sync encounters errors. Status displays STOPPED when + Config Sync stops syncing configs to the cluster. Status displays PENDING + when Config Sync has not reached the desired state. Otherwise, Status + displays UNSPECIFIED. + + The Synced_to_Fleet_Default status indicates whether each membership's + configuration has been synced with the fleet-default membership + configuration (https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features). Synced_to_Fleet_Default displays FLEET_DEFAULT_NOT_CONFIGURED when fleet-default membership configuration is not enabled. diff --git a/gcloud/beta/container/hub/config-management/status b/gcloud/beta/container/hub/config-management/status index 80db96c24..4a48c4a9a 100644 --- a/gcloud/beta/container/hub/config-management/status +++ b/gcloud/beta/container/hub/config-management/status @@ -8,9 +8,19 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) The Synced_to_Fleet_Default status indicates whether each - membership's configuration has been synced with the fleet-default - membership configuration + (BETA) The Status column indicates the status of the Config Sync component. + Status displays NOT_INSTALLED when Config Sync is not installed. Status + displays NOT_CONFIGURED when Config Sync is installed but git/oci is not + configured. Status displays SYNCED when Config Sync is installed and + git/oci is configured and the last sync was successful. Status displays + ERROR when Config Sync encounters errors. Status displays STOPPED when + Config Sync stops syncing configs to the cluster. Status displays PENDING + when Config Sync has not reached the desired state. Otherwise, Status + displays UNSPECIFIED. + + The Synced_to_Fleet_Default status indicates whether each membership's + configuration has been synced with the fleet-default membership + configuration (https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features). Synced_to_Fleet_Default displays FLEET_DEFAULT_NOT_CONFIGURED when fleet-default membership configuration is not enabled. diff --git a/gcloud/beta/eventarc/google-api-sources/create b/gcloud/beta/eventarc/google-api-sources/create index 583ead195..dc9208ab1 100644 --- a/gcloud/beta/eventarc/google-api-sources/create +++ b/gcloud/beta/eventarc/google-api-sources/create @@ -7,8 +7,8 @@ SYNOPSIS (GOOGLE_API_SOURCE : --location=LOCATION) (--destination-message-bus=DESTINATION_MESSAGE_BUS : --destination-message-bus-project=DESTINATION_MESSAGE_BUS_PROJECT) - [--async] [--crypto-key=CRYPTO_KEY] [--logging-config=LOGGING_CONFIG] - [GCLOUD_WIDE_FLAG ...] + [--async] [--crypto-key=CRYPTO_KEY] [--labels=[KEY=VALUE,...]] + [--logging-config=LOGGING_CONFIG] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Create an Eventarc Google API source. @@ -102,6 +102,9 @@ OPTIONAL FLAGS encryption. If this is unspecified, Google-managed keys will be used for encryption. + --labels=[KEY=VALUE,...] + Labels to apply to the Google API source. + --logging-config=LOGGING_CONFIG The logging config for the Google API source. LOGGING_CONFIG must be one of: NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, diff --git a/gcloud/beta/eventarc/google-api-sources/update b/gcloud/beta/eventarc/google-api-sources/update index 3aa98d881..8a44b4cd9 100644 --- a/gcloud/beta/eventarc/google-api-sources/update +++ b/gcloud/beta/eventarc/google-api-sources/update @@ -5,7 +5,7 @@ NAME SYNOPSIS gcloud beta eventarc google-api-sources update (GOOGLE_API_SOURCE : --location=LOCATION) [--async] - [--logging-config=LOGGING_CONFIG] + [--labels=[KEY=VALUE,...]] [--logging-config=LOGGING_CONFIG] [--clear-crypto-key | --crypto-key=CRYPTO_KEY] [--destination-message-bus=DESTINATION_MESSAGE_BUS : --destination-message-bus-project=DESTINATION_MESSAGE_BUS_PROJECT] @@ -77,6 +77,9 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. + --labels=[KEY=VALUE,...] + Labels to apply to the Google API source. + --logging-config=LOGGING_CONFIG The logging config of the Google API source. LOGGING_CONFIG must be one of: NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, diff --git a/gcloud/beta/eventarc/message-buses/create b/gcloud/beta/eventarc/message-buses/create index 67d31f465..4cb66b1ec 100644 --- a/gcloud/beta/eventarc/message-buses/create +++ b/gcloud/beta/eventarc/message-buses/create @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta eventarc message-buses create (MESSAGE_BUS : --location=LOCATION) [--async] [--crypto-key=CRYPTO_KEY] - [--logging-config=LOGGING_CONFIG] [GCLOUD_WIDE_FLAG ...] + [--labels=[KEY=VALUE,...]] [--logging-config=LOGGING_CONFIG] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Create an Eventarc message bus. @@ -60,6 +61,9 @@ FLAGS encryption. If this is unspecified, Google-managed keys will be used for encryption. + --labels=[KEY=VALUE,...] + Labels to apply to the message bus. + --logging-config=LOGGING_CONFIG The logging config of the message bus. LOGGING_CONFIG must be one of: NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. diff --git a/gcloud/beta/eventarc/message-buses/update b/gcloud/beta/eventarc/message-buses/update index 955c75b03..8dcd6b39e 100644 --- a/gcloud/beta/eventarc/message-buses/update +++ b/gcloud/beta/eventarc/message-buses/update @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud beta eventarc message-buses update (MESSAGE_BUS : --location=LOCATION) [--async] - [--logging-config=LOGGING_CONFIG] + [--labels=[KEY=VALUE,...]] [--logging-config=LOGGING_CONFIG] [--clear-crypto-key | --crypto-key=CRYPTO_KEY] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -64,6 +64,9 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. + --labels=[KEY=VALUE,...] + Labels to apply to the message bus. + --logging-config=LOGGING_CONFIG The logging config of the message bus. LOGGING_CONFIG must be one of: NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. diff --git a/gcloud/beta/iap/web/disable b/gcloud/beta/iap/web/disable index ba3cc997e..e63649530 100644 --- a/gcloud/beta/iap/web/disable +++ b/gcloud/beta/iap/web/disable @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud beta iap web disable - [--resource-type=RESOURCE_TYPE : --service=SERVICE] + [--resource-type=RESOURCE_TYPE : --region=REGION --service=SERVICE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -16,16 +16,25 @@ EXAMPLES $ gcloud beta iap web disable --resource-type=app-engine - To disable IAP on a backend service, run: + To disable IAP on a global backend service, run: $ gcloud beta iap web disable --resource-type=backend-services \ --service=SERVICE_ID + To disable IAP on a region backend service, run: + + $ gcloud beta iap web disable --resource-type=backend-services \ + --service=SERVICE_ID --region=REGION + FLAGS --resource-type=RESOURCE_TYPE Resource type of the IAP resource. RESOURCE_TYPE must be one of: app-engine, backend-services. + --region=REGION + Region name. Not applicable for app-engine. Optional when resource-type + is compute. + --service=SERVICE Service name. Required with --resource-type=backend-services. diff --git a/gcloud/beta/iap/web/enable b/gcloud/beta/iap/web/enable index a2908addd..4d5484177 100644 --- a/gcloud/beta/iap/web/enable +++ b/gcloud/beta/iap/web/enable @@ -6,7 +6,7 @@ SYNOPSIS gcloud beta iap web enable [--oauth2-client-id=OAUTH2_CLIENT_ID --oauth2-client-secret=OAUTH2_CLIENT_SECRET] - [--resource-type=RESOURCE_TYPE : --service=SERVICE] + [--resource-type=RESOURCE_TYPE : --region=REGION --service=SERVICE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -20,12 +20,18 @@ EXAMPLES $ gcloud beta iap web enable --resource-type=app-engine \ --oauth2-client-id=CLIENT_ID --oauth2-client-secret=SECRET - To enable IAP on a backend service, run: + To enable IAP on a global backend service, run: $ gcloud beta iap web enable --resource-type=backend-services \ --oauth2-client-id=CLIENT_ID --oauth2-client-secret=SECRET \ --service=SERVICE_ID + To enable IAP on a region backend service, run: + + $ gcloud beta iap web enable --resource-type=backend-services \ + --oauth2-client-id=CLIENT_ID --oauth2-client-secret=SECRET \ + --service=SERVICE_ID --region=REGION + FLAGS --oauth2-client-id=OAUTH2_CLIENT_ID OAuth 2.0 client ID to use. @@ -37,6 +43,10 @@ FLAGS Resource type of the IAP resource. RESOURCE_TYPE must be one of: app-engine, backend-services. + --region=REGION + Region name. Not applicable for app-engine. Optional when resource-type + is compute. + --service=SERVICE Service name. Required with --resource-type=backend-services. diff --git a/gcloud/beta/network-connectivity/regional-endpoints/create b/gcloud/beta/network-connectivity/regional-endpoints/create index 931bda008..098d5e92b 100644 --- a/gcloud/beta/network-connectivity/regional-endpoints/create +++ b/gcloud/beta/network-connectivity/regional-endpoints/create @@ -60,9 +60,11 @@ REQUIRED FLAGS OPTIONAL FLAGS --address=ADDRESS - The IPv4 address or address resource URI of the Regional Endpoint. When - no address value is provided, an IP from the subnetwork is allocated. - IPv6 address support is not available yet. + The IP Address of the Regional Endpoint. When no address is provided, + an IP from the subnetwork is allocated. Use one of the following + formats:\ * IPv4 address as in 10.0.0.1 * Address resource URI as in + projects/{project}/regions/{region}/addresses/{address_name} for an + IPv4 or IPv6 address. --async Return immediately, without waiting for the operation in progress to diff --git a/gcloud/beta/network-connectivity/spokes/linked-interconnect-attachments/create b/gcloud/beta/network-connectivity/spokes/linked-interconnect-attachments/create index e58c0d83a..7a95af7dc 100644 --- a/gcloud/beta/network-connectivity/spokes/linked-interconnect-attachments/create +++ b/gcloud/beta/network-connectivity/spokes/linked-interconnect-attachments/create @@ -6,7 +6,7 @@ SYNOPSIS gcloud beta network-connectivity spokes linked-interconnect-attachments create (SPOKE : --region=REGION) --hub=HUB --interconnect-attachments=[INTERCONNECT_ATTACHMENTS,...] [--async] - [--description=DESCRIPTION] + [--description=DESCRIPTION] [--group=GROUP] [--include-import-ranges=[INCLUDE_IMPORT_RANGES,...]] [--labels=[KEY=VALUE,...]] [--site-to-site-data-transfer] [GCLOUD_WIDE_FLAG ...] @@ -77,6 +77,10 @@ OPTIONAL FLAGS --description=DESCRIPTION Description of the spoke to create. + --group=GROUP + The group that the spoke will be added to. The group must already + exist. If unset, the spoke will be added to the ``default`` group. + --include-import-ranges=[INCLUDE_IMPORT_RANGES,...] IP address range(s) allowed to be imported from hub subnets. Only ``ALL_IPV4_RANGES`` can be added to the list. If it's empty, the spoke diff --git a/gcloud/beta/network-connectivity/spokes/linked-router-appliances/create b/gcloud/beta/network-connectivity/spokes/linked-router-appliances/create index 41574b313..6cabf25d2 100644 --- a/gcloud/beta/network-connectivity/spokes/linked-router-appliances/create +++ b/gcloud/beta/network-connectivity/spokes/linked-router-appliances/create @@ -6,7 +6,7 @@ SYNOPSIS gcloud beta network-connectivity spokes linked-router-appliances create (SPOKE : --region=REGION) --hub=HUB --router-appliance=[instance=INSTANCE],[ip=IP] [--async] - [--description=DESCRIPTION] + [--description=DESCRIPTION] [--group=GROUP] [--include-import-ranges=[INCLUDE_IMPORT_RANGES,...]] [--labels=[KEY=VALUE,...]] [--site-to-site-data-transfer] [GCLOUD_WIDE_FLAG ...] @@ -83,6 +83,10 @@ OPTIONAL FLAGS --description=DESCRIPTION Description of the spoke to create. + --group=GROUP + The group that the spoke will be added to. The group must already + exist. If unset, the spoke will be added to the ``default`` group. + --include-import-ranges=[INCLUDE_IMPORT_RANGES,...] IP address range(s) allowed to be imported from hub subnets. Only ``ALL_IPV4_RANGES`` can be added to the list. If it's empty, the spoke diff --git a/gcloud/beta/network-connectivity/spokes/linked-vpn-tunnels/create b/gcloud/beta/network-connectivity/spokes/linked-vpn-tunnels/create index aeb40dde1..e2931057e 100644 --- a/gcloud/beta/network-connectivity/spokes/linked-vpn-tunnels/create +++ b/gcloud/beta/network-connectivity/spokes/linked-vpn-tunnels/create @@ -5,7 +5,7 @@ NAME SYNOPSIS gcloud beta network-connectivity spokes linked-vpn-tunnels create (SPOKE : --region=REGION) --hub=HUB --vpn-tunnels=[VPN_TUNNELS,...] - [--async] [--description=DESCRIPTION] + [--async] [--description=DESCRIPTION] [--group=GROUP] [--include-import-ranges=[INCLUDE_IMPORT_RANGES,...]] [--labels=[KEY=VALUE,...]] [--site-to-site-data-transfer] [GCLOUD_WIDE_FLAG ...] @@ -75,6 +75,10 @@ OPTIONAL FLAGS --description=DESCRIPTION Description of the spoke to create. + --group=GROUP + The group that the spoke will be added to. The group must already + exist. If unset, the spoke will be added to the ``default`` group. + --include-import-ranges=[INCLUDE_IMPORT_RANGES,...] IP address range(s) allowed to be imported from hub subnets. Only ``ALL_IPV4_RANGES`` can be added to the list. If it's empty, the spoke diff --git a/gcloud/beta/network-management/connectivity-tests/create b/gcloud/beta/network-management/connectivity-tests/create index 3863b1c21..ec4300a5b 100644 --- a/gcloud/beta/network-management/connectivity-tests/create +++ b/gcloud/beta/network-management/connectivity-tests/create @@ -18,7 +18,8 @@ SYNOPSIS --source-gke-master-cluster=SOURCE_GKE_MASTER_CLUSTER --source-instance=SOURCE_INSTANCE --source-ip-address=SOURCE_IP_ADDRESS) [--async] - [--description=DESCRIPTION] [--destination-network=DESTINATION_NETWORK] + [--description=DESCRIPTION] [--destination-fqdn=DESTINATION_FQDN] + [--destination-network=DESTINATION_NETWORK] [--destination-port=DESTINATION_PORT] [--destination-project=DESTINATION_PROJECT] [--labels=[KEY=VALUE,...]] [--other-projects=[OTHER_PROJECTS,...]] [--protocol=PROTOCOL] @@ -118,6 +119,10 @@ OPTIONAL FLAGS --description=DESCRIPTION The description of the connectivity test. + --destination-fqdn=DESTINATION_FQDN + A hostname as the destination endpoint. Only applicable for Google + Kubernetes Engine. + --destination-network=DESTINATION_NETWORK A VPC network URI where the destination is located. diff --git a/gcloud/beta/network-management/connectivity-tests/update b/gcloud/beta/network-management/connectivity-tests/update index df3a207c7..61daee143 100644 --- a/gcloud/beta/network-management/connectivity-tests/update +++ b/gcloud/beta/network-management/connectivity-tests/update @@ -5,6 +5,7 @@ NAME SYNOPSIS gcloud beta network-management connectivity-tests update CONNECTIVITY_TEST [--async] [--description=DESCRIPTION] + [--destination-fqdn=DESTINATION_FQDN] [--destination-network=DESTINATION_NETWORK] [--destination-port=DESTINATION_PORT] [--destination-project=DESTINATION_PROJECT] [--labels=[KEY=VALUE,...]] @@ -79,6 +80,10 @@ FLAGS --description=DESCRIPTION The description of the connectivity test. + --destination-fqdn=DESTINATION_FQDN + A hostname as the destination endpoint. Only applicable for Google + Kubernetes Engine. + --destination-network=DESTINATION_NETWORK A VPC network URI where the destination is located. diff --git a/gcloud/beta/redis/clusters/backup-collections/describe b/gcloud/beta/redis/clusters/backup-collections/describe new file mode 100644 index 000000000..b8adff904 --- /dev/null +++ b/gcloud/beta/redis/clusters/backup-collections/describe @@ -0,0 +1,76 @@ +NAME + gcloud beta redis clusters backup-collections describe - show metadata for + a backup collection + +SYNOPSIS + gcloud beta redis clusters backup-collections describe + (BACKUP_COLLECTION : --region=REGION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) 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/v1beta1 API. The full documentation for this + API can be found at: https://cloud.google.com/memorystore/docs/redis/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha redis clusters backup-collections describe + diff --git a/gcloud/beta/redis/clusters/backup-collections/help b/gcloud/beta/redis/clusters/backup-collections/help new file mode 100644 index 000000000..853323a96 --- /dev/null +++ b/gcloud/beta/redis/clusters/backup-collections/help @@ -0,0 +1,32 @@ +NAME + gcloud beta redis clusters backup-collections - manage backup collections + of Memorystore for Redis Cluster instances + +SYNOPSIS + gcloud beta redis clusters backup-collections COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) 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 + (BETA) Show metadata for a backup collection. + + list + (BETA) List backup collections in a region. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha redis clusters backup-collections + diff --git a/gcloud/beta/redis/clusters/backup-collections/list b/gcloud/beta/redis/clusters/backup-collections/list new file mode 100644 index 000000000..e3b5f2b4a --- /dev/null +++ b/gcloud/beta/redis/clusters/backup-collections/list @@ -0,0 +1,89 @@ +NAME + gcloud beta redis clusters backup-collections list - list backup + collections in a region + +SYNOPSIS + gcloud beta redis clusters backup-collections list [--region=REGION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) 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 beta 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/v1beta1 API. The full documentation for this + API can be found at: https://cloud.google.com/memorystore/docs/redis/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha redis clusters backup-collections list + diff --git a/gcloud/beta/redis/clusters/backups/delete b/gcloud/beta/redis/clusters/backups/delete new file mode 100644 index 000000000..0307ab495 --- /dev/null +++ b/gcloud/beta/redis/clusters/backups/delete @@ -0,0 +1,88 @@ +NAME + gcloud beta redis clusters backups delete - delete a Memorystore for Redis + Cluster backup + +SYNOPSIS + gcloud beta redis clusters backups delete + (BACKUP : --backup-collection=BACKUP_COLLECTION --region=REGION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) 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 beta 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/v1beta1 API. The full documentation for this + API can be found at: https://cloud.google.com/memorystore/docs/redis/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha redis clusters backups delete + diff --git a/gcloud/beta/redis/clusters/backups/describe b/gcloud/beta/redis/clusters/backups/describe new file mode 100644 index 000000000..9c68c0381 --- /dev/null +++ b/gcloud/beta/redis/clusters/backups/describe @@ -0,0 +1,85 @@ +NAME + gcloud beta redis clusters backups describe - show metadata for a + Memorystore for Redis Cluster backup + +SYNOPSIS + gcloud beta redis clusters backups describe + (BACKUP : --backup-collection=BACKUP_COLLECTION --region=REGION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) 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 beta 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/v1beta1 API. The full documentation for this + API can be found at: https://cloud.google.com/memorystore/docs/redis/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha redis clusters backups describe + diff --git a/gcloud/beta/redis/clusters/backups/export b/gcloud/beta/redis/clusters/backups/export new file mode 100644 index 000000000..c575a1631 --- /dev/null +++ b/gcloud/beta/redis/clusters/backups/export @@ -0,0 +1,91 @@ +NAME + gcloud beta redis clusters backups export - export a Redis cluster backup + to a Google Cloud Storage bucket + +SYNOPSIS + gcloud beta redis clusters backups export + (BACKUP : --backup-collection=BACKUP_COLLECTION --region=REGION) + --gcs-bucket=GCS_BUCKET [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) 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 beta 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/v1beta1 API. The full documentation for this + API can be found at: https://cloud.google.com/memorystore/docs/redis/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha redis clusters backups export + diff --git a/gcloud/beta/redis/clusters/backups/help b/gcloud/beta/redis/clusters/backups/help new file mode 100644 index 000000000..f3fddf998 --- /dev/null +++ b/gcloud/beta/redis/clusters/backups/help @@ -0,0 +1,36 @@ +NAME + gcloud beta redis clusters backups - manage backups of Memorystore for + Redis Cluster instances + +SYNOPSIS + gcloud beta redis clusters backups COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) 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 + (BETA) Delete a Memorystore for Redis Cluster backup. + + describe + (BETA) Show metadata for a Memorystore for Redis Cluster backup. + + export + (BETA) Export a Redis cluster backup to a Google Cloud Storage bucket. + + list + (BETA) List backups under a backup collection in a region. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha redis clusters backups + diff --git a/gcloud/beta/redis/clusters/backups/list b/gcloud/beta/redis/clusters/backups/list new file mode 100644 index 000000000..5955f09b7 --- /dev/null +++ b/gcloud/beta/redis/clusters/backups/list @@ -0,0 +1,105 @@ +NAME + gcloud beta redis clusters backups list - list backups under a backup + collection in a region + +SYNOPSIS + gcloud beta 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 + (BETA) 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 beta 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/v1beta1 API. The full documentation for this + API can be found at: https://cloud.google.com/memorystore/docs/redis/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha redis clusters backups list + diff --git a/gcloud/beta/redis/clusters/create b/gcloud/beta/redis/clusters/create index b9d7a3dd6..710832984 100644 --- a/gcloud/beta/redis/clusters/create +++ b/gcloud/beta/redis/clusters/create @@ -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, diff --git a/gcloud/beta/redis/clusters/create-backup b/gcloud/beta/redis/clusters/create-backup new file mode 100644 index 000000000..0b319aafd --- /dev/null +++ b/gcloud/beta/redis/clusters/create-backup @@ -0,0 +1,80 @@ +NAME + gcloud beta redis clusters create-backup - create a backup of a Redis + cluster + +SYNOPSIS + gcloud beta redis clusters create-backup (CLUSTER : --region=REGION) + [--async] [--backup-id=BACKUP_ID] [--ttl=TTL] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) 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/v1beta1 API. The full documentation for this + API can be found at: https://cloud.google.com/memorystore/docs/redis/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha redis clusters create-backup + diff --git a/gcloud/beta/redis/clusters/help b/gcloud/beta/redis/clusters/help index 9d7388594..86c5706d2 100644 --- a/gcloud/beta/redis/clusters/help +++ b/gcloud/beta/redis/clusters/help @@ -2,7 +2,7 @@ NAME gcloud beta redis clusters - manage Memorystore for Redis Cluster instances SYNOPSIS - gcloud beta redis clusters COMMAND [GCLOUD_WIDE_FLAG ...] + gcloud beta redis clusters GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Manage Memorystore for Redis Cluster instances. @@ -12,6 +12,16 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. +GROUPS + GROUP is one of the following: + + backup-collections + (BETA) Manage backup collections of Memorystore for Redis Cluster + instances. + + backups + (BETA) Manage backups of Memorystore for Redis Cluster instances. + COMMANDS COMMAND is one of the following: @@ -21,6 +31,9 @@ COMMANDS create (BETA) Create a new Memorystore for Redis Cluster instance. + create-backup + (BETA) Create a backup of a Redis cluster. + delete (BETA) Delete a Memorystore for Redis Cluster instance. diff --git a/gcloud/beta/sql/instances/create b/gcloud/beta/sql/instances/create index 7826fbda6..9b11f4344 100644 --- a/gcloud/beta/sql/instances/create +++ b/gcloud/beta/sql/instances/create @@ -529,8 +529,8 @@ FLAGS established from specified consumer projects. --enable-private-service-connect - When the flag is set, a Cloud SQL instance will be created with Private - Service Connect enabled. + Enable connecting to the Cloud SQL instance with Private Service + Connect. Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the instance. The 'Compute Engine Service Agent' diff --git a/gcloud/beta/sql/instances/patch b/gcloud/beta/sql/instances/patch index 31bedf55c..3117faee7 100644 --- a/gcloud/beta/sql/instances/patch +++ b/gcloud/beta/sql/instances/patch @@ -23,6 +23,7 @@ SYNOPSIS [--[no-]enable-google-ml-integration] [--[no-]enable-google-private-path] [--enable-password-policy] [--enable-point-in-time-recovery] + [--[no-]enable-private-service-connect] [--failover-dr-replica-name=FAILOVER_DR_REPLICA_NAME] [--follow-gae-app=FOLLOW_GAE_APP] [--[no-]insights-config-query-insights-enabled] @@ -129,7 +130,7 @@ FLAGS --clear-failover-dr-replica-name Clear the DR replica setting for the primary instance. Flag is only - available for MySQL. + available for MySQL and PostgreSQL database instances. --clear-password-policy Clear the existing password policy. This flag is only available for @@ -226,10 +227,16 @@ FLAGS fraction of a second, via write-ahead logs. Must have automatic backups enabled to use. Make sure storage can support at least 7 days of logs. + --[no-]enable-private-service-connect + Enable connecting to the Cloud SQL instance with Private Service + Connect. Use --enable-private-service-connect to enable and + --no-enable-private-service-connect to disable. + --failover-dr-replica-name=FAILOVER_DR_REPLICA_NAME Set a Disaster Recovery (DR) replica with the specified name for the primary instance. This must be one of the existing cross region - replicas of the primary instance. Flag is only available for MySQL. + replicas of the primary instance. Flag is only available for MySQL and + PostgreSQL database instances. --follow-gae-app=FOLLOW_GAE_APP First Generation instances only. The App Engine app this instance diff --git a/gcloud/compute/commitments/create b/gcloud/compute/commitments/create index d0374ab41..35a2d8131 100644 --- a/gcloud/compute/commitments/create +++ b/gcloud/compute/commitments/create @@ -105,10 +105,10 @@ OPTIONAL FLAGS accelerator-optimized-a3, accelerator-optimized-a3-mega, compute-optimized, compute-optimized-c2d, compute-optimized-c3, compute-optimized-c3d, compute-optimized-h3, general-purpose, - general-purpose-c4, general-purpose-e2, general-purpose-n2, - general-purpose-n2d, general-purpose-n4, general-purpose-t2d, - graphics-optimized, memory-optimized, memory-optimized-m3, - storage-optimized-z3. + general-purpose-c4, general-purpose-c4a, general-purpose-e2, + general-purpose-n2, general-purpose-n2d, general-purpose-n4, + general-purpose-t2d, graphics-optimized, memory-optimized, + memory-optimized-m3, storage-optimized-z3. Manage the reservations to be created with the commitment. diff --git a/gcloud/compute/disks/convert b/gcloud/compute/disks/convert new file mode 100644 index 000000000..8593c5bbf --- /dev/null +++ b/gcloud/compute/disks/convert @@ -0,0 +1,134 @@ +NAME + gcloud compute disks convert - convert a Compute Engine Persistent Disk + volume to a Hyperdisk volume + +SYNOPSIS + gcloud compute disks convert DISK_NAME --target-disk-type=TARGET_DISK_TYPE + [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING + --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] + [--region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Convert Compute Engine Persistent Disk volumes to Hyperdisk volumes. + + gcloud compute disks convert converts a Compute Engine Persistent Disk + volume to a Hyperdisk volume. For a comprehensive guide, refer to: + https://cloud.google.com/sdk/gcloud/reference/compute/disks/convert. + +EXAMPLES + The following command converts a PD Standard disk to a Hyperdisk + Throughput: + + $ gcloud compute disks convert my-disk-1 --zone=ZONE \ + --target-disk-type=hyperdisk-throughput + +POSITIONAL ARGUMENTS + DISK_NAME + Name of the disk to operate on. + +REQUIRED FLAGS + --target-disk-type=TARGET_DISK_TYPE + Specifies the type of Hyperdisk to convert to, for example, to convert + a Hyperdisk Balanced volume, specify hyperdisk-balanced. To get a list + of available disk types, run gcloud compute disk-types list. + +OPTIONAL FLAGS + Key resource - The Cloud KMS (Key Management Service) cryptokey that will + be used to protect the disk. The 'Compute Engine Service Agent' service + account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. + The arguments in this group can be used to specify the attributes of this + resource. + + --kms-key=KMS_KEY + ID of the key or fully qualified identifier for the key. + + To set the kms-key attribute: + ▸ provide the argument --kms-key on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --kms-keyring=KMS_KEYRING + The KMS keyring of the key. + + To set the kms-keyring attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-keyring on the command line. + + --kms-location=KMS_LOCATION + The Google Cloud location for the key. + + To set the kms-location attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-location on the command line; + ▸ provide the argument --region on the command line. + + --kms-project=KMS_PROJECT + The Google Cloud project for the key. + + To set the kms-project attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-project on the command line; + ▸ set the property core/project. + + At most one of these can be specified: + + --region=REGION + Region of the disk to operate on. If not specified, you might be + prompted to select a region (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/region property: + + $ gcloud config set compute/region REGION + + A list of regions can be fetched by running: + + $ gcloud compute regions list + + To unset the property, run: + + $ gcloud config unset compute/region + + Alternatively, the region can be stored in the environment variable + CLOUDSDK_COMPUTE_REGION. + + --zone=ZONE + Zone of the disk to operate on. If not specified and the compute/zone + property isn't set, you might be prompted to select a zone + (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/zone property: + + $ gcloud config set compute/zone ZONE + + A list of zones can be fetched by running: + + $ gcloud compute zones list + + To unset the property, run: + + $ gcloud config unset compute/zone + + Alternatively, the zone can be stored in the environment variable + CLOUDSDK_COMPUTE_ZONE. + +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. + +NOTES + These variants are also available: + + $ gcloud alpha compute disks convert + + $ gcloud beta compute disks convert + diff --git a/gcloud/compute/disks/help b/gcloud/compute/disks/help index 31a4e8054..2711aafe7 100644 --- a/gcloud/compute/disks/help +++ b/gcloud/compute/disks/help @@ -37,6 +37,9 @@ COMMANDS add-resource-policies Add resource policies to a Compute Engine disk. + convert + Convert a Compute Engine Persistent Disk volume to a Hyperdisk volume. + create Create Compute Engine persistent disks. diff --git a/gcloud/compute/instance-templates/create b/gcloud/compute/instance-templates/create index 83e7d47dd..4202258f1 100644 --- a/gcloud/compute/instance-templates/create +++ b/gcloud/compute/instance-templates/create @@ -745,17 +745,17 @@ FLAGS the subnet or legacy network IP range. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --region=REGION Region of the subnetwork to attach. If not specified, you might be diff --git a/gcloud/compute/instances/bulk/create b/gcloud/compute/instances/bulk/create index db2e28d2c..ba8d9e057 100644 --- a/gcloud/compute/instances/bulk/create +++ b/gcloud/compute/instances/bulk/create @@ -693,17 +693,17 @@ OPTIONAL FLAGS instances can not be restarted and will not migrate. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --resource-manager-tags=[KEY=VALUE,...] Specifies a list of resource manager tags to apply to the instance. diff --git a/gcloud/compute/instances/create b/gcloud/compute/instances/create index 65586f08f..dac6f3beb 100644 --- a/gcloud/compute/instances/create +++ b/gcloud/compute/instances/create @@ -846,17 +846,17 @@ FLAGS the subnet or legacy network IP range. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --require-csek-key-create Refuse to create resources not protected by a user managed key in the diff --git a/gcloud/compute/instances/create-with-container b/gcloud/compute/instances/create-with-container index 09d72d093..f101c38da 100644 --- a/gcloud/compute/instances/create-with-container +++ b/gcloud/compute/instances/create-with-container @@ -750,17 +750,17 @@ FLAGS the subnet or legacy network IP range. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --resource-policies=[RESOURCE_POLICY,...] A list of resource policy names to be added to the instance. The diff --git a/gcloud/compute/instances/set-scheduling b/gcloud/compute/instances/set-scheduling index ed266a04a..81edf010b 100644 --- a/gcloud/compute/instances/set-scheduling +++ b/gcloud/compute/instances/set-scheduling @@ -73,17 +73,17 @@ FLAGS to enable and --no-preemptible to disable. --provisioning-model=PROVISIONING_MODEL - Specifies provisioning model, which determines price, obtainability, - and runtime for the VM instance. PROVISIONING_MODEL must be one of: + Specifies the provisioning model for your VM instances. This choice + affects the price, availability, and how long your VM instances can + run. PROVISIONING_MODEL must be one of: SPOT - Spot VMs are spare capacity; Spot VMs are discounted to have much - lower prices than standard VMs but have no guaranteed runtime. Spot - VMs are the new version of preemptible VM instances, except Spot - VMs do not have a 24-hour maximum runtime. + Compute Engine may stop a Spot VM instance whenever it needs + capacity. Because Spot VM instances don't have a guaranteed + runtime, they come at a discounted price. STANDARD - Default. Standard provisioning model for VM instances, which has - user-controlled runtime but no Spot discounts. + The default option. The STANDARD provisioning model gives you full + control over your VM instances' runtime. --[no-]restart-on-failure The instances will be restarted if they are terminated by Compute diff --git a/gcloud/database-migration/connection-profiles/create/mysql b/gcloud/database-migration/connection-profiles/create/mysql index 84750a848..cdeba2abb 100644 --- a/gcloud/database-migration/connection-profiles/create/mysql +++ b/gcloud/database-migration/connection-profiles/create/mysql @@ -88,19 +88,29 @@ FLAGS --ca-certificate=CA_CERTIFICATE x509 PEM-encoded certificate of the CA that signed the database - server's certificate. Database Migration Service will use this - certificate to verify it's connecting to the correct host. Database - Migration Service encrypts the value when storing it. + server's certificate. The value for this flag needs to be the content + of the certificate file, not the path to the file. For example, on a + Linux machine you can use command substitution: + --ca-certificate=$(. + Database Migration Service will use this certificate to verify it's + connecting to the correct host. Database Migration Service encrypts the + value when storing it. --client-certificate=CLIENT_CERTIFICATE x509 PEM-encoded certificate that will be used by the replica to - authenticate against the database server. Database Migration Service - encrypts the value when storing it. + authenticate against the database server. The value for this flag needs + to be the content of the certificate file, not the path to the file. + For example, on a Linux machine you can use command substitution: + --ca-certificate=$(. + Database Migration Service encrypts the value when storing it. --private-key=PRIVATE_KEY Unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with - the Client Certificate. Database Migration Service encrypts the value - when storing it. + the Client Certificate. The value for this flag needs to be the content + of the certificate file, not the path to the file. For example, on a + Linux machine you can use command substitution: + --ca-certificate=$(. + Database Migration Service encrypts the value when storing it. --host=HOST IP or hostname of the database. When --psc-service-attachment is also diff --git a/gcloud/database-migration/connection-profiles/create/oracle b/gcloud/database-migration/connection-profiles/create/oracle index cde35b2cd..3e9fc4af2 100644 --- a/gcloud/database-migration/connection-profiles/create/oracle +++ b/gcloud/database-migration/connection-profiles/create/oracle @@ -93,9 +93,13 @@ OPTIONAL FLAGS --ca-certificate=CA_CERTIFICATE x509 PEM-encoded certificate of the CA that signed the database - server's certificate. Database Migration Service will use this - certificate to verify it's connecting to the correct host. Database - Migration Service encrypts the value when storing it. + server's certificate. The value for this flag needs to be the content + of the certificate file, not the path to the file. For example, on a + Linux machine you can use command substitution: + --ca-certificate=$(. + Database Migration Service will use this certificate to verify it's + connecting to the correct host. Database Migration Service encrypts the + value when storing it. --display-name=DISPLAY_NAME A user-friendly name for the connection profile. The display name can diff --git a/gcloud/database-migration/connection-profiles/create/postgresql b/gcloud/database-migration/connection-profiles/create/postgresql index 0eab628aa..a4a48d773 100644 --- a/gcloud/database-migration/connection-profiles/create/postgresql +++ b/gcloud/database-migration/connection-profiles/create/postgresql @@ -91,19 +91,29 @@ FLAGS --ca-certificate=CA_CERTIFICATE x509 PEM-encoded certificate of the CA that signed the database - server's certificate. Database Migration Service will use this - certificate to verify it's connecting to the correct host. Database - Migration Service encrypts the value when storing it. + server's certificate. The value for this flag needs to be the content + of the certificate file, not the path to the file. For example, on a + Linux machine you can use command substitution: + --ca-certificate=$(. + Database Migration Service will use this certificate to verify it's + connecting to the correct host. Database Migration Service encrypts the + value when storing it. --client-certificate=CLIENT_CERTIFICATE x509 PEM-encoded certificate that will be used by the replica to - authenticate against the database server. Database Migration Service - encrypts the value when storing it. + authenticate against the database server. The value for this flag needs + to be the content of the certificate file, not the path to the file. + For example, on a Linux machine you can use command substitution: + --ca-certificate=$(. + Database Migration Service encrypts the value when storing it. --private-key=PRIVATE_KEY Unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with - the Client Certificate. Database Migration Service encrypts the value - when storing it. + the Client Certificate. The value for this flag needs to be the content + of the certificate file, not the path to the file. For example, on a + Linux machine you can use command substitution: + --ca-certificate=$(. + Database Migration Service encrypts the value when storing it. --host=HOST IP or hostname of the database. When --psc-service-attachment is also diff --git a/gcloud/database-migration/connection-profiles/update b/gcloud/database-migration/connection-profiles/update index 2f5fbad07..bfa3ed6de 100644 --- a/gcloud/database-migration/connection-profiles/update +++ b/gcloud/database-migration/connection-profiles/update @@ -69,14 +69,21 @@ FLAGS --ca-certificate=CA_CERTIFICATE x509 PEM-encoded certificate of the CA that signed the database - server's certificate. Database Migration Service will use this - certificate to verify it's connecting to the correct host. Database - Migration Service encrypts the value when storing it. + server's certificate. The value for this flag needs to be the content + of the certificate file, not the path to the file. For example, on a + Linux machine you can use command substitution: + --ca-certificate=$(. + Database Migration Service will use this certificate to verify it's + connecting to the correct host. Database Migration Service encrypts the + value when storing it. --client-certificate=CLIENT_CERTIFICATE x509 PEM-encoded certificate that will be used by the replica to - authenticate against the database server. Database Migration Service - encrypts the value when storing it. + authenticate against the database server. The value for this flag needs + to be the content of the certificate file, not the path to the file. + For example, on a Linux machine you can use command substitution: + --ca-certificate=$(. + Database Migration Service encrypts the value when storing it. --cloudsql-instance=CLOUDSQL_INSTANCE If the source or destination is a Cloud SQL database, then use this @@ -98,8 +105,11 @@ FLAGS --private-key=PRIVATE_KEY Unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with - the Client Certificate. Database Migration Service encrypts the value - when storing it. + the Client Certificate. The value for this flag needs to be the content + of the certificate file, not the path to the file. For example, on a + Linux machine you can use command substitution: + --ca-certificate=$(. + Database Migration Service encrypts the value when storing it. --update-labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to update. If a label exists, its value diff --git a/gcloud/eventarc/triggers/create b/gcloud/eventarc/triggers/create index 2c8310d67..ae0074f5f 100644 --- a/gcloud/eventarc/triggers/create +++ b/gcloud/eventarc/triggers/create @@ -16,8 +16,8 @@ SYNOPSIS --destination-run-region=DESTINATION_RUN_REGION]) [--async] [--channel=CHANNEL] [--event-data-content-type=EVENT_DATA_CONTENT_TYPE] [--event-filters-path-pattern=[ATTRIBUTE=PATH_PATTERN,...]] - [--service-account=SERVICE_ACCOUNT] [--transport-topic=TRANSPORT_TOPIC] - [GCLOUD_WIDE_FLAG ...] + [--labels=[KEY=VALUE,...]] [--service-account=SERVICE_ACCOUNT] + [--transport-topic=TRANSPORT_TOPIC] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Create an Eventarc trigger. @@ -183,6 +183,9 @@ OPTIONAL FLAGS destination. Currently, path pattern format is only available for the resourceName attribute for Cloud Audit Log events. + --labels=[KEY=VALUE,...] + Labels to apply to the trigger. + --service-account=SERVICE_ACCOUNT The IAM service account email associated with the trigger. diff --git a/gcloud/eventarc/triggers/update b/gcloud/eventarc/triggers/update index b6f10d123..f0450b7a1 100644 --- a/gcloud/eventarc/triggers/update +++ b/gcloud/eventarc/triggers/update @@ -6,6 +6,7 @@ SYNOPSIS [--event-data-content-type=EVENT_DATA_CONTENT_TYPE] [--event-filters=[ATTRIBUTE=VALUE,...]] [--event-filters-path-pattern=[ATTRIBUTE=PATH_PATTERN,...]] + [--labels=[KEY=VALUE,...]] [--clear-service-account | --service-account=SERVICE_ACCOUNT] [--destination-gke-namespace=DESTINATION_GKE_NAMESPACE --destination-gke-service=DESTINATION_GKE_SERVICE @@ -86,6 +87,9 @@ FLAGS destination. Currently, path pattern format is only available for the resourceName attribute for Cloud Audit Log events. + --labels=[KEY=VALUE,...] + Labels to apply to the trigger. + At most one of these can be specified: --clear-service-account diff --git a/gcloud/iam/help b/gcloud/iam/help index 6a317ac01..4a621872d 100644 --- a/gcloud/iam/help +++ b/gcloud/iam/help @@ -27,6 +27,9 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + oauth-clients + Create and manage OAuth clients. + policies Manage IAM deny policies. diff --git a/gcloud/iam/oauth-clients/create b/gcloud/iam/oauth-clients/create new file mode 100644 index 000000000..eec5a1028 --- /dev/null +++ b/gcloud/iam/oauth-clients/create @@ -0,0 +1,119 @@ +NAME + gcloud iam oauth-clients create - create an OAuth client + +SYNOPSIS + gcloud iam oauth-clients create (OAUTH_CLIENT : --location=LOCATION) + --allowed-grant-types=[ALLOWED_GRANT_TYPES,...] + --allowed-redirect-uris=[ALLOWED_REDIRECT_URIS,...] + --allowed-scopes=[ALLOWED_SCOPES,...] --client-type=CLIENT_TYPE + [--description=DESCRIPTION] [--disabled] [--display-name=DISPLAY_NAME] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new OAuth client. + +EXAMPLES + The following command creates a disabled OAuth client with ID + my-oauth-client in the default project: + + $ gcloud iam oauth-clients create my-oauth-client \ + --location="global" --client-type="confidential-client" \ + --display-name="My oauth client" \ + --description="My oauth client description" --disabled \ + --allowed-grant-types="authorization-code-grant,refresh-token-gr\ + ant" \ + --allowed-scopes="https://www.googleapis.com/auth/cloud-platform\ + ,openid" --allowed-redirect-uris="https://example.com" + +POSITIONAL ARGUMENTS + Oauth client resource - The OAuth client 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 project attribute: + ◆ provide the argument oauth_client 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. + + OAUTH_CLIENT + ID of the oauth client or fully qualified identifier for the oauth + client. + + To set the oauth_client attribute: + ▸ provide the argument oauth_client 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 name. + + To set the location attribute: + ▸ provide the argument oauth_client on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +REQUIRED FLAGS + --allowed-grant-types=[ALLOWED_GRANT_TYPES,...] + A list of OAuth grant types that are allowed for the OAuth client. + + The following grant types are currently supported: + + ◆ authorization-code-grant + + ◆ refresh-token-grant + + --allowed-redirect-uris=[ALLOWED_REDIRECT_URIS,...] + A list of redirect uris that is allowed for redirecting when the + authorization is completed. + + --allowed-scopes=[ALLOWED_SCOPES,...] + A list of scopes that the OAuth client is allowed to request during + OAuth flows. + + The following scopes are currently supported: + + ◆ https://www.googleapis.com/auth/cloud-platform: View, edit, + configure, and delete your Google Cloud data, and view the email + address for your Google Account. + + ◆ openid: Associate you with your personal info on Google Cloud. + + ◆ email: View your Google Cloud Account email address. + + --client-type=CLIENT_TYPE + The type of OAuth client. CLIENT_TYPE must be one of: + confidential-client, public-client. + +OPTIONAL FLAGS + --description=DESCRIPTION + A description of the OAuth client. Cannot exceed 256 characters. + + --disabled + Disables the OAuth client. You cannot use a disabled OAuth client for + login. Include --no-disabled to enable a disabled OAuth client. + + --display-name=DISPLAY_NAME + A display name for the OAuth client. Cannot exceed 32 characters. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This variant is also available: + + $ gcloud alpha iam oauth-clients create + diff --git a/gcloud/iam/oauth-clients/credentials/create b/gcloud/iam/oauth-clients/credentials/create new file mode 100644 index 000000000..66656da73 --- /dev/null +++ b/gcloud/iam/oauth-clients/credentials/create @@ -0,0 +1,91 @@ +NAME + gcloud iam oauth-clients credentials create - create an OAuth client + credential + +SYNOPSIS + gcloud iam oauth-clients credentials create + (CREDENTIAL : --location=LOCATION --oauth-client=OAUTH_CLIENT) + [--disabled] [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new OAuth client credential. + +EXAMPLES + To create a disabled OAuth client credential with ID + my-oauth-client-credential in the default project, run: + + $ gcloud iam oauth-clients credentials create \ + my-oauth-client-credential --location="global" \ + --oauth-client="my-oauth-client" \ + --display-name="My OAuth client credential" --disabled + +POSITIONAL ARGUMENTS + Oauth client credential resource - The OAuth client credential 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 project attribute: + ◆ provide the argument credential 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. + + CREDENTIAL + ID of the oauth client credential or fully qualified identifier for + the oauth client credential. + + To set the credential attribute: + ▸ provide the argument credential 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 name. + + To set the location attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --oauth-client=OAUTH_CLIENT + ID to use for the OAuth client, which becomes the final component of + the resource name. This value should be 4-32 characters, and may + contain the characters [a-z0-9-]. The prefix gcp- is reserved for use + by Google, and may not be specified. + + To set the oauth-client attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --oauth-client on the command line. + +FLAGS + --disabled + Disables the OAuth client credential. You cannot use a disabled OAuth + client credential for OAuth. Include --no-disabled to enable a disabled + OAuth client credential. + + --display-name=DISPLAY_NAME + A display name for the OAuth client credential. Cannot exceed 32 + characters. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This variant is also available: + + $ gcloud alpha iam oauth-clients credentials create + diff --git a/gcloud/iam/oauth-clients/credentials/delete b/gcloud/iam/oauth-clients/credentials/delete new file mode 100644 index 000000000..213fd7f9e --- /dev/null +++ b/gcloud/iam/oauth-clients/credentials/delete @@ -0,0 +1,80 @@ +NAME + gcloud iam oauth-clients credentials delete - delete an OAuth client + credential + +SYNOPSIS + gcloud iam oauth-clients credentials delete + (CREDENTIAL : --location=LOCATION --oauth-client=OAUTH_CLIENT) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete an OAuth client credential. + +EXAMPLES + To delete the OAuth client credential with ID my-oauth-client-credential in + the default project, run: + + $ gcloud iam oauth-clients credentials delete \ + my-oauth-client-credential --location="global" \ + --oauth-client="my-oauth-client" + +POSITIONAL ARGUMENTS + Oauth client credential resource - The OAuth client credential 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 credential 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. + + CREDENTIAL + ID of the oauth client credential or fully qualified identifier for + the oauth client credential. + + To set the credential attribute: + ▸ provide the argument credential 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 name. + + To set the location attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --oauth-client=OAUTH_CLIENT + ID to use for the OAuth client, which becomes the final component of + the resource name. This value should be 4-32 characters, and may + contain the characters [a-z0-9-]. The prefix gcp- is reserved for use + by Google, and may not be specified. + + To set the oauth-client attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --oauth-client on the command line. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This variant is also available: + + $ gcloud alpha iam oauth-clients credentials delete + diff --git a/gcloud/iam/oauth-clients/credentials/describe b/gcloud/iam/oauth-clients/credentials/describe new file mode 100644 index 000000000..999c86f4d --- /dev/null +++ b/gcloud/iam/oauth-clients/credentials/describe @@ -0,0 +1,80 @@ +NAME + gcloud iam oauth-clients credentials describe - describe an OAuth client + credential + +SYNOPSIS + gcloud iam oauth-clients credentials describe + (CREDENTIAL : --location=LOCATION --oauth-client=OAUTH_CLIENT) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe an OAuth client credential. + +EXAMPLES + To describe the OAuth client credential with ID my-oauth-client-credential + in the default project, run: + + $ gcloud iam oauth-clients credentials describe \ + my-oauth-client-credential --location="global" \ + --oauth-client="my-oauth-client" + +POSITIONAL ARGUMENTS + Oauth client credential resource - The OAuth client credential 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 credential 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. + + CREDENTIAL + ID of the oauth client credential or fully qualified identifier for + the oauth client credential. + + To set the credential attribute: + ▸ provide the argument credential 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 name. + + To set the location attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --oauth-client=OAUTH_CLIENT + ID to use for the OAuth client, which becomes the final component of + the resource name. This value should be 4-32 characters, and may + contain the characters [a-z0-9-]. The prefix gcp- is reserved for use + by Google, and may not be specified. + + To set the oauth-client attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --oauth-client on the command line. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This variant is also available: + + $ gcloud alpha iam oauth-clients credentials describe + diff --git a/gcloud/iam/oauth-clients/credentials/help b/gcloud/iam/oauth-clients/credentials/help new file mode 100644 index 000000000..029ee92c3 --- /dev/null +++ b/gcloud/iam/oauth-clients/credentials/help @@ -0,0 +1,39 @@ +NAME + gcloud iam oauth-clients credentials - create and manage OAuth client + credentials + +SYNOPSIS + gcloud iam oauth-clients credentials COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + The gcloud iam oauth-clients credentials group lets you create and manage + OAuth client credentials for projects on the Google Cloud Platform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create an OAuth client credential. + + delete + Delete an OAuth client credential. + + describe + Describe an OAuth client credential. + + list + List OAuth client credentials. + + update + Update an OAuth client credential. + +NOTES + This variant is also available: + + $ gcloud alpha iam oauth-clients credentials + diff --git a/gcloud/iam/oauth-clients/credentials/list b/gcloud/iam/oauth-clients/credentials/list new file mode 100644 index 000000000..17a020842 --- /dev/null +++ b/gcloud/iam/oauth-clients/credentials/list @@ -0,0 +1,86 @@ +NAME + gcloud iam oauth-clients credentials list - list OAuth client credentials + +SYNOPSIS + gcloud iam oauth-clients credentials list + (--oauth-client=OAUTH_CLIENT : --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List OAuth client credentials. + +EXAMPLES + To list all OAuth client credentials in the default project, run: + + $ gcloud iam oauth-clients credentials list --location="global" \ + --oauth-client="my-oauth-client" + +REQUIRED FLAGS + Oauth client resource - The OAuth client you want to list credentials 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 --oauth-client 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. + + --oauth-client=OAUTH_CLIENT + ID of the oauth client or fully qualified identifier for the oauth + client. + + To set the oauth-client attribute: + ▸ provide the argument --oauth-client on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + The location name. + + To set the location attribute: + ▸ provide the argument --oauth-client on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +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. + + --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. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This variant is also available: + + $ gcloud alpha iam oauth-clients credentials list + diff --git a/gcloud/iam/oauth-clients/credentials/update b/gcloud/iam/oauth-clients/credentials/update new file mode 100644 index 000000000..c63bfefe8 --- /dev/null +++ b/gcloud/iam/oauth-clients/credentials/update @@ -0,0 +1,91 @@ +NAME + gcloud iam oauth-clients credentials update - update an OAuth client + credential + +SYNOPSIS + gcloud iam oauth-clients credentials update + (CREDENTIAL : --location=LOCATION --oauth-client=OAUTH_CLIENT) + [--disabled] [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update an OAuth client credential. + +EXAMPLES + To update the OAuth client credential with ID my-oauth-client-credential in + the default project, run: + + $ gcloud iam oauth-clients credentials update \ + my-oauth-client-credential --location="global" \ + --oauth-client="my-oauth-client" \ + --display-name="My OAuth client credential" --disabled + +POSITIONAL ARGUMENTS + Oauth client credential resource - The OAuth client credential to update. + 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 credential 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. + + CREDENTIAL + ID of the oauth client credential or fully qualified identifier for + the oauth client credential. + + To set the credential attribute: + ▸ provide the argument credential 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 name. + + To set the location attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --oauth-client=OAUTH_CLIENT + ID to use for the OAuth client, which becomes the final component of + the resource name. This value should be 4-32 characters, and may + contain the characters [a-z0-9-]. The prefix gcp- is reserved for use + by Google, and may not be specified. + + To set the oauth-client attribute: + ▸ provide the argument credential on the command line with a fully + specified name; + ▸ provide the argument --oauth-client on the command line. + +FLAGS + --disabled + Disables the OAuth client credential. You cannot use a disabled OAuth + client credential for OAuth. Include --no-disabled to enable a disabled + OAuth client credential. + + --display-name=DISPLAY_NAME + A display name for the OAuth client credential. Cannot exceed 32 + characters. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This variant is also available: + + $ gcloud alpha iam oauth-clients credentials update + diff --git a/gcloud/iam/oauth-clients/delete b/gcloud/iam/oauth-clients/delete new file mode 100644 index 000000000..5f7462b73 --- /dev/null +++ b/gcloud/iam/oauth-clients/delete @@ -0,0 +1,65 @@ +NAME + gcloud iam oauth-clients delete - delete an OAuth client + +SYNOPSIS + gcloud iam oauth-clients delete (OAUTH_CLIENT : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete an OAuth client. + +EXAMPLES + The following command deletes the OAuth client with the ID my-oauth-client + in the default project: + + $ gcloud iam oauth-clients delete my-oauth-client --location="global" + +POSITIONAL ARGUMENTS + Oauth client resource - The OAuth client 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 oauth_client 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. + + OAUTH_CLIENT + ID of the oauth client or fully qualified identifier for the oauth + client. + + To set the oauth_client attribute: + ▸ provide the argument oauth_client 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 name. + + To set the location attribute: + ▸ provide the argument oauth_client on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This variant is also available: + + $ gcloud alpha iam oauth-clients delete + diff --git a/gcloud/iam/oauth-clients/describe b/gcloud/iam/oauth-clients/describe new file mode 100644 index 000000000..60bba251a --- /dev/null +++ b/gcloud/iam/oauth-clients/describe @@ -0,0 +1,66 @@ +NAME + gcloud iam oauth-clients describe - describe an OAuth client + +SYNOPSIS + gcloud iam oauth-clients describe (OAUTH_CLIENT : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe an OAuth client. + +EXAMPLES + The following command describes the OAuth client with the ID + my-oauth-client in the default project: + + $ gcloud iam oauth-clients describe my-oauth-client \ + --location="global" + +POSITIONAL ARGUMENTS + Oauth client resource - The OAuth client 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 oauth_client 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. + + OAUTH_CLIENT + ID of the oauth client or fully qualified identifier for the oauth + client. + + To set the oauth_client attribute: + ▸ provide the argument oauth_client 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 name. + + To set the location attribute: + ▸ provide the argument oauth_client on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This variant is also available: + + $ gcloud alpha iam oauth-clients describe + diff --git a/gcloud/iam/oauth-clients/help b/gcloud/iam/oauth-clients/help new file mode 100644 index 000000000..29f8e4ec1 --- /dev/null +++ b/gcloud/iam/oauth-clients/help @@ -0,0 +1,47 @@ +NAME + gcloud iam oauth-clients - create and manage OAuth clients + +SYNOPSIS + gcloud iam oauth-clients GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + The gcloud iam oauth-clients group lets you create and manage OAuth clients + for projects on the Google Cloud Platform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + credentials + Create and manage OAuth client credentials. + +COMMANDS + COMMAND is one of the following: + + create + Create an OAuth client. + + delete + Delete an OAuth client. + + describe + Describe an OAuth client. + + list + List OAuth clients. + + undelete + Undelete an OAuth client. + + update + Update an OAuth client. + +NOTES + This variant is also available: + + $ gcloud alpha iam oauth-clients + diff --git a/gcloud/iam/oauth-clients/list b/gcloud/iam/oauth-clients/list new file mode 100644 index 000000000..8cac66aeb --- /dev/null +++ b/gcloud/iam/oauth-clients/list @@ -0,0 +1,83 @@ +NAME + gcloud iam oauth-clients list - list OAuth clients + +SYNOPSIS + gcloud iam oauth-clients list --location=LOCATION [--show-deleted] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List OAuth clients. + +EXAMPLES + The following command lists all OAuth clients in the default project, + including the soft-deleted ones: + + $ gcloud iam oauth-clients list --location="global" --show-deleted + +REQUIRED FLAGS + Location resource - The location you want to list OAuth clients for. 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 --location 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. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. + + To set the location attribute: + ▸ provide the argument --location on the command line. + +FLAGS + --show-deleted + Whether to return soft-deleted OAuth clients. + +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. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This variant is also available: + + $ gcloud alpha iam oauth-clients list + diff --git a/gcloud/iam/oauth-clients/undelete b/gcloud/iam/oauth-clients/undelete new file mode 100644 index 000000000..cb692e3fa --- /dev/null +++ b/gcloud/iam/oauth-clients/undelete @@ -0,0 +1,66 @@ +NAME + gcloud iam oauth-clients undelete - undelete an OAuth client + +SYNOPSIS + gcloud iam oauth-clients undelete (OAUTH_CLIENT : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Undelete an OAuth client. + +EXAMPLES + The following command undeletes the OAuth client with the ID + my-oauth-client in the default project: + + $ gcloud iam oauth-clients undelete my-oauth-client \ + --location="global" + +POSITIONAL ARGUMENTS + Oauth client resource - The OAuth client to undelete. 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 oauth_client 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. + + OAUTH_CLIENT + ID of the oauth client or fully qualified identifier for the oauth + client. + + To set the oauth_client attribute: + ▸ provide the argument oauth_client 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 name. + + To set the location attribute: + ▸ provide the argument oauth_client on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This variant is also available: + + $ gcloud alpha iam oauth-clients undelete + diff --git a/gcloud/iam/oauth-clients/update b/gcloud/iam/oauth-clients/update new file mode 100644 index 000000000..e74276184 --- /dev/null +++ b/gcloud/iam/oauth-clients/update @@ -0,0 +1,112 @@ +NAME + gcloud iam oauth-clients update - update an OAuth client + +SYNOPSIS + gcloud iam oauth-clients update (OAUTH_CLIENT : --location=LOCATION) + [--allowed-grant-types=[ALLOWED_GRANT_TYPES,...]] + [--allowed-redirect-uris=[ALLOWED_REDIRECT_URIS,...]] + [--allowed-scopes=[ALLOWED_SCOPES,...]] [--description=DESCRIPTION] + [--disabled] [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update an OAuth Client. + +EXAMPLES + The following command updates the OAuth client with ID my-oauth-client in + the default project: + + $ gcloud iam oauth-clients update my-oauth-client \ + --location="global" --display-name="My oauth client" \ + --description="My oauth client description" --disabled \ + --allowed-grant-types="authorization-code-grant,refresh-token-gr\ + ant" \ + --allowed-scopes="https://www.googleapis.com/auth/cloud-platform\ + ,openid" --allowed-redirect-uris="http://localhost/" + +POSITIONAL ARGUMENTS + Oauth client resource - The OAuth client to update. 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 oauth_client 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. + + OAUTH_CLIENT + ID of the oauth client or fully qualified identifier for the oauth + client. + + To set the oauth_client attribute: + ▸ provide the argument oauth_client 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 name. + + To set the location attribute: + ▸ provide the argument oauth_client on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --allowed-grant-types=[ALLOWED_GRANT_TYPES,...] + A list of OAuth grant types that are allowed for the OAuth client. + + The following grant types are currently supported: + + ◆ authorization-code-grant + + ◆ refresh-token-grant + + --allowed-redirect-uris=[ALLOWED_REDIRECT_URIS,...] + A list of redirect uris that is allowed for redirecting when the + authorization is completed. + + --allowed-scopes=[ALLOWED_SCOPES,...] + A list of scopes that the OAuth client is allowed to request during + OAuth flows. + + The following scopes are currently supported: + + ◆ https://www.googleapis.com/auth/cloud-platform: View, edit, + configure, and delete your Google Cloud data, and view the email + address for your Google Account. + + ◆ openid: Associate you with your personal info on Google Cloud. + + ◆ email: View your Google Cloud Account email address. + + --description=DESCRIPTION + A description of the OAuth client. Cannot exceed 256 characters. + + --disabled + Disables the OAuth client. You cannot use a disabled OAuth client for + login. Include --no-disabled to enable a disabled OAuth client. + + --display-name=DISPLAY_NAME + A display name for the OAuth client. Cannot exceed 32 characters. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This variant is also available: + + $ gcloud alpha iam oauth-clients update + diff --git a/gcloud/iap/web/disable b/gcloud/iap/web/disable index 3d6e7c63f..5edad7cbf 100644 --- a/gcloud/iap/web/disable +++ b/gcloud/iap/web/disable @@ -3,7 +3,8 @@ NAME an IAP resource SYNOPSIS - gcloud iap web disable [--resource-type=RESOURCE_TYPE : --service=SERVICE] + gcloud iap web disable + [--resource-type=RESOURCE_TYPE : --region=REGION --service=SERVICE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -15,16 +16,25 @@ EXAMPLES $ gcloud iap web disable --resource-type=app-engine - To disable IAP on a backend service, run: + To disable IAP on a global backend service, run: $ gcloud iap web disable --resource-type=backend-services \ --service=SERVICE_ID + To disable IAP on a region backend service, run: + + $ gcloud iap web disable --resource-type=backend-services \ + --service=SERVICE_ID --region=REGION + FLAGS --resource-type=RESOURCE_TYPE Resource type of the IAP resource. RESOURCE_TYPE must be one of: app-engine, backend-services. + --region=REGION + Region name. Not applicable for app-engine. Optional when resource-type + is compute. + --service=SERVICE Service name. Required with --resource-type=backend-services. diff --git a/gcloud/iap/web/enable b/gcloud/iap/web/enable index d2d2e6808..a3a882a86 100644 --- a/gcloud/iap/web/enable +++ b/gcloud/iap/web/enable @@ -6,7 +6,7 @@ SYNOPSIS gcloud iap web enable [--oauth2-client-id=OAUTH2_CLIENT_ID --oauth2-client-secret=OAUTH2_CLIENT_SECRET] - [--resource-type=RESOURCE_TYPE : --service=SERVICE] + [--resource-type=RESOURCE_TYPE : --region=REGION --service=SERVICE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -20,12 +20,18 @@ EXAMPLES $ gcloud iap web enable --resource-type=app-engine \ --oauth2-client-id=CLIENT_ID --oauth2-client-secret=SECRET - To enable IAP on a backend service, run: + To enable IAP on a global backend service, run: $ gcloud iap web enable --resource-type=backend-services \ --oauth2-client-id=CLIENT_ID --oauth2-client-secret=SECRET \ --service=SERVICE_ID + To enable IAP on a region backend service, run: + + $ gcloud iap web enable --resource-type=backend-services \ + --oauth2-client-id=CLIENT_ID --oauth2-client-secret=SECRET \ + --service=SERVICE_ID --region=REGION + FLAGS --oauth2-client-id=OAUTH2_CLIENT_ID OAuth 2.0 client ID to use. @@ -37,6 +43,10 @@ FLAGS Resource type of the IAP resource. RESOURCE_TYPE must be one of: app-engine, backend-services. + --region=REGION + Region name. Not applicable for app-engine. Optional when resource-type + is compute. + --service=SERVICE Service name. Required with --resource-type=backend-services. diff --git a/gcloud/network-connectivity/regional-endpoints/create b/gcloud/network-connectivity/regional-endpoints/create index 7625017e7..8b55b03f8 100644 --- a/gcloud/network-connectivity/regional-endpoints/create +++ b/gcloud/network-connectivity/regional-endpoints/create @@ -60,9 +60,13 @@ REQUIRED FLAGS OPTIONAL FLAGS --address=ADDRESS - The IPv4 address or address resource URI of the Regional Endpoint. When - no address value is provided, an IP from the subnetwork is allocated. - IPv6 address support is not available yet. + The IP Address of the Regional Endpoint. When no address is provided, + an IP from the subnetwork is allocated. Use one of the following + formats: + ◆ IPv4 address as in ``10.0.0.1"" + ◆ Address resource URI as in + ``projects/{project}/regions/{region}/addresses/{address_name} for an + IPv4 or IPv6 address."" --async Return immediately, without waiting for the operation in progress to diff --git a/gcloud/network-connectivity/spokes/linked-interconnect-attachments/create b/gcloud/network-connectivity/spokes/linked-interconnect-attachments/create index dd42c2c44..7345222ee 100644 --- a/gcloud/network-connectivity/spokes/linked-interconnect-attachments/create +++ b/gcloud/network-connectivity/spokes/linked-interconnect-attachments/create @@ -6,7 +6,7 @@ SYNOPSIS gcloud network-connectivity spokes linked-interconnect-attachments create (SPOKE : --region=REGION) --hub=HUB --interconnect-attachments=[INTERCONNECT_ATTACHMENTS,...] [--async] - [--description=DESCRIPTION] + [--description=DESCRIPTION] [--group=GROUP] [--include-import-ranges=[INCLUDE_IMPORT_RANGES,...]] [--labels=[KEY=VALUE,...]] [--site-to-site-data-transfer] [GCLOUD_WIDE_FLAG ...] @@ -76,6 +76,10 @@ OPTIONAL FLAGS --description=DESCRIPTION Description of the spoke to create. + --group=GROUP + The group that the spoke will be added to. The group must already + exist. If unset, the spoke will be added to the ``default`` group. + --include-import-ranges=[INCLUDE_IMPORT_RANGES,...] IP address range(s) allowed to be imported from hub subnets. Only ``ALL_IPV4_RANGES`` can be added to the list. If it's empty, the spoke diff --git a/gcloud/network-connectivity/spokes/linked-router-appliances/create b/gcloud/network-connectivity/spokes/linked-router-appliances/create index 99bb4d5a7..ec6326e28 100644 --- a/gcloud/network-connectivity/spokes/linked-router-appliances/create +++ b/gcloud/network-connectivity/spokes/linked-router-appliances/create @@ -6,7 +6,7 @@ SYNOPSIS gcloud network-connectivity spokes linked-router-appliances create (SPOKE : --region=REGION) --hub=HUB --router-appliance=[instance=INSTANCE],[ip=IP] [--async] - [--description=DESCRIPTION] + [--description=DESCRIPTION] [--group=GROUP] [--include-import-ranges=[INCLUDE_IMPORT_RANGES,...]] [--labels=[KEY=VALUE,...]] [--site-to-site-data-transfer] [GCLOUD_WIDE_FLAG ...] @@ -83,6 +83,10 @@ OPTIONAL FLAGS --description=DESCRIPTION Description of the spoke to create. + --group=GROUP + The group that the spoke will be added to. The group must already + exist. If unset, the spoke will be added to the ``default`` group. + --include-import-ranges=[INCLUDE_IMPORT_RANGES,...] IP address range(s) allowed to be imported from hub subnets. Only ``ALL_IPV4_RANGES`` can be added to the list. If it's empty, the spoke diff --git a/gcloud/network-connectivity/spokes/linked-vpn-tunnels/create b/gcloud/network-connectivity/spokes/linked-vpn-tunnels/create index 049315767..fb8dda8a1 100644 --- a/gcloud/network-connectivity/spokes/linked-vpn-tunnels/create +++ b/gcloud/network-connectivity/spokes/linked-vpn-tunnels/create @@ -5,7 +5,7 @@ NAME SYNOPSIS gcloud network-connectivity spokes linked-vpn-tunnels create (SPOKE : --region=REGION) --hub=HUB --vpn-tunnels=[VPN_TUNNELS,...] - [--async] [--description=DESCRIPTION] + [--async] [--description=DESCRIPTION] [--group=GROUP] [--include-import-ranges=[INCLUDE_IMPORT_RANGES,...]] [--labels=[KEY=VALUE,...]] [--site-to-site-data-transfer] [GCLOUD_WIDE_FLAG ...] @@ -74,6 +74,10 @@ OPTIONAL FLAGS --description=DESCRIPTION Description of the spoke to create. + --group=GROUP + The group that the spoke will be added to. The group must already + exist. If unset, the spoke will be added to the ``default`` group. + --include-import-ranges=[INCLUDE_IMPORT_RANGES,...] IP address range(s) allowed to be imported from hub subnets. Only ``ALL_IPV4_RANGES`` can be added to the list. If it's empty, the spoke diff --git a/gcloud/network-management/connectivity-tests/create b/gcloud/network-management/connectivity-tests/create index c6a80beed..e279f0983 100644 --- a/gcloud/network-management/connectivity-tests/create +++ b/gcloud/network-management/connectivity-tests/create @@ -18,7 +18,8 @@ SYNOPSIS --source-gke-master-cluster=SOURCE_GKE_MASTER_CLUSTER --source-instance=SOURCE_INSTANCE --source-ip-address=SOURCE_IP_ADDRESS) [--async] - [--description=DESCRIPTION] [--destination-network=DESTINATION_NETWORK] + [--description=DESCRIPTION] [--destination-fqdn=DESTINATION_FQDN] + [--destination-network=DESTINATION_NETWORK] [--destination-port=DESTINATION_PORT] [--destination-project=DESTINATION_PROJECT] [--labels=[KEY=VALUE,...]] [--other-projects=[OTHER_PROJECTS,...]] [--protocol=PROTOCOL] @@ -118,6 +119,10 @@ OPTIONAL FLAGS --description=DESCRIPTION The description of the connectivity test. + --destination-fqdn=DESTINATION_FQDN + A hostname as the destination endpoint. Only applicable for Google + Kubernetes Engine. + --destination-network=DESTINATION_NETWORK A VPC network URI where the destination is located. diff --git a/gcloud/network-management/connectivity-tests/update b/gcloud/network-management/connectivity-tests/update index c14080819..576d4f70b 100644 --- a/gcloud/network-management/connectivity-tests/update +++ b/gcloud/network-management/connectivity-tests/update @@ -5,6 +5,7 @@ NAME SYNOPSIS gcloud network-management connectivity-tests update CONNECTIVITY_TEST [--async] [--description=DESCRIPTION] + [--destination-fqdn=DESTINATION_FQDN] [--destination-network=DESTINATION_NETWORK] [--destination-port=DESTINATION_PORT] [--destination-project=DESTINATION_PROJECT] [--labels=[KEY=VALUE,...]] @@ -79,6 +80,10 @@ FLAGS --description=DESCRIPTION The description of the connectivity test. + --destination-fqdn=DESTINATION_FQDN + A hostname as the destination endpoint. Only applicable for Google + Kubernetes Engine. + --destination-network=DESTINATION_NETWORK A VPC network URI where the destination is located. diff --git a/gcloud/sql/instances/create b/gcloud/sql/instances/create index 12563f40d..dceaec50c 100644 --- a/gcloud/sql/instances/create +++ b/gcloud/sql/instances/create @@ -489,8 +489,8 @@ FLAGS established from specified consumer projects. --enable-private-service-connect - When the flag is set, a Cloud SQL instance will be created with Private - Service Connect enabled. + Enable connecting to the Cloud SQL instance with Private Service + Connect. Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the instance. The 'Compute Engine Service Agent' diff --git a/gcloud/sql/instances/patch b/gcloud/sql/instances/patch index 6dbf27c96..16a36b077 100644 --- a/gcloud/sql/instances/patch +++ b/gcloud/sql/instances/patch @@ -7,7 +7,8 @@ SYNOPSIS [--async] [--audit-bucket-path=AUDIT_BUCKET_PATH] [--audit-retention-interval=AUDIT_RETENTION_INTERVAL] [--audit-upload-interval=AUDIT_UPLOAD_INTERVAL] - [--availability-type=AVAILABILITY_TYPE] [--clear-password-policy] + [--availability-type=AVAILABILITY_TYPE] + [--clear-failover-dr-replica-name] [--clear-password-policy] [--connector-enforcement=CONNECTOR_ENFORCEMENT] [--cpu=CPU] [--database-version=DATABASE_VERSION] [--[no-]deletion-protection] [--deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE] @@ -18,7 +19,9 @@ SYNOPSIS [--[no-]enable-dataplex-integration] [--[no-]enable-google-ml-integration] [--[no-]enable-google-private-path] [--enable-password-policy] - [--enable-point-in-time-recovery] [--follow-gae-app=FOLLOW_GAE_APP] + [--enable-point-in-time-recovery] + [--failover-dr-replica-name=FAILOVER_DR_REPLICA_NAME] + [--follow-gae-app=FOLLOW_GAE_APP] [--[no-]insights-config-query-insights-enabled] [--insights-config-query-plans-per-minute=INSIGHTS_CONFIG_QUERY_PLANS_PER_MINUTE] [--insights-config-query-string-length=INSIGHTS_CONFIG_QUERY_STRING_LENGTH] @@ -109,6 +112,10 @@ FLAGS zonal Provides no failover capability. This is the default. + --clear-failover-dr-replica-name + Clear the DR replica setting for the primary instance. Flag is only + available for MySQL and PostgreSQL database instances. + --clear-password-policy Clear the existing password policy. This flag is only available for Postgres. @@ -213,6 +220,12 @@ FLAGS fraction of a second, via write-ahead logs. Must have automatic backups enabled to use. Make sure storage can support at least 7 days of logs. + --failover-dr-replica-name=FAILOVER_DR_REPLICA_NAME + Set a Disaster Recovery (DR) replica with the specified name for the + primary instance. This must be one of the existing cross region + replicas of the primary instance. Flag is only available for MySQL and + PostgreSQL database instances. + --follow-gae-app=FOLLOW_GAE_APP First Generation instances only. The App Engine app this instance should follow. It must be in the same region as the instance. WARNING: diff --git a/gcloud/storage/buckets/create b/gcloud/storage/buckets/create index b51f96d56..79aaeab2f 100644 --- a/gcloud/storage/buckets/create +++ b/gcloud/storage/buckets/create @@ -11,7 +11,7 @@ SYNOPSIS [--enable-hierarchical-namespace] [--enable-per-object-retention] [--location=LOCATION, -l LOCATION] [--[no-]pap, --[no-]public-access-prevention] - [--placement=REGION,REGION] + [--placement=[REGION,...]] [--recovery-point-objective=SETTING, --rpo=SETTING] [--retention-period=RETENTION_PERIOD] [--soft-delete-duration=SOFT_DELETE_DURATION] @@ -77,9 +77,8 @@ FLAGS --public-access-prevention to enable and --no-public-access-prevention to disable. - --placement=REGION,REGION - A comma-separated list of exactly 2 regions that form the custom - [dual-region] + --placement=[REGION,...] + A comma-separated list of regions that form the custom [dual-region] (https://cloud.google.com/storage/docs/locations#location-dr). Only regions within the same continent are or will ever be valid. Invalid location pairs (such as mixed-continent, or with unsupported regions) diff --git a/gcloud/transfer/agents/install b/gcloud/transfer/agents/install index bb44ac62a..2a5efb622 100644 --- a/gcloud/transfer/agents/install +++ b/gcloud/transfer/agents/install @@ -3,7 +3,7 @@ NAME SYNOPSIS gcloud transfer agents install --pool=POOL [--count=COUNT] - [--creds-file=CREDS_FILE] [--docker-network=DOCKER_NETWORK] + [--creds-file=CREDS_FILE] [--docker-network=NETWORK] [--[no-]enable-multipart] [--id-prefix=ID_PREFIX] [--logs-directory=LOGS_DIRECTORY; default="/tmp"] [--memlock-limit=MEMLOCK_LIMIT; default=64000000] @@ -63,13 +63,12 @@ FLAGS Note that the credentials location will be mounted to the agent container. - --docker-network=DOCKER_NETWORK - Specify the network to connect the Docker container to. This flag maps + --docker-network=NETWORK + Specify the network to connect the container to. This flag maps directly to the --network flag in the underlying 'docker run' command. - If binding directly to the Docker host's network is an option, then - setting this value to 'host' can dramatically improve transfer - performance. + If binding directly to the host's network is an option, then setting + this value to 'host' can dramatically improve transfer performance. --[no-]enable-multipart Split up files and transfer the resulting chunks in parallel before