diff --git a/gcloud/_version b/gcloud/_version index 206f14cef..33dbf92f7 100644 --- a/gcloud/_version +++ b/gcloud/_version @@ -1,8 +1,8 @@ -Google Cloud SDK 472.0.0 -alpha 2024.04.12 -beta 2024.04.12 +Google Cloud SDK 474.0.0 +alpha 2024.04.26 +beta 2024.04.26 bq 2.1.4 bundled-python3-unix 3.11.8 -core 2024.04.12 +core 2024.04.26 gcloud-crc32c 1.0.0 gsutil 5.27 diff --git a/gcloud/alloydb/clusters/create b/gcloud/alloydb/clusters/create index a992fa492..15ce55926 100644 --- a/gcloud/alloydb/clusters/create +++ b/gcloud/alloydb/clusters/create @@ -19,6 +19,8 @@ SYNOPSIS : --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT] --automated-backup-retention-count=RETENTION_COUNT | --automated-backup-retention-period=RETENTION_PERIOD]] [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] + [--maintenance-window-day=MAINTENANCE_WINDOW_DAY + --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -254,6 +256,22 @@ OPTIONAL FLAGS ▸ provide the argument --kms-project on the command line; ▸ set the property core/project. + Specify preferred day and time for maintenance. + + --maintenance-window-day=MAINTENANCE_WINDOW_DAY + Day of week for maintenance window, in UTC time zone. + MAINTENANCE_WINDOW_DAY must be one of: MONDAY, TUESDAY, WEDNESDAY, + THURSDAY, FRIDAY, SATURDAY, SUNDAY. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR + Hour of day for maintenance window, in UTC time zone. + + This flag argument must be specified if any of the other arguments in + this group are specified. + 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/alloydb/clusters/create-secondary b/gcloud/alloydb/clusters/create-secondary index 3d57e0e93..4a2379b75 100644 --- a/gcloud/alloydb/clusters/create-secondary +++ b/gcloud/alloydb/clusters/create-secondary @@ -6,6 +6,11 @@ SYNOPSIS gcloud alloydb clusters create-secondary CLUSTER --primary-cluster=PRIMARY_CLUSTER --region=REGION [--allocated-ip-range-name=ALLOCATED_IP_RANGE_NAME] [--async] + [--automated-backup-days-of-week=[DAYS_OF_WEEK,...] + --automated-backup-start-times=[START_TIMES,...] + --automated-backup-window=TIMEOUT_PERIOD --enable-automated-backup + [--automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY + : --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT] --automated-backup-retention-count=RETENTION_COUNT | --automated-backup-retention-period=RETENTION_PERIOD] [--continuous-backup-recovery-window-days=RECOVERY_PERIOD --enable-continuous-backup [--continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY @@ -50,6 +55,88 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. + Automated backup policy. If unspecified, automated backups are copied from + the associated primary cluster. + + --automated-backup-days-of-week=[DAYS_OF_WEEK,...] + Comma-separated list of days of the week to perform a backup. At + least one day of the week must be provided. (e.g., + --automated-backup-days-of-week=MONDAY,WEDNESDAY,SUNDAY). + DAYS_OF_WEEK must be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, + FRIDAY, SATURDAY, SUNDAY. + + --automated-backup-start-times=[START_TIMES,...] + Comma-separated list of times during the day to start a backup. At + least one start time must be provided. The start times are assumed to + be in UTC and required to be an exact hour in the format HH:00. + (e.g., --automated-backup-start-times=01:00,13:00) + + --automated-backup-window=TIMEOUT_PERIOD + The length of the time window beginning at start time during which a + backup can be taken. If a backup does not succeed within this time + window, it will be canceled and considered failed. The backup window + must be at least 5 minutes long. There is no upper bound on the + window. If not set, it will default to 1 hour. + + --enable-automated-backup + Enables Automated Backups on the cluster. + + Key resource - The Cloud KMS (Key Management Service) cryptokey that + will be used to protect the automated backups. The 'AlloyDB 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. + + --automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY + ID of the key or fully qualified identifier for the key. + + To set the kms-key attribute: + ▫ provide the argument --automated-backup-encryption-key on the + command line. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING + The KMS keyring of the key. + + To set the kms-keyring attribute: + ▫ provide the argument --automated-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --automated-backup-encryption-key-keyring + on the command line. + + --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION + The Google Cloud location for the key. + + To set the kms-location attribute: + ▫ provide the argument --automated-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --automated-backup-encryption-key-location + on the command line. + + --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT + The Google Cloud project for the key. + + To set the kms-project attribute: + ▫ provide the argument --automated-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --automated-backup-encryption-key-project + on the command line; + ▫ set the property core/project. + + Retention policy. If no retention policy is provided, all automated + backups will be retained. + + At most one of these can be specified: + + --automated-backup-retention-count=RETENTION_COUNT + Number of most recent successful backups retained. + + --automated-backup-retention-period=RETENTION_PERIOD + Retention period of the backup relative to creation time. See $ + gcloud topic datetimes for information on duration formats. + Continuous Backup configuration. If unspecified, continuous backups are copied from the associated primary cluster. diff --git a/gcloud/alloydb/clusters/update b/gcloud/alloydb/clusters/update index 1a2c835e0..d6c271a70 100644 --- a/gcloud/alloydb/clusters/update +++ b/gcloud/alloydb/clusters/update @@ -13,6 +13,9 @@ SYNOPSIS [--continuous-backup-recovery-window-days=RECOVERY_PERIOD --enable-continuous-backup --clear-continuous-backup-encryption-key | [--continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY : --continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING --continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION --continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT]] + [--maintenance-window-any + | --maintenance-window-day=MAINTENANCE_WINDOW_DAY + --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -191,6 +194,29 @@ OPTIONAL FLAGS --continuous-backup-encryption-key-project on the command line; ◇ set the property core/project. + Configure a preferred maintenance window. + + At most one of these can be specified: + + --maintenance-window-any + Remove the user-specified maintenance window. + + Specify preferred day and time for maintenance. + + --maintenance-window-day=MAINTENANCE_WINDOW_DAY + Day of week for maintenance window, in UTC time zone. + MAINTENANCE_WINDOW_DAY must be one of: MONDAY, TUESDAY, WEDNESDAY, + THURSDAY, FRIDAY, SATURDAY, SUNDAY. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR + Hour of day for maintenance window, in UTC time zone. + + This flag argument must be specified if any of the other arguments + in this group are specified. + 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/ai/endpoints/deploy-model b/gcloud/alpha/ai/endpoints/deploy-model index 96f5471f4..cb1b7917e 100644 --- a/gcloud/alpha/ai/endpoints/deploy-model +++ b/gcloud/alpha/ai/endpoints/deploy-model @@ -11,7 +11,7 @@ SYNOPSIS [--enable-container-logging] [--machine-type=MACHINE_TYPE] [--max-replica-count=MAX_REPLICA_COUNT] [--min-replica-count=MIN_REPLICA_COUNT] - [--service-account=SERVICE_ACCOUNT] + [--service-account=SERVICE_ACCOUNT] [--tpu-topology=TPU_TOPOLOGY] [--traffic-split=[DEPLOYED_MODEL_ID=VALUE,...]] [--shared-resources=SHARED_RESOURCES : --shared-resources-region=SHARED_RESOURCES_REGION] @@ -136,6 +136,11 @@ OPTIONAL FLAGS not specified, the container runs as a service account that doesn't have access to the resource project. + --tpu-topology=TPU_TOPOLOGY + CloudTPU topology to use for this deployment. Required for multihost + CloudTPU deployments: + https://cloud.google.com/kubernetes-engine/docs/concepts/tpus#topology. + --traffic-split=[DEPLOYED_MODEL_ID=VALUE,...] List of pairs of deployed model id and value to set as traffic split. diff --git a/gcloud/alpha/alloydb/clusters/create b/gcloud/alpha/alloydb/clusters/create index 0d9431f27..08505a9b5 100644 --- a/gcloud/alpha/alloydb/clusters/create +++ b/gcloud/alpha/alloydb/clusters/create @@ -19,6 +19,8 @@ SYNOPSIS : --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT] --automated-backup-retention-count=RETENTION_COUNT | --automated-backup-retention-period=RETENTION_PERIOD]] [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] + [--maintenance-window-day=MAINTENANCE_WINDOW_DAY + --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -254,6 +256,22 @@ OPTIONAL FLAGS ▸ provide the argument --kms-project on the command line; ▸ set the property core/project. + Specify preferred day and time for maintenance. + + --maintenance-window-day=MAINTENANCE_WINDOW_DAY + Day of week for maintenance window, in UTC time zone. + MAINTENANCE_WINDOW_DAY must be one of: MONDAY, TUESDAY, WEDNESDAY, + THURSDAY, FRIDAY, SATURDAY, SUNDAY. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR + Hour of day for maintenance window, in UTC time zone. + + This flag argument must be specified if any of the other arguments in + this group are specified. + 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/alloydb/clusters/create-secondary b/gcloud/alpha/alloydb/clusters/create-secondary index 4a4e80899..01ded5615 100644 --- a/gcloud/alpha/alloydb/clusters/create-secondary +++ b/gcloud/alpha/alloydb/clusters/create-secondary @@ -6,6 +6,11 @@ SYNOPSIS gcloud alpha alloydb clusters create-secondary CLUSTER --primary-cluster=PRIMARY_CLUSTER --region=REGION [--allocated-ip-range-name=ALLOCATED_IP_RANGE_NAME] [--async] + [--automated-backup-days-of-week=[DAYS_OF_WEEK,...] + --automated-backup-start-times=[START_TIMES,...] + --automated-backup-window=TIMEOUT_PERIOD --enable-automated-backup + [--automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY + : --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT] --automated-backup-retention-count=RETENTION_COUNT | --automated-backup-retention-period=RETENTION_PERIOD] [--continuous-backup-recovery-window-days=RECOVERY_PERIOD --enable-continuous-backup [--continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY @@ -50,6 +55,88 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. + Automated backup policy. If unspecified, automated backups are copied from + the associated primary cluster. + + --automated-backup-days-of-week=[DAYS_OF_WEEK,...] + Comma-separated list of days of the week to perform a backup. At + least one day of the week must be provided. (e.g., + --automated-backup-days-of-week=MONDAY,WEDNESDAY,SUNDAY). + DAYS_OF_WEEK must be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, + FRIDAY, SATURDAY, SUNDAY. + + --automated-backup-start-times=[START_TIMES,...] + Comma-separated list of times during the day to start a backup. At + least one start time must be provided. The start times are assumed to + be in UTC and required to be an exact hour in the format HH:00. + (e.g., --automated-backup-start-times=01:00,13:00) + + --automated-backup-window=TIMEOUT_PERIOD + The length of the time window beginning at start time during which a + backup can be taken. If a backup does not succeed within this time + window, it will be canceled and considered failed. The backup window + must be at least 5 minutes long. There is no upper bound on the + window. If not set, it will default to 1 hour. + + --enable-automated-backup + Enables Automated Backups on the cluster. + + Key resource - The Cloud KMS (Key Management Service) cryptokey that + will be used to protect the automated backups. The 'AlloyDB 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. + + --automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY + ID of the key or fully qualified identifier for the key. + + To set the kms-key attribute: + ▫ provide the argument --automated-backup-encryption-key on the + command line. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING + The KMS keyring of the key. + + To set the kms-keyring attribute: + ▫ provide the argument --automated-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --automated-backup-encryption-key-keyring + on the command line. + + --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION + The Google Cloud location for the key. + + To set the kms-location attribute: + ▫ provide the argument --automated-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --automated-backup-encryption-key-location + on the command line. + + --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT + The Google Cloud project for the key. + + To set the kms-project attribute: + ▫ provide the argument --automated-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --automated-backup-encryption-key-project + on the command line; + ▫ set the property core/project. + + Retention policy. If no retention policy is provided, all automated + backups will be retained. + + At most one of these can be specified: + + --automated-backup-retention-count=RETENTION_COUNT + Number of most recent successful backups retained. + + --automated-backup-retention-period=RETENTION_PERIOD + Retention period of the backup relative to creation time. See $ + gcloud topic datetimes for information on duration formats. + Continuous Backup configuration. If unspecified, continuous backups are copied from the associated primary cluster. diff --git a/gcloud/alpha/alloydb/clusters/update b/gcloud/alpha/alloydb/clusters/update index c4ff43461..c6421ef21 100644 --- a/gcloud/alpha/alloydb/clusters/update +++ b/gcloud/alpha/alloydb/clusters/update @@ -13,6 +13,9 @@ SYNOPSIS [--continuous-backup-recovery-window-days=RECOVERY_PERIOD --enable-continuous-backup --clear-continuous-backup-encryption-key | [--continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY : --continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING --continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION --continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT]] + [--maintenance-window-any + | --maintenance-window-day=MAINTENANCE_WINDOW_DAY + --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -191,6 +194,29 @@ OPTIONAL FLAGS --continuous-backup-encryption-key-project on the command line; ◇ set the property core/project. + Configure a preferred maintenance window. + + At most one of these can be specified: + + --maintenance-window-any + Remove the user-specified maintenance window. + + Specify preferred day and time for maintenance. + + --maintenance-window-day=MAINTENANCE_WINDOW_DAY + Day of week for maintenance window, in UTC time zone. + MAINTENANCE_WINDOW_DAY must be one of: MONDAY, TUESDAY, WEDNESDAY, + THURSDAY, FRIDAY, SATURDAY, SUNDAY. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR + Hour of day for maintenance window, in UTC time zone. + + This flag argument must be specified if any of the other arguments + in this group are specified. + 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/artifacts/generic/download b/gcloud/alpha/artifacts/generic/download new file mode 100644 index 000000000..a55b5d76e --- /dev/null +++ b/gcloud/alpha/artifacts/generic/download @@ -0,0 +1,92 @@ +NAME + gcloud alpha artifacts generic download - download a generic artifact from + a generic artifact repository + +SYNOPSIS + gcloud alpha artifacts generic download --destination=DESTINATION + --package=ARTIFACT --version=VERSION [--name=NAME] + [--location=LOCATION --repository=REPOSITORY] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Download a generic artifact from a generic artifact repository. + +EXAMPLES + To download version v0.1.0 of myfile.txt located in a repository in + "us-central1" to /path/to/destination/: + + $ gcloud alpha artifacts generic download --location=us-central1 \ + --project=myproject --repository=myrepo --package=mypackage \ + --version=v0.1.0 --destination=/path/to/destination/ \ + --name=myfile.txt + + To download all files of version v0.1.0 and package mypackage located in a + repository in "us-central1" to /path/to/destination/ while maintaining the + folder hierarchy: + + $ gcloud alpha artifacts generic download --location=us-central1 \ + --project=myproject --repository=myrepo --package=mypackage \ + --version=v0.1.0 --destination=/path/to/destination/ + +REQUIRED FLAGS + --destination=DESTINATION + The path where you want to save the downloaded file. + + --package=ARTIFACT + The artifact to download. + + --version=VERSION + The version of the artifact to download. + +OPTIONAL FLAGS + --name=NAME + If specified, the file name within the artifact to download. + + Repository resource - The Artifact Registry repository. If not specified, + the current artifacts/repository is used. 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 --repository on the command line with a fully + specified name; + ◆ set the property artifacts/repository with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + Location of the repository. + + To set the location attribute: + ▸ provide the argument --repository on the command line with a + fully specified name; + ▸ set the property artifacts/repository with a fully specified + name; + ▸ provide the argument --location on the command line; + ▸ set the property artifacts/location. + + --repository=REPOSITORY + ID of the repository or fully qualified identifier for the + repository. + + To set the repository attribute: + ▸ provide the argument --repository on the command line; + ▸ set the property artifacts/repository. + +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. These variants are also available: + + $ gcloud artifacts generic download + + $ gcloud beta artifacts generic download + diff --git a/gcloud/alpha/iot/devices/commands/help b/gcloud/alpha/artifacts/generic/help similarity index 52% rename from gcloud/alpha/iot/devices/commands/help rename to gcloud/alpha/artifacts/generic/help index f95f49e87..8e9f79c53 100644 --- a/gcloud/alpha/iot/devices/commands/help +++ b/gcloud/alpha/artifacts/generic/help @@ -1,13 +1,11 @@ NAME - gcloud alpha iot devices commands - manage commands for Cloud IoT devices + gcloud alpha artifacts generic - manage Artifact Registry generic artifacts SYNOPSIS - gcloud alpha iot devices commands COMMAND [GCLOUD_WIDE_FLAG ...] + gcloud alpha artifacts generic COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) (DEPRECATED) Manage commands for Cloud IoT devices. - - This command is deprecated. Google Cloud IoT Core has been retired. + (ALPHA) Manage Artifact Registry generic artifacts. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -17,8 +15,11 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: - send - (ALPHA) (DEPRECATED) Sends a command to a device. + download + (ALPHA) Download a generic artifact from a generic artifact repository. + + upload + (ALPHA) Uploads an artifact to a generic repository. NOTES This command is currently in alpha and might change without notice. If this @@ -26,7 +27,7 @@ NOTES project, you might be trying to access an API with an invitation-only early access allowlist. These variants are also available: - $ gcloud iot devices commands + $ gcloud artifacts generic - $ gcloud beta iot devices commands + $ gcloud beta artifacts generic diff --git a/gcloud/alpha/artifacts/generic/upload b/gcloud/alpha/artifacts/generic/upload new file mode 100644 index 000000000..a8d724408 --- /dev/null +++ b/gcloud/alpha/artifacts/generic/upload @@ -0,0 +1,107 @@ +NAME + gcloud alpha artifacts generic upload - uploads an artifact to a generic + repository + +SYNOPSIS + gcloud alpha artifacts generic upload --package=PACKAGE --version=VERSION + (--source=SOURCE | --source-directory=SOURCE_DIRECTORY) [--async] + [--destination-path=DESTINATION_PATH] [--skip-existing] + [--location=LOCATION --repository=REPOSITORY] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Uploads an artifact to a generic repository. + +EXAMPLES + To upload version v0.1.0 of a generic artifact located in /path/to/file/ to + a repository in "us-central1": + + $ gcloud alpha artifacts generic upload --location=us-central1 \ + --project=myproject --repository=myrepo --package=mypackage \ + --version=v0.1.0 --source=/path/to/file/ + + To upload version v0.1.0 of a generic artifact located in /path/to/file/ to + a repository in "us-central1" within a folder structure: + + $ gcloud alpha artifacts generic upload --location=us-central1 \ + --project=myproject --repository=myrepo --package=mypackage \ + --version=v0.1.0 --source=/path/to/file/ \ + --destination-path=folder/file + +REQUIRED FLAGS + --package=PACKAGE + The package to upload. + + --version=VERSION + The version of the package. You cannot overwrite an existing version in + the repository. + + Exactly one of these must be specified: + + --source=SOURCE + The path to the file you are uploading. + + --source-directory=SOURCE_DIRECTORY + The directory you are uploading. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --destination-path=DESTINATION_PATH + Use to specify the path to upload a generic artifact to within a folder + structure. + + --skip-existing + If specified, skip uploading files that already exist in the + repository, and continue to upload the remaining files. + + Repository resource - The Artifact Registry repository. If not specified, + the current artifacts/repository is used. 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 --repository on the command line with a fully + specified name; + ◆ set the property artifacts/repository with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + Location of the repository. + + To set the location attribute: + ▸ provide the argument --repository on the command line with a + fully specified name; + ▸ set the property artifacts/repository with a fully specified + name; + ▸ provide the argument --location on the command line; + ▸ set the property artifacts/location. + + --repository=REPOSITORY + ID of the repository or fully qualified identifier for the + repository. + + To set the repository attribute: + ▸ provide the argument --repository on the command line; + ▸ set the property artifacts/repository. + +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. These variants are also available: + + $ gcloud artifacts generic upload + + $ gcloud beta artifacts generic upload + diff --git a/gcloud/alpha/artifacts/help b/gcloud/alpha/artifacts/help index c9090fbe5..97647180d 100644 --- a/gcloud/alpha/artifacts/help +++ b/gcloud/alpha/artifacts/help @@ -24,6 +24,9 @@ GROUPS files (ALPHA) Manage Artifact Registry files. + generic + (ALPHA) Manage Artifact Registry generic artifacts. + go (ALPHA) Manage Artifact Registry Go modules. diff --git a/gcloud/alpha/beyondcorp/app/help b/gcloud/alpha/beyondcorp/app/help index a9650c71b..f2b872aa7 100644 --- a/gcloud/alpha/beyondcorp/app/help +++ b/gcloud/alpha/beyondcorp/app/help @@ -33,9 +33,6 @@ GROUPS connectors (ALPHA) Create and manipulate beyondcorp connectors. - legacy - (ALPHA) Manages application legacy connectors and connections. - operations (ALPHA) List and Describe beyondcorp appconnector operations. diff --git a/gcloud/alpha/beyondcorp/app/legacy/connections/create b/gcloud/alpha/beyondcorp/app/legacy/connections/create deleted file mode 100644 index 6bb8798fc..000000000 --- a/gcloud/alpha/beyondcorp/app/legacy/connections/create +++ /dev/null @@ -1,134 +0,0 @@ -NAME - gcloud alpha beyondcorp app legacy connections create - create a new - Beyondcorp application legacy connection - -SYNOPSIS - gcloud alpha beyondcorp app legacy connections create - (CONNECTION : --location=LOCATION) - (--application-endpoint=APPLICATION_ENDPOINT - | --application-endpoint-host=APPLICATION_ENDPOINT_HOST - --application-endpoint-port=APPLICATION_ENDPOINT_PORT) [--async] - [--connectors=[CONNECTORS,...]] [--display-name=DISPLAY_NAME] - [--labels=[KEY=VALUE,...]] [--type=TYPE; default="TCP_PROXY"] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) Create a new Beyondcorp application legacy connection. - -EXAMPLES - The following command creates a legacy Connection with ID my-connection - using default tcp type connection: - - $ gcloud alpha beyondcorp app legacy connections create \ - my-connection --location=us-central1 \ - --application-endpoint=localhost:8080 - - The following command creates a legacy Connection with ID my-connection - with explicit project value for all required and optional parameters: - - $ gcloud alpha beyondcorp app legacy connections create \ - my-connection --project=projectId --location=us-central1 \ - --application-endpoint-host=localhost \ - --application-endpoint-port=8080 --type=tcp \ - --connectors=my-connector1,my-connector2 --labels='foo=bar' \ - --display-name=connection-display-name --async - -POSITIONAL ARGUMENTS - Connection resource - The Beyondcorp application connection you want 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 connection on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - This must be specified. - - CONNECTION - ID of the connection or fully qualified identifier for the - connection. - - To set the connection attribute: - ▸ provide the argument connection 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 beyondcorp service. - - To set the location attribute: - ▸ provide the argument connection on the command line with a fully - specified name; - ▸ provide the argument --location on the command line. - -REQUIRED FLAGS - Application endpoint. - - Exactly one of these must be specified: - - --application-endpoint=APPLICATION_ENDPOINT - Address of the remote application endpoint for the Beyondcorp - Connection in form of :. - - --application-endpoint-host=APPLICATION_ENDPOINT_HOST - Hostname or IP address of the remote application endpoint. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --application-endpoint-port=APPLICATION_ENDPOINT_PORT - Port of the remote application endpoint. - - This flag argument must be specified if any of the other arguments in - this group are specified. - -OPTIONAL FLAGS - --async - Return immediately, without waiting for the operation in progress to - complete. - - --connectors=[CONNECTORS,...] - List of connectors name that are authorised to be associated with this - Connection. - - --display-name=DISPLAY_NAME - An arbitrary user-provided name for the connection. Cannot exceed 64 - characters. - - --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. - - --type=TYPE; default="TCP_PROXY" - The type of network connnectivity used by the connection. TYPE must be - (only one value is supported): - - tcp - TCP connection - -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 beyondcorp/v1alpha API. The full documentation for - this API can be found at: https://cloud.google.com/ - -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/beyondcorp/app/legacy/connections/delete b/gcloud/alpha/beyondcorp/app/legacy/connections/delete deleted file mode 100644 index 94e5328fd..000000000 --- a/gcloud/alpha/beyondcorp/app/legacy/connections/delete +++ /dev/null @@ -1,72 +0,0 @@ -NAME - gcloud alpha beyondcorp app legacy connections delete - delete a single - legacy Connection - -SYNOPSIS - gcloud alpha beyondcorp app legacy connections delete - (CONNECTION : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) Delete a single legacy Connection. - -EXAMPLES - To delete a legacy connection named my-connection run: - - $ gcloud alpha beyondcorp app legacy connections delete \ - my-connection --project={project} --location={location} - -POSITIONAL ARGUMENTS - Connection resource - The Beyondcorp connection 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 connection on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - This must be specified. - - CONNECTION - ID of the connection or fully qualified identifier for the - connection. - - To set the connection attribute: - ▸ provide the argument connection 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 beyondcorp service. - - To set the location attribute: - ▸ provide the argument connection 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. - -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 beyondcorp/v1alpha API. The full documentation for - this API can be found at: https://cloud.google.com/ - -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/beyondcorp/app/legacy/connections/describe b/gcloud/alpha/beyondcorp/app/legacy/connections/describe deleted file mode 100644 index bbae026a6..000000000 --- a/gcloud/alpha/beyondcorp/app/legacy/connections/describe +++ /dev/null @@ -1,76 +0,0 @@ -NAME - gcloud alpha beyondcorp app legacy connections describe - describe a single - legacy Connection - -SYNOPSIS - gcloud alpha beyondcorp app legacy connections describe - (CONNECTION : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) Describe a single legacy Connection. - -EXAMPLES - To describe a legacy connection my-connection run: - - $ gcloud alpha beyondcorp app legacy connections describe \ - my-connection --project={project} --location=us-central1 - - To describe a legacy connection my-connection in a project for location - us-central1 in table form, run: - - $ gcloud alpha beyondcorp app legacy connections describe \ - my-connection --project={project} --location=us-central1 \ - --format=table(displayName, name.basename(), state, \ - applicationEndpoint.host, applicationEndpoint.port, \ - updateTime, labels) - -POSITIONAL ARGUMENTS - Connection resource - The Beyondcorp connector you want to get details - about. 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 connection on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - This must be specified. - - CONNECTION - ID of the connection or fully qualified identifier for the - connection. - - To set the connection attribute: - ▸ provide the argument connection 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 beyondcorp service. - - To set the location attribute: - ▸ provide the argument connection 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 beyondcorp/v1alpha API. The full documentation for - this API can be found at: https://cloud.google.com/ - -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/beyondcorp/app/legacy/connections/help b/gcloud/alpha/beyondcorp/app/legacy/connections/help deleted file mode 100644 index 612657de3..000000000 --- a/gcloud/alpha/beyondcorp/app/legacy/connections/help +++ /dev/null @@ -1,43 +0,0 @@ -NAME - gcloud alpha beyondcorp app legacy connections - create and manipulate - beyondcorp connections - -SYNOPSIS - gcloud alpha beyondcorp app legacy connections COMMAND - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) A Beyondcorp Connection resource represents a BeyondCorp protected - connection to a remote application. It creates all the necessary Google - Cloud Platform components needed for creating a BeyondCorp protected - connection. Multiple connectors can be authorised for a single Connection. - -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 a new Beyondcorp application legacy connection. - - delete - (ALPHA) Delete a single legacy Connection. - - describe - (ALPHA) Describe a single legacy Connection. - - list - (ALPHA) List Beyondcorp legacy connection Resources. - - update - (ALPHA) Update an existing legacy Beyondcorp application connection. - -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/beyondcorp/app/legacy/connections/list b/gcloud/alpha/beyondcorp/app/legacy/connections/list deleted file mode 100644 index c77e8d751..000000000 --- a/gcloud/alpha/beyondcorp/app/legacy/connections/list +++ /dev/null @@ -1,93 +0,0 @@ -NAME - gcloud alpha beyondcorp app legacy connections list - list Beyondcorp - legacy connection Resources - -SYNOPSIS - gcloud alpha beyondcorp app legacy connections list --location=LOCATION - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) List Beyondcorp legacy connection resources based on project and - location. - -EXAMPLES - To list all legacy connections in a project for location us-central1 in - table form, run: - - $ gcloud alpha beyondcorp app legacy connections list \ - --project=projectId --location=us-central1 - - To list all legacy connections in a project for location us-central1 in - json form, run: - - $ gcloud alpha beyondcorp app legacy connections list \ - --project=projectId --location=us-central1 \ - --format=json(displayName, name.basename(), state, \ - applicationEndpoint.host, applicationEndpoint.port, \ - updateTime, labels) - -REQUIRED FLAGS - Location resource - Arguments and flags that define the Beyondcorp - connector you want to list. 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; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - 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. - -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 beyondcorp/v1alpha API. The full documentation for - this API can be found at: https://cloud.google.com/ - -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/beyondcorp/app/legacy/connections/update b/gcloud/alpha/beyondcorp/app/legacy/connections/update deleted file mode 100644 index 83067c248..000000000 --- a/gcloud/alpha/beyondcorp/app/legacy/connections/update +++ /dev/null @@ -1,123 +0,0 @@ -NAME - gcloud alpha beyondcorp app legacy connections update - update an existing - legacy Beyondcorp application connection - -SYNOPSIS - gcloud alpha beyondcorp app legacy connections update - (CONNECTION : --location=LOCATION) - [--application-endpoint=APPLICATION_ENDPOINT] [--async] - [--connectors=[CONNECTORS,...]] [--display-name=DISPLAY_NAME] - [--update-labels=[KEY=VALUE,...]] - [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) Update an existing legacy Beyondcorp application connection. - -EXAMPLES - To modify the legacy connection my-connection in 'us-central1' by adding - labels 'k0', with value 'value1' and label 'k1' with value 'value2' and - removing labels with key 'k3', run: - - $ gcloud alpha beyondcorp app legacy connections update \ - my-connection --location=us-central1 \ - --display-name=new-display-name --connectors={connector1} \ - --application-endpoint=host:port \ - --update-labels=k0=value1,k1=value2 --remove-labels=k3 - -POSITIONAL ARGUMENTS - Connection resource - The Beyondcorp connection you want 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 connection on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - This must be specified. - - CONNECTION - ID of the connection or fully qualified identifier for the - connection. - - To set the connection attribute: - ▸ provide the argument connection 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 beyondcorp service. - - To set the location attribute: - ▸ provide the argument connection on the command line with a fully - specified name; - ▸ provide the argument --location on the command line. - -FLAGS - --application-endpoint=APPLICATION_ENDPOINT - Address of the remote application endpoint for the Beyondcorp - Connection in form of :. - - --async - Return immediately, without waiting for the operation in progress to - complete. - - --connectors=[CONNECTORS,...] - List of connectors name that are authorised to be associated with this - Connection. - - --display-name=DISPLAY_NAME - An arbitrary user-provided name for the connection. Cannot exceed 64 - characters. - - --update-labels=[KEY=VALUE,...] - List of label KEY=VALUE pairs to update. If a label exists, its value - is modified. Otherwise, a new label is created. - - 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. - - At most one of these can be specified: - - --clear-labels - Remove all labels. If --update-labels is also specified then - --clear-labels is applied first. - - For example, to remove all labels: - - $ gcloud alpha beyondcorp app legacy connections update \ - --clear-labels - - To remove all existing labels and create two new labels, foo and baz: - - $ gcloud alpha beyondcorp app legacy connections update \ - --clear-labels --update-labels foo=bar,baz=qux - - --remove-labels=[KEY,...] - List of label keys to remove. If a label does not exist it is - silently ignored. If --update-labels is also specified then - --update-labels is applied first. - -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 beyondcorp/v1alpha API. The full documentation for - this API can be found at: https://cloud.google.com/ - -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/beyondcorp/app/legacy/connectors/create b/gcloud/alpha/beyondcorp/app/legacy/connectors/create deleted file mode 100644 index 6b8ce6375..000000000 --- a/gcloud/alpha/beyondcorp/app/legacy/connectors/create +++ /dev/null @@ -1,101 +0,0 @@ -NAME - gcloud alpha beyondcorp app legacy connectors create - create a new - Beyondcorp application legacy connector - -SYNOPSIS - gcloud alpha beyondcorp app legacy connectors create - (CONNECTOR : --location=LOCATION) --member=MEMBER [--async] - [--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) Create a new Beyondcorp application legacy connector. - -EXAMPLES - The following command creates a Connector with ID my-connector in the - default user project: - - $ gcloud alpha beyondcorp app legacy connectors create \ - my-connector --location=us-central1 \ - --member=serviceAccount:connector-sa@projectId.iam.gserviceaccou\ - nt.com - - The following command creates a Connector with ID my-connector with - explicit project value for all required and optional parameters: - - $ gcloud alpha beyondcorp app legacy connectors create \ - my-connector --project=projectId --location=us-central1 \ - --member=serviceAccount:connector-sa@projectId.iam.gserviceaccou\ - nt.com --labels='foo=bar' --display-name=connector-display-name \ - --async - -POSITIONAL ARGUMENTS - Connector resource - The Beyondcorp connector you want 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 connector on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - This must be specified. - - CONNECTOR - ID of the connector or fully qualified identifier for the connector. - - To set the connector attribute: - ▸ provide the argument connector 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 beyondcorp service. - - To set the location attribute: - ▸ provide the argument connector on the command line with a fully - specified name; - ▸ provide the argument --location on the command line. - -REQUIRED FLAGS - --member=MEMBER - Connector service account email in form of 'serviceAccount:email'. - -OPTIONAL FLAGS - --async - Return immediately, without waiting for the operation in progress to - complete. - - --display-name=DISPLAY_NAME - An arbitrary user-provided name for the connector. Cannot exceed 64 - characters. - - --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. - -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 beyondcorp/v1alpha API. The full documentation for - this API can be found at: https://cloud.google.com/ - -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/beyondcorp/app/legacy/connectors/delete b/gcloud/alpha/beyondcorp/app/legacy/connectors/delete deleted file mode 100644 index 7e10c373e..000000000 --- a/gcloud/alpha/beyondcorp/app/legacy/connectors/delete +++ /dev/null @@ -1,71 +0,0 @@ -NAME - gcloud alpha beyondcorp app legacy connectors delete - delete a single - legacy Connector - -SYNOPSIS - gcloud alpha beyondcorp app legacy connectors delete - (CONNECTOR : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) Delete a single legacy Connector. - -EXAMPLES - To delete a legacy connector my-connector run: - - $ gcloud alpha beyondcorp app legacy connectors delete \ - my-connector --project={project} --location={location} - -POSITIONAL ARGUMENTS - Connector resource - The Beyondcorp connector 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 connector on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - This must be specified. - - CONNECTOR - ID of the connector or fully qualified identifier for the connector. - - To set the connector attribute: - ▸ provide the argument connector 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 beyondcorp service. - - To set the location attribute: - ▸ provide the argument connector 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. - -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 beyondcorp/v1alpha API. The full documentation for - this API can be found at: https://cloud.google.com/ - -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/beyondcorp/app/legacy/connectors/describe b/gcloud/alpha/beyondcorp/app/legacy/connectors/describe deleted file mode 100644 index f7cfc3ca5..000000000 --- a/gcloud/alpha/beyondcorp/app/legacy/connectors/describe +++ /dev/null @@ -1,78 +0,0 @@ -NAME - gcloud alpha beyondcorp app legacy connectors describe - describe a single - legacy Connector - -SYNOPSIS - gcloud alpha beyondcorp app legacy connectors describe - (CONNECTOR : --location=LOCATION) [--details] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) Describe a single legacy Connector. - -EXAMPLES - To describe a connector my-connector run: - - $ gcloud alpha beyondcorp app legacy connectors describe \ - my-connector --project={project} --location={location} - - To describe a connector in a project for location us-central1 in table - form, run: - - $ gcloud alpha beyondcorp app legacy connectors describe \ - --project=projectId --location=us-central1 \ - --format=table(displayName, name, state, \ - principalInfo.serviceAccount.email,createTime,updateTime,labels) - -POSITIONAL ARGUMENTS - Connector resource - The Beyondcorp connector you want to get details - about. 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 connector on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - This must be specified. - - CONNECTOR - ID of the connector or fully qualified identifier for the connector. - - To set the connector attribute: - ▸ provide the argument connector 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 beyondcorp service. - - To set the location attribute: - ▸ provide the argument connector on the command line with a fully - specified name; - ▸ provide the argument --location on the command line. - -FLAGS - --details - Includes details. - -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 beyondcorp/v1alpha API. The full documentation for - this API can be found at: https://cloud.google.com/ - -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/beyondcorp/app/legacy/connectors/help b/gcloud/alpha/beyondcorp/app/legacy/connectors/help deleted file mode 100644 index 4f3a55169..000000000 --- a/gcloud/alpha/beyondcorp/app/legacy/connectors/help +++ /dev/null @@ -1,44 +0,0 @@ -NAME - gcloud alpha beyondcorp app legacy connectors - create and manipulate - beyondcorp connectors - -SYNOPSIS - gcloud alpha beyondcorp app legacy connectors COMMAND - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) A Beyondcorp connector represents an application facing component - deployed proximal to and with direct access to the application instances. - It is used to establish connectivity between the remote enterprise - environment and Google Cloud Platform. It initiates connections to the - applications and can proxy the data from users over the connection. - -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 a new Beyondcorp application legacy connector. - - delete - (ALPHA) Delete a single legacy Connector. - - describe - (ALPHA) Describe a single legacy Connector. - - list - (ALPHA) List Beyondcorp legacy connector Resources. - - update - (ALPHA) Update an existing Beyondcorp application legacy connector. - -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/beyondcorp/app/legacy/connectors/list b/gcloud/alpha/beyondcorp/app/legacy/connectors/list deleted file mode 100644 index f5dae3cf6..000000000 --- a/gcloud/alpha/beyondcorp/app/legacy/connectors/list +++ /dev/null @@ -1,92 +0,0 @@ -NAME - gcloud alpha beyondcorp app legacy connectors list - list Beyondcorp legacy - connector Resources - -SYNOPSIS - gcloud alpha beyondcorp app legacy connectors list --location=LOCATION - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) List Beyondcorp legacy connector resources based on project and - location. - -EXAMPLES - To list all legacy connectors in a project for location us-central1 in - table form, run: - - $ gcloud alpha beyondcorp app legacy connectors list \ - --project=projectId --location=us-central1 - - To list all legacy connectors in a project for location us-central1 in json - form, run: - - $ gcloud alpha beyondcorp app legacy connectors list \ - --project=projectId --location=us-central1 \ - --format=json(displayName, name, state, \ - principalInfo.serviceAccount.email,createTime,updateTime,labels) - -REQUIRED FLAGS - Location resource - Arguments and flags that define the Beyondcorp - connector you want to list. 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; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - 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. - -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 beyondcorp/v1alpha API. The full documentation for - this API can be found at: https://cloud.google.com/ - -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/beyondcorp/app/legacy/connectors/update b/gcloud/alpha/beyondcorp/app/legacy/connectors/update deleted file mode 100644 index feb5b1474..000000000 --- a/gcloud/alpha/beyondcorp/app/legacy/connectors/update +++ /dev/null @@ -1,110 +0,0 @@ -NAME - gcloud alpha beyondcorp app legacy connectors update - update an existing - Beyondcorp application legacy connector - -SYNOPSIS - gcloud alpha beyondcorp app legacy connectors update - (CONNECTOR : --location=LOCATION) [--async] - [--display-name=DISPLAY_NAME] [--update-labels=[KEY=VALUE,...]] - [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) Update an existing Beyondcorp application legacy connector. - -EXAMPLES - To modify the legacy connector my-connector in 'us-central1' by adding - labels 'k0', with value 'value1' and label 'k1' with value 'value2' and - removing labels with key 'k3', run: - - $ gcloud alpha beyondcorp app legacy connectors update \ - my-connector --location=us-central1 \ - --display-name=new-display-name \ - --update-labels=k0=value1,k1=value2 --remove-labels=k3 - -POSITIONAL ARGUMENTS - Connector resource - The Beyondcorp connector you want 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 connector on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - This must be specified. - - CONNECTOR - ID of the connector or fully qualified identifier for the connector. - - To set the connector attribute: - ▸ provide the argument connector 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 beyondcorp service. - - To set the location attribute: - ▸ provide the argument connector 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. - - --display-name=DISPLAY_NAME - An arbitrary user-provided name for the connector. Cannot exceed 64 - characters. - - --update-labels=[KEY=VALUE,...] - List of label KEY=VALUE pairs to update. If a label exists, its value - is modified. Otherwise, a new label is created. - - 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. - - At most one of these can be specified: - - --clear-labels - Remove all labels. If --update-labels is also specified then - --clear-labels is applied first. - - For example, to remove all labels: - - $ gcloud alpha beyondcorp app legacy connectors update --clear-labels - - To remove all existing labels and create two new labels, foo and baz: - - $ gcloud alpha beyondcorp app legacy connectors update \ - --clear-labels --update-labels foo=bar,baz=qux - - --remove-labels=[KEY,...] - List of label keys to remove. If a label does not exist it is - silently ignored. If --update-labels is also specified then - --update-labels is applied first. - -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 beyondcorp/v1alpha API. The full documentation for - this API can be found at: https://cloud.google.com/ - -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/beyondcorp/app/legacy/help b/gcloud/alpha/beyondcorp/app/legacy/help deleted file mode 100644 index 06b3da35e..000000000 --- a/gcloud/alpha/beyondcorp/app/legacy/help +++ /dev/null @@ -1,41 +0,0 @@ -NAME - gcloud alpha beyondcorp app legacy - manages application legacy connectors - and connections - -SYNOPSIS - gcloud alpha beyondcorp app legacy GROUP [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) The gcloud beyondcorp command group lets you secure non-gcp - application by managing legacy connectors and connections. - - BeyondCorp Enterprise offers a zero trust solution that enables secure - access with integrated threat and data protection.The solution enables - secure access to both Google Cloud Platform and on-prem hosted apps. For - remote apps that are not deployed in Google Cloud Platform, BeyondCorp - Enterprise's App connector provides simplified connectivity and app - publishing experience. - - More information on Beyondcorp can be found here: - https://cloud.google.com/beyondcorp - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -GROUPS - GROUP is one of the following: - - connections - (ALPHA) Create and manipulate beyondcorp connections. - - connectors - (ALPHA) Create and manipulate beyondcorp connectors. - -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/backend-buckets/add-iam-policy-binding b/gcloud/alpha/compute/backend-buckets/add-iam-policy-binding index 132ff15d1..d39890f01 100644 --- a/gcloud/alpha/compute/backend-buckets/add-iam-policy-binding +++ b/gcloud/alpha/compute/backend-buckets/add-iam-policy-binding @@ -78,7 +78,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud compute backend-buckets add-iam-policy-binding $ gcloud beta compute backend-buckets add-iam-policy-binding diff --git a/gcloud/alpha/compute/backend-buckets/get-iam-policy b/gcloud/alpha/compute/backend-buckets/get-iam-policy index 3cf579013..a2264abb2 100644 --- a/gcloud/alpha/compute/backend-buckets/get-iam-policy +++ b/gcloud/alpha/compute/backend-buckets/get-iam-policy @@ -83,7 +83,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud compute backend-buckets get-iam-policy $ gcloud beta compute backend-buckets get-iam-policy diff --git a/gcloud/alpha/compute/backend-buckets/remove-iam-policy-binding b/gcloud/alpha/compute/backend-buckets/remove-iam-policy-binding index 706eb51d6..157f76a6c 100644 --- a/gcloud/alpha/compute/backend-buckets/remove-iam-policy-binding +++ b/gcloud/alpha/compute/backend-buckets/remove-iam-policy-binding @@ -79,7 +79,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud compute backend-buckets remove-iam-policy-binding $ gcloud beta compute backend-buckets remove-iam-policy-binding diff --git a/gcloud/alpha/compute/backend-buckets/set-iam-policy b/gcloud/alpha/compute/backend-buckets/set-iam-policy index eae47d4ba..aedd1f013 100644 --- a/gcloud/alpha/compute/backend-buckets/set-iam-policy +++ b/gcloud/alpha/compute/backend-buckets/set-iam-policy @@ -64,7 +64,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud compute backend-buckets set-iam-policy $ gcloud beta compute backend-buckets set-iam-policy diff --git a/gcloud/alpha/compute/commitments/create b/gcloud/alpha/compute/commitments/create index b2059476f..48dda02c3 100644 --- a/gcloud/alpha/compute/commitments/create +++ b/gcloud/alpha/compute/commitments/create @@ -106,7 +106,7 @@ OPTIONAL FLAGS 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. + memory-optimized-x4, storage-optimized-z3. Manage the reservations to be created with the commitment. diff --git a/gcloud/alpha/compute/firewall-policies/help b/gcloud/alpha/compute/firewall-policies/help index 2b0be1658..9a3028fcb 100644 --- a/gcloud/alpha/compute/firewall-policies/help +++ b/gcloud/alpha/compute/firewall-policies/help @@ -22,6 +22,10 @@ GROUPS (ALPHA) Read and manipulate Compute Engine organization firewall policy associations. + mirroring-rules + (ALPHA) Read and manipulate Compute Engine organization firewall policy + packet mirroring rules. + rules (ALPHA) Read and manipulate Compute Engine organization firewall policy rules. diff --git a/gcloud/alpha/compute/firewall-policies/mirroring-rules/create b/gcloud/alpha/compute/firewall-policies/mirroring-rules/create new file mode 100644 index 000000000..9ef5a81e1 --- /dev/null +++ b/gcloud/alpha/compute/firewall-policies/mirroring-rules/create @@ -0,0 +1,144 @@ +NAME + gcloud alpha compute firewall-policies mirroring-rules create - creates a + Compute Engine firewall policy packet mirroring rule + +SYNOPSIS + gcloud alpha compute firewall-policies mirroring-rules create PRIORITY + --action=ACTION --firewall-policy=FIREWALL_POLICY + [--description=DESCRIPTION] + [--dest-address-groups=[DEST_ADDRESS_GROUPS,...]] + [--dest-fqdns=[DEST_FQDNS,...]] [--dest-ip-ranges=[DEST_IP_RANGE,...]] + [--dest-region-codes=[DEST_REGION_CODES,...]] + [--dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...]] + [--direction=DIRECTION] [--[no-]disabled] + [--layer4-configs=[LAYER4_CONFIG,...]] [--organization=ORGANIZATION] + [--security-profile-group=SECURITY_PROFILE_GROUP] + [--src-address-groups=[SOURCE_ADDRESS_GROUPS,...]] + [--src-fqdns=[SOURCE_FQDNS,...]] [--src-ip-ranges=[SRC_IP_RANGE,...]] + [--src-region-codes=[SOURCE_REGION_CODES,...]] + [--src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...]] + [--target-resources=[TARGET_RESOURCES,...]] + [--target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute firewall-policies mirroring-rules create is + used to create organization firewall policy packet mirroring rules. + +EXAMPLES + To create a packet mirroring rule with priority ``10" in an organization + firewall policy with ID ``123456789", run: + + $ gcloud alpha compute firewall-policies mirroring-rules create 10 \ + --firewall-policy=123456789 --action=mirror \ + --security-profile-group=organizations/123/locations/global/\ + securityProfileGroups/custom-security-profile-group \ + --description=example-rule + +POSITIONAL ARGUMENTS + PRIORITY + Priority of the firewall policy rule to create. + +REQUIRED FLAGS + --action=ACTION + Action to take if the request matches the match condition. ACTION must + be one of: mirror, do_not_mirror, goto_next. + + --firewall-policy=FIREWALL_POLICY + Short name of the firewall policy into which the rule should be + inserted. + +OPTIONAL FLAGS + --description=DESCRIPTION + An optional, textual description for the rule. + + --dest-address-groups=[DEST_ADDRESS_GROUPS,...] + Destination address groups to match for this rule. Can only be + specified if DIRECTION is egress. + + --dest-fqdns=[DEST_FQDNS,...] + Destination FQDNs to match for this rule. Can only be specified if + DIRECTION is egress. + + --dest-ip-ranges=[DEST_IP_RANGE,...] + Destination IP ranges to match for this rule. + + --dest-region-codes=[DEST_REGION_CODES,...] + Destination Region Code to match for this rule. Can only be specified + if DIRECTION is egress. + + --dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...] + Destination Threat Intelligence lists to match for this rule. Can only + be specified if DIRECTION is egress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. + + --direction=DIRECTION + Direction of the traffic the rule is applied. The default is to apply + on incoming traffic. DIRECTION must be one of: INGRESS, EGRESS. + + --[no-]disabled + Use this flag to disable the rule. Disabled rules will not affect + traffic. Use --disabled to enable and --no-disabled to disable. + + --layer4-configs=[LAYER4_CONFIG,...] + A list of destination protocols and ports to which the firewall rule + will apply. + + --organization=ORGANIZATION + Organization which the organization firewall policy belongs to. Must be + set if FIREWALL_POLICY is short name. + + --security-profile-group=SECURITY_PROFILE_GROUP + An org-based security profile group to be used with + apply_security_profile_group action. Allowed formats are: a) + http(s):////organizations//locations/global/securityProfileGroups/ + b) + (//)/organizations//locations/global/securityProfileGroups/ + c) . In case "c" gCloud CLI will create a reference matching + format "a", but to make it work + CLOUDSDK_API_ENDPOINT_OVERRIDES_NETWORKSECURITY property must be set. + In order to set this property, please run the command gcloud config set + api_endpoint_overrides/networksecurity https:///. + + --src-address-groups=[SOURCE_ADDRESS_GROUPS,...] + Source address groups to match for this rule. Can only be specified if + DIRECTION is ingress. + + --src-fqdns=[SOURCE_FQDNS,...] + Source FQDNs to match for this rule. Can only be specified if DIRECTION + is ingress. + + --src-ip-ranges=[SRC_IP_RANGE,...] + Source IP ranges to match for this rule. + + --src-region-codes=[SOURCE_REGION_CODES,...] + Source Region Code to match for this rule. Can only be specified if + DIRECTION is ingress. + + --src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...] + Source Threat Intelligence lists to match for this rule. Can only be + specified if DIRECTION is ingress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. + + --target-resources=[TARGET_RESOURCES,...] + List of URLs of target resources to which the rule is applied. + + --target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...] + List of target service accounts for the rule. + +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/firewall-policies/mirroring-rules/delete b/gcloud/alpha/compute/firewall-policies/mirroring-rules/delete new file mode 100644 index 000000000..fe71e1c99 --- /dev/null +++ b/gcloud/alpha/compute/firewall-policies/mirroring-rules/delete @@ -0,0 +1,48 @@ +NAME + gcloud alpha compute firewall-policies mirroring-rules delete - deletes a + Compute Engine organization firewall policy packet mirroring rule + +SYNOPSIS + gcloud alpha compute firewall-policies mirroring-rules delete PRIORITY + --firewall-policy=FIREWALL_POLICY [--organization=ORGANIZATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute firewall-policies mirroring-rules delete is + used to delete organization firewall policy packet mirroring rules. + +EXAMPLES + To delete a rule with priority ``10" in an organization firewall policy + with ID ``123456789", run: + + $ gcloud alpha compute firewall-policies mirroring-rules delete 10 \ + --firewall-policy=123456789 + +POSITIONAL ARGUMENTS + PRIORITY + Priority of the firewall policy rule to delete. + +REQUIRED FLAGS + --firewall-policy=FIREWALL_POLICY + Short name of the firewall policy into which the rule should be + deleted. + +OPTIONAL FLAGS + --organization=ORGANIZATION + Organization which the organization firewall policy belongs to. Must be + set if FIREWALL_POLICY is short name. + +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/firewall-policies/mirroring-rules/describe b/gcloud/alpha/compute/firewall-policies/mirroring-rules/describe new file mode 100644 index 000000000..9070882db --- /dev/null +++ b/gcloud/alpha/compute/firewall-policies/mirroring-rules/describe @@ -0,0 +1,48 @@ +NAME + gcloud alpha compute firewall-policies mirroring-rules describe - describes + a Compute Engine organization firewall policy packet mirroring rule + +SYNOPSIS + gcloud alpha compute firewall-policies mirroring-rules describe PRIORITY + --firewall-policy=FIREWALL_POLICY [--organization=ORGANIZATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute firewall-policies mirroring-rules describe is + used to describe organization firewall policy packet mirroring rules. + +EXAMPLES + To describe a packet mirroring rule with priority ``10" in an organization + firewall policy with ID ``123456789", run: + + $ gcloud alpha compute firewall-policies mirroring-rules describe \ + 10 --firewall-policy=123456789 + +POSITIONAL ARGUMENTS + PRIORITY + Priority of the firewall policy rule to describe. + +REQUIRED FLAGS + --firewall-policy=FIREWALL_POLICY + Short name of the firewall policy into which the rule should be + described. + +OPTIONAL FLAGS + --organization=ORGANIZATION + Organization which the organization firewall policy belongs to. Must be + set if FIREWALL_POLICY is short name. + +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/firewall-policies/mirroring-rules/help b/gcloud/alpha/compute/firewall-policies/mirroring-rules/help new file mode 100644 index 000000000..68907e4f6 --- /dev/null +++ b/gcloud/alpha/compute/firewall-policies/mirroring-rules/help @@ -0,0 +1,41 @@ +NAME + gcloud alpha compute firewall-policies mirroring-rules - read and + manipulate Compute Engine organization firewall policy packet mirroring + rules + +SYNOPSIS + gcloud alpha compute firewall-policies mirroring-rules COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Read and manipulate Compute Engine organization firewall policy + packet mirroring rules. + +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) Creates a Compute Engine firewall policy packet mirroring rule. + + delete + (ALPHA) Deletes a Compute Engine organization firewall policy packet + mirroring rule. + + describe + (ALPHA) Describes a Compute Engine organization firewall policy packet + mirroring rule. + + update + (ALPHA) Updates a Compute Engine firewall policy packet mirroring rule. + +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/firewall-policies/mirroring-rules/update b/gcloud/alpha/compute/firewall-policies/mirroring-rules/update new file mode 100644 index 000000000..e100a1a84 --- /dev/null +++ b/gcloud/alpha/compute/firewall-policies/mirroring-rules/update @@ -0,0 +1,147 @@ +NAME + gcloud alpha compute firewall-policies mirroring-rules update - updates a + Compute Engine firewall policy packet mirroring rule + +SYNOPSIS + gcloud alpha compute firewall-policies mirroring-rules update PRIORITY + --firewall-policy=FIREWALL_POLICY [--action=ACTION] + [--description=DESCRIPTION] + [--dest-address-groups=[DEST_ADDRESS_GROUPS,...]] + [--dest-fqdns=[DEST_FQDNS,...]] [--dest-ip-ranges=[DEST_IP_RANGE,...]] + [--dest-region-codes=[DEST_REGION_CODES,...]] + [--dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...]] + [--direction=DIRECTION] [--[no-]disabled] + [--layer4-configs=[LAYER4_CONFIG,...]] [--new-priority=NEW_PRIORITY] + [--organization=ORGANIZATION] + [--security-profile-group=SECURITY_PROFILE_GROUP] + [--src-address-groups=[SOURCE_ADDRESS_GROUPS,...]] + [--src-fqdns=[SOURCE_FQDNS,...]] [--src-ip-ranges=[SRC_IP_RANGE,...]] + [--src-region-codes=[SOURCE_REGION_CODES,...]] + [--src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...]] + [--target-resources=[TARGET_RESOURCES,...]] + [--target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute firewall-policies mirroring-rules update is + used to update organization firewall policy packet mirroring rules. + +EXAMPLES + To update a rule with priority ``10" in an organization firewall policy + with ID ``123456789" to change the action to ``allow" and description to + ``new-example-rule", run: + + $ gcloud alpha compute firewall-policies mirroring-rules update 10 \ + --firewall-policy=123456789 --action=do_not_mirror \ + --description=new-example-rule + +POSITIONAL ARGUMENTS + PRIORITY + Priority of the firewall policy rule to update. + +REQUIRED FLAGS + --firewall-policy=FIREWALL_POLICY + Short name of the firewall policy into which the rule should be + updated. + +OPTIONAL FLAGS + --action=ACTION + Action to take if the request matches the match condition. ACTION must + be one of: mirror, do_not_mirror, goto_next. + + --description=DESCRIPTION + An optional, textual description for the rule. + + --dest-address-groups=[DEST_ADDRESS_GROUPS,...] + Destination address groups to match for this rule. Can only be + specified if DIRECTION is egress. + + --dest-fqdns=[DEST_FQDNS,...] + Destination FQDNs to match for this rule. Can only be specified if + DIRECTION is egress. + + --dest-ip-ranges=[DEST_IP_RANGE,...] + Destination IP ranges to match for this rule. + + --dest-region-codes=[DEST_REGION_CODES,...] + Destination Region Code to match for this rule. Can only be specified + if DIRECTION is egress. + + --dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...] + Destination Threat Intelligence lists to match for this rule. Can only + be specified if DIRECTION is egress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. + + --direction=DIRECTION + Direction of the traffic the rule is applied. The default is to apply + on incoming traffic. DIRECTION must be one of: INGRESS, EGRESS. + + --[no-]disabled + Use this flag to disable the rule. Disabled rules will not affect + traffic. Use --disabled to enable and --no-disabled to disable. + + --layer4-configs=[LAYER4_CONFIG,...] + A list of destination protocols and ports to which the firewall rule + will apply. + + --new-priority=NEW_PRIORITY + New priority for the rule to update. Valid in [0, 65535]. + + --organization=ORGANIZATION + Organization which the organization firewall policy belongs to. Must be + set if FIREWALL_POLICY is short name. + + --security-profile-group=SECURITY_PROFILE_GROUP + An org-based security profile group to be used with + apply_security_profile_group action. Allowed formats are: a) + http(s):////organizations//locations/global/securityProfileGroups/ + b) + (//)/organizations//locations/global/securityProfileGroups/ + c) . In case "c" gCloud CLI will create a reference matching + format "a", but to make it work + CLOUDSDK_API_ENDPOINT_OVERRIDES_NETWORKSECURITY property must be set. + In order to set this property, please run the command gcloud config set + api_endpoint_overrides/networksecurity https:///. + + --src-address-groups=[SOURCE_ADDRESS_GROUPS,...] + Source address groups to match for this rule. Can only be specified if + DIRECTION is ingress. + + --src-fqdns=[SOURCE_FQDNS,...] + Source FQDNs to match for this rule. Can only be specified if DIRECTION + is ingress. + + --src-ip-ranges=[SRC_IP_RANGE,...] + Source IP ranges to match for this rule. + + --src-region-codes=[SOURCE_REGION_CODES,...] + Source Region Code to match for this rule. Can only be specified if + DIRECTION is ingress. + + --src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...] + Source Threat Intelligence lists to match for this rule. Can only be + specified if DIRECTION is ingress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. + + --target-resources=[TARGET_RESOURCES,...] + List of URLs of target resources to which the rule is applied. + + --target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...] + List of target service accounts for the rule. + +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/instance-templates/create b/gcloud/alpha/compute/instance-templates/create index 2eb7407f0..132a5b471 100644 --- a/gcloud/alpha/compute/instance-templates/create +++ b/gcloud/alpha/compute/instance-templates/create @@ -42,7 +42,7 @@ SYNOPSIS [--network=NETWORK] [--network-interface=[PROPERTY=VALUE,...]] [--network-performance-configs=[PROPERTY=VALUE,...]] [--network-tier=NETWORK_TIER] [--numa-node-count=NUMA_NODE_COUNT] - [--partner-metadata=[KEY=VALUE,...]] + [--partner-metadata=[NAMESPACE/KEY=VALUE,...]] [--partner-metadata-from-file=LOCAL_FILE_PATH] [--performance-monitoring-unit=PERFORMANCE_MONITORING_UNIT] [--post-key-revocation-action-type=POLICY] [--preemptible] @@ -347,18 +347,17 @@ FLAGS Specifies a textual description for the instance template. --discard-local-ssds-at-termination-timestamp=DISCARD_LOCAL_SSDS_AT_TERMINATION_TIMESTAMP - Required and only allowed for VMs that have one or more local SSDs, use - --termination-action=STOP (default), and use either --max-run-duration - or --termination-time. This flag indicates whether you want Compute - Engine to discard (true) or preserve (false) local SSD data when the - VM's terminationTimestamp is reached. + Required to be set to true and only allowed for VMs that have one or + more local SSDs, use --instance-termination-action=STOP, and use either + --max-run-duration or --termination-time. - If set to false, Compute Engine will preserve local SSD data by - including the --discard-local-ssd=false flag in the automatic - termination command. The --discard-local-ssd=false flag preserves local - SSD data by migrating it to persistent storage until you rerun the VM. - Importantly, preserving local SSD data incurs costs and is subject to - restrictions. For more information, see + This flag indicates the value that you want Compute Engine to use for + the --discard-local-ssd flag in the automatic gcloud compute instances + stop command. This flag only supports the true value, which discards + local SSD data when automatically stopping this VM during its + terminationTimestamp. + + For more information about the --discard-local-ssd flag, see https://cloud.google.com/compute/docs/disks/local-ssd#stop_instance. --disk=[auto-delete=AUTO-DELETE],[boot=BOOT],[device-name=DEVICE-NAME],[mode=MODE],[name=NAME] @@ -436,15 +435,16 @@ FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM preemption - (--provisioning-model=SPOT or --preemptible) or automatic instance - termination (--max-run-duration or --termination-time). + (--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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. --internal-ipv6-address=INTERNAL_IPV6_ADDRESS Assigns the given internal IPv6 address or range to the instance that @@ -545,7 +545,7 @@ FLAGS --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration - relative to the VM instance's most-recent start time. Format the + relative to the last time when the VM began running. Format the duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and seconds followed by d, h, m, and s respectively. For example, specify 30m for a duration of 30 minutes or specify 1d2h3m4s for a duration of @@ -555,13 +555,15 @@ FLAGS If neither --max-run-duration nor --termination-time is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --max-run-duration, the VM instance - is automatically terminated when the VM's current runtime reaches - MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or - suspended, --max-run-duration and (unless the VM uses - --provisioning-model=SPOT) --instance-termination-action are - automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped or + suspended and redefined whenever the VM is rerun. For + --max-run-duration specifically, the terminationTimestamp is the sum of + MAX_RUN_DURATION and the time when the VM last entered the RUNNING + state, which changes whenever the VM is rerun. --mesh=[gke-cluster=GKE-CLUSTER],[workload=WORKLOAD] Controls whether the Anthos Service Mesh service proxy (Envoy) and @@ -747,13 +749,12 @@ FLAGS 1, 2, 4 or 8. Setting NUMA node count to 0 means using the default setting. - --partner-metadata=[KEY=VALUE,...] - Partner Metadata assigned to the instance. A map from a - subdomain(namespace) to entries map. + --partner-metadata=[NAMESPACE/KEY=VALUE,...] + Partner metadata specifying namespace and its entries. The entries can + be key-value pairs or in json format. --partner-metadata-from-file=LOCAL_FILE_PATH - path to json local file which including the definintion of partner - metadata. + Path to a local json file containing partner metadata. --performance-monitoring-unit=PERFORMANCE_MONITORING_UNIT The set of performance measurement counters to enable for the instance. @@ -923,12 +924,15 @@ FLAGS If neither --termination-time nor --max-run-duration is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --termination-time, the VM instance - is automatically terminated at the specified timestamp. Note: Anytime - the VM instance is stopped or suspended, --termination-time and (unless - the VM uses --provisioning-model=SPOT) --instance-termination-action - are automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped or + suspended and redefined whenever the VM is rerun. For + --termination-time specifically, the terminationTimestamp remains the + same whenever the VM is rerun, but any requests to rerun the VM fail if + the specified timestamp is in the past. --threads-per-core=THREADS_PER_CORE The number of visible threads per physical core. To disable diff --git a/gcloud/alpha/compute/instance-templates/describe b/gcloud/alpha/compute/instance-templates/describe index fb4d4831c..b6b2a7c3d 100644 --- a/gcloud/alpha/compute/instance-templates/describe +++ b/gcloud/alpha/compute/instance-templates/describe @@ -21,13 +21,15 @@ POSITIONAL ARGUMENTS FLAGS --view=VIEW - specify Instance view. VIEW must be one of: + Specifies the information that the output should contain. VIEW must be + one of: BASIC - Default view of instance, Including everything except Partner - Metadata. + Default output view. Output contains all configuration details of + the instance template, except partner metadata. FULL - Include everything in instance + Output contains all configuration details of the instance template, + including partner metadata. At most one of these can be specified: diff --git a/gcloud/alpha/compute/instance-templates/list b/gcloud/alpha/compute/instance-templates/list index a164a28f2..9c308d42e 100644 --- a/gcloud/alpha/compute/instance-templates/list +++ b/gcloud/alpha/compute/instance-templates/list @@ -53,13 +53,15 @@ FLAGS Flag --regexp is deprecated. Use --filter="name~'REGEXP'" instead. --view=VIEW - specify Instance view. VIEW must be one of: + Specifies the information that the output should contain. VIEW must be + one of: BASIC - Default view of instance, Including everything except Partner - Metadata. + Default output view. Output contains all configuration details of + the instance template, except partner metadata. FULL - Include everything in instance template + Output contains all configuration details of the instance template, + including partner metadata. At most one of these can be specified: diff --git a/gcloud/alpha/compute/instances/add-partner-metadata b/gcloud/alpha/compute/instances/add-partner-metadata index 51f24495a..03bcfdd14 100644 --- a/gcloud/alpha/compute/instances/add-partner-metadata +++ b/gcloud/alpha/compute/instances/add-partner-metadata @@ -1,10 +1,10 @@ NAME - gcloud alpha compute instances add-partner-metadata - add or update or - patch partner metadata + gcloud alpha compute instances add-partner-metadata - add or update partner + metadata SYNOPSIS gcloud alpha compute instances add-partner-metadata INSTANCE_NAME - [--partner-metadata=[KEY=VALUE,...]] + [--partner-metadata=[NAMESPACE/KEY=VALUE,...]] [--partner-metadata-from-file=LOCAL_FILE_PATH] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...] @@ -13,27 +13,28 @@ DESCRIPTION add or update or patch partner metadata of a virtual machine instance. Every instance has access to a metadata server that can be used to query partner metadata that has been set through this tool. For information on - metadata, see + metadata, see About VM metadata + (https://cloud.google.com/compute/docs/metadata/overview). - Only Namespaces keys that are provided are mutated. Existing Namespaces + Only namespaces keys that are provided are mutated. Existing Namespaces entries will remain unaffected. In order to retrieve partner metadata, run: $ gcloud compute instances describe example-instance --zone - us-central1-a --format="value(partnerMetadata)" + us-central1-a --view=FULL --format="value(partnerMetadata)" where example-instance is the name of the virtual machine instance you're querying partner metadata from. EXAMPLES - To add partner metadata under namespace gcar.googleapis.com/engine to + To add partner metadata under namespace test.compute.googleapis.com to instance TEST_INSTANCE run: $ gcloud alpha compute instances add-partner-metadata \ TEST_INSTANCE \ - --partner-metadata=gcar.googleapis.com/engine="{ "engine": { \ - "type": V8 } }" + --partner-metadata=test.compute.googleapis.com/entries="{ \ + "engine": { "type": V8 } }" To add partner metadata from a file: @@ -47,13 +48,12 @@ POSITIONAL ARGUMENTS at: https://cloud.google.com/compute/docs/reference/rest/v1/instances FLAGS - --partner-metadata=[KEY=VALUE,...] - Partner Metadata assigned to the instance. A map from a - subdomain(namespace) to entries map. + --partner-metadata=[NAMESPACE/KEY=VALUE,...] + Partner metadata specifying namespace and its entries. The entries can + be key-value pairs or in json format. --partner-metadata-from-file=LOCAL_FILE_PATH - path to json local file which including the definintion of partner - metadata. + Path to a local json file containing partner metadata. --zone=ZONE Zone of the instance to set partner metadata on. If not specified, you @@ -91,5 +91,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 beta compute instances add-partner-metadata diff --git a/gcloud/alpha/compute/instances/bulk/create b/gcloud/alpha/compute/instances/bulk/create index aa537e985..e2ca33a94 100644 --- a/gcloud/alpha/compute/instances/bulk/create +++ b/gcloud/alpha/compute/instances/bulk/create @@ -383,18 +383,17 @@ OPTIONAL FLAGS Specifies a textual description of the instances. --discard-local-ssds-at-termination-timestamp=DISCARD_LOCAL_SSDS_AT_TERMINATION_TIMESTAMP - Required and only allowed for VMs that have one or more local SSDs, use - --termination-action=STOP (default), and use either --max-run-duration - or --termination-time. This flag indicates whether you want Compute - Engine to discard (true) or preserve (false) local SSD data when the - VM's terminationTimestamp is reached. + Required to be set to true and only allowed for VMs that have one or + more local SSDs, use --instance-termination-action=STOP, and use either + --max-run-duration or --termination-time. - If set to false, Compute Engine will preserve local SSD data by - including the --discard-local-ssd=false flag in the automatic - termination command. The --discard-local-ssd=false flag preserves local - SSD data by migrating it to persistent storage until you rerun the VM. - Importantly, preserving local SSD data incurs costs and is subject to - restrictions. For more information, see + This flag indicates the value that you want Compute Engine to use for + the --discard-local-ssd flag in the automatic gcloud compute instances + stop command. This flag only supports the true value, which discards + local SSD data when automatically stopping this VM during its + terminationTimestamp. + + For more information about the --discard-local-ssd flag, see https://cloud.google.com/compute/docs/disks/local-ssd#stop_instance. --disk=[boot=BOOT],[device-name=DEVICE-NAME],[name=NAME],[scope=SCOPE] @@ -448,15 +447,16 @@ OPTIONAL FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM preemption - (--provisioning-model=SPOT or --preemptible) or automatic instance - termination (--max-run-duration or --termination-time). + (--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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. @@ -540,7 +540,7 @@ OPTIONAL FLAGS --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration - relative to the VM instance's most-recent start time. Format the + relative to the last time when the VM began running. Format the duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and seconds followed by d, h, m, and s respectively. For example, specify 30m for a duration of 30 minutes or specify 1d2h3m4s for a duration of @@ -550,13 +550,15 @@ OPTIONAL FLAGS If neither --max-run-duration nor --termination-time is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --max-run-duration, the VM instance - is automatically terminated when the VM's current runtime reaches - MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or - suspended, --max-run-duration and (unless the VM uses - --provisioning-model=SPOT) --instance-termination-action are - automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped or + suspended and redefined whenever the VM is rerun. For + --max-run-duration specifically, the terminationTimestamp is the sum of + MAX_RUN_DURATION and the time when the VM last entered the RUNNING + state, which changes whenever the VM is rerun. --metadata=KEY=VALUE,[KEY=VALUE,...] Metadata to be made available to the guest operating system running on @@ -847,12 +849,15 @@ OPTIONAL FLAGS If neither --termination-time nor --max-run-duration is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --termination-time, the VM instance - is automatically terminated at the specified timestamp. Note: Anytime - the VM instance is stopped or suspended, --termination-time and (unless - the VM uses --provisioning-model=SPOT) --instance-termination-action - are automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped or + suspended and redefined whenever the VM is rerun. For + --termination-time specifically, the terminationTimestamp remains the + same whenever the VM is rerun, but any requests to rerun the VM fail if + the specified timestamp is in the past. --threads-per-core=THREADS_PER_CORE The number of visible threads per physical core. To disable diff --git a/gcloud/alpha/compute/instances/create b/gcloud/alpha/compute/instances/create index 350b38859..866452146 100644 --- a/gcloud/alpha/compute/instances/create +++ b/gcloud/alpha/compute/instances/create @@ -48,7 +48,7 @@ SYNOPSIS [--network-performance-configs=[PROPERTY=VALUE,...]] [--network-tier=NETWORK_TIER] [--node-project=NODE_PROJECT] [--numa-node-count=NUMA_NODE_COUNT] - [--partner-metadata=[KEY=VALUE,...]] + [--partner-metadata=[NAMESPACE/KEY=VALUE,...]] [--partner-metadata-from-file=LOCAL_FILE_PATH] [--performance-monitoring-unit=PERFORMANCE_MONITORING_UNIT] [--post-key-revocation-action-type=POLICY] [--preemptible] @@ -447,18 +447,17 @@ FLAGS Specifies a textual description of the instances. --discard-local-ssds-at-termination-timestamp=DISCARD_LOCAL_SSDS_AT_TERMINATION_TIMESTAMP - Required and only allowed for VMs that have one or more local SSDs, use - --termination-action=STOP (default), and use either --max-run-duration - or --termination-time. This flag indicates whether you want Compute - Engine to discard (true) or preserve (false) local SSD data when the - VM's terminationTimestamp is reached. + Required to be set to true and only allowed for VMs that have one or + more local SSDs, use --instance-termination-action=STOP, and use either + --max-run-duration or --termination-time. - If set to false, Compute Engine will preserve local SSD data by - including the --discard-local-ssd=false flag in the automatic - termination command. The --discard-local-ssd=false flag preserves local - SSD data by migrating it to persistent storage until you rerun the VM. - Importantly, preserving local SSD data incurs costs and is subject to - restrictions. For more information, see + This flag indicates the value that you want Compute Engine to use for + the --discard-local-ssd flag in the automatic gcloud compute instances + stop command. This flag only supports the true value, which discards + local SSD data when automatically stopping this VM during its + terminationTimestamp. + + For more information about the --discard-local-ssd flag, see https://cloud.google.com/compute/docs/disks/local-ssd#stop_instance. --disk=[auto-delete=AUTO-DELETE],[boot=BOOT],[device-name=DEVICE-NAME],[force-attach=FORCE-ATTACH],[mode=MODE],[name=NAME],[scope=SCOPE] @@ -558,15 +557,16 @@ FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM preemption - (--provisioning-model=SPOT or --preemptible) or automatic instance - termination (--max-run-duration or --termination-time). + (--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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. --internal-ipv6-address=INTERNAL_IPV6_ADDRESS Assigns the given internal IPv6 address or range to the instance that @@ -688,7 +688,7 @@ FLAGS --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration - relative to the VM instance's most-recent start time. Format the + relative to the last time when the VM began running. Format the duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and seconds followed by d, h, m, and s respectively. For example, specify 30m for a duration of 30 minutes or specify 1d2h3m4s for a duration of @@ -698,13 +698,15 @@ FLAGS If neither --max-run-duration nor --termination-time is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --max-run-duration, the VM instance - is automatically terminated when the VM's current runtime reaches - MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or - suspended, --max-run-duration and (unless the VM uses - --provisioning-model=SPOT) --instance-termination-action are - automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped or + suspended and redefined whenever the VM is rerun. For + --max-run-duration specifically, the terminationTimestamp is the sum of + MAX_RUN_DURATION and the time when the VM last entered the RUNNING + state, which changes whenever the VM is rerun. --metadata=KEY=VALUE,[KEY=VALUE,...] Metadata to be made available to the guest operating system running on @@ -792,13 +794,12 @@ FLAGS 1, 2, 4 or 8. Setting NUMA node count to 0 means using the default setting. - --partner-metadata=[KEY=VALUE,...] - Partner Metadata assigned to the instance. A map from a - subdomain(namespace) to entries map. + --partner-metadata=[NAMESPACE/KEY=VALUE,...] + Partner metadata specifying namespace and its entries. The entries can + be key-value pairs or in json format. --partner-metadata-from-file=LOCAL_FILE_PATH - path to json local file which including the definintion of partner - metadata. + Path to a local json file containing partner metadata. --performance-monitoring-unit=PERFORMANCE_MONITORING_UNIT The set of performance measurement counters to enable for the instance. @@ -967,12 +968,15 @@ FLAGS If neither --termination-time nor --max-run-duration is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --termination-time, the VM instance - is automatically terminated at the specified timestamp. Note: Anytime - the VM instance is stopped or suspended, --termination-time and (unless - the VM uses --provisioning-model=SPOT) --instance-termination-action - are automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped or + suspended and redefined whenever the VM is rerun. For + --termination-time specifically, the terminationTimestamp remains the + same whenever the VM is rerun, but any requests to rerun the VM fail if + the specified timestamp is in the past. --threads-per-core=THREADS_PER_CORE The number of visible threads per physical core. To disable diff --git a/gcloud/alpha/compute/instances/create-with-container b/gcloud/alpha/compute/instances/create-with-container index c71f59284..dd263499f 100644 --- a/gcloud/alpha/compute/instances/create-with-container +++ b/gcloud/alpha/compute/instances/create-with-container @@ -453,15 +453,16 @@ FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM preemption - (--provisioning-model=SPOT or --preemptible) or automatic instance - termination (--max-run-duration or --termination-time). + (--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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. --internal-ipv6-address=INTERNAL_IPV6_ADDRESS Assigns the given internal IPv6 address or range to the instance that diff --git a/gcloud/alpha/compute/instances/describe b/gcloud/alpha/compute/instances/describe index 9c2c2b13c..51c524cc2 100644 --- a/gcloud/alpha/compute/instances/describe +++ b/gcloud/alpha/compute/instances/describe @@ -38,13 +38,15 @@ FLAGS stored with the given keys. --view=VIEW - specify Instance view. VIEW must be one of: + Specifies the information that the output should contain. VIEW must be + one of: BASIC - Default view of instance, Including everything except Partner - Metadata. + Default output view. Output contains all configuration details of + the instance, except partner metadata. FULL - Include everything in instance + Output contains all configuration details of the instance, + including partner metadata. --zone=ZONE Zone of the instance to describe. If not specified, you might be diff --git a/gcloud/alpha/compute/instances/help b/gcloud/alpha/compute/instances/help index b694884a3..3bb41c7fb 100644 --- a/gcloud/alpha/compute/instances/help +++ b/gcloud/alpha/compute/instances/help @@ -60,7 +60,7 @@ COMMANDS (ALPHA) Add or update instance metadata. add-partner-metadata - (ALPHA) add or update or patch partner metadata. + (ALPHA) Add or update partner metadata. add-resource-policies (ALPHA) Add resource policies to Compute Engine VM instances. @@ -119,7 +119,7 @@ COMMANDS zones. patch-partner-metadata - (ALPHA) patch partner metadata. + (ALPHA) Patch partner metadata. perform-maintenance (ALPHA) Perform maintenance of Google Compute Engine instance. @@ -135,7 +135,7 @@ COMMANDS (ALPHA) Remove instance metadata. remove-partner-metadata - (ALPHA) remove partner metadata namespace. + (ALPHA) Remove partner metadata. remove-resource-policies (ALPHA) Remove resource policies from Compute Engine VM instances. diff --git a/gcloud/alpha/compute/instances/list b/gcloud/alpha/compute/instances/list index da91a1cad..4949d25fe 100644 --- a/gcloud/alpha/compute/instances/list +++ b/gcloud/alpha/compute/instances/list @@ -46,13 +46,15 @@ FLAGS Flag --regexp is deprecated. Use --filter="name~'REGEXP'" instead. --view=VIEW - specify Instance view. VIEW must be one of: + Specifies the information that the output should contain. VIEW must be + one of: BASIC - Default view of instance, Including everything except Partner - Metadata. + Default output view. Output contains all configuration details of + the instance, except partner metadata. FULL - Include everything in instance + Output contains all configuration details of the instance, + including partner metadata. --zones=ZONE,[ZONE,...] If provided, only resources from the given zones are queried. diff --git a/gcloud/alpha/compute/instances/patch-partner-metadata b/gcloud/alpha/compute/instances/patch-partner-metadata index 7b2d2d07c..c79d2e743 100644 --- a/gcloud/alpha/compute/instances/patch-partner-metadata +++ b/gcloud/alpha/compute/instances/patch-partner-metadata @@ -4,40 +4,40 @@ NAME SYNOPSIS gcloud alpha compute instances patch-partner-metadata INSTANCE_NAME - [--partner-metadata=[KEY=VALUE,...]] + [--partner-metadata=[NAMESPACE/KEY=VALUE,...]] [--partner-metadata-from-file=LOCAL_FILE_PATH] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) gcloud alpha compute instances patch-partner-metadata can be used - to add or patch partner metadata of a virtual machine instance. Every - instance has access to a metadata server that can be used to query partner - metadata that has been set through this tool. For information on metadata, - see + to patch partner metadata of a virtual machine instance. Every instance has + access to a metadata server that can be used to query partner metadata that + has been set through this tool. For information on metadata, see About VM + metadata (https://cloud.google.com/compute/docs/metadata/overview). - Only Namespaces keys that are provided are mutated. Existing Namespaces + Only namespaces keys that are provided are mutated. Existing Namespaces entries will remain unaffected. In order to retrieve partner metadata, run: $ gcloud compute instances describe example-instance --zone - us-central1-a --format="value(partnerMetadata)" + us-central1-a --view=FULL --format="value(partnerMetadata)" where example-instance is the name of the virtual machine instance you're querying partner metadata from. EXAMPLES - To add partner metadata under namespace gcar.googleapis.com/engine to + To add partner metadata under namespace test.compute.googleapis.com to instance TEST_INSTANCE run: $ gcloud alpha compute instances patch-partner-metadata \ TEST_INSTANCE \ - --partner-metadata=gcar.googleapis.com/engine="{ "engine": { \ - "type": V8 } }" + --partner-metadata=test.compute.googleapis.com/entries/\ + engine="{ "engine": { "type": V8 } }" To add partner metadata from a file: - $ gcloud alpha compute instances add-partner-metadata \ + $ gcloud alpha compute instances patch-partner-metadata \ TEST_INSTANCE --partner-metadata-from-file=examples/engine.json POSITIONAL ARGUMENTS @@ -47,13 +47,12 @@ POSITIONAL ARGUMENTS at: https://cloud.google.com/compute/docs/reference/rest/v1/instances FLAGS - --partner-metadata=[KEY=VALUE,...] - Partner Metadata assigned to the instance. A map from a - subdomain(namespace) to entries map. + --partner-metadata=[NAMESPACE/KEY=VALUE,...] + Partner metadata specifying namespace and its entries. The entries can + be key-value pairs or in json format. --partner-metadata-from-file=LOCAL_FILE_PATH - path to json local file which including the definintion of partner - metadata. + Path to a local json file containing partner metadata. --zone=ZONE Zone of the instance to set partner metadata on. If not specified, you @@ -91,5 +90,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 beta compute instances patch-partner-metadata diff --git a/gcloud/alpha/compute/instances/remove-partner-metadata b/gcloud/alpha/compute/instances/remove-partner-metadata index 723e5203c..035202a65 100644 --- a/gcloud/alpha/compute/instances/remove-partner-metadata +++ b/gcloud/alpha/compute/instances/remove-partner-metadata @@ -1,6 +1,6 @@ NAME gcloud alpha compute instances remove-partner-metadata - remove partner - metadata namespace + metadata SYNOPSIS gcloud alpha compute instances remove-partner-metadata INSTANCE_NAME @@ -8,16 +8,19 @@ SYNOPSIS DESCRIPTION (ALPHA) gcloud alpha compute instances remove-partner-metadata can be used - to remove instance metadata entries. + to remove a specific entry in a namespace, a specific namespace, or all + namespaces. EXAMPLES - To remove partner metadata namespace gcar.googleapis.com/engine and - gcar.googleapis.com/body along with their data from an instance named - INSTANCE_NAME, run: + To remove partner metadata specific entry in a namespace + test.compute.googleapis.com/entries/engine an instance named INSTANCE_NAME, + run: $ gcloud alpha compute instances remove-partner-metadata \ - INSTANCE_NAME \ - --keys=gcar.googleapis.com/engine,gcar.googleapis.com/body + INSTANCE_NAME --keys=test.compute.googleapis.com/entries/engine + + To remove specific namespace with its data, run: $ gcloud alpha compute instances remove-partner-metadata \ + INSTANCE_NAME --keys=test.compute.googleapis.com To remove all namespaces, run: $ gcloud alpha compute instances remove-partner-metadata \ INSTANCE_NAME --all @@ -73,5 +76,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 beta compute instances remove-partner-metadata diff --git a/gcloud/alpha/compute/instances/set-scheduling b/gcloud/alpha/compute/instances/set-scheduling index b7477e6c8..3357c9c19 100644 --- a/gcloud/alpha/compute/instances/set-scheduling +++ b/gcloud/alpha/compute/instances/set-scheduling @@ -129,18 +129,17 @@ FLAGS the scheduling options. --discard-local-ssds-at-termination-timestamp=DISCARD_LOCAL_SSDS_AT_TERMINATION_TIMESTAMP - Required and only allowed for VMs that have one or more local SSDs, - use --termination-action=STOP (default), and use either - --max-run-duration or --termination-time. This flag indicates whether - you want Compute Engine to discard (true) or preserve (false) local - SSD data when the VM's terminationTimestamp is reached. + Required to be set to true and only allowed for VMs that have one or + more local SSDs, use --instance-termination-action=STOP, and use + either --max-run-duration or --termination-time. - If set to false, Compute Engine will preserve local SSD data by - including the --discard-local-ssd=false flag in the automatic - termination command. The --discard-local-ssd=false flag preserves - local SSD data by migrating it to persistent storage until you rerun - the VM. Importantly, preserving local SSD data incurs costs and is - subject to restrictions. For more information, see + This flag indicates the value that you want Compute Engine to use for + the --discard-local-ssd flag in the automatic gcloud compute + instances stop command. This flag only supports the true value, which + discards local SSD data when automatically stopping this VM during + its terminationTimestamp. + + For more information about the --discard-local-ssd flag, see https://cloud.google.com/compute/docs/disks/local-ssd#stop_instance. Instance Termination Action @@ -158,15 +157,16 @@ FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM - preemption (--provisioning-model=SPOT or --preemptible) or automatic - instance termination (--max-run-duration or --termination-time). + 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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. Max Run Duration @@ -177,7 +177,7 @@ FLAGS --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration - relative to the VM instance's most-recent start time. Format the + relative to the last time when the VM began running. Format the duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and seconds followed by d, h, m, and s respectively. For example, specify 30m for a duration of 30 minutes or specify 1d2h3m4s for a @@ -187,13 +187,15 @@ FLAGS If neither --max-run-duration nor --termination-time is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --max-run-duration, the VM - instance is automatically terminated when the VM's current runtime - reaches MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or - suspended, --max-run-duration and (unless the VM uses - --provisioning-model=SPOT) --instance-termination-action are - automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped + or suspended and redefined whenever the VM is rerun. For + --max-run-duration specifically, the terminationTimestamp is the sum + of MAX_RUN_DURATION and the time when the VM last entered the RUNNING + state, which changes whenever the VM is rerun. Sole Tenancy. @@ -247,12 +249,15 @@ FLAGS If neither --termination-time nor --max-run-duration is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --termination-time, the VM - instance is automatically terminated at the specified timestamp. - Note: Anytime the VM instance is stopped or suspended, - --termination-time and (unless the VM uses --provisioning-model=SPOT) - --instance-termination-action are automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped + or suspended and redefined whenever the VM is rerun. For + --termination-time specifically, the terminationTimestamp remains the + same whenever the VM is rerun, but any requests to rerun the VM fail + if the specified timestamp is in the past. Maintenance Behavior. diff --git a/gcloud/alpha/compute/instances/update b/gcloud/alpha/compute/instances/update index eb5509107..974eecf1f 100644 --- a/gcloud/alpha/compute/instances/update +++ b/gcloud/alpha/compute/instances/update @@ -7,7 +7,8 @@ SYNOPSIS [--[no-]deletion-protection] [--[no-]enable-display-device] [--[no-]graceful-shutdown] [--graceful-shutdown-max-duration=GRACEFUL_SHUTDOWN_MAX_DURATION] - [--min-cpu-platform=PLATFORM] [--partner-metadata=[KEY=VALUE,...]] + [--min-cpu-platform=PLATFORM] + [--partner-metadata=[NAMESPACE/KEY=VALUE,...]] [--partner-metadata-from-file=LOCAL_FILE_PATH] [--[no-]shielded-integrity-monitoring] [--shielded-learn-integrity-policy] [--[no-]shielded-secure-boot] @@ -81,13 +82,12 @@ FLAGS You can find more information on-line: https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform - --partner-metadata=[KEY=VALUE,...] - Partner Metadata assigned to the instance. A map from a - subdomain(namespace) to entries map. + --partner-metadata=[NAMESPACE/KEY=VALUE,...] + Partner metadata specifying namespace and its entries. The entries can + be key-value pairs or in json format. --partner-metadata-from-file=LOCAL_FILE_PATH - path to json local file which including the definintion of partner - metadata. + Path to a local json file containing partner metadata. --[no-]shielded-integrity-monitoring Enables monitoring and attestation of the boot integrity of the diff --git a/gcloud/alpha/compute/interconnects/attachments/dedicated/create b/gcloud/alpha/compute/interconnects/attachments/dedicated/create index 9c53dafee..9a6fb5854 100644 --- a/gcloud/alpha/compute/interconnects/attachments/dedicated/create +++ b/gcloud/alpha/compute/interconnects/attachments/dedicated/create @@ -75,10 +75,10 @@ OPTIONAL FLAGS request fails if all candidate subnets are in use at Google's edge. --cloud-router-ipv6-interface-id=INTERFACE_ID - The cloud-router-ipv6-interface-id field is not available. + cloud-router-ipv6-interface-id field is not available. --customer-router-ipv6-interface-id=PEER_INTERFACE_ID - The customer-router-ipv6-interface-id field is not available. + customer-router-ipv6-interface-id field is not available. --description=DESCRIPTION Human-readable plain-text description of attachment. @@ -131,8 +131,8 @@ OPTIONAL FLAGS --mtu=MTU Maximum transmission unit (MTU) is the size of the largest IP packet - passing through this interconnect attachment. Only 1440 and 1500 are - allowed values. If not specified, the value will default to 1440. + passing through this interconnect attachment. Must be one of 1440, + 1460, 1500, or 8896. If not specified, the value will default to 1440. --region=REGION Region of the interconnect attachment to create. If not specified, you @@ -155,8 +155,8 @@ OPTIONAL FLAGS CLOUDSDK_COMPUTE_REGION. --stack-type=STACK_TYPE - The stack type of the protocol(s) enabled on this interconnect - attachment. STACK_TYPE must be one of: + Stack type of the protocol(s) enabled on this interconnect attachment. + STACK_TYPE must be one of: IPV4_IPV6 Both IPv4 and IPv6 protocols are enabled on this attachment. @@ -164,12 +164,12 @@ OPTIONAL FLAGS Only IPv4 protocol is enabled on this attachment. --subnet-length=SUBNET_LENGTH - The length of the IPv4 subnet mask for this attachment. 29 is the - default value, except for attachments on Cross-Cloud Interconnects - whose remote location's "constraints.subnetLengthRange" field specifies - a minimum subnet length of 30. In that case, the default value is 30. - The default value is recommended when there's no requirement on the - subnet length. SUBNET_LENGTH must be one of: 29, 30. + Length of the IPv4 subnet mask for this attachment. 29 is the default + value, except for attachments on Cross-Cloud Interconnects whose remote + location's "constraints.subnetLengthRange" field specifies a minimum + subnet length of 30. In that case, the default value is 30. The default + value is recommended when there's no requirement on the subnet length. + SUBNET_LENGTH must be one of: 29, 30. --vlan=VLAN Desired VLAN for this attachment, in the range 2-4093. If not supplied, diff --git a/gcloud/alpha/compute/interconnects/attachments/dedicated/update b/gcloud/alpha/compute/interconnects/attachments/dedicated/update index af2c227e4..223553a83 100644 --- a/gcloud/alpha/compute/interconnects/attachments/dedicated/update +++ b/gcloud/alpha/compute/interconnects/attachments/dedicated/update @@ -55,10 +55,10 @@ FLAGS The candididate-ipv6-subnets field is not available. --cloud-router-ipv6-interface-id=INTERFACE_ID - The cloud-router-ipv6-interface-id field is not available. + cloud-router-ipv6-interface-id field is not available. --customer-router-ipv6-interface-id=PEER_INTERFACE_ID - The customer-router-ipv6-interface-id field is not available. + customer-router-ipv6-interface-id field is not available. --description=DESCRIPTION Human-readable plain-text description of attachment. @@ -74,8 +74,8 @@ FLAGS --mtu=MTU Maximum transmission unit (MTU) is the size of the largest IP packet - passing through this interconnect attachment. Only 1440 and 1500 are - allowed values. If not specified, the value will default to 1440. + passing through this interconnect attachment. Must be one of 1440, + 1460, 1500, or 8896. If not specified, the value will default to 1440. --region=REGION Region of the interconnect attachment to patch. If not specified, you @@ -98,8 +98,8 @@ FLAGS CLOUDSDK_COMPUTE_REGION. --stack-type=STACK_TYPE - The stack type of the protocol(s) enabled on this interconnect - attachment. STACK_TYPE must be one of: + Stack type of the protocol(s) enabled on this interconnect attachment. + STACK_TYPE must be one of: IPV4_IPV6 Both IPv4 and IPv6 protocols are enabled on this attachment. diff --git a/gcloud/alpha/compute/interconnects/attachments/partner/create b/gcloud/alpha/compute/interconnects/attachments/partner/create index dd3113836..e3051d495 100644 --- a/gcloud/alpha/compute/interconnects/attachments/partner/create +++ b/gcloud/alpha/compute/interconnects/attachments/partner/create @@ -92,8 +92,8 @@ OPTIONAL FLAGS --mtu=MTU Maximum transmission unit (MTU) is the size of the largest IP packet - passing through this interconnect attachment. Only 1440 and 1500 are - allowed values. If not specified, the value will default to 1440. + passing through this interconnect attachment. Must be one of 1440, + 1460, 1500, or 8896. If not specified, the value will default to 1440. --region=REGION Region of the interconnect attachment to create. If not specified, you @@ -116,8 +116,8 @@ OPTIONAL FLAGS CLOUDSDK_COMPUTE_REGION. --stack-type=STACK_TYPE - The stack type of the protocol(s) enabled on this interconnect - attachment. STACK_TYPE must be one of: + Stack type of the protocol(s) enabled on this interconnect attachment. + STACK_TYPE must be one of: IPV4_IPV6 Both IPv4 and IPv6 protocols are enabled on this attachment. diff --git a/gcloud/alpha/compute/interconnects/attachments/partner/update b/gcloud/alpha/compute/interconnects/attachments/partner/update index 09bdd89fb..d81f52ea6 100644 --- a/gcloud/alpha/compute/interconnects/attachments/partner/update +++ b/gcloud/alpha/compute/interconnects/attachments/partner/update @@ -30,8 +30,8 @@ FLAGS --mtu=MTU Maximum transmission unit (MTU) is the size of the largest IP packet - passing through this interconnect attachment. Only 1440 and 1500 are - allowed values. If not specified, the value will default to 1440. + passing through this interconnect attachment. Must be one of 1440, + 1460, 1500, or 8896. If not specified, the value will default to 1440. --region=REGION Region of the interconnect attachment to patch. If not specified, you @@ -54,8 +54,8 @@ FLAGS CLOUDSDK_COMPUTE_REGION. --stack-type=STACK_TYPE - The stack type of the protocol(s) enabled on this interconnect - attachment. STACK_TYPE must be one of: + Stack type of the protocol(s) enabled on this interconnect attachment. + STACK_TYPE must be one of: IPV4_IPV6 Both IPv4 and IPv6 protocols are enabled on this attachment. diff --git a/gcloud/alpha/compute/network-endpoint-groups/create b/gcloud/alpha/compute/network-endpoint-groups/create index bf46b75a0..df88d6736 100644 --- a/gcloud/alpha/compute/network-endpoint-groups/create +++ b/gcloud/alpha/compute/network-endpoint-groups/create @@ -7,8 +7,8 @@ SYNOPSIS [--client-port-mapping-mode=CLIENT_PORT_MAPPING_MODE] [--default-port=DEFAULT_PORT] [--network=NETWORK] [--network-endpoint-type=NETWORK_ENDPOINT_TYPE; - default="gce-vm-ip-port"] [--psc-target-service=PSC_TARGET_SERVICE] - [--subnet=SUBNET] + default="gce-vm-ip-port"] [--producer-port=PRODUCER_PORT] + [--psc-target-service=PSC_TARGET_SERVICE] [--subnet=SUBNET] [--cloud-function-name=CLOUD_FUNCTION_NAME --cloud-function-url-mask=CLOUD_FUNCTION_URL_MASK | --cloud-run-service=CLOUD_RUN_SERVICE @@ -52,11 +52,11 @@ FLAGS network endpoint. If this flag isn't specified for a NEG with endpoint type - gce-vm-ip-port or non-gcp-private-ip-port, then every network endpoint - in the network endpoint group must have a port specified. For a global - NEG with endpoint type internet-ip-port and internet-fqdn-port if the - default port is not specified, the well-known port for your backend - protocol is used (80 for HTTP, 443 for HTTPS). + gce-vm-ip-port, gce-vm-ip-portmap or non-gcp-private-ip-port, then + every network endpoint in the network endpoint group must have a port + specified. For a global NEG with endpoint type internet-ip-port and + internet-fqdn-port if the default port is not specified, the well-known + port for your backend protocol is used (80 for HTTP, 443 for HTTPS). This flag is not supported for NEGs with endpoint type serverless. @@ -69,7 +69,7 @@ FLAGS This is only supported for NEGs with endpoint type gce-vm-ip-port, non-gcp-private-ip-port, gce-vm-ip, private-service-connect, - internet-ip-port, or internet-fqdn-port. + internet-ip-port, internet-fqdn-port, or gce-vm-ip-portmap. For Private Service Connect NEGs, you can optionally specify --network and --subnet if --psc-target-service points to a published service. If @@ -124,9 +124,26 @@ FLAGS optional. If unspecified, the primary NIC address is used. A port must not be specified. + gce-vm-ip-portmap + Endpoint IP address must belong to a VM in Compute Engine (either + the primary IP or as part of an aliased IP range). The + --default-port must be specified or every network endpoint in the + network endpoint group must have a port and client-port specified. + NETWORK_ENDPOINT_TYPE must be one of: gce-vm-ip-port, internet-ip-port, internet-fqdn-port, non-gcp-private-ip-port, - serverless, gce-vm-ip, private-service-connect. + serverless, gce-vm-ip, private-service-connect, gce-vm-ip-portmap. + + --producer-port=PRODUCER_PORT + The psc producer port to use when consumer PSC NEG connects to a + producer. + + If this flag isn't specified for a PSC NEG with endpoint type + private-service-connect, then PSC NEG will be connected to a first port + in the available pcs producer port range. + + This flag is not supported for NEGs with endpoint type other than + private-service-connect. --psc-target-service=PSC_TARGET_SERVICE PSC target service name to add to the private service connect network @@ -139,9 +156,9 @@ FLAGS region where the network endpoint group is created. This is only supported for NEGs with endpoint type gce-vm-ip-port, - gce-vm-ip, or private-service-connect. For Private Service Connect - NEGs, you can optionally specify --network and --subnet if - --psc-target-service points to a published service. If + gce-vm-ip, private-service-connect, or gce-vm-ip-portmap. For Private + Service Connect NEGs, you can optionally specify --network and --subnet + if --psc-target-service points to a published service. If --psc-target-service points to the regional service endpoint of a Google API, do not specify --network or --subnet. diff --git a/gcloud/alpha/compute/network-endpoint-groups/update b/gcloud/alpha/compute/network-endpoint-groups/update index f1a37c998..0c278c330 100644 --- a/gcloud/alpha/compute/network-endpoint-groups/update +++ b/gcloud/alpha/compute/network-endpoint-groups/update @@ -4,9 +4,11 @@ NAME SYNOPSIS gcloud alpha compute network-endpoint-groups update NAME - (--add-endpoint=[client-port=CLIENT-PORT], + (--add-endpoint=[client-destination-port=CLIENT-DESTINATION-PORT], + [client-port=CLIENT-PORT], [fqdn=FQDN],[instance=INSTANCE],[ip=IP],[ipv6=IPV6],[port=PORT] - | --remove-endpoint=[client-port=CLIENT-PORT], + | --remove-endpoint=[client-destination-port=CLIENT-DESTINATION-PORT], + [client-port=CLIENT-PORT], [fqdn=FQDN],[instance=INSTANCE],[ip=IP],[ipv6=IPV6],[port=PORT]) [--global | --region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...] @@ -38,7 +40,7 @@ REQUIRED FLAGS Exactly one of these must be specified: - --add-endpoint=[client-port=CLIENT-PORT],[fqdn=FQDN],[instance=INSTANCE],[ip=IP],[ipv6=IPV6],[port=PORT] + --add-endpoint=[client-destination-port=CLIENT-DESTINATION-PORT],[client-port=CLIENT-PORT],[fqdn=FQDN],[instance=INSTANCE],[ip=IP],[ipv6=IPV6],[port=PORT] The network endpoint to add to the network endpoint group. Keys used depend on the endpoint type of the NEG. @@ -67,7 +69,7 @@ REQUIRED FLAGS *port* - Required endpoint port unless NEG default port is set. - *client-port* - Required endpoint client port only for the port + *client-destination-port* - Required endpoint client destination port only for the port mapping NEG. internet-ip-port @@ -129,7 +131,7 @@ REQUIRED FLAGS IP address must be the VM's network interface address. If not specified, the primary NIC address is used. - --remove-endpoint=[client-port=CLIENT-PORT],[fqdn=FQDN],[instance=INSTANCE],[ip=IP],[ipv6=IPV6],[port=PORT] + --remove-endpoint=[client-destination-port=CLIENT-DESTINATION-PORT],[client-port=CLIENT-PORT],[fqdn=FQDN],[instance=INSTANCE],[ip=IP],[ipv6=IPV6],[port=PORT] The network endpoint to detach from the network endpoint group. Keys used depend on the endpoint type of the NEG. @@ -147,7 +149,7 @@ REQUIRED FLAGS *port* - Optional port of the network endpoint to detach. - *client-port* - Optional client port, only for port mapping NEGs. + *client-destination-port* - Optional client destination port, only for port mapping NEGs. internet-ip-port diff --git a/gcloud/alpha/compute/network-firewall-policies/help b/gcloud/alpha/compute/network-firewall-policies/help index dfd460049..ecfe2fddd 100644 --- a/gcloud/alpha/compute/network-firewall-policies/help +++ b/gcloud/alpha/compute/network-firewall-policies/help @@ -22,6 +22,10 @@ GROUPS (ALPHA) Read and manipulate Compute Engine network firewall policy associations. + mirroring-rules + (ALPHA) Read and manipulate Compute Engine packet mirroring rules in + network firewall policy. + rules (ALPHA) Read and manipulate Compute Engine network firewall policy rules. diff --git a/gcloud/alpha/compute/network-firewall-policies/mirroring-rules/create b/gcloud/alpha/compute/network-firewall-policies/mirroring-rules/create new file mode 100644 index 000000000..01a9a6480 --- /dev/null +++ b/gcloud/alpha/compute/network-firewall-policies/mirroring-rules/create @@ -0,0 +1,153 @@ +NAME + gcloud alpha compute network-firewall-policies mirroring-rules create - + creates a Compute Engine network firewall policy packet mirroring rule + +SYNOPSIS + gcloud alpha compute network-firewall-policies mirroring-rules create + PRIORITY --action=ACTION --firewall-policy=FIREWALL_POLICY + --global-firewall-policy [--description=DESCRIPTION] + [--dest-address-groups=[DEST_ADDRESS_GROUPS,...]] + [--dest-fqdns=[DEST_FQDNS,...]] [--dest-ip-ranges=[DEST_IP_RANGE,...]] + [--dest-region-codes=[DEST_REGION_CODES,...]] + [--dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...]] + [--direction=DIRECTION] [--[no-]disabled] + [--layer4-configs=[LAYER4_CONFIG,...]] + [--security-profile-group=SECURITY_PROFILE_GROUP] + [--src-address-groups=[SOURCE_ADDRESS_GROUPS,...]] + [--src-fqdns=[SOURCE_FQDNS,...]] [--src-ip-ranges=[SRC_IP_RANGE,...]] + [--src-region-codes=[SOURCE_REGION_CODES,...]] + [--src-secure-tags=[SOURCE_SECURE_TAGS,...]] + [--src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...]] + [--target-secure-tags=[TARGET_SECURE_TAGS,...]] + [--target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute network-firewall-policies mirroring-rules + create is used to create network firewall policy packet mirroring rules. + +EXAMPLES + To create a rule with priority 10 in a global network firewall policy with + name my-policy and description example rule, run: + + $ gcloud alpha compute network-firewall-policies mirroring-rules \ + create 10 --firewall-policy=my-policy --action=do_not_mirror \ + --description="example rule" --global-firewall-policy + +POSITIONAL ARGUMENTS + PRIORITY + Priority of the rule to be inserted. Valid in [0, 65535]. + +REQUIRED FLAGS + --action=ACTION + Action to take if the request matches the match condition. ACTION must + be one of: mirror, do_not_mirror, goto_next. + + --firewall-policy=FIREWALL_POLICY + Firewall policy ID with which to create rule. + + --global-firewall-policy + Use this flag to indicate that firewall policy is global. + +OPTIONAL FLAGS + --description=DESCRIPTION + An optional, textual description for the rule. + + --dest-address-groups=[DEST_ADDRESS_GROUPS,...] + Destination address groups to match for this rule. Can only be + specified if DIRECTION is engress. + + --dest-fqdns=[DEST_FQDNS,...] + Destination FQDNs to match for this rule. Can only be specified if + DIRECTION is egress. + + --dest-ip-ranges=[DEST_IP_RANGE,...] + Destination IP ranges to match for this rule. + + --dest-region-codes=[DEST_REGION_CODES,...] + Destination Region Code to match for this rule. Can only be specified + if DIRECTION is egress. + + --dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...] + Destination Threat Intelligence lists to match for this rule. Can only + be specified if DIRECTION is egress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. + + --direction=DIRECTION + Direction of the traffic the rule is applied. The default is to apply + on incoming traffic. DIRECTION must be one of: INGRESS, EGRESS. + + --[no-]disabled + Use this flag to disable the rule. Disabled rules will not affect + traffic. Use --disabled to enable and --no-disabled to disable. + + --layer4-configs=[LAYER4_CONFIG,...] + A list of destination protocols and ports to which the firewall rule + will apply. + + --security-profile-group=SECURITY_PROFILE_GROUP + A security profile group to be used with apply_security_profile_group + action. + + --src-address-groups=[SOURCE_ADDRESS_GROUPS,...] + Source address groups to match for this rule. Can only be specified if + DIRECTION is ingress. + + --src-fqdns=[SOURCE_FQDNS,...] + Source FQDNs to match for this rule. Can only be specified if DIRECTION + is ingress. + + --src-ip-ranges=[SRC_IP_RANGE,...] + A list of IP address blocks that are allowed to make inbound + connections that match the firewall rule to the instances on the + network. The IP address blocks must be specified in CIDR format: + http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing.Either + --src-ip-ranges or --src-secure-tags must be specified for INGRESS + traffic. If both --src-ip-ranges and --src-secure-tags are specified, + the rule matches if either the range of the source matches + --src-ip-ranges or the secure tag of the source matches + --src-secure-tags.Multiple IP address blocks can be specified if they + are separated by commas. + + --src-region-codes=[SOURCE_REGION_CODES,...] + Source Region Code to match for this rule. Can only be specified if + DIRECTION is ingress. + + --src-secure-tags=[SOURCE_SECURE_TAGS,...] + A list of instance secure tags indicating the set of instances on the + network to which the rule applies if all other fields match. Either + --src-ip-ranges or --src-secure-tags must be specified for ingress + traffic. If both --src-ip-ranges and --src-secure-tags are specified, + an inbound connection is allowed if either the range of the source + matches --src-ip-ranges or the tag of the source matches + --src-secure-tags. Secure Tags can be assigned to instances during + instance creation. + + --src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...] + Source Threat Intelligence lists to match for this rule. Can only be + specified if DIRECTION is ingress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. + + --target-secure-tags=[TARGET_SECURE_TAGS,...] + An optional, list of target secure tags with a name of the format + tagValues/ or full namespaced name + + --target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...] + List of target service accounts for the rule. + +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/network-firewall-policies/mirroring-rules/delete b/gcloud/alpha/compute/network-firewall-policies/mirroring-rules/delete new file mode 100644 index 000000000..fb9dc9fdf --- /dev/null +++ b/gcloud/alpha/compute/network-firewall-policies/mirroring-rules/delete @@ -0,0 +1,45 @@ +NAME + gcloud alpha compute network-firewall-policies mirroring-rules delete - + deletes a Compute Engine network firewall policy packet mirroirng rule + +SYNOPSIS + gcloud alpha compute network-firewall-policies mirroring-rules delete + PRIORITY --firewall-policy=FIREWALL_POLICY --global-firewall-policy + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute network-firewall-policies mirroring-rules + delete is used to delete network firewall policy packet mirroring rules. + +EXAMPLES + To delete a rule with priority 10 in a global network firewall policy with + name my-policy, run: + + $ gcloud alpha compute network-firewall-policies mirroring-rules \ + delete 10 --firewall-policy=my-policy --global-firewall-policy + +POSITIONAL ARGUMENTS + PRIORITY + Priority of the rule to be deleted. Valid in [0, 65535]. + +REQUIRED FLAGS + --firewall-policy=FIREWALL_POLICY + Firewall policy ID with which to delete rule. + + --global-firewall-policy + Use this flag to indicate that firewall policy is global. + +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/network-firewall-policies/mirroring-rules/describe b/gcloud/alpha/compute/network-firewall-policies/mirroring-rules/describe new file mode 100644 index 000000000..77ba91313 --- /dev/null +++ b/gcloud/alpha/compute/network-firewall-policies/mirroring-rules/describe @@ -0,0 +1,47 @@ +NAME + gcloud alpha compute network-firewall-policies mirroring-rules describe - + describes a Compute Engine network firewall policy pakcet mirroring + rule + +SYNOPSIS + gcloud alpha compute network-firewall-policies mirroring-rules describe + PRIORITY --firewall-policy=FIREWALL_POLICY --global-firewall-policy + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute network-firewall-policies mirroring-rules + describe is used to describe network firewall policy packet mirroring + rules. + +EXAMPLES + To describe a rule with priority 10 in a global network firewall policy + with name my-policy, run: + + $ gcloud alpha compute network-firewall-policies mirroring-rules \ + describe 10 --firewall-policy=my-policy --global-firewall-policy + +POSITIONAL ARGUMENTS + PRIORITY + Priority of the rule to be described. Valid in [0, 65535]. + +REQUIRED FLAGS + --firewall-policy=FIREWALL_POLICY + Firewall policy ID with which to describe rule. + + --global-firewall-policy + Use this flag to indicate that firewall policy is global. + +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/network-firewall-policies/mirroring-rules/help b/gcloud/alpha/compute/network-firewall-policies/mirroring-rules/help new file mode 100644 index 000000000..2948e1ffb --- /dev/null +++ b/gcloud/alpha/compute/network-firewall-policies/mirroring-rules/help @@ -0,0 +1,43 @@ +NAME + gcloud alpha compute network-firewall-policies mirroring-rules - read and + manipulate Compute Engine packet mirroring rules in network firewall + policy + +SYNOPSIS + gcloud alpha compute network-firewall-policies mirroring-rules COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Read and manipulate Compute Engine packet mirroring rules in + network firewall policy. + +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) Creates a Compute Engine network firewall policy packet + mirroring rule. + + delete + (ALPHA) Deletes a Compute Engine network firewall policy packet + mirroirng rule. + + describe + (ALPHA) Describes a Compute Engine network firewall policy pakcet + mirroring rule. + + update + (ALPHA) Updates a Compute Engine network firewall policy packet + mirroring rule. + +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/network-firewall-policies/mirroring-rules/update b/gcloud/alpha/compute/network-firewall-policies/mirroring-rules/update new file mode 100644 index 000000000..832819a5a --- /dev/null +++ b/gcloud/alpha/compute/network-firewall-policies/mirroring-rules/update @@ -0,0 +1,157 @@ +NAME + gcloud alpha compute network-firewall-policies mirroring-rules update - + updates a Compute Engine network firewall policy packet mirroring rule + +SYNOPSIS + gcloud alpha compute network-firewall-policies mirroring-rules update + PRIORITY --firewall-policy=FIREWALL_POLICY --global-firewall-policy + [--action=ACTION] [--description=DESCRIPTION] + [--dest-address-groups=[DEST_ADDRESS_GROUPS,...]] + [--dest-fqdns=[DEST_FQDNS,...]] [--dest-ip-ranges=[DEST_IP_RANGE,...]] + [--dest-region-codes=[DEST_REGION_CODES,...]] + [--dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...]] + [--direction=DIRECTION] [--[no-]disabled] + [--layer4-configs=[LAYER4_CONFIG,...]] [--new-priority=NEW_PRIORITY] + [--security-profile-group=SECURITY_PROFILE_GROUP] + [--src-address-groups=[SOURCE_ADDRESS_GROUPS,...]] + [--src-fqdns=[SOURCE_FQDNS,...]] [--src-ip-ranges=[SRC_IP_RANGE,...]] + [--src-region-codes=[SOURCE_REGION_CODES,...]] + [--src-secure-tags=[SOURCE_SECURE_TAGS,...]] + [--src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...]] + [--target-secure-tags=[TARGET_SECURE_TAGS,...]] + [--target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute network-firewall-policies mirroring-rules + update is used to update network firewall policy packet mirroring rules. + +EXAMPLES + To update a rule with priority 10 in a global network firewall policy with + name my-policy to change the action to mirror and description to new + example rule, run: + + $ gcloud alpha compute network-firewall-policies mirroring-rules \ + update 10 --firewall-policy=my-policy --action=mirror \ + --description="new example rule" + +POSITIONAL ARGUMENTS + PRIORITY + Priority of the rule to be updated. Valid in [0, 65535]. + +REQUIRED FLAGS + --firewall-policy=FIREWALL_POLICY + Firewall policy ID with which to update rule. + + --global-firewall-policy + Use this flag to indicate that firewall policy is global. + +OPTIONAL FLAGS + --action=ACTION + Action to take if the request matches the match condition. ACTION must + be one of: mirror, do_not_mirror, goto_next. + + --description=DESCRIPTION + An optional, textual description for the rule. + + --dest-address-groups=[DEST_ADDRESS_GROUPS,...] + Destination address groups to match for this rule. Can only be + specified if DIRECTION is engress. + + --dest-fqdns=[DEST_FQDNS,...] + Destination FQDNs to match for this rule. Can only be specified if + DIRECTION is egress. + + --dest-ip-ranges=[DEST_IP_RANGE,...] + Destination IP ranges to match for this rule. + + --dest-region-codes=[DEST_REGION_CODES,...] + Destination Region Code to match for this rule. Can only be specified + if DIRECTION is egress. + + --dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...] + Destination Threat Intelligence lists to match for this rule. Can only + be specified if DIRECTION is egress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. + + --direction=DIRECTION + Direction of the traffic the rule is applied. The default is to apply + on incoming traffic. DIRECTION must be one of: INGRESS, EGRESS. + + --[no-]disabled + Use this flag to disable the rule. Disabled rules will not affect + traffic. Use --disabled to enable and --no-disabled to disable. + + --layer4-configs=[LAYER4_CONFIG,...] + A list of destination protocols and ports to which the firewall rule + will apply. + + --new-priority=NEW_PRIORITY + New priority for the rule to update. Valid in [0, 65535]. + + --security-profile-group=SECURITY_PROFILE_GROUP + A security profile group to be used with apply_security_profile_group + action. + + --src-address-groups=[SOURCE_ADDRESS_GROUPS,...] + Source address groups to match for this rule. Can only be specified if + DIRECTION is ingress. + + --src-fqdns=[SOURCE_FQDNS,...] + Source FQDNs to match for this rule. Can only be specified if DIRECTION + is ingress. + + --src-ip-ranges=[SRC_IP_RANGE,...] + A list of IP address blocks that are allowed to make inbound + connections that match the firewall rule to the instances on the + network. The IP address blocks must be specified in CIDR format: + http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing.Either + --src-ip-ranges or --src-secure-tags must be specified for INGRESS + traffic. If both --src-ip-ranges and --src-secure-tags are specified, + the rule matches if either the range of the source matches + --src-ip-ranges or the secure tag of the source matches + --src-secure-tags.Multiple IP address blocks can be specified if they + are separated by commas. + + --src-region-codes=[SOURCE_REGION_CODES,...] + Source Region Code to match for this rule. Can only be specified if + DIRECTION is ingress. + + --src-secure-tags=[SOURCE_SECURE_TAGS,...] + A list of instance secure tags indicating the set of instances on the + network to which the rule applies if all other fields match. Either + --src-ip-ranges or --src-secure-tags must be specified for ingress + traffic. If both --src-ip-ranges and --src-secure-tags are specified, + an inbound connection is allowed if either the range of the source + matches --src-ip-ranges or the tag of the source matches + --src-secure-tags. Secure Tags can be assigned to instances during + instance creation. + + --src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...] + Source Threat Intelligence lists to match for this rule. Can only be + specified if DIRECTION is ingress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. + + --target-secure-tags=[TARGET_SECURE_TAGS,...] + An optional, list of target secure tags with a name of the format + tagValues/ or full namespaced name + + --target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...] + List of target service accounts for the rule. + +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/packet-mirrorings/create b/gcloud/alpha/compute/packet-mirrorings/create index ee420ef23..e4d144a8b 100644 --- a/gcloud/alpha/compute/packet-mirrorings/create +++ b/gcloud/alpha/compute/packet-mirrorings/create @@ -75,11 +75,12 @@ OPTIONAL FLAGS --no-enable to disable. --filter-cidr-ranges=[CIDR_RANGE,...] - List of IP CIDR ranges that apply as filters on the source or - destination IP in the IP header for packet mirroring traffic. All - traffic between the VM and the IPs listed here will be mirrored using - this configuration. This can be a Public IP as well. If unspecified, - the config applies to all traffic. + One or more IPv4 or IPv6 CIDR ranges that apply as filters on the + source (ingress) or destination (egress) IP in the IP header. If no + ranges are specified, all IPv4 traffic that matches the specified + IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is + specified, all IPv4 traffic is mirrored. To mirror all IPv4 and IPv6 + traffic, use 0.0.0.0/0,::/0 --filter-direction=DIRECTION ◆ For ingress, only ingress traffic is mirrored. diff --git a/gcloud/alpha/compute/project-zonal-metadata/add b/gcloud/alpha/compute/project-zonal-metadata/add index 81b336c9f..c29f75256 100644 --- a/gcloud/alpha/compute/project-zonal-metadata/add +++ b/gcloud/alpha/compute/project-zonal-metadata/add @@ -49,7 +49,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud compute project-zonal-metadata add $ gcloud beta compute project-zonal-metadata add diff --git a/gcloud/alpha/compute/project-zonal-metadata/describe b/gcloud/alpha/compute/project-zonal-metadata/describe index ad850d70e..3745afd0f 100644 --- a/gcloud/alpha/compute/project-zonal-metadata/describe +++ b/gcloud/alpha/compute/project-zonal-metadata/describe @@ -32,7 +32,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud compute project-zonal-metadata describe $ gcloud beta compute project-zonal-metadata describe diff --git a/gcloud/alpha/compute/project-zonal-metadata/help b/gcloud/alpha/compute/project-zonal-metadata/help index 510dc3ef4..b1eaab72d 100644 --- a/gcloud/alpha/compute/project-zonal-metadata/help +++ b/gcloud/alpha/compute/project-zonal-metadata/help @@ -29,7 +29,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud compute project-zonal-metadata $ gcloud beta compute project-zonal-metadata diff --git a/gcloud/alpha/compute/project-zonal-metadata/remove b/gcloud/alpha/compute/project-zonal-metadata/remove index 18e2ce29b..8faf100c6 100644 --- a/gcloud/alpha/compute/project-zonal-metadata/remove +++ b/gcloud/alpha/compute/project-zonal-metadata/remove @@ -56,7 +56,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud compute project-zonal-metadata remove $ gcloud beta compute project-zonal-metadata remove diff --git a/gcloud/alpha/compute/queued-resources/create b/gcloud/alpha/compute/queued-resources/create index 6e4a9681e..ed37ab990 100644 --- a/gcloud/alpha/compute/queued-resources/create +++ b/gcloud/alpha/compute/queued-resources/create @@ -367,18 +367,17 @@ OPTIONAL FLAGS Specifies a textual description of the instances. --discard-local-ssds-at-termination-timestamp=DISCARD_LOCAL_SSDS_AT_TERMINATION_TIMESTAMP - Required and only allowed for VMs that have one or more local SSDs, use - --termination-action=STOP (default), and use either --max-run-duration - or --termination-time. This flag indicates whether you want Compute - Engine to discard (true) or preserve (false) local SSD data when the - VM's terminationTimestamp is reached. + Required to be set to true and only allowed for VMs that have one or + more local SSDs, use --instance-termination-action=STOP, and use either + --max-run-duration or --termination-time. - If set to false, Compute Engine will preserve local SSD data by - including the --discard-local-ssd=false flag in the automatic - termination command. The --discard-local-ssd=false flag preserves local - SSD data by migrating it to persistent storage until you rerun the VM. - Importantly, preserving local SSD data incurs costs and is subject to - restrictions. For more information, see + This flag indicates the value that you want Compute Engine to use for + the --discard-local-ssd flag in the automatic gcloud compute instances + stop command. This flag only supports the true value, which discards + local SSD data when automatically stopping this VM during its + terminationTimestamp. + + For more information about the --discard-local-ssd flag, see https://cloud.google.com/compute/docs/disks/local-ssd#stop_instance. --disk=[boot=BOOT],[device-name=DEVICE-NAME],[name=NAME],[scope=SCOPE] @@ -432,15 +431,16 @@ OPTIONAL FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM preemption - (--provisioning-model=SPOT or --preemptible) or automatic instance - termination (--max-run-duration or --termination-time). + (--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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. @@ -513,7 +513,7 @@ OPTIONAL FLAGS --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration - relative to the VM instance's most-recent start time. Format the + relative to the last time when the VM began running. Format the duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and seconds followed by d, h, m, and s respectively. For example, specify 30m for a duration of 30 minutes or specify 1d2h3m4s for a duration of @@ -523,13 +523,15 @@ OPTIONAL FLAGS If neither --max-run-duration nor --termination-time is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --max-run-duration, the VM instance - is automatically terminated when the VM's current runtime reaches - MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or - suspended, --max-run-duration and (unless the VM uses - --provisioning-model=SPOT) --instance-termination-action are - automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped or + suspended and redefined whenever the VM is rerun. For + --max-run-duration specifically, the terminationTimestamp is the sum of + MAX_RUN_DURATION and the time when the VM last entered the RUNNING + state, which changes whenever the VM is rerun. --metadata=KEY=VALUE,[KEY=VALUE,...] Metadata to be made available to the guest operating system running on @@ -820,12 +822,15 @@ OPTIONAL FLAGS If neither --termination-time nor --max-run-duration is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --termination-time, the VM instance - is automatically terminated at the specified timestamp. Note: Anytime - the VM instance is stopped or suspended, --termination-time and (unless - the VM uses --provisioning-model=SPOT) --instance-termination-action - are automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped or + suspended and redefined whenever the VM is rerun. For + --termination-time specifically, the terminationTimestamp remains the + same whenever the VM is rerun, but any requests to rerun the VM fail if + the specified timestamp is in the past. --threads-per-core=THREADS_PER_CORE The number of visible threads per physical core. To disable diff --git a/gcloud/alpha/compute/snapshot-settings/update b/gcloud/alpha/compute/snapshot-settings/update index 4c024dd69..48f8a1b4b 100644 --- a/gcloud/alpha/compute/snapshot-settings/update +++ b/gcloud/alpha/compute/snapshot-settings/update @@ -36,10 +36,11 @@ FLAGS complete. --storage-location-names=[STORAGE_LOCATION_NAMES,...] - The custom storage locations that you specify for the project's - snapshots. Use this flag only when you use the SPECIFIC_LOCATIONS value - for the --storage-location-policy flag. For more information, refer to - the snapshot settings documentation at + The custom storage location that you specify for the project's + snapshots. You can specify only a single location. Use this flag only + when you use the specific-locations value for the + --storage-location-policy flag. For more information, refer to the + snapshot settings documentation at https://cloud.google.com/compute/docs/disks/snapshot-settings. --storage-location-policy=STORAGE_LOCATION_POLICY diff --git a/gcloud/alpha/compute/target-https-proxies/create b/gcloud/alpha/compute/target-https-proxies/create index 5249453eb..39d825328 100644 --- a/gcloud/alpha/compute/target-https-proxies/create +++ b/gcloud/alpha/compute/target-https-proxies/create @@ -8,6 +8,7 @@ SYNOPSIS [--http-keep-alive-timeout-sec=HTTP_KEEP_ALIVE_TIMEOUT_SEC] [--proxy-bind] [--quic-override=QUIC_OVERRIDE; default="NONE"] [--server-tls-policy=SERVER_TLS_POLICY] [--ssl-policy=SSL_POLICY] + [--tls-early-data=TLS_EARLY_DATA] [--certificate-manager-certificates=[CERTIFICATE_MANAGER_CERTIFICATES, ...] | --ssl-certificates=SSL_CERTIFICATE,[...]] [--global | --region=REGION] @@ -134,6 +135,29 @@ OPTIONAL FLAGS and load balancers that are using the HTTPS proxy. The SSL policy must exist and cannot be deleted while referenced by a target HTTPS proxy. + --tls-early-data=TLS_EARLY_DATA + TLS 1.3 Early Data ("0-RTT" or "zero round trip") allows clients to + include HTTP request data alongside a TLS handshake. This can improve + application performance, especially on networks where connection + interruptions may be common, such as on mobile. This applies to both + HTTP over TCP (ie: HTTP/1.1 and HTTP/2) and HTTP/3 over QUIC. + TLS_EARLY_DATA must be one of: + + DISABLED + TLS 1.3 Early Data is not advertised, and any (invalid) attempts to + send Early Data will be rejected. + PERMISSIVE + Enables TLS 1.3 Early Data for requests with safe HTTP methods + (GET, HEAD, OPTIONS, TRACE). This mode does not enforce any other + limitations for requests with Early Data. The application owner + should validate that Early Data is acceptable for a given request + path. + STRICT + Enables TLS 1.3 Early Data for requests with safe HTTP methods, and + HTTP requests that do not have query parameters. Requests that send + Early Data containing non-idempotent HTTP methods or with query + parameters will be rejected with a HTTP 425. + At most one of these can be specified: Certificate resource - certificate-manager-certificates to attach. This diff --git a/gcloud/alpha/compute/target-https-proxies/update b/gcloud/alpha/compute/target-https-proxies/update index b3449e4a4..991062c05 100644 --- a/gcloud/alpha/compute/target-https-proxies/update +++ b/gcloud/alpha/compute/target-https-proxies/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha compute target-https-proxies update NAME - [--quic-override=QUIC_OVERRIDE] [--url-map=URL_MAP] + [--quic-override=QUIC_OVERRIDE] [--tls-early-data=TLS_EARLY_DATA] + [--url-map=URL_MAP] [--certificate-manager-certificates=[CERTIFICATE_MANAGER_CERTIFICATES, ...] | --clear-ssl-certificates | --ssl-certificates=SSL_CERTIFICATE,[...] --global-ssl-certificates @@ -68,6 +69,29 @@ FLAGS NONE Allows Google to control when QUIC is rolled out. + --tls-early-data=TLS_EARLY_DATA + TLS 1.3 Early Data ("0-RTT" or "zero round trip") allows clients to + include HTTP request data alongside a TLS handshake. This can improve + application performance, especially on networks where connection + interruptions may be common, such as on mobile. This applies to both + HTTP over TCP (ie: HTTP/1.1 and HTTP/2) and HTTP/3 over QUIC. + TLS_EARLY_DATA must be one of: + + DISABLED + TLS 1.3 Early Data is not advertised, and any (invalid) attempts to + send Early Data will be rejected. + PERMISSIVE + Enables TLS 1.3 Early Data for requests with safe HTTP methods + (GET, HEAD, OPTIONS, TRACE). This mode does not enforce any other + limitations for requests with Early Data. The application owner + should validate that Early Data is acceptable for a given request + path. + STRICT + Enables TLS 1.3 Early Data for requests with safe HTTP methods, and + HTTP requests that do not have query parameters. Requests that send + Early Data containing non-idempotent HTTP methods or with query + parameters will be rejected with a HTTP 425. + --url-map=URL_MAP A reference to a URL map resource. A URL map defines the mapping of URLs to backend services. Before you can refer to a URL map, you must diff --git a/gcloud/alpha/config/get b/gcloud/alpha/config/get index 5acca824f..2717f6583 100644 --- a/gcloud/alpha/config/get +++ b/gcloud/alpha/config/get @@ -270,8 +270,7 @@ AVAILABLE PROPERTIES to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. Defaults to - https://cloudiot.googleapis.com/ + Overrides API endpoint for gcloud iot command group. cloudkms Overrides API endpoint for gcloud kms command group. Defaults to diff --git a/gcloud/alpha/config/help b/gcloud/alpha/config/help index 6638cf37d..3c82aa0b9 100644 --- a/gcloud/alpha/config/help +++ b/gcloud/alpha/config/help @@ -302,8 +302,7 @@ AVAILABLE PROPERTIES to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. Defaults to - https://cloudiot.googleapis.com/ + Overrides API endpoint for gcloud iot command group. cloudkms Overrides API endpoint for gcloud kms command group. Defaults to diff --git a/gcloud/alpha/config/list b/gcloud/alpha/config/list index 6c8501a1e..be12c90c4 100644 --- a/gcloud/alpha/config/list +++ b/gcloud/alpha/config/list @@ -314,8 +314,7 @@ AVAILABLE PROPERTIES to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. Defaults to - https://cloudiot.googleapis.com/ + Overrides API endpoint for gcloud iot command group. cloudkms Overrides API endpoint for gcloud kms command group. Defaults to diff --git a/gcloud/alpha/config/set b/gcloud/alpha/config/set index b86080627..522805ac6 100644 --- a/gcloud/alpha/config/set +++ b/gcloud/alpha/config/set @@ -317,8 +317,7 @@ AVAILABLE PROPERTIES to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. Defaults to - https://cloudiot.googleapis.com/ + Overrides API endpoint for gcloud iot command group. cloudkms Overrides API endpoint for gcloud kms command group. Defaults to diff --git a/gcloud/alpha/config/unset b/gcloud/alpha/config/unset index ed4e0c982..8f18023ef 100644 --- a/gcloud/alpha/config/unset +++ b/gcloud/alpha/config/unset @@ -278,8 +278,7 @@ AVAILABLE PROPERTIES to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. Defaults to - https://cloudiot.googleapis.com/ + Overrides API endpoint for gcloud iot command group. cloudkms Overrides API endpoint for gcloud kms command group. Defaults to diff --git a/gcloud/alpha/container/backup-restore/backup-plans/create b/gcloud/alpha/container/backup-restore/backup-plans/create index 9290a8657..455163aca 100644 --- a/gcloud/alpha/container/backup-restore/backup-plans/create +++ b/gcloud/alpha/container/backup-restore/backup-plans/create @@ -10,9 +10,12 @@ SYNOPSIS [--deactivated] [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] [--backup-delete-lock-days=BACKUP_DELETE_LOCK_DAYS --backup-retain-days=BACKUP_RETAIN_DAYS --locked] - [--cron-schedule=CRON_SCHEDULE : --paused] [--encryption-key=ENCRYPTION_KEY - --include-secrets --include-volume-data] [GCLOUD_WIDE_FLAG ...] + --include-secrets --include-volume-data] + [--paused --cron-schedule=CRON_SCHEDULE + [--target-rpo-minutes=TARGET_RPO_MINUTES + : --exclusion-windows-file=EXCLUSION_WINDOWS_FILE]] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Create a Backup for GKE backup plan. @@ -130,18 +133,6 @@ OPTIONAL FLAGS If set, subsequent updates are not allowed to the backup plan's retention policy and this value cannot be changed. - --cron-schedule=CRON_SCHEDULE - Schedule on which backups will be automatically created. - - Use standard cron (http://en.wikipedia.org/wiki/Cron#Overview) syntax. - For example, 10 3 * * * will automatically create a backup at 0310 - every day. All times are interpreted as UTC. The minimum interval - between scheduled backups is 10 minutes. - - --paused - If set, automatic backup creation is suppressed. When unset, automatic - backup creation resumes with the next scheduled create event. - --encryption-key=ENCRYPTION_KEY Encryption key used for encrypting the backup. @@ -158,6 +149,27 @@ OPTIONAL FLAGS PersistentVolumeClaims that fall within the scope. If unset, the default is false. + --paused + If set, automatic backup creation is suppressed. When unset, automatic + backup creation resumes with the next scheduled create event. + + --cron-schedule=CRON_SCHEDULE + Schedule on which backups will be automatically created. + + Use standard cron (http://en.wikipedia.org/wiki/Cron#Overview) syntax. + For example, 10 3 * * * will automatically create a backup at 0310 + every day. All times are interpreted as UTC. The minimum interval + between scheduled backups is 10 minutes. + + --target-rpo-minutes=TARGET_RPO_MINUTES + Schedule backups based on target RPO minutes instead of fixed cron + schedules. Cannot be used with --cron-schedule. + + --exclusion-windows-file=EXCLUSION_WINDOWS_FILE + If provided, defines an array of exclusion windows for RPO based + schedules from the given config file in yaml. Only used together with + --target-rpo-minutes for creation and rpo-based plans during update. + 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/container/backup-restore/backup-plans/update b/gcloud/alpha/container/backup-restore/backup-plans/update index 614118129..42d054bf5 100644 --- a/gcloud/alpha/container/backup-restore/backup-plans/update +++ b/gcloud/alpha/container/backup-restore/backup-plans/update @@ -12,9 +12,11 @@ SYNOPSIS [--backup-delete-lock-days=BACKUP_DELETE_LOCK_DAYS --backup-retain-days=BACKUP_RETAIN_DAYS --locked] [--clear-labels | --remove-labels=[KEY,...]] - [--cron-schedule=CRON_SCHEDULE --paused] [--encryption-key=ENCRYPTION_KEY - --include-secrets --include-volume-data] [GCLOUD_WIDE_FLAG ...] + --include-secrets --include-volume-data] + [--paused --cron-schedule=CRON_SCHEDULE + --exclusion-windows-file=EXCLUSION_WINDOWS_FILE + --target-rpo-minutes=TARGET_RPO_MINUTES] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Update a Backup for GKE backup plan. @@ -147,18 +149,6 @@ FLAGS silently ignored. If --update-labels is also specified then --update-labels is applied first. - --cron-schedule=CRON_SCHEDULE - Schedule on which backups will be automatically created. - - Use standard cron (http://en.wikipedia.org/wiki/Cron#Overview) syntax. - For example, 10 3 * * * will automatically create a backup at 0310 - every day. All times are interpreted as UTC. The minimum interval - between scheduled backups is 10 minutes. - - --paused - If set, automatic backup creation is suppressed. When unset, automatic - backup creation resumes with the next scheduled create event. - --encryption-key=ENCRYPTION_KEY Encryption key used for encrypting the backup. @@ -175,6 +165,27 @@ FLAGS PersistentVolumeClaims that fall within the scope. If unset, the default is false. + --paused + If set, automatic backup creation is suppressed. When unset, automatic + backup creation resumes with the next scheduled create event. + + --cron-schedule=CRON_SCHEDULE + Schedule on which backups will be automatically created. + + Use standard cron (http://en.wikipedia.org/wiki/Cron#Overview) syntax. + For example, 10 3 * * * will automatically create a backup at 0310 + every day. All times are interpreted as UTC. The minimum interval + between scheduled backups is 10 minutes. + + --exclusion-windows-file=EXCLUSION_WINDOWS_FILE + If provided, defines an array of exclusion windows for RPO based + schedules from the given config file in yaml. Only used together with + --target-rpo-minutes for creation and rpo-based plans during update. + + --target-rpo-minutes=TARGET_RPO_MINUTES + Schedule backups based on target RPO minutes instead of fixed cron + schedules. Cannot be used with --cron-schedule. + 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/container/backup-restore/backups/get-backup-index-download-url b/gcloud/alpha/container/backup-restore/backups/get-backup-index-download-url new file mode 100644 index 000000000..51760ed4f --- /dev/null +++ b/gcloud/alpha/container/backup-restore/backups/get-backup-index-download-url @@ -0,0 +1,85 @@ +NAME + gcloud alpha container backup-restore backups get-backup-index-download-url + - get a backup index download URL + +SYNOPSIS + gcloud alpha container backup-restore backups get-backup-index-download-url + (BACKUP : --backup-plan=BACKUP_PLAN --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get backup index download URL for a Backup for GKE backup. Backup + index displays resources' basic information stored in the backup. + +EXAMPLES + To get the backup index associated with a backup my-backup in backup plan + my-backup-plan in project my-project in location us-central1, run: + + $ gcloud alpha container backup-restore backups \ + get-backup-index-download-url my-backup --project=my-project \ + --location=us-central1 --backup-plan=my-backup-plan + +POSITIONAL ARGUMENTS + Backup resource - Name of the backup to create. Once the backup is + created, this name can't be changed. This must be 63 or fewer characters + long and must be unique within the project, location, and backup plan. The + name may be provided either as a relative name, e.g. + projects//locations//backupPlans//backups/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. BACKUP --project= --location= + --backup_plan=. 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-plan=BACKUP_PLAN + Backup Plan name. + + To set the backup-plan attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --backup-plan on the command line; + ▸ set the property gkebackup/backup_plan. + + --location=LOCATION + Google Cloud location. + + 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; + ▸ set the property gkebackup/location. + +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 container backup-restore backups \ + get-backup-index-download-url + diff --git a/gcloud/alpha/container/backup-restore/backups/help b/gcloud/alpha/container/backup-restore/backups/help index c9a5d18e0..452792eaa 100644 --- a/gcloud/alpha/container/backup-restore/backups/help +++ b/gcloud/alpha/container/backup-restore/backups/help @@ -25,6 +25,9 @@ COMMANDS describe (ALPHA) Describe a backup. + get-backup-index-download-url + (ALPHA) Get a backup index download URL. + get-iam-policy (ALPHA) Get the IAM policy for a backup. diff --git a/gcloud/alpha/container/binauthz/policy/export-system-policy b/gcloud/alpha/container/binauthz/policy/export-system-policy index 4a0337142..535bad31e 100644 --- a/gcloud/alpha/container/binauthz/policy/export-system-policy +++ b/gcloud/alpha/container/binauthz/policy/export-system-policy @@ -35,8 +35,8 @@ FLAGS asia-south2, asia-southeast1, asia-southeast2, australia-southeast1, australia-southeast2, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west10, europe-west12, - europe-west2, europe-west3, europe-west4, europe-west5, europe-west6, - europe-west8, europe-west9, me-central1, me-central2, me-west1, + europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, + europe-west9, me-central1, me-central2, me-west1, northamerica-northeast1, northamerica-northeast2, southamerica-east1, southamerica-west1, us-central1, us-central2, us-east1, us-east4, us-east5, us-east7, us-south1, us-west1, us-west2, us-west3, us-west4, diff --git a/gcloud/alpha/container/clusters/create b/gcloud/alpha/container/clusters/create index d74457ee5..0afa7d966 100644 --- a/gcloud/alpha/container/clusters/create +++ b/gcloud/alpha/container/clusters/create @@ -18,6 +18,7 @@ SYNOPSIS [--cluster-ipv4-cidr=CLUSTER_IPV4_CIDR] [--cluster-secondary-range-name=NAME] [--cluster-version=CLUSTER_VERSION] + [--containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE] [--create-subnetwork=[KEY=VALUE,...]] [--database-encryption-key=DATABASE_ENCRYPTION_KEY] [--default-max-pods-per-node=DEFAULT_MAX_PODS_PER_NODE] @@ -36,10 +37,10 @@ SYNOPSIS [--enable-l4-ilb-subsetting] [--enable-legacy-authorization] [--enable-logging-monitoring-system-only] [--enable-managed-prometheus] [--enable-master-global-access] [--enable-multi-networking] - [--enable-network-policy] [--enable-pod-security-policy] - [--enable-secret-manager] [--enable-service-externalips] - [--enable-shielded-nodes] [--enable-stackdriver-kubernetes] - [--enable-vertical-pod-autoscaling] + [--enable-nested-virtualization] [--enable-network-policy] + [--enable-pod-security-policy] [--enable-secret-manager] + [--enable-service-externalips] [--enable-shielded-nodes] + [--enable-stackdriver-kubernetes] [--enable-vertical-pod-autoscaling] [--fleet-project=PROJECT_ID_OR_NUMBER] [--gateway-api=GATEWAY_API] [--identity-provider=IDENTITY_PROVIDER] [--image-type=IMAGE_TYPE] [--in-transit-encryption=IN_TRANSIT_ENCRYPTION] @@ -167,10 +168,10 @@ FLAGS (Optional) The NVIDIA driver version to install. GPU_DRIVER_VERSION must be one of: - `default`: Install the default driver version. + `default`: Install the default driver version for this GKE version. - `latest`: Install the latest available driver version. Available only for - nodes that use Container-Optimized OS. + `latest`: Install the latest driver version available for this GKE version. + Can only be used for nodes that use Container-Optimized OS. `disabled`: Skip automatic driver installation. You must manually install a driver after you create the cluster. If you omit the flag `gpu-driver-version`, @@ -299,6 +300,10 @@ FLAGS within VPCs that peer with this cluster. You should specify --cluster-ipv4-cidr to prevent conflicts. + This field is not applicable in a Shared VPC setup where the IP address + range for the pods must be specified with + --cluster-secondary-range-name + --cluster-secondary-range-name=NAME Set the secondary range to be used as the source for pod IPs. Alias ranges will be allocated from this secondary range. NAME must be the @@ -316,6 +321,17 @@ FLAGS $ gcloud container get-server-config + --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + Path of the YAML file that contains containerd configuration entries + like configuring access to private image registries. + + For detailed information on the configuration usage, please refer to + https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration. + + Note: Updating the containerd configuration of an existing cluster or + node pool requires recreation of the existing nodes, which might cause + disruptions in running workloads. + --create-subnetwork=[KEY=VALUE,...] Create a new subnetwork for the cluster. The name and range of the subnetwork can be customized via optional 'name' and 'range' key-value @@ -599,6 +615,12 @@ FLAGS Enables multi-networking on the cluster. Multi-networking is disabled by default. + --enable-nested-virtualization + Enables the use of nested virtualization on the default initial node + pool. Defaults to false. Can only be enabled on UBUNTU_CONTAINERD base + image or COS_CONTAINERD base image with version 1.28.4-gke.1083000 and + above. + --enable-network-policy Enable network policy enforcement for this cluster. If you are enabling network policy on an existing cluster the network policy addon must @@ -1208,9 +1230,9 @@ FLAGS sysctl: net.core.somaxconn: '2048' net.ipv4.tcp_rmem: '4096 87380 6291456' - hugepageConfig: - hugepage_size2m: '1024' - hugepage_size1g: '2' + hugepageConfig: + hugepage_size2m: '1024' + hugepage_size1g: '2' List of supported kubelet configs in 'kubeletConfig'. diff --git a/gcloud/alpha/container/clusters/create-auto b/gcloud/alpha/container/clusters/create-auto index 559032eba..d06ac2b30 100644 --- a/gcloud/alpha/container/clusters/create-auto +++ b/gcloud/alpha/container/clusters/create-auto @@ -10,6 +10,7 @@ SYNOPSIS [--cluster-ipv4-cidr=CLUSTER_IPV4_CIDR] [--cluster-secondary-range-name=NAME] [--cluster-version=CLUSTER_VERSION] + [--containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE] [--create-subnetwork=[KEY=VALUE,...]] [--database-encryption-key=DATABASE_ENCRYPTION_KEY] [--enable-backup-restore] [--enable-cilium-clusterwide-network-policy] @@ -124,6 +125,10 @@ FLAGS within VPCs that peer with this cluster. You should specify --cluster-ipv4-cidr to prevent conflicts. + This field is not applicable in a Shared VPC setup where the IP address + range for the pods must be specified with + --cluster-secondary-range-name + --cluster-secondary-range-name=NAME Set the secondary range to be used as the source for pod IPs. Alias ranges will be allocated from this secondary range. NAME must be the @@ -140,6 +145,17 @@ FLAGS $ gcloud container get-server-config + --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + Path of the YAML file that contains containerd configuration entries + like configuring access to private image registries. + + For detailed information on the configuration usage, please refer to + https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration. + + Note: Updating the containerd configuration of an existing cluster or + node pool requires recreation of the existing nodes, which might cause + disruptions in running workloads. + --create-subnetwork=[KEY=VALUE,...] Create a new subnetwork for the cluster. The name and range of the subnetwork can be customized via optional 'name' and 'range' key-value diff --git a/gcloud/alpha/container/clusters/update b/gcloud/alpha/container/clusters/update index 3ca1b8194..27a6e567c 100644 --- a/gcloud/alpha/container/clusters/update +++ b/gcloud/alpha/container/clusters/update @@ -8,6 +8,7 @@ SYNOPSIS | --autoprovisioning-resource-manager-tags=[KEY=VALUE,...] | --autoscaling-profile=AUTOSCALING_PROFILE | --clear-fleet-project | --complete-credential-rotation | --complete-ip-rotation + | --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE | --database-encryption-key=DATABASE_ENCRYPTION_KEY | --disable-database-encryption | --disable-default-snat | --disable-workload-identity | --enable-autoscaling @@ -199,6 +200,17 @@ REQUIRED FLAGS single IP state. See documentation for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-rotation. + --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + Path of the YAML file that contains containerd configuration entries + like configuring access to private image registries. + + For detailed information on the configuration usage, please refer to + https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration. + + Note: Updating the containerd configuration of an existing cluster or + node pool requires recreation of the existing nodes, which might + cause disruptions in running workloads. + --database-encryption-key=DATABASE_ENCRYPTION_KEY Enable Database Encryption. diff --git a/gcloud/alpha/container/fleet/mesh/debug/bug-report b/gcloud/alpha/container/fleet/mesh/debug/bug-report new file mode 100644 index 000000000..51da2f36b --- /dev/null +++ b/gcloud/alpha/container/fleet/mesh/debug/bug-report @@ -0,0 +1,61 @@ +NAME + gcloud alpha container fleet mesh debug bug-report - capture cluster + information and logs into archive to help diagnose problems + +SYNOPSIS + gcloud alpha container fleet mesh debug bug-report + (--membership=MEMBERSHIP : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Example: $gcloud alpha container fleet mesh debug bug-report + --project=projectId --membership=membershipId --location=location + +REQUIRED FLAGS + Membership resource - The group of arguments defining a membership. 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 --membership 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. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. + + To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. + + To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + +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 container fleet mesh debug bug-report + diff --git a/gcloud/alpha/container/fleet/mesh/debug/help b/gcloud/alpha/container/fleet/mesh/debug/help new file mode 100644 index 000000000..c0a25c7ad --- /dev/null +++ b/gcloud/alpha/container/fleet/mesh/debug/help @@ -0,0 +1,35 @@ +NAME + gcloud alpha container fleet mesh debug - debug Service Mesh memberships + +SYNOPSIS + gcloud alpha container fleet mesh debug COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Debug Service Mesh memberships. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + bug-report + (ALPHA) Capture cluster information and logs into archive to help + diagnose problems. + + proxy-config + (ALPHA) Retrieve a configuration summary for a given Envoy instance. + + proxy-status + (ALPHA) Retrieve the envoy configuration sync status. + +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 container fleet mesh debug + diff --git a/gcloud/alpha/container/fleet/mesh/debug/proxy-config b/gcloud/alpha/container/fleet/mesh/debug/proxy-config new file mode 100644 index 000000000..e225d8bc9 --- /dev/null +++ b/gcloud/alpha/container/fleet/mesh/debug/proxy-config @@ -0,0 +1,90 @@ +NAME + gcloud alpha container fleet mesh debug proxy-config - retrieve a + configuration summary for a given Envoy instance + +SYNOPSIS + gcloud alpha container fleet mesh debug proxy-config POD_NAME_NAMESPACE + --type=TYPE (--membership=MEMBERSHIP : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Retrieve a configuration summary for a given Envoy instance. + +EXAMPLES + To retrieve the type cluster config dump for Pod instance pn.default. + + $gcloud alpha container fleet mesh debug proxy-config pn.default --type=cluster + --project=projectId + --membership=membershipId + --location=us-central1 + +POSITIONAL ARGUMENTS + POD_NAME_NAMESPACE + Pod to check against. Use in format of + +REQUIRED FLAGS + --type=TYPE + Proxy configuration type, one of + all|clusters|listeners|routes|endpoints|bootstrap|log|secret + + all Retrieves all configuration for the Envoy in the specified pod + bootstrap Retrieves bootstrap configuration for the Envoy in the specified pod + cluster Retrieves cluster configuration for the Envoy in the specified pod + ecds Retrieves typed extension configuration for the Envoy in the specified pod + endpoint Retrieves endpoint configuration for the Envoy in the specified pod + listener Retrieves listener configuration for the Envoy in the specified pod + log Retrieves logging levels of the Envoy in the specified pod + route Retrieves route configuration for the Envoy in the specified pod + secret Retrieves secret configuration for the Envoy in the specified pod + + TYPE must be one of: all, bootstrap, cluster, listeners, routes, + endpoints, listener, log, secret. + + Membership resource - The group of arguments defining a membership. 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 --membership 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. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. + + To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. + + To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + +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 container fleet mesh debug proxy-config + diff --git a/gcloud/alpha/container/fleet/mesh/debug/proxy-status b/gcloud/alpha/container/fleet/mesh/debug/proxy-status new file mode 100644 index 000000000..8b984d376 --- /dev/null +++ b/gcloud/alpha/container/fleet/mesh/debug/proxy-status @@ -0,0 +1,66 @@ +NAME + gcloud alpha container fleet mesh debug proxy-status - retrieve the envoy + configuration sync status + +SYNOPSIS + gcloud alpha container fleet mesh debug proxy-status + (--membership=MEMBERSHIP : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Retrieve the envoy configuration sync status. + +EXAMPLES + Retrieve the configuration sync status of all the proxies with the control + plane. + + Example: $gcloud alpha container fleet mesh debug proxy-status --project=projectId --membership=membershipId --location=us-central1 + +REQUIRED FLAGS + Membership resource - The group of arguments defining a membership. 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 --membership 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. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. + + To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. + + To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + +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 container fleet mesh debug proxy-status + diff --git a/gcloud/alpha/container/fleet/mesh/help b/gcloud/alpha/container/fleet/mesh/help index 7476d8a0f..7860400be 100644 --- a/gcloud/alpha/container/fleet/mesh/help +++ b/gcloud/alpha/container/fleet/mesh/help @@ -12,6 +12,12 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. +GROUPS + GROUP is one of the following: + + debug + (ALPHA) Debug Service Mesh memberships. + COMMANDS COMMAND is one of the following: diff --git a/gcloud/alpha/container/hub/mesh/debug/bug-report b/gcloud/alpha/container/hub/mesh/debug/bug-report new file mode 100644 index 000000000..e6a5689e9 --- /dev/null +++ b/gcloud/alpha/container/hub/mesh/debug/bug-report @@ -0,0 +1,61 @@ +NAME + gcloud alpha container hub mesh debug bug-report - capture cluster + information and logs into archive to help diagnose problems + +SYNOPSIS + gcloud alpha container hub mesh debug bug-report + (--membership=MEMBERSHIP : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Example: $gcloud alpha container hub mesh debug bug-report + --project=projectId --membership=membershipId --location=location + +REQUIRED FLAGS + Membership resource - The group of arguments defining a membership. 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 --membership 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. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. + + To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. + + To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + +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 container hub mesh debug bug-report + diff --git a/gcloud/alpha/container/hub/mesh/debug/help b/gcloud/alpha/container/hub/mesh/debug/help new file mode 100644 index 000000000..b2c7c03f0 --- /dev/null +++ b/gcloud/alpha/container/hub/mesh/debug/help @@ -0,0 +1,35 @@ +NAME + gcloud alpha container hub mesh debug - debug Service Mesh memberships + +SYNOPSIS + gcloud alpha container hub mesh debug COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Debug Service Mesh memberships. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + bug-report + (ALPHA) Capture cluster information and logs into archive to help + diagnose problems. + + proxy-config + (ALPHA) Retrieve a configuration summary for a given Envoy instance. + + proxy-status + (ALPHA) Retrieve the envoy configuration sync status. + +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 container hub mesh debug + diff --git a/gcloud/alpha/container/hub/mesh/debug/proxy-config b/gcloud/alpha/container/hub/mesh/debug/proxy-config new file mode 100644 index 000000000..3f9384b84 --- /dev/null +++ b/gcloud/alpha/container/hub/mesh/debug/proxy-config @@ -0,0 +1,90 @@ +NAME + gcloud alpha container hub mesh debug proxy-config - retrieve a + configuration summary for a given Envoy instance + +SYNOPSIS + gcloud alpha container hub mesh debug proxy-config POD_NAME_NAMESPACE + --type=TYPE (--membership=MEMBERSHIP : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Retrieve a configuration summary for a given Envoy instance. + +EXAMPLES + To retrieve the type cluster config dump for Pod instance pn.default. + + $gcloud alpha container hub mesh debug proxy-config pn.default --type=cluster + --project=projectId + --membership=membershipId + --location=us-central1 + +POSITIONAL ARGUMENTS + POD_NAME_NAMESPACE + Pod to check against. Use in format of + +REQUIRED FLAGS + --type=TYPE + Proxy configuration type, one of + all|clusters|listeners|routes|endpoints|bootstrap|log|secret + + all Retrieves all configuration for the Envoy in the specified pod + bootstrap Retrieves bootstrap configuration for the Envoy in the specified pod + cluster Retrieves cluster configuration for the Envoy in the specified pod + ecds Retrieves typed extension configuration for the Envoy in the specified pod + endpoint Retrieves endpoint configuration for the Envoy in the specified pod + listener Retrieves listener configuration for the Envoy in the specified pod + log Retrieves logging levels of the Envoy in the specified pod + route Retrieves route configuration for the Envoy in the specified pod + secret Retrieves secret configuration for the Envoy in the specified pod + + TYPE must be one of: all, bootstrap, cluster, listeners, routes, + endpoints, listener, log, secret. + + Membership resource - The group of arguments defining a membership. 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 --membership 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. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. + + To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. + + To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + +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 container hub mesh debug proxy-config + diff --git a/gcloud/alpha/container/hub/mesh/debug/proxy-status b/gcloud/alpha/container/hub/mesh/debug/proxy-status new file mode 100644 index 000000000..da170eb7f --- /dev/null +++ b/gcloud/alpha/container/hub/mesh/debug/proxy-status @@ -0,0 +1,66 @@ +NAME + gcloud alpha container hub mesh debug proxy-status - retrieve the envoy + configuration sync status + +SYNOPSIS + gcloud alpha container hub mesh debug proxy-status + (--membership=MEMBERSHIP : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Retrieve the envoy configuration sync status. + +EXAMPLES + Retrieve the configuration sync status of all the proxies with the control + plane. + + Example: $gcloud alpha container hub mesh debug proxy-status --project=projectId --membership=membershipId --location=us-central1 + +REQUIRED FLAGS + Membership resource - The group of arguments defining a membership. 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 --membership 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. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. + + To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. + + To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + +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 container hub mesh debug proxy-status + diff --git a/gcloud/alpha/container/hub/mesh/help b/gcloud/alpha/container/hub/mesh/help index 4d762284c..02cd7face 100644 --- a/gcloud/alpha/container/hub/mesh/help +++ b/gcloud/alpha/container/hub/mesh/help @@ -12,6 +12,12 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. +GROUPS + GROUP is one of the following: + + debug + (ALPHA) Debug Service Mesh memberships. + COMMANDS COMMAND is one of the following: diff --git a/gcloud/alpha/container/node-pools/create b/gcloud/alpha/container/node-pools/create index 406fe9266..8e58279c7 100644 --- a/gcloud/alpha/container/node-pools/create +++ b/gcloud/alpha/container/node-pools/create @@ -15,15 +15,16 @@ SYNOPSIS pod-ipv4-range=SECONDARY_RANGE_NAME, [max-pods-per-node=NUM_PODS],...]] [--async] [--boot-disk-kms-key=BOOT_DISK_KMS_KEY] [--cluster=CLUSTER] + [--containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE] [--disable-pod-cidr-overprovision] [--disk-size=DISK_SIZE] [--disk-type=DISK_TYPE] [--enable-autoprovisioning] [--enable-autorepair] [--no-enable-autoupgrade] [--enable-blue-green-upgrade] [--enable-confidential-nodes] [--enable-confidential-storage] [--enable-gvnic] - [--enable-image-streaming] [--enable-private-nodes] - [--enable-queued-provisioning] [--enable-surge-upgrade] - [--image-type=IMAGE_TYPE] [--labels=[KEY=VALUE,...]] - [--linux-sysctls=KEY=VALUE,[KEY=VALUE,...]] + [--enable-image-streaming] [--enable-nested-virtualization] + [--enable-private-nodes] [--enable-queued-provisioning] + [--enable-surge-upgrade] [--image-type=IMAGE_TYPE] + [--labels=[KEY=VALUE,...]] [--linux-sysctls=KEY=VALUE,[KEY=VALUE,...]] [--logging-variant=LOGGING_VARIANT] [--machine-type=MACHINE_TYPE, -m MACHINE_TYPE] [--max-pods-per-node=MAX_PODS_PER_NODE] @@ -40,8 +41,9 @@ SYNOPSIS [--num-nodes=NUM_NODES; default=3] [--placement-policy=PLACEMENT_POLICY] [--placement-type=PLACEMENT_TYPE] [--preemptible] [--resource-manager-tags=[KEY=VALUE,...]] - [--sandbox=[type=TYPE]] [--shielded-integrity-monitoring] - [--shielded-secure-boot] + [--sandbox=[type=TYPE]] + [--secondary-boot-disk=[disk-image=DISK_IMAGE,[mode=MODE],...]] + [--shielded-integrity-monitoring] [--shielded-secure-boot] [--sole-tenant-node-affinity-file=SOLE_TENANT_NODE_AFFINITY_FILE] [--spot] [--standard-rollout-policy=[batch-node-count=BATCH_NODE_COUNT, @@ -112,10 +114,10 @@ FLAGS (Optional) The NVIDIA driver version to install. GPU_DRIVER_VERSION must be one of: - `default`: Install the default driver version. + `default`: Install the default driver version for this GKE version. - `latest`: Install the latest available driver version. Available only for - nodes that use Container-Optimized OS. + `latest`: Install the latest driver version available for this GKE version. + Can only be used for nodes that use Container-Optimized OS. `disabled`: Skip automatic driver installation. You must manually install a driver after you create the cluster. If you omit the flag `gpu-driver-version`, @@ -186,6 +188,17 @@ FLAGS The cluster to add the node pool to. Overrides the default container/cluster property value for this command invocation. + --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + Path of the YAML file that contains containerd configuration entries + like configuring access to private image registries. + + For detailed information on the configuration usage, please refer to + https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration. + + Note: Updating the containerd configuration of an existing cluster or + node pool requires recreation of the existing nodes, which might cause + disruptions in running workloads. + --disable-pod-cidr-overprovision Disables pod cidr overprovision on nodes. Pod cidr overprovisioning is enabled by default. @@ -250,6 +263,11 @@ FLAGS --enable-image-streaming Specifies whether to enable image streaming on node pool. + --enable-nested-virtualization + Enables the use of nested virtualization on the node pool. Defaults to + false. Can only be enabled on UBUNTU_CONTAINERD base image or + COS_CONTAINERD base image with version 1.28.4-gke.1083000 and above. + --enable-private-nodes Enables provisioning nodes with private IP addresses only. @@ -580,6 +598,17 @@ FLAGS The only supported type is 'gvisor'. + --secondary-boot-disk=[disk-image=DISK_IMAGE,[mode=MODE],...] + Attaches secondary boot disks to all nodes. + + disk-image + (Required) The full resource path to the source disk image to + create the secondary boot disks from. + + mode + (Optional) The configuration mode for the secondary boot disks. The + default value is "CONTAINER_IMAGE_CACHE". + --shielded-integrity-monitoring Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy @@ -654,9 +683,9 @@ FLAGS sysctl: net.core.somaxconn: '2048' net.ipv4.tcp_rmem: '4096 87380 6291456' - hugepageConfig: - hugepage_size2m: '1024' - hugepage_size1g: '2' + hugepageConfig: + hugepage_size2m: '1024' + hugepage_size1g: '2' List of supported kubelet configs in 'kubeletConfig'. diff --git a/gcloud/alpha/container/node-pools/update b/gcloud/alpha/container/node-pools/update index d87f55f36..121057ae6 100644 --- a/gcloud/alpha/container/node-pools/update +++ b/gcloud/alpha/container/node-pools/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha container node-pools update NAME - (--enable-confidential-nodes | --enable-gvnic + (--containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + | --enable-confidential-nodes | --enable-gvnic | --enable-image-streaming | --enable-private-nodes | --enable-queued-provisioning | --labels=[KEY=VALUE,...] | --logging-variant=LOGGING_VARIANT @@ -49,6 +50,17 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS Exactly one of these must be specified: + --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + Path of the YAML file that contains containerd configuration entries + like configuring access to private image registries. + + For detailed information on the configuration usage, please refer to + https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration. + + Note: Updating the containerd configuration of an existing cluster or + node pool requires recreation of the existing nodes, which might + cause disruptions in running workloads. + --enable-confidential-nodes Recreate all the nodes in the node pool to be confidential VM https://cloud.google.com/compute/confidential-vm/docs/about-cvm. @@ -192,9 +204,9 @@ REQUIRED FLAGS sysctl: net.core.somaxconn: '2048' net.ipv4.tcp_rmem: '4096 87380 6291456' - hugepageConfig: - hugepage_size2m: '1024' - hugepage_size1g: '2' + hugepageConfig: + hugepage_size2m: '1024' + hugepage_size1g: '2' List of supported kubelet configs in 'kubeletConfig'. diff --git a/gcloud/alpha/dns/managed-zones/create b/gcloud/alpha/dns/managed-zones/create index 5912eaad3..0ace78cb8 100644 --- a/gcloud/alpha/dns/managed-zones/create +++ b/gcloud/alpha/dns/managed-zones/create @@ -2,8 +2,8 @@ NAME gcloud alpha dns managed-zones create - create a Cloud DNS managed-zone SYNOPSIS - gcloud alpha dns managed-zones create ZONE_NAME --description=DESCRIPTION - --dns-name=DNS_NAME [--denial-of-existence=DENIAL_OF_EXISTENCE] + gcloud alpha dns managed-zones create ZONE_NAME --dns-name=DNS_NAME + [--denial-of-existence=DENIAL_OF_EXISTENCE] [--description=DESCRIPTION] [--dnssec-state=DNSSEC_STATE] [--forwarding-targets=[IP_ADDRESSES,...]] [--gkeclusters=[GKECLUSTERS,...]] [--ksk-algorithm=KSK_ALGORITHM] [--ksk-key-length=KSK_KEY_LENGTH] [--labels=[KEY=VALUE,...]] @@ -43,9 +43,6 @@ POSITIONAL ARGUMENTS The name of the managed-zone to be created. REQUIRED FLAGS - --description=DESCRIPTION - Short description for the managed-zone. - --dns-name=DNS_NAME The DNS name suffix that will be managed with the created zone. @@ -54,6 +51,9 @@ OPTIONAL FLAGS Requires DNSSEC enabled. DENIAL_OF_EXISTENCE must be one of: nsec, nsec3. + --description=DESCRIPTION + Short description for the managed zone. + --dnssec-state=DNSSEC_STATE The DNSSEC state for this managed zone. DNSSEC_STATE must be one of: diff --git a/gcloud/alpha/dns/managed-zones/update b/gcloud/alpha/dns/managed-zones/update index 982af10a0..41ead8317 100644 --- a/gcloud/alpha/dns/managed-zones/update +++ b/gcloud/alpha/dns/managed-zones/update @@ -60,7 +60,7 @@ FLAGS nsec3. --description=DESCRIPTION - Short description for the managed-zone. + Short description for the managed zone. --dnssec-state=DNSSEC_STATE The DNSSEC state for this managed zone. DNSSEC_STATE must be one of: diff --git a/gcloud/alpha/domains/registrations/configure/dns b/gcloud/alpha/domains/registrations/configure/dns index 9ca70a7f4..c809f2ca5 100644 --- a/gcloud/alpha/domains/registrations/configure/dns +++ b/gcloud/alpha/domains/registrations/configure/dns @@ -18,10 +18,6 @@ DESCRIPTION servers and DNSSEC options for the given domain. However, advanced options like glue records are available. - When using Cloud DNS Zone or Google Domains name servers, DNSSEC will be - enabled by default where possible. You can disable it using the - --disable-dnssec flag. - EXAMPLES To start an interactive flow to configure DNS settings for example.com, run: @@ -33,7 +29,14 @@ EXAMPLES $ gcloud alpha domains registrations configure dns example.com \ --cloud-dns-zone=example-zone - If the managed-zone is signed, DNSSEC will be enabled for the domain. + DNSSEC will not be enabled as it may not be safe to enable it (e.g. when + the Cloud DNS managed-zone was signed less than 24h ago). + + To use a signed Cloud DNS managed-zone example-zone for example.com and + enable DNSSEC, run: + + $ gcloud alpha domains registrations configure dns example.com \ + --cloud-dns-zone=example-zone --no-disable-dnssec To change DNS settings for example.com according to information from a YAML file dns_settings.yaml, run: @@ -90,8 +93,6 @@ COMMONLY USED FLAGS for the domain. If it's in the same project, you can use short name. If not, use the full resource name, e.g.: --cloud-dns-zone=projects/example-project/managedZones/example-zone. - If the zone is signed, DNSSEC will be enabled by default unless you - pass --disable-dnssec. --dns-settings-from-file=DNS_SETTINGS_FILE_NAME A YAML file containing the required DNS settings. If specified, its @@ -129,9 +130,7 @@ COMMONLY USED FLAGS List of DNS name servers for the domain. --use-google-domains-dns - (DEPRECATED) Use free name servers provided by Google Domains. If - the zone is signed, DNSSEC will be enabled by default unless you - pass --disable-dnssec. + (DEPRECATED) Use free name servers provided by Google Domains. The --use-google-domains-dns option is deprecated; See https://cloud.google.com/domains/docs/deprecations/feature-deprecations. @@ -146,8 +145,12 @@ OTHER FLAGS to a Cloud DNS Zone or Google Domains nameservers. --unsafe-dns-update - Use this flag to allow DNS changes that may make your domain stop - serving. + (DEPRECATED) Use this flag to allow DNS changes that may make your + domain stop serving. + + The --unsafe-dns-update option is deprecated. To complete an unsafe DNS + operation first disable DNSSEC, then change name servers, then + (optionally) enable DNSSEC. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/domains/registrations/register b/gcloud/alpha/domains/registrations/register index e469c74f0..86ba7708c 100644 --- a/gcloud/alpha/domains/registrations/register +++ b/gcloud/alpha/domains/registrations/register @@ -23,9 +23,9 @@ DESCRIPTION Also in rare cases, the domain may end up in state REGISTRATION_FAILED. In that case, delete the registration resource and try again. - When using Cloud DNS Zone or Google Domains name servers, DNSSEC will be - enabled by default where possible. You can choose to not enable DNSSEC by - using the --disable-dnssec flag. + When using Cloud DNS Zone DNSSEC will be enabled by default whenever the + Zone is DNSSEC signed. You can choose to not enable DNSSEC by using the + --disable-dnssec flag. EXAMPLES To register example.com interactively, run: diff --git a/gcloud/alpha/iam/workforce-pools/providers/create-oidc b/gcloud/alpha/iam/workforce-pools/providers/create-oidc index 8eb3c8a34..af4dff0f8 100644 --- a/gcloud/alpha/iam/workforce-pools/providers/create-oidc +++ b/gcloud/alpha/iam/workforce-pools/providers/create-oidc @@ -13,7 +13,10 @@ SYNOPSIS [--async] [--attribute-condition=ATTRIBUTE_CONDITION] [--client-secret-value=CLIENT_SECRET_VALUE] [--description=DESCRIPTION] [--disabled] [--display-name=DISPLAY_NAME] - [--jwk-json-path=JWK_JSON_PATH] [GCLOUD_WIDE_FLAG ...] + [--jwk-json-path=JWK_JSON_PATH] + [--extra-attributes-client-id=EXTRA_ATTRIBUTES_CLIENT_ID + --extra-attributes-client-secret-value=EXTRA_ATTRIBUTES_CLIENT_SECRET_VALUE --extra-attributes-issuer-uri=EXTRA_ATTRIBUTES_ISSUER_URI --extra-attributes-type=EXTRA_ATTRIBUTES_TYPE : --extra-attributes-filter=EXTRA_ATTRIBUTES_FILTER] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Create a new OIDC workforce pool provider. @@ -266,6 +269,34 @@ OPTIONAL FLAGS ] } + --extra-attributes-client-id=EXTRA_ATTRIBUTES_CLIENT_ID + The OAuth 2.0 client ID for retrieving extra attributes from the + identity provider. Required to get the Access Token using client + credentials grant flow. + + --extra-attributes-client-secret-value=EXTRA_ATTRIBUTES_CLIENT_SECRET_VALUE + The OAuth 2.0 client secret for retrieving extra attributes from the + identity provider. Required to get the Access Token using client + credentials grant flow. + + --extra-attributes-issuer-uri=EXTRA_ATTRIBUTES_ISSUER_URI + OIDC identity provider's issuer URI. Must be a valid URI using the + 'https' scheme. Required to get the OIDC discovery document. + + --extra-attributes-type=EXTRA_ATTRIBUTES_TYPE + Represents the identity provider and type of claims that should be + fetched. EXTRA_ATTRIBUTES_TYPE must be one of: + attributes-type-unspecified, azure-ad-groups-mail. + + --extra-attributes-filter=EXTRA_ATTRIBUTES_FILTER + The filter used to request specific records from IdP. In case of + attributes type as AZURE_AD_GROUPS_MAIL, it represents the filter used + to request specific groups for users from IdP. By default all the + groups associated with the user are fetched. The groups that are used + should be mail enabled and security enabled. See + https://learn.microsoft.com/en-us/graph/search-query-parameter for more + details. + 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/iam/workforce-pools/providers/update-oidc b/gcloud/alpha/iam/workforce-pools/providers/update-oidc index d80328983..c6eb4112f 100644 --- a/gcloud/alpha/iam/workforce-pools/providers/update-oidc +++ b/gcloud/alpha/iam/workforce-pools/providers/update-oidc @@ -13,6 +13,9 @@ SYNOPSIS [--web-sso-assertion-claims-behavior=WEB_SSO_ASSERTION_CLAIMS_BEHAVIOR] [--web-sso-response-type=WEB_SSO_RESPONSE_TYPE] [--clear-client-secret | --client-secret-value=CLIENT_SECRET_VALUE] + [--clear-extra-attributes-config + | --extra-attributes-client-id=EXTRA_ATTRIBUTES_CLIENT_ID + --extra-attributes-client-secret-value=EXTRA_ATTRIBUTES_CLIENT_SECRET_VALUE --extra-attributes-filter=EXTRA_ATTRIBUTES_FILTER --extra-attributes-issuer-uri=EXTRA_ATTRIBUTES_ISSUER_URI --extra-attributes-type=EXTRA_ATTRIBUTES_TYPE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -253,6 +256,39 @@ FLAGS The OIDC client secret. Required to enable Authorization Code flow for web sign-in. + At most one of these can be specified: + + --clear-extra-attributes-config + Clear the extra attributes configuration + + --extra-attributes-client-id=EXTRA_ATTRIBUTES_CLIENT_ID + The OAuth 2.0 client ID for retrieving extra attributes from the + identity provider. Required to get the Access Token using client + credentials grant flow. + + --extra-attributes-client-secret-value=EXTRA_ATTRIBUTES_CLIENT_SECRET_VALUE + The OAuth 2.0 client secret for retrieving extra attributes from the + identity provider. Required to get the Access Token using client + credentials grant flow. + + --extra-attributes-filter=EXTRA_ATTRIBUTES_FILTER + The filter used to request specific records from IdP. In case of + attributes type as AZURE_AD_GROUPS_MAIL, it represents the filter + used to request specific groups for users from IdP. By default all + the groups associated with the user are fetched. The groups that are + used should be mail enabled and security enabled. See + https://learn.microsoft.com/en-us/graph/search-query-parameter for + more details. + + --extra-attributes-issuer-uri=EXTRA_ATTRIBUTES_ISSUER_URI + OIDC identity provider's issuer URI. Must be a valid URI using the + 'https' scheme. Required to get the OIDC discovery document. + + --extra-attributes-type=EXTRA_ATTRIBUTES_TYPE + Represents the identity provider and type of claims that should be + fetched. EXTRA_ATTRIBUTES_TYPE must be one of: + attributes-type-unspecified, azure-ad-groups-mail. + 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/iot/devices/commands/send b/gcloud/alpha/iot/devices/commands/send deleted file mode 100644 index 473b10891..000000000 --- a/gcloud/alpha/iot/devices/commands/send +++ /dev/null @@ -1,109 +0,0 @@ -NAME - gcloud alpha iot devices commands send - sends a command to a device - -SYNOPSIS - gcloud alpha iot devices commands send - (--command-data=COMMAND_DATA | --command-file=COMMAND_FILE) - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--subfolder=SUBFOLDER] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Sends a command to a device. - -EXAMPLES - To send a simple command to a device in 'my-registry' and region - 'us-central1' using a special command subfolder, run: - - $ gcloud alpha iot devices commands send --region=us-central1 \ - --registry=my-registry --device=my-device \ - --command-data="restart job" \ - --subfolder="/jobs/metric_collector" - - To send a command containing special characters to a device in - 'my-registry' and region 'us-central1', run: - - $ gcloud alpha iot devices commands send --region=us-central1 \ - --registry=my-registry --device=my-device \ - --command-file=/path/to/command.file - -REQUIRED FLAGS - Exactly one of these must be specified: - - --command-data=COMMAND_DATA - The data for this command, as a string. For any values that contain - special characters (in the context of your shell), use the - --command-file flag instead. - - --command-file=COMMAND_FILE - Path to a local file containing the data for this command. - - Device resource - The device you want to send commands to. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The name of the Cloud IoT registry. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -OPTIONAL FLAGS - --subfolder=SUBFOLDER - The commands subfolder to append to the topic path. - - This field must not have more than 256 characters, and must not contain - any MQTT wildcards ("+" or "#") or null 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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices commands send - - $ gcloud beta iot devices commands send - diff --git a/gcloud/alpha/iot/devices/configs/describe b/gcloud/alpha/iot/devices/configs/describe deleted file mode 100644 index 51355eddc..000000000 --- a/gcloud/alpha/iot/devices/configs/describe +++ /dev/null @@ -1,83 +0,0 @@ -NAME - gcloud alpha iot devices configs describe - show details about the latest - configuration for a device - -SYNOPSIS - gcloud alpha iot devices configs describe - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Show details about the latest configuration for a device. - -EXAMPLES - To show the details of the latest configuration for a device in region - 'us-central1', run: - - $ gcloud alpha iot devices configs describe --region=us-central1 \ - --registry=my-registry --device=my-device - -REQUIRED FLAGS - Device resource - The device you want to show the configuration 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The name of the Cloud IoT registry. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices configs describe - - $ gcloud beta iot devices configs describe - diff --git a/gcloud/alpha/iot/devices/configs/get-value b/gcloud/alpha/iot/devices/configs/get-value deleted file mode 100644 index d1e28c9b1..000000000 --- a/gcloud/alpha/iot/devices/configs/get-value +++ /dev/null @@ -1,79 +0,0 @@ -NAME - gcloud alpha iot devices configs get-value - show the binary data of a - device's latest configuration - -SYNOPSIS - gcloud alpha iot devices configs get-value - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Show the binary data of a device's latest - configuration. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To show the binary data of the latest configuration of a device in region - 'us-central1', run: - - $ gcloud alpha iot devices configs get-value --region=us-central1 \ - --registry=my-registry --device=my-device - -REQUIRED FLAGS - Device resource - The device for the configuration to get the value 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices configs get-value - - $ gcloud beta iot devices configs get-value - diff --git a/gcloud/alpha/iot/devices/configs/help b/gcloud/alpha/iot/devices/configs/help deleted file mode 100644 index bfc667d5f..000000000 --- a/gcloud/alpha/iot/devices/configs/help +++ /dev/null @@ -1,46 +0,0 @@ -NAME - gcloud alpha iot devices configs - manage configurations for Cloud IoT - devices - -SYNOPSIS - gcloud alpha iot devices configs COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Manage configurations for Cloud IoT devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing configurations for Google Cloud IoT devices. - -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) (DEPRECATED) Show details about the latest configuration for a - device. - - get-value - (ALPHA) (DEPRECATED) Show the binary data of a device's latest - configuration. - - list - (ALPHA) (DEPRECATED) List configs for a device. - - update - (ALPHA) (DEPRECATED) Update a specific device configuration. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices configs - - $ gcloud beta iot devices configs - diff --git a/gcloud/alpha/iot/devices/configs/list b/gcloud/alpha/iot/devices/configs/list deleted file mode 100644 index e325e571b..000000000 --- a/gcloud/alpha/iot/devices/configs/list +++ /dev/null @@ -1,111 +0,0 @@ -NAME - gcloud alpha iot devices configs list - list configs for a device - -SYNOPSIS - gcloud alpha iot devices configs list - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - This command lists all available configurations in the history of the - device. Up to 10 are kept; you may restrict the output to fewer via the - --limit flag. - -EXAMPLES - To list the 3 latest configurations of a device in region 'us-central1', - run: - - $ gcloud alpha iot devices configs list --region=us-central1 \ - --registry=my-registry --device=my-device --limit=3 - -REQUIRED FLAGS - Device resource - The device you want to list the configs 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The name of the Cloud IoT registry. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - - --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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices configs list - - $ gcloud beta iot devices configs list - diff --git a/gcloud/alpha/iot/devices/configs/update b/gcloud/alpha/iot/devices/configs/update deleted file mode 100644 index 7553c7020..000000000 --- a/gcloud/alpha/iot/devices/configs/update +++ /dev/null @@ -1,111 +0,0 @@ -NAME - gcloud alpha iot devices configs update - update a specific device - configuration - -SYNOPSIS - gcloud alpha iot devices configs update - (--config-data=CONFIG_DATA | --config-file=CONFIG_FILE) - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--version-to-update=VERSION_TO_UPDATE] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Update a specific device configuration. - - This command is deprecated. Google Cloud IoT Core has been retired. - - This command updates the current configuration of the device. - - It always creates a new config with a new version number; if - --version-to-update is provided, the config at that version is used as a - base. - -EXAMPLES - To update the latest configuration of a device in region 'us-central1', - run: - - $ gcloud alpha iot devices configs update --region=us-central1 \ - --registry=my-registry --device=my-device \ - --config-data="job_timeout:300" - - To update the latest configuration of a device in region 'us-central1' only - if the latest configuration version is 11, run: - - $ gcloud alpha iot devices configs update --region=us-central1 \ - --registry=my-registry --device=my-device \ - --config-file=/path/to/config.base64 --version-to-update=11 - -REQUIRED FLAGS - Exactly one of these must be specified: - - --config-data=CONFIG_DATA - The data for this configuration, as a string. For any values that - contain special characters (in the context of your shell), use the - --config-file flag instead. - - --config-file=CONFIG_FILE - Path to a local file containing the data for this configuration. - - Device resource - The device for the configuration 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -OPTIONAL FLAGS - --version-to-update=VERSION_TO_UPDATE - The version number to update. If this value is 0 or unspecified, it - will not check the version number of the server and will always update - the current version; otherwise, this update will fail if the version - number provided does not match the latest version on the server. This - is used to detect conflicts with simultaneous updates. - -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. These variants are also available: - - $ gcloud iot devices configs update - - $ gcloud beta iot devices configs update - diff --git a/gcloud/alpha/iot/devices/create b/gcloud/alpha/iot/devices/create deleted file mode 100644 index c0789e872..000000000 --- a/gcloud/alpha/iot/devices/create +++ /dev/null @@ -1,197 +0,0 @@ -NAME - gcloud alpha iot devices create - create a new device - -SYNOPSIS - gcloud alpha iot devices create - (DEVICE : --region=REGION --registry=REGISTRY) - [--auth-method=AUTH_METHOD] [--blocked] [--device-type=DEVICE_TYPE] - [--log-level=LOG_LEVEL] [--metadata=[KEY=VALUE,...]] - [--metadata-from-file=[KEY=PATH,...]] - [--public-key=[path=PATH, - type=TYPE,[expiration-time=EXPIRATION-TIME],...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Create a new device. - -EXAMPLES - To create a new device 'my-device' in device registry 'my-registry' and - region 'us-central1', run: - - $ gcloud alpha iot devices create my-device --region=us-central1 \ - --registry=my-registry - - The following command creates a new non-gateway device 'my-device' in - device registry 'my-registry' and region 'us-central1', blocks the device, - and sets metadata values. - - $ gcloud alpha iot devices create my-device --region=us-central1 \ - --registry=my-registry --blocked --device-type=non-gateway \ - --metadata=key1=value1,key2=value2 - -POSITIONAL ARGUMENTS - Device resource - The device you want 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 device 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. - - DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument device 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The name of the Cloud IoT registry. - - To set the registry attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -FLAGS - --auth-method=AUTH_METHOD - The authorization/authentication method used by devices in relation to - the gateway. This property is set only on gateways. If left - unspecified, devices will not be able to access the gateway. - AUTH_METHOD must be one of: - - association-and-device-auth-token - The device is authenticated through both device credentials and - gateway association. - association-only - The device is authenticated through the gateway association only. - Device credentials are ignored if provided. - device-auth-token-only - The device is authenticated through its own credentials. Gateway - association is not checked. - - --blocked - If blocked, connections from this device will fail. - - Can be used to temporarily prevent the device from connecting if, for - example, the sensor is generating bad data and needs maintenance. - - Connections to device is not blocked by default. - - --device-type=DEVICE_TYPE - Whether this device is a gateway. If unspecified, non-gateway is - assumed. DEVICE_TYPE must be one of: gateway, non-gateway. - - --log-level=LOG_LEVEL - The default logging verbosity for activity from devices in this - registry. The verbosity level can be overridden by setting a specific - device's log level. LOG_LEVEL must be one of: - - debug - All events will be logged. - error - Error events will be logged. - info - Informational events will be logged, such as connections and - disconnections. Also includes error events. - none - Disables logging. - - --metadata=[KEY=VALUE,...] - The metadata key/value pairs assigned to devices. This metadata is not - interpreted or indexed by Cloud IoT Core. It can be used to add - contextual information for the device. - - Keys should only contain the following characters [a-zA-Z0-9-_] and be - fewer than 128 bytes in length. Values are free-form strings. Each - value must be fewer than or equal to 32 KB in size. - - The total size of all keys and values must be less than 256 KB, and the - maximum number of key-value pairs is 500. - - --metadata-from-file=[KEY=PATH,...] - Same as --metadata, but the metadata values will be read from the file - specified by path. - - --public-key=[path=PATH,type=TYPE,[expiration-time=EXPIRATION-TIME],...] - Specify a public key. - - Supports four key types: - - ◆ rsa-x509-pem: As RSA_PEM, but wrapped in an X.509v3 certificate - (RFC5280 (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, - and wrapped by -----BEGIN CERTIFICATE----- and -----END - CERTIFICATE-----. - ◆ rsa-pem: An RSA public key encoded in base64, and wrapped by - -----BEGIN PUBLIC KEY----- and -----END PUBLIC KEY-----. This can be - used to verify RS256 signatures in JWT tokens (RFC7518 - (https://www.ietf.org/rfc/rfc7518.txt)). - ◆ rs256: Deprecated name for rsa-x509-pem - ◆ es256-x509-pem: As ES256_PEM, but wrapped in an X.509v3 certificate - (RFC5280 (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, - and wrapped by -----BEGIN CERTIFICATE----- and -----END - CERTIFICATE-----. - ◆ es256-pem: Public key for the ECDSA algorithm using P-256 and - SHA-256, encoded in base64, and wrapped by -----BEGIN PUBLIC KEY----- - and -----END PUBLIC KEY-----. This can be used to verify JWT tokens - with the ES256 algorithm (RFC7518 - (https://www.ietf.org/rfc/rfc7518.txt)). This curve is defined in - OpenSSL (https://www.openssl.org/) as the prime256v1 curve. - ◆ es256: Deprecated nmame for es256-pem - - The key specification is given via the following sub-arguments: - - ◆ path: Required. The path on disk to the file containing the key. - ◆ type: Required. One of [es256, es256-pem, es256-x509-pem, rs256, - rsa-pem, rsa-x509-pem]. The type of the key. - ◆ expiration-time: Optional. The expiration time for the key. See $ - gcloud topic datetimes for information on time formats. - - For example: - - --public-key \ - path=/path/to/id_rsa.pem,type=RSA_PEM,expiration-time=2017-01-01T00:00-05 - - This flag may be provide multiple times to provide multiple keys - (maximum 3). - -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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices create - - $ gcloud beta iot devices create - diff --git a/gcloud/alpha/iot/devices/credentials/clear b/gcloud/alpha/iot/devices/credentials/clear deleted file mode 100644 index 090a2b487..000000000 --- a/gcloud/alpha/iot/devices/credentials/clear +++ /dev/null @@ -1,77 +0,0 @@ -NAME - gcloud alpha iot devices credentials clear - delete all credentials from a - device - -SYNOPSIS - gcloud alpha iot devices credentials clear - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Delete all credentials from a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete all credentials from a device in region 'us-central1', run: - - $ gcloud alpha iot devices credentials clear --region=us-central1 \ - --registry=my-registry --device=my-device - -REQUIRED FLAGS - Device resource - The device for which to clear credentials. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices credentials clear - - $ gcloud beta iot devices credentials clear - diff --git a/gcloud/alpha/iot/devices/credentials/create b/gcloud/alpha/iot/devices/credentials/create deleted file mode 100644 index e5e5444cd..000000000 --- a/gcloud/alpha/iot/devices/credentials/create +++ /dev/null @@ -1,125 +0,0 @@ -NAME - gcloud alpha iot devices credentials create - add a new credential to a - device - -SYNOPSIS - gcloud alpha iot devices credentials create --path=PATH --type=TYPE - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--expiration-time=EXPIRATION_TIME] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Add a new credential to a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - - A device may have at most 3 credentials. - -EXAMPLES - To add an RSA public key wrapped in an X.509v3 certificate to a device, - run: - - $ gcloud alpha iot devices credentials create --region=us-central1 \ - --registry=my-registry --device=my-device \ - --path=/path/to/cert.pem --type=rsa-x509-pem - - To add a public key for the ECDSA algorithm to a device, run: - - $ gcloud alpha iot devices credentials create --region=us-central1 \ - --registry=my-registry --device=my-device \ - --path=/path/to/ec_public.pem --type=es256-pem - -REQUIRED FLAGS - --path=PATH - The path on disk to the file containing the key. - - --type=TYPE - The type of the key. TYPE must be one of: - - es256 - Deprecated nmame for es256-pem - es256-pem - Public key for the ECDSA algorithm using P-256 and SHA-256, encoded - in base64, and wrapped by -----BEGIN PUBLIC KEY----- and -----END - PUBLIC KEY-----. This can be used to verify JWT tokens with the - ES256 algorithm (RFC7518 (https://www.ietf.org/rfc/rfc7518.txt)). - This curve is defined in OpenSSL (https://www.openssl.org/) as the - prime256v1 curve. - es256-x509-pem - As ES256_PEM, but wrapped in an X.509v3 certificate (RFC5280 - (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and - wrapped by -----BEGIN CERTIFICATE----- and -----END - CERTIFICATE-----. - rs256 - Deprecated name for rsa-x509-pem - rsa-pem - An RSA public key encoded in base64, and wrapped by -----BEGIN - PUBLIC KEY----- and -----END PUBLIC KEY-----. This can be used to - verify RS256 signatures in JWT tokens (RFC7518 - (https://www.ietf.org/rfc/rfc7518.txt)). - rsa-x509-pem - As RSA_PEM, but wrapped in an X.509v3 certificate (RFC5280 - (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and - wrapped by -----BEGIN CERTIFICATE----- and -----END - CERTIFICATE-----. - - Device resource - The device for which to create credentials. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -OPTIONAL FLAGS - --expiration-time=EXPIRATION_TIME - The expiration time for the key. See $ gcloud topic datetimes for - information on time formats. - -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. These variants are also available: - - $ gcloud iot devices credentials create - - $ gcloud beta iot devices credentials create - diff --git a/gcloud/alpha/iot/devices/credentials/delete b/gcloud/alpha/iot/devices/credentials/delete deleted file mode 100644 index 2ad6334ab..000000000 --- a/gcloud/alpha/iot/devices/credentials/delete +++ /dev/null @@ -1,81 +0,0 @@ -NAME - gcloud alpha iot devices credentials delete - delete a credential from a - device - -SYNOPSIS - gcloud alpha iot devices credentials delete INDEX - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Delete a credential from a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete the first credential from a device in region 'us-central1', run: - - $ gcloud alpha iot devices credentials delete --region=us-central1 \ - --registry=my-registry --device=my-device 0 - -POSITIONAL ARGUMENTS - INDEX - The index (zero-based) of the credential to delete. - -REQUIRED FLAGS - Device resource - The device from which to delete credentials. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices credentials delete - - $ gcloud beta iot devices credentials delete - diff --git a/gcloud/alpha/iot/devices/credentials/describe b/gcloud/alpha/iot/devices/credentials/describe deleted file mode 100644 index 269f83e49..000000000 --- a/gcloud/alpha/iot/devices/credentials/describe +++ /dev/null @@ -1,81 +0,0 @@ -NAME - gcloud alpha iot devices credentials describe - show details about a - specific device credential - -SYNOPSIS - gcloud alpha iot devices credentials describe INDEX - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Show details about a specific device credential. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To describe the first credential of a device in region 'us-central1', run: - - $ gcloud alpha iot devices credentials describe \ - --region=us-central1 --registry=my-registry --device=my-device 0 - -POSITIONAL ARGUMENTS - INDEX - The index (zero-based) of the credential to describe. - -REQUIRED FLAGS - Device resource - The device to which the credential belongs. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices credentials describe - - $ gcloud beta iot devices credentials describe - diff --git a/gcloud/alpha/iot/devices/credentials/help b/gcloud/alpha/iot/devices/credentials/help deleted file mode 100644 index b82fcd90e..000000000 --- a/gcloud/alpha/iot/devices/credentials/help +++ /dev/null @@ -1,50 +0,0 @@ -NAME - gcloud alpha iot devices credentials - manage credentials for Cloud IoT - devices - -SYNOPSIS - gcloud alpha iot devices credentials COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Manage credentials for Cloud IoT devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing credentials for Google Cloud IoT devices. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - clear - (ALPHA) (DEPRECATED) Delete all credentials from a device. - - create - (ALPHA) (DEPRECATED) Add a new credential to a device. - - delete - (ALPHA) (DEPRECATED) Delete a credential from a device. - - describe - (ALPHA) (DEPRECATED) Show details about a specific device credential. - - list - (ALPHA) (DEPRECATED) List credentials for a device. - - update - (ALPHA) (DEPRECATED) Update a specific device 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. These variants are also available: - - $ gcloud iot devices credentials - - $ gcloud beta iot devices credentials - diff --git a/gcloud/alpha/iot/devices/credentials/list b/gcloud/alpha/iot/devices/credentials/list deleted file mode 100644 index 4c704f5de..000000000 --- a/gcloud/alpha/iot/devices/credentials/list +++ /dev/null @@ -1,96 +0,0 @@ -NAME - gcloud alpha iot devices credentials list - list credentials for a device - -SYNOPSIS - gcloud alpha iot devices credentials list - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--filter=EXPRESSION] [--limit=LIMIT] [--sort-by=[FIELD,...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) List credentials for a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To list the credentials of a device in region 'us-central1', run: - - $ gcloud alpha iot devices credentials list --region=us-central1 \ - --registry=my-registry --device=my-device - -REQUIRED FLAGS - Device resource - The device for which to list credentials. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices credentials list - - $ gcloud beta iot devices credentials list - diff --git a/gcloud/alpha/iot/devices/credentials/update b/gcloud/alpha/iot/devices/credentials/update deleted file mode 100644 index 9ccd9fff7..000000000 --- a/gcloud/alpha/iot/devices/credentials/update +++ /dev/null @@ -1,88 +0,0 @@ -NAME - gcloud alpha iot devices credentials update - update a specific device - credential - -SYNOPSIS - gcloud alpha iot devices credentials update INDEX - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--expiration-time=EXPIRATION_TIME] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Update a specific device credential. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To update the expiration time of the first credential of a device in region - 'us-central1', run: - - $ gcloud alpha iot devices credentials update --region=us-central1 \ - --registry=my-registry --device=my-device \ - --expiration-time=2020-12-30T10:50:22Z 0 - -POSITIONAL ARGUMENTS - INDEX - The index (zero-based) of the credential to update. - -REQUIRED FLAGS - Device resource - The device for which to update credentials. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -OPTIONAL FLAGS - --expiration-time=EXPIRATION_TIME - The expiration time for the key. See $ gcloud topic datetimes for - information on time formats. - -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. These variants are also available: - - $ gcloud iot devices credentials update - - $ gcloud beta iot devices credentials update - diff --git a/gcloud/alpha/iot/devices/delete b/gcloud/alpha/iot/devices/delete deleted file mode 100644 index e89c2a776..000000000 --- a/gcloud/alpha/iot/devices/delete +++ /dev/null @@ -1,80 +0,0 @@ -NAME - gcloud alpha iot devices delete - delete a device - -SYNOPSIS - gcloud alpha iot devices delete - (DEVICE : --region=REGION --registry=REGISTRY) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Delete a device. - -EXAMPLES - To delete a device from device registry 'my-registry', run: - - $ gcloud alpha iot devices delete my-device --region=us-central1 \ - --registry=my-registry - -POSITIONAL ARGUMENTS - Device resource - The device 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 device 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. - - DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument device 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The name of the Cloud IoT registry. - - To set the registry attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --registry 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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices delete - - $ gcloud beta iot devices delete - diff --git a/gcloud/alpha/iot/devices/describe b/gcloud/alpha/iot/devices/describe deleted file mode 100644 index ee4211129..000000000 --- a/gcloud/alpha/iot/devices/describe +++ /dev/null @@ -1,80 +0,0 @@ -NAME - gcloud alpha iot devices describe - show details about a device - -SYNOPSIS - gcloud alpha iot devices describe - (DEVICE : --region=REGION --registry=REGISTRY) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Show details about a device. - -EXAMPLES - To show details about a device, run: - - $ gcloud alpha iot devices describe my-device --region=us-central1 \ - --registry=my-registry - -POSITIONAL ARGUMENTS - Device resource - The device 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 device 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. - - DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument device 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The name of the Cloud IoT registry. - - To set the registry attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --registry 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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices describe - - $ gcloud beta iot devices describe - diff --git a/gcloud/alpha/iot/devices/gateways/bind b/gcloud/alpha/iot/devices/gateways/bind deleted file mode 100644 index 5348c8e27..000000000 --- a/gcloud/alpha/iot/devices/gateways/bind +++ /dev/null @@ -1,125 +0,0 @@ -NAME - gcloud alpha iot devices gateways bind - associate a device with a gateway - -SYNOPSIS - gcloud alpha iot devices gateways bind - (--device=DEVICE - : --device-region=DEVICE_REGION --device-registry=DEVICE_REGISTRY) - (--gateway=GATEWAY : --gateway-region=GATEWAY_REGION - --gateway-registry=GATEWAY_REGISTRY) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Associate a device with a gateway. - -EXAMPLES - To associate 'my-device' with 'my-gateway' in region 'us-central1', run: - - $ gcloud alpha iot devices gateways bind --device=my-device \ - --device-region=us-central1 --device-registry=my-registry \ - --gateway=my-gateway --gateway-region=us-central1 \ - --gateway-registry=my-registry - -REQUIRED FLAGS - Device resource - The device to bind to the gateway. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --device-region=DEVICE_REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --device-region on the command line. - - --device-registry=DEVICE_REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --device-registry on the command line; - ▸ provide the argument --gateway-registry on the command line. - - Gateway resource - The gateway device to bind to. 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 --gateway 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. - - --gateway=GATEWAY - ID of the gateway or fully qualified identifier for the gateway. - - To set the gateway attribute: - ▸ provide the argument --gateway on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --gateway-region=GATEWAY_REGION - The Cloud region for the gateway. - - To set the region attribute: - ▸ provide the argument --gateway on the command line with a fully - specified name; - ▸ provide the argument --gateway-region on the command line. - - --gateway-registry=GATEWAY_REGISTRY - The device registry for the gateway. - - To set the registry attribute: - ▸ provide the argument --gateway on the command line with a fully - specified name; - ▸ provide the argument --gateway-registry on the command line; - ▸ provide the argument --device-registry 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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices gateways bind - - $ gcloud beta iot devices gateways bind - diff --git a/gcloud/alpha/iot/devices/gateways/help b/gcloud/alpha/iot/devices/gateways/help deleted file mode 100644 index 3e5cbaac6..000000000 --- a/gcloud/alpha/iot/devices/gateways/help +++ /dev/null @@ -1,40 +0,0 @@ -NAME - gcloud alpha iot devices gateways - manage Cloud IoT Core Gateway - Associations - -SYNOPSIS - gcloud alpha iot devices gateways COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Manage Cloud IoT Core Gateway Associations. - - This command is deprecated. Google Cloud IoT Core has been retired. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - bind - (ALPHA) (DEPRECATED) Associate a device with a gateway. - - list-bound-devices - (ALPHA) (DEPRECATED) Lists all of the devices bound to the gateway. - - unbind - (ALPHA) (DEPRECATED) Remove the association between a device and a - gateway. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices gateways - - $ gcloud beta iot devices gateways - diff --git a/gcloud/alpha/iot/devices/gateways/list-bound-devices b/gcloud/alpha/iot/devices/gateways/list-bound-devices deleted file mode 100644 index 792377eeb..000000000 --- a/gcloud/alpha/iot/devices/gateways/list-bound-devices +++ /dev/null @@ -1,105 +0,0 @@ -NAME - gcloud alpha iot devices gateways list-bound-devices - lists all of the - devices bound to the gateway - -SYNOPSIS - gcloud alpha iot devices gateways list-bound-devices --gateway=GATEWAY - (--registry=REGISTRY : --region=REGION) [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Lists all of the devices bound to the gateway. - -EXAMPLES - To list all of the devices bound to the gateway 'my-gateway' in region - 'us-central1' and in registry 'my-registry', run: - - $ gcloud alpha iot devices gateways list-bound-devices \ - --gateway=my-gateway --region=us-central1 --registry=my-registry - -REQUIRED FLAGS - --gateway=GATEWAY - The gateway id or numeric id you want to list bound devices for. - - Registry resource - The registry you want to list bound devices 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - - --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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices gateways list-bound-devices - - $ gcloud beta iot devices gateways list-bound-devices - diff --git a/gcloud/alpha/iot/devices/gateways/unbind b/gcloud/alpha/iot/devices/gateways/unbind deleted file mode 100644 index b008a2437..000000000 --- a/gcloud/alpha/iot/devices/gateways/unbind +++ /dev/null @@ -1,127 +0,0 @@ -NAME - gcloud alpha iot devices gateways unbind - remove the association between a - device and a gateway - -SYNOPSIS - gcloud alpha iot devices gateways unbind - (--device=DEVICE - : --device-region=DEVICE_REGION --device-registry=DEVICE_REGISTRY) - (--gateway=GATEWAY : --gateway-region=GATEWAY_REGION - --gateway-registry=GATEWAY_REGISTRY) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Remove the association between a device and a gateway. - -EXAMPLES - To remove the association between 'my-device' and 'my-gateway' in region - 'us-central1', run: - - $ gcloud alpha iot devices gateways unbind --device=my-device \ - --device-region=us-central1 --device-registry=my-registry \ - --gateway=my-gateway --gateway-region=us-central1 \ - --gateway-registry=my-registry - -REQUIRED FLAGS - Device resource - The device to unbind from the gateway. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --device-region=DEVICE_REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --device-region on the command line. - - --device-registry=DEVICE_REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --device-registry on the command line; - ▸ provide the argument --gateway-registry on the command line. - - Gateway resource - The gateway device to unbind 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 --gateway 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. - - --gateway=GATEWAY - ID of the gateway or fully qualified identifier for the gateway. - - To set the gateway attribute: - ▸ provide the argument --gateway on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --gateway-region=GATEWAY_REGION - The Cloud region for the gateway. - - To set the region attribute: - ▸ provide the argument --gateway on the command line with a fully - specified name; - ▸ provide the argument --gateway-region on the command line. - - --gateway-registry=GATEWAY_REGISTRY - The device registry for the gateway. - - To set the registry attribute: - ▸ provide the argument --gateway on the command line with a fully - specified name; - ▸ provide the argument --gateway-registry on the command line; - ▸ provide the argument --device-registry 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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices gateways unbind - - $ gcloud beta iot devices gateways unbind - diff --git a/gcloud/alpha/iot/devices/help b/gcloud/alpha/iot/devices/help deleted file mode 100644 index ca8650adc..000000000 --- a/gcloud/alpha/iot/devices/help +++ /dev/null @@ -1,64 +0,0 @@ -NAME - gcloud alpha iot devices - manage Cloud IoT Devices - -SYNOPSIS - gcloud alpha iot devices GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Manage Cloud IoT Devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing Google Cloud IoT Devices. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -GROUPS - GROUP is one of the following: - - commands - (ALPHA) (DEPRECATED) Manage commands for Cloud IoT devices. - - configs - (ALPHA) (DEPRECATED) Manage configurations for Cloud IoT devices. - - credentials - (ALPHA) (DEPRECATED) Manage credentials for Cloud IoT devices. - - gateways - (ALPHA) (DEPRECATED) Manage Cloud IoT Core Gateway Associations. - - states - (ALPHA) (DEPRECATED) Manage states for Cloud IoT devices. - -COMMANDS - COMMAND is one of the following: - - create - (ALPHA) (DEPRECATED) Create a new device. - - delete - (ALPHA) (DEPRECATED) Delete a device. - - describe - (ALPHA) (DEPRECATED) Show details about a device. - - list - (ALPHA) (DEPRECATED) List devices. - - update - (ALPHA) (DEPRECATED) Update an existing device. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices - - $ gcloud beta iot devices - diff --git a/gcloud/alpha/iot/devices/list b/gcloud/alpha/iot/devices/list deleted file mode 100644 index 75965c4c8..000000000 --- a/gcloud/alpha/iot/devices/list +++ /dev/null @@ -1,126 +0,0 @@ -NAME - gcloud alpha iot devices list - list devices - -SYNOPSIS - gcloud alpha iot devices list (--registry=REGISTRY : --region=REGION) - [--device-field-mask=DEVICE_FIELD_MASK; - default="blocked,gatewayConfig"] [--device-ids=[DEVICE_IDS,...]] - [--device-num-ids=[DEVICE_NUM_IDS,...]] [--device-type=DEVICE_TYPE] - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - List devices. - -EXAMPLES - To list all devices in the device registry 'my-registry' and region - 'us-central1', run: - - $ gcloud alpha iot devices list --region=us-central1 \ - --registry=my-registry - -REQUIRED FLAGS - Registry resource - The registry you want to list the devices 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --device-field-mask=DEVICE_FIELD_MASK; default="blocked,gatewayConfig" - If given, returns all specified device fields instead of the default - set. The value is a comma-separated list of field names. Example: - "lastErrorStatus,config,metadata". See full list of device fields at: - https://cloud.google.com/iot/docs/reference/cloudiot/rest/v1/projects.locations.registries.devices - - --device-ids=[DEVICE_IDS,...] - If given, show only devices with one of the provided IDs. - - --device-num-ids=[DEVICE_NUM_IDS,...] - If given, show only devices with one of the provided numerical IDs. - - --device-type=DEVICE_TYPE - If specified, show only devices of that type. If left unspecified, show - devices of any type. DEVICE_TYPE must be one of: gateway, non-gateway. - -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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices list - - $ gcloud beta iot devices list - diff --git a/gcloud/alpha/iot/devices/states/help b/gcloud/alpha/iot/devices/states/help deleted file mode 100644 index 4ebaaf06a..000000000 --- a/gcloud/alpha/iot/devices/states/help +++ /dev/null @@ -1,34 +0,0 @@ -NAME - gcloud alpha iot devices states - manage states for Cloud IoT devices - -SYNOPSIS - gcloud alpha iot devices states COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Manage states for Cloud IoT devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing states for Google Cloud IoT devices. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - list - (ALPHA) (DEPRECATED) List states for a device. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices states - - $ gcloud beta iot devices states - diff --git a/gcloud/alpha/iot/devices/states/list b/gcloud/alpha/iot/devices/states/list deleted file mode 100644 index 1875506f9..000000000 --- a/gcloud/alpha/iot/devices/states/list +++ /dev/null @@ -1,110 +0,0 @@ -NAME - gcloud alpha iot devices states list - list states for a device - -SYNOPSIS - gcloud alpha iot devices states list - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - This command lists all available states in the history of the device. Up to - 10 are kept; you may restrict the output to fewer via the --limit flag. - -EXAMPLES - To list states for the device 'my-device' in region 'us-central1' and in - registry 'my-registry', run: - - $ gcloud alpha iot devices states list --device=my-device \ - --region=us-central1 --registry=my-registry - -REQUIRED FLAGS - Device resource - The registry you want to list the devices 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The name of the Cloud IoT registry. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - - --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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot devices states list - - $ gcloud beta iot devices states list - diff --git a/gcloud/alpha/iot/devices/update b/gcloud/alpha/iot/devices/update deleted file mode 100644 index 63f7f1f3f..000000000 --- a/gcloud/alpha/iot/devices/update +++ /dev/null @@ -1,141 +0,0 @@ -NAME - gcloud alpha iot devices update - update an existing device - -SYNOPSIS - gcloud alpha iot devices update - (DEVICE : --region=REGION --registry=REGISTRY) - [--auth-method=AUTH_METHOD] [--blocked] [--log-level=LOG_LEVEL] - [--metadata=[KEY=VALUE,...]] [--metadata-from-file=[KEY=PATH,...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - (ALPHA) (DEPRECATED) Update an existing device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - The following command updates the device 'my-device' in device registry - 'my-registry' in region 'us-central1'. It blocks the device and sets - metadata values. - - $ gcloud alpha iot devices update my-device --region=us-central1 \ - --registry=my-registry --blocked \ - --metadata=key1=value1,key2=value2 - -POSITIONAL ARGUMENTS - Device resource - The device 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 device 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. - - DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument device on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -FLAGS - --auth-method=AUTH_METHOD - The authorization/authentication method used by devices in relation to - the gateway. This property is set only on gateways. If left - unspecified, devices will not be able to access the gateway. - AUTH_METHOD must be one of: - - association-and-device-auth-token - The device is authenticated through both device credentials and - gateway association. - association-only - The device is authenticated through the gateway association only. - Device credentials are ignored if provided. - device-auth-token-only - The device is authenticated through its own credentials. Gateway - association is not checked. - - --blocked - If blocked, connections from this device will fail. - - Can be used to temporarily prevent the device from connecting if, for - example, the sensor is generating bad data and needs maintenance. - - Use --no-blocked to enable connections and --blocked to disable. - - --log-level=LOG_LEVEL - The default logging verbosity for activity from devices in this - registry. The verbosity level can be overridden by setting a specific - device's log level. - - LOG_LEVEL must be one of: - - debug - All events will be logged - error - Error events will be logged. - info - Informational events will be logged, such as connections and - disconnections. Also includes error events. - none - Disables logging. - - --metadata=[KEY=VALUE,...] - The metadata key/value pairs assigned to devices. This metadata is not - interpreted or indexed by Cloud IoT Core. It can be used to add - contextual information for the device. - - Keys should only contain the following characters [a-zA-Z0-9-_] and be - fewer than 128 bytes in length. Values are free-form strings. Each - value must be fewer than or equal to 32 KB in size. - - The total size of all keys and values must be less than 256 KB, and the - maximum number of key-value pairs is 500. - - --metadata-from-file=[KEY=PATH,...] - Same as --metadata, but the metadata values will be read from the file - specified by path. - -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. These variants are also available: - - $ gcloud iot devices update - - $ gcloud beta iot devices update - diff --git a/gcloud/alpha/iot/help b/gcloud/alpha/iot/help deleted file mode 100644 index 48c620805..000000000 --- a/gcloud/alpha/iot/help +++ /dev/null @@ -1,37 +0,0 @@ -NAME - gcloud alpha iot - manage Cloud IoT resources - -SYNOPSIS - gcloud alpha iot GROUP [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Manage Cloud IoT resources. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing Google Cloud IoT resources. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -GROUPS - GROUP is one of the following: - - devices - (ALPHA) (DEPRECATED) Manage Cloud IoT Devices. - - registries - (ALPHA) (DEPRECATED) Manage Cloud IoT Registries. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot - - $ gcloud beta iot - diff --git a/gcloud/alpha/iot/registries/add-iam-policy-binding b/gcloud/alpha/iot/registries/add-iam-policy-binding deleted file mode 100644 index 07cae9938..000000000 --- a/gcloud/alpha/iot/registries/add-iam-policy-binding +++ /dev/null @@ -1,150 +0,0 @@ -NAME - gcloud alpha iot registries add-iam-policy-binding - add IAM policy binding - to a device registry - -SYNOPSIS - gcloud alpha iot registries add-iam-policy-binding - (REGISTRY : --region=REGION) --member=PRINCIPAL --role=ROLE - [--condition=[KEY=VALUE,...] - | --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Add an IAM policy binding to the IAM policy of a device registry. One - binding consists of a member, a role, and an optional condition. - -EXAMPLES - To add an IAM policy binding for the role of 'roles/editor' for the user - 'test-user@gmail.com' with registry 'my-registry' and region 'us-central1', - run: - - $ gcloud alpha iot registries add-iam-policy-binding my-registry \ - --region='us-central1' --member='user:test-user@gmail.com' \ - --role='roles/editor' - - To add an IAM policy binding which expires at the end of the year 2018 for - the role of 'roles/cloudiot.provisioner' and the user 'test-user@gmail.com' - with registry 'my-registry' and region 'us-central1', run: - - $ gcloud alpha iot registries add-iam-policy-binding my-registry \ - --region='us-central1' --member='user:test-user@gmail.com' \ - --role='roles/cloudiot.provisioner' \ - --condition='expression=request.time < - timestamp("2019-01-01T00:00:00Z"),title=expires_end_of_2018,descrip\ - tion=Expires at midnight on 2018-12-31' - - See https://cloud.google.com/iam/docs/managing-policies for details of - policy role and member types. - -POSITIONAL ARGUMENTS - Registry resource - The device registry for which to add IAM policy - binding to. 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - -REQUIRED FLAGS - --member=PRINCIPAL - The principal to add the binding for. Should be of the form - user|group|serviceAccount:email or domain:domain. - - Examples: user:test-user@gmail.com, group:admins@example.com, - serviceAccount:test123@example.domain.com, or - domain:example.domain.com. - - Some resources also accept the following special values: - ◆ allUsers - Special identifier that represents anyone who is on the - internet, with or without a Google account. - ◆ allAuthenticatedUsers - Special identifier that represents anyone - who is authenticated with a Google account or a service account. - - --role=ROLE - Role name to assign to the principal. The role name is the complete - path of a predefined role, such as roles/logging.viewer, or the role ID - for a custom role, such as - organizations/{ORGANIZATION_ID}/roles/logging.viewer. - -OPTIONAL FLAGS - At most one of these can be specified: - - --condition=[KEY=VALUE,...] - A condition to include in the binding. When the condition is - explicitly specified as None (--condition=None), a binding without a - condition is added. When the condition is specified and is not None, - --role cannot be a basic role. Basic roles are roles/editor, - roles/owner, and roles/viewer. For more on conditions, refer to the - conditions overview guide: - https://cloud.google.com/iam/docs/conditions-overview - - When using the --condition flag, include the following key-value - pairs: - - expression - (Required) Condition expression that evaluates to True or False. - This uses a subset of Common Expression Language syntax. - - If the condition expression includes a comma, use a different - delimiter to separate the key-value pairs. Specify the delimiter - before listing the key-value pairs. For example, to specify a - colon (:) as the delimiter, do the following: - --condition=^:^title=TITLE:expression=EXPRESSION. For more - information, see - https://cloud.google.com/sdk/gcloud/reference/topic/escaping. - - title - (Required) A short string describing the purpose of the - expression. - - description - (Optional) Additional description for the expression. - - --condition-from-file=CONDITION_FROM_FILE - Path to a local JSON or YAML file that defines the condition. To see - available fields, see the help for --condition. - -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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -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 iot registries add-iam-policy-binding - diff --git a/gcloud/alpha/iot/registries/create b/gcloud/alpha/iot/registries/create deleted file mode 100644 index 356243689..000000000 --- a/gcloud/alpha/iot/registries/create +++ /dev/null @@ -1,129 +0,0 @@ -NAME - gcloud alpha iot registries create - create a new device registry - -SYNOPSIS - gcloud alpha iot registries create (REGISTRY : --region=REGION) - [--no-enable-http-config] [--no-enable-mqtt-config] - [--event-notification-config=[subfolder=SUBFOLDER],[topic=TOPIC]] - [--log-level=LOG_LEVEL] [--public-key-path=PUBLIC_KEY_PATH] - [--state-pubsub-topic=STATE_PUBSUB_TOPIC] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Create a new device registry. - -EXAMPLES - To create a new device registry 'my-registry' in region 'us-central1', run: - - $ gcloud alpha iot registries create --region=us-central1 my-registry - - The following command creates a new device registry 'my-registry' in region - 'us-central1', enables MQTT and HTTP connections, and sets - 'pubsub-topic-name' as the Cloud Pub/Sub topic for state notifications. - - $ gcloud alpha iot registries create my-registry \ - --region=us-central1 --enable-http-config --enable-mqtt-config \ - --state-pubsub-topic=pubsub-topic-name - -POSITIONAL ARGUMENTS - Registry resource - The registry you want 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --enable-http-config - Whether to allow device connections to the HTTP bridge. Enabled by - default, use --no-enable-http-config to disable. - - --enable-mqtt-config - Whether to allow MQTT connections to this device registry. Enabled by - default, use --no-enable-mqtt-config to disable. - - --event-notification-config=[subfolder=SUBFOLDER],[topic=TOPIC] - The configuration for notification of telemetry events received from - the device. This flag can be specified multiple times to add multiple - configs to the device registry. Configs are added to the registry in - the order the flags are specified. Only one config with an empty - subfolder field is allowed and must be specified last. - - topic - A Google Cloud Pub/Sub topic name for event notifications - - subfolder - If the subfolder name matches this string exactly, this - configuration will be used to publish telemetry events. If empty - all strings are matched. - - --log-level=LOG_LEVEL - The default logging verbosity for activity from devices in this - registry. The verbosity level can be overridden by setting a specific - device's log level. LOG_LEVEL must be one of: - - debug - All events will be logged. - error - Error events will be logged. - info - Informational events will be logged, such as connections and - disconnections. Also includes error events. - none - Disables logging. - - --public-key-path=PUBLIC_KEY_PATH - Path to a file containing an X.509v3 certificate (RFC5280 - (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped - by -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----. - - --state-pubsub-topic=STATE_PUBSUB_TOPIC - A Google Cloud Pub/Sub topic name for state notifications. - -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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot registries create - - $ gcloud beta iot registries create - diff --git a/gcloud/alpha/iot/registries/credentials/clear b/gcloud/alpha/iot/registries/credentials/clear deleted file mode 100644 index b67b0da19..000000000 --- a/gcloud/alpha/iot/registries/credentials/clear +++ /dev/null @@ -1,68 +0,0 @@ -NAME - gcloud alpha iot registries credentials clear - delete all credentials from - a registry - -SYNOPSIS - gcloud alpha iot registries credentials clear - (--registry=REGISTRY : --region=REGION) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Delete all credentials from a registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete all credentials from a registry in region 'us-central1', run: - - $ gcloud alpha iot registries credentials clear \ - --region=us-central1 --registry=my-registry - -REQUIRED FLAGS - Registry resource - The device registry for which to clear credentials. - 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot registries credentials clear - - $ gcloud beta iot registries credentials clear - diff --git a/gcloud/alpha/iot/registries/credentials/create b/gcloud/alpha/iot/registries/credentials/create deleted file mode 100644 index bde85f4f8..000000000 --- a/gcloud/alpha/iot/registries/credentials/create +++ /dev/null @@ -1,79 +0,0 @@ -NAME - gcloud alpha iot registries credentials create - add a new credential to a - registry - -SYNOPSIS - gcloud alpha iot registries credentials create --path=PATH - (--registry=REGISTRY : --region=REGION) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - (ALPHA) (DEPRECATED) Add a new credential to a registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - - A registry may have at most 10 credentials. - -EXAMPLES - To add a credential located in '/path/to/cert.pem' to a registry, run: - - $ gcloud alpha iot registries credentials create \ - --region=us-central1 --registry=my-registry \ - --path=/path/to/cert.pem - -REQUIRED FLAGS - --path=PATH - Path to a file containing an X.509v3 certificate (RFC5280 - (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped - by -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----. - - Registry resource - The device registry for which to create credentials. - 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot registries credentials create - - $ gcloud beta iot registries credentials create - diff --git a/gcloud/alpha/iot/registries/credentials/delete b/gcloud/alpha/iot/registries/credentials/delete deleted file mode 100644 index b4a448f04..000000000 --- a/gcloud/alpha/iot/registries/credentials/delete +++ /dev/null @@ -1,72 +0,0 @@ -NAME - gcloud alpha iot registries credentials delete - delete a credential from a - registry - -SYNOPSIS - gcloud alpha iot registries credentials delete INDEX - (--registry=REGISTRY : --region=REGION) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Delete a credential from a registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete the first credential from a registry, run: - - $ gcloud alpha iot registries credentials delete \ - --region=us-central1 --registry=my-registry 0 - -POSITIONAL ARGUMENTS - INDEX - The index (zero-based) of the credential to delete. - -REQUIRED FLAGS - Registry resource - The device registry from which to delete credentials. - 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot registries credentials delete - - $ gcloud beta iot registries credentials delete - diff --git a/gcloud/alpha/iot/registries/credentials/describe b/gcloud/alpha/iot/registries/credentials/describe deleted file mode 100644 index 5fdac0434..000000000 --- a/gcloud/alpha/iot/registries/credentials/describe +++ /dev/null @@ -1,73 +0,0 @@ -NAME - gcloud alpha iot registries credentials describe - show details about a - specific registry credential - -SYNOPSIS - gcloud alpha iot registries credentials describe INDEX - (--registry=REGISTRY : --region=REGION) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Show details about a specific registry credential. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To describe the first credential of a registry in region 'us-central1', - run: - - $ gcloud alpha iot registries credentials describe \ - --region=us-central1 --registry=my-registry 0 - -POSITIONAL ARGUMENTS - INDEX - The index (zero-based) of the credential to describe. - -REQUIRED FLAGS - Registry resource - The device registry to which the credential belongs. - 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot registries credentials describe - - $ gcloud beta iot registries credentials describe - diff --git a/gcloud/alpha/iot/registries/credentials/help b/gcloud/alpha/iot/registries/credentials/help deleted file mode 100644 index d758c6789..000000000 --- a/gcloud/alpha/iot/registries/credentials/help +++ /dev/null @@ -1,47 +0,0 @@ -NAME - gcloud alpha iot registries credentials - manage credentials for Cloud IoT - devices - -SYNOPSIS - gcloud alpha iot registries credentials COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Manage credentials for Cloud IoT devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing credentials for Google Cloud IoT devices. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - clear - (ALPHA) (DEPRECATED) Delete all credentials from a registry. - - create - (ALPHA) (DEPRECATED) Add a new credential to a registry. - - delete - (ALPHA) (DEPRECATED) Delete a credential from a registry. - - describe - (ALPHA) (DEPRECATED) Show details about a specific registry credential. - - list - (ALPHA) (DEPRECATED) List credentials for a registry. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot registries credentials - - $ gcloud beta iot registries credentials - diff --git a/gcloud/alpha/iot/registries/credentials/list b/gcloud/alpha/iot/registries/credentials/list deleted file mode 100644 index c44dbac10..000000000 --- a/gcloud/alpha/iot/registries/credentials/list +++ /dev/null @@ -1,88 +0,0 @@ -NAME - gcloud alpha iot registries credentials list - list credentials for a - registry - -SYNOPSIS - gcloud alpha iot registries credentials list - (--registry=REGISTRY : --region=REGION) [--filter=EXPRESSION] - [--limit=LIMIT] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) List credentials for a registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To list the credentials of a registry, run: - - $ gcloud alpha iot registries credentials list \ - --region=us-central1 --registry=my-registry - -REQUIRED FLAGS - Registry resource - The device registry for which to list credentials. 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot registries credentials list - - $ gcloud beta iot registries credentials list - diff --git a/gcloud/alpha/iot/registries/delete b/gcloud/alpha/iot/registries/delete deleted file mode 100644 index 9a7e8c0f9..000000000 --- a/gcloud/alpha/iot/registries/delete +++ /dev/null @@ -1,71 +0,0 @@ -NAME - gcloud alpha iot registries delete - delete a device registry - -SYNOPSIS - gcloud alpha iot registries delete (REGISTRY : --region=REGION) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Delete a device registry. - -EXAMPLES - To delete a device registry, run: - - $ gcloud alpha iot registries delete my-registry --region=us-central1 - -POSITIONAL ARGUMENTS - Registry resource - The registry 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region 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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot registries delete - - $ gcloud beta iot registries delete - diff --git a/gcloud/alpha/iot/registries/describe b/gcloud/alpha/iot/registries/describe deleted file mode 100644 index 432209bfe..000000000 --- a/gcloud/alpha/iot/registries/describe +++ /dev/null @@ -1,72 +0,0 @@ -NAME - gcloud alpha iot registries describe - show details about a device registry - -SYNOPSIS - gcloud alpha iot registries describe (REGISTRY : --region=REGION) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Show details about a device registry. - -EXAMPLES - To show details about a device registry, run: - - $ gcloud alpha iot registries describe my-registry \ - --region=us-central1 - -POSITIONAL ARGUMENTS - Registry resource - The registry you want to get the details 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region 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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot registries describe - - $ gcloud beta iot registries describe - diff --git a/gcloud/alpha/iot/registries/get-iam-policy b/gcloud/alpha/iot/registries/get-iam-policy deleted file mode 100644 index 7882f030d..000000000 --- a/gcloud/alpha/iot/registries/get-iam-policy +++ /dev/null @@ -1,104 +0,0 @@ -NAME - gcloud alpha iot registries get-iam-policy - get the IAM policy for a - device registry - -SYNOPSIS - gcloud alpha iot registries get-iam-policy (REGISTRY : --region=REGION) - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - This command gets the IAM policy for a device registry. If formatted as - JSON, the output can be edited and used as a policy file for - set-iam-policy. The output includes an "etag" field identifying the version - emitted and allowing detection of concurrent policy updates; see $ gcloud - iot registries set-iam-policy for additional details. - -EXAMPLES - To print the IAM policy for a given device registry, run: - - $ gcloud alpha iot registries get-iam-policy --region=us-central1 \ - my-registry - -POSITIONAL ARGUMENTS - Registry resource - The device registry for which to display the IAM - policy. 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - - --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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot registries get-iam-policy - - $ gcloud beta iot registries get-iam-policy - diff --git a/gcloud/alpha/iot/registries/help b/gcloud/alpha/iot/registries/help deleted file mode 100644 index e738d86a0..000000000 --- a/gcloud/alpha/iot/registries/help +++ /dev/null @@ -1,64 +0,0 @@ -NAME - gcloud alpha iot registries - manage Cloud IoT Registries - -SYNOPSIS - gcloud alpha iot registries GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) Manage Cloud IoT Registries. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing Google Cloud IoT Registries. - -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) (DEPRECATED) Manage credentials for Cloud IoT devices. - -COMMANDS - COMMAND is one of the following: - - add-iam-policy-binding - (ALPHA) (DEPRECATED) Add IAM policy binding to a device registry. - - create - (ALPHA) (DEPRECATED) Create a new device registry. - - delete - (ALPHA) (DEPRECATED) Delete a device registry. - - describe - (ALPHA) (DEPRECATED) Show details about a device registry. - - get-iam-policy - (ALPHA) (DEPRECATED) Get the IAM policy for a device registry. - - list - (ALPHA) (DEPRECATED) List device registries. - - remove-iam-policy-binding - (ALPHA) (DEPRECATED) Remove IAM policy binding of a device registry. - - set-iam-policy - (ALPHA) (DEPRECATED) Set the IAM policy for a device registry. - - update - (ALPHA) (DEPRECATED) Update a device registry. - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot registries - - $ gcloud beta iot registries - diff --git a/gcloud/alpha/iot/registries/remove-iam-policy-binding b/gcloud/alpha/iot/registries/remove-iam-policy-binding deleted file mode 100644 index 8031d7bc8..000000000 --- a/gcloud/alpha/iot/registries/remove-iam-policy-binding +++ /dev/null @@ -1,157 +0,0 @@ -NAME - gcloud alpha iot registries remove-iam-policy-binding - remove IAM policy - binding of a device registry - -SYNOPSIS - gcloud alpha iot registries remove-iam-policy-binding - (REGISTRY : --region=REGION) --member=PRINCIPAL --role=ROLE - [--all | --condition=[KEY=VALUE,...] - | --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Remove an IAM policy binding from the IAM policy of a device registry. One - binding consists of a member, a role, and an optional condition. - -EXAMPLES - To remove an IAM policy binding for the role of 'roles/editor' for the user - 'test-user@gmail.com' with registry 'my-registry' and region 'us-central1', - run: - - $ gcloud alpha iot registries remove-iam-policy-binding \ - my-registry --region='us-central1' \ - --member='user:test-user@gmail.com' --role='roles/editor' - - To remove an IAM policy binding which expires at the end of the year 2018 - for the role of 'roles/cloudiot.provisioner' and the user - 'test-user@gmail.com' with registry 'my-registry' and region 'us-central1', - run: - - $ gcloud alpha iot registries remove-iam-policy-binding \ - my-registry --region='us-central1' \ - --member='user:test-user@gmail.com' \ - --role='roles/cloudiot.provisioner' \ - --condition='expression=request.time < - timestamp("2019-01-01T00:00:00Z"),title=expires_end_of_2018,descrip\ - tion=Expires at midnight on 2018-12-31' - - See https://cloud.google.com/iam/docs/managing-policies for details of - policy role and member types. - -POSITIONAL ARGUMENTS - Registry resource - The device registry for which to remove IAM policy - binding 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - -REQUIRED FLAGS - --member=PRINCIPAL - The principal to remove the binding for. Should be of the form - user|group|serviceAccount:email or domain:domain. - - Examples: user:test-user@gmail.com, group:admins@example.com, - serviceAccount:test123@example.domain.com, or - domain:example.domain.com. - - Deleted principals have an additional deleted: prefix and a ?uid=UID - suffix, where UID is a unique identifier for the principal. Example: - deleted:user:test-user@gmail.com?uid=123456789012345678901. - - Some resources also accept the following special values: - ◆ allUsers - Special identifier that represents anyone who is on the - internet, with or without a Google account. - ◆ allAuthenticatedUsers - Special identifier that represents anyone - who is authenticated with a Google account or a service account. - - --role=ROLE - The role to remove the principal from. - -OPTIONAL FLAGS - At most one of these can be specified: - - --all - Remove all bindings with this role and principal, irrespective of any - conditions. - - --condition=[KEY=VALUE,...] - The condition of the binding that you want to remove. When the - condition is explicitly specified as None (--condition=None), a - binding without a condition is removed. Otherwise, only a binding - with a condition that exactly matches the specified condition - (including the optional description) is removed. For more on - conditions, refer to the conditions overview guide: - https://cloud.google.com/iam/docs/conditions-overview - - When using the --condition flag, include the following key-value - pairs: - - expression - (Required) Condition expression that evaluates to True or False. - This uses a subset of Common Expression Language syntax. - - If the condition expression includes a comma, use a different - delimiter to separate the key-value pairs. Specify the delimiter - before listing the key-value pairs. For example, to specify a - colon (:) as the delimiter, do the following: - --condition=^:^title=TITLE:expression=EXPRESSION. For more - information, see - https://cloud.google.com/sdk/gcloud/reference/topic/escaping. - - title - (Required) A short string describing the purpose of the - expression. - - description - (Optional) Additional description for the expression. - - --condition-from-file=CONDITION_FROM_FILE - Path to a local JSON or YAML file that defines the condition. To see - available fields, see the help for --condition. - -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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -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 iot registries remove-iam-policy-binding - diff --git a/gcloud/alpha/iot/registries/set-iam-policy b/gcloud/alpha/iot/registries/set-iam-policy deleted file mode 100644 index 4b440cd31..000000000 --- a/gcloud/alpha/iot/registries/set-iam-policy +++ /dev/null @@ -1,92 +0,0 @@ -NAME - gcloud alpha iot registries set-iam-policy - set the IAM policy for a - device registry - -SYNOPSIS - gcloud alpha iot registries set-iam-policy (REGISTRY : --region=REGION) - POLICY_FILE [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - This command replaces the existing IAM policy for a device registry, given - a REGISTRY and a file encoded in JSON or YAML that contains the IAM policy. - If the given policy file specifies an "etag" value, then the replacement - will succeed only if the policy already in place matches that etag. (An - etag obtained via $ gcloud iot registries get-iam-policy will prevent the - replacement if the policy for the device registry has been subsequently - updated.) A policy file that does not contain an etag value will replace - any existing policy for the device registry. - -EXAMPLES - The following command will read an IAM policy defined in a JSON file - 'policy.json' and set it for a device registry with identifier - 'my-registry' - - $ gcloud alpha iot registries set-iam-policy --region=us-central1 \ - my-registry policy.json - - See https://cloud.google.com/iam/docs/managing-policies for details of the - policy file format and contents. - -POSITIONAL ARGUMENTS - Registry resource - The device registry for which to set the IAM policy. - 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - POLICY_FILE - Path to a local JSON or YAML formatted file containing a valid policy. - - The output of the get-iam-policy command is a valid file, as is any - JSON or YAML file conforming to the structure of a Policy - (https://cloud.google.com/iam/reference/rest/v1/Policy). - -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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: - - $ gcloud iot registries set-iam-policy - - $ gcloud beta iot registries set-iam-policy - diff --git a/gcloud/alpha/iot/registries/update b/gcloud/alpha/iot/registries/update deleted file mode 100644 index 963645dca..000000000 --- a/gcloud/alpha/iot/registries/update +++ /dev/null @@ -1,118 +0,0 @@ -NAME - gcloud alpha iot registries update - update a device registry - -SYNOPSIS - gcloud alpha iot registries update (REGISTRY : --region=REGION) - [--enable-http-config] [--enable-mqtt-config] - [--event-notification-config=[subfolder=SUBFOLDER],[topic=TOPIC]] - [--log-level=LOG_LEVEL] [--state-pubsub-topic=STATE_PUBSUB_TOPIC] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - (ALPHA) (DEPRECATED) Update a device registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - The following command updates the device registry 'my-registry' in region - 'us-central1'. It enables MQTT and HTTP connections and sets - 'pubsub-topic-name' as the Cloud Pub/Sub topic for state notifications. - - $ gcloud alpha iot registries update my-registry \ - --region=us-central1 --enable-http-config --enable-mqtt-config \ - --state-pubsub-topic=pubsub-topic-name - -POSITIONAL ARGUMENTS - Registry resource - The device registry 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --enable-http-config - Whether to allow device connections to the HTTP bridge. - - --enable-mqtt-config - Whether to allow MQTT connections to this device registry. - - --event-notification-config=[subfolder=SUBFOLDER],[topic=TOPIC] - The configuration for notification of telemetry events received from - the device. This flag can be specified multiple times to add multiple - configs to the device registry. Configs are added to the registry in - the order the flags are specified. Only one config with an empty - subfolder field is allowed and must be specified last. - - topic - A Google Cloud Pub/Sub topic name for event notifications - - subfolder - If the subfolder name matches this string exactly, this - configuration will be used to publish telemetry events. If empty - all strings are matched. - - --log-level=LOG_LEVEL - The default logging verbosity for activity from devices in this - registry. The verbosity level can be overridden by setting a specific - device's log level. - - LOG_LEVEL must be one of: - - debug - All events will be logged - error - Error events will be logged. - info - Informational events will be logged, such as connections and - disconnections. Also includes error events. - none - Disables logging. - - --state-pubsub-topic=STATE_PUBSUB_TOPIC - A Google Cloud Pub/Sub topic name for state notifications. - -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. These variants are also available: - - $ gcloud iot registries update - - $ gcloud beta iot registries update - diff --git a/gcloud/alpha/logging/settings/update b/gcloud/alpha/logging/settings/update index a68ad5bdf..567ef0283 100644 --- a/gcloud/alpha/logging/settings/update +++ b/gcloud/alpha/logging/settings/update @@ -12,8 +12,9 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Use this command to update the --kms-key-name, --storage-location - and --disable-default-sink associated with the Cloud Logging Logs Router. + (ALPHA) Use this command to update the --kms-key-name, --storage-location, + --disable-default-sink and --analytics-mode associated with the Cloud + Logging Logs Router. The Cloud KMS key must already exist and Cloud Logging must have permission to access it. @@ -58,6 +59,12 @@ EXAMPLES $ gcloud alpha logging settings update \ --organization=[ORGANIZATION_ID] --disable-default-sink=false + To enable analytics for the log buckets under an organization, run: + + $ gcloud alpha logging settings update \ + --organization=[ORGANIZATION_ID] --disable-default-sink=false \ + --analytics-mode=enabled + REQUIRED FLAGS Exactly one of these must be specified: diff --git a/gcloud/alpha/looker/instances/describe b/gcloud/alpha/looker/instances/describe index fcaf895c2..9da379457 100644 --- a/gcloud/alpha/looker/instances/describe +++ b/gcloud/alpha/looker/instances/describe @@ -1,5 +1,6 @@ NAME gcloud alpha looker instances describe - show metadata for a Looker + instance SYNOPSIS gcloud alpha looker instances describe (INSTANCE : --region=REGION) @@ -8,9 +9,6 @@ SYNOPSIS DESCRIPTION (ALPHA) Show metadata for a Looker instance. - Displays all metadata associated with a Looker instance given a valid - instance name. - This command can fail for the following reasons: ▪ The instance specified does not exist. ▪ The active account does not have permission to access the given @@ -22,6 +20,11 @@ EXAMPLES $ gcloud alpha looker instances describe my-looker-instance + To display all fields of the instance metadata, add the --format=json flag: + + $ gcloud alpha looker instances describe my-looker-instance \ + --format=json + POSITIONAL ARGUMENTS Instance resource - Arguments and flags that specify the Looker instance you want to describe. The arguments in this group can be used to specify diff --git a/gcloud/alpha/looker/instances/help b/gcloud/alpha/looker/instances/help index fb4398599..d1d6bac01 100644 --- a/gcloud/alpha/looker/instances/help +++ b/gcloud/alpha/looker/instances/help @@ -62,7 +62,7 @@ COMMANDS (ALPHA) Delete a Looker instance. describe - (ALPHA) Show metadata for a Looker. + (ALPHA) Show metadata for a Looker instance. export (ALPHA) Export a Looker instance. diff --git a/gcloud/alpha/monitoring/uptime/create b/gcloud/alpha/monitoring/uptime/create index 020d8b5e2..247319ecc 100644 --- a/gcloud/alpha/monitoring/uptime/create +++ b/gcloud/alpha/monitoring/uptime/create @@ -12,7 +12,8 @@ SYNOPSIS --custom-content-type=CUSTOM_CONTENT_TYPE --headers=[KEY=VALUE,...] --mask-headers=MASK_HEADERS --password=PASSWORD --path=PATH --pings-count=PINGS_COUNT --port=PORT --protocol=PROTOCOL - --request-method=REQUEST_METHOD --username=USERNAME + --request-method=REQUEST_METHOD + --service-agent-auth=SERVICE_AGENT_AUTH --username=USERNAME --validate-ssl=VALIDATE_SSL --status-classes=[status-class,...] | --status-codes=[status-code,...]] [--matcher-content=MATCHER_CONTENT @@ -175,6 +176,17 @@ OPTIONAL FLAGS post HTTP POST method + Uptime check service agent authorization. + + --service-agent-auth=SERVICE_AGENT_AUTH + The type of authentication to use for the HTTP request. Can only be + set if --protocol is https. + + SERVICE_AGENT_AUTH must be (only one value is supported): + + oidc-token + OIDC Token authentication + --username=USERNAME The username to use when authenticating with the HTTP server. Can only be set if --protocol is http or https. diff --git a/gcloud/alpha/monitoring/uptime/update b/gcloud/alpha/monitoring/uptime/update index 245d77209..278b5ad9c 100644 --- a/gcloud/alpha/monitoring/uptime/update +++ b/gcloud/alpha/monitoring/uptime/update @@ -7,7 +7,8 @@ SYNOPSIS [--body=BODY --content-type=CONTENT_TYPE --custom-content-type=CUSTOM_CONTENT_TYPE --mask-headers=MASK_HEADERS --password=PASSWORD --path=PATH --pings-count=PINGS_COUNT --port=PORT - --request-method=REQUEST_METHOD --username=USERNAME + --request-method=REQUEST_METHOD + --service-agent-auth=SERVICE_AGENT_AUTH --username=USERNAME --validate-ssl=VALIDATE_SSL --add-status-classes=[status-class,...] | --clear-status-classes=CLEAR_STATUS_CLASSES | --remove-status-classes=[status-class,...] @@ -120,6 +121,17 @@ FLAGS post HTTP POST method + Uptime check service agent authorization. + + --service-agent-auth=SERVICE_AGENT_AUTH + The type of authentication to use for the HTTP request. Can only be + set if --protocol is https. + + SERVICE_AGENT_AUTH must be (only one value is supported): + + oidc-token + OIDC Token authentication + --username=USERNAME The username to use when authenticating with the HTTP server. Can only be set if --protocol is http or https. diff --git a/gcloud/alpha/netapp/storage-pools/create b/gcloud/alpha/netapp/storage-pools/create index 5562421ec..e7ccace73 100644 --- a/gcloud/alpha/netapp/storage-pools/create +++ b/gcloud/alpha/netapp/storage-pools/create @@ -99,16 +99,20 @@ REQUIRED FLAGS extreme Extreme Service Level for Cloud NetApp Storage Pool. The Extreme - Service Level has a throughput per TiB of allocated volume size of - 128 MiB/s. + Service Level has a throughput per GiB of allocated volume size of + 128 KiB/s. + flex + Flex Service Level for Cloud NetApp Storage Pool. The Flex Service + Level has a throughput per GiB of allocated volume size of 16 + KiB/s. premium Premium Service Level for Cloud NetApp Storage Pool. The Premium - Service Level has a throughput per TiB of allocated volume size of - 64 MiB/s. + Service Level has a throughput per GiB of allocated volume size of + 64 KiB/s. standard Standard Service Level for Cloud NetApp Storage Pool. The Standard - Service Level has a throughput per TiB of allocated volume size of - 128 MiB/s. + Service Level has a throughput per GiB of allocated volume size of + 16 KiB/s. OPTIONAL FLAGS Active directory resource - The Active Directory to attach to the Storage diff --git a/gcloud/alpha/network-services/service-lb-policies/create b/gcloud/alpha/network-services/service-lb-policies/create index 8038ece01..9adfed606 100644 --- a/gcloud/alpha/network-services/service-lb-policies/create +++ b/gcloud/alpha/network-services/service-lb-policies/create @@ -113,7 +113,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud network-services service-lb-policies create $ gcloud beta network-services service-lb-policies create diff --git a/gcloud/alpha/network-services/service-lb-policies/delete b/gcloud/alpha/network-services/service-lb-policies/delete index 944ea6323..6e468fe69 100644 --- a/gcloud/alpha/network-services/service-lb-policies/delete +++ b/gcloud/alpha/network-services/service-lb-policies/delete @@ -69,7 +69,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud network-services service-lb-policies delete $ gcloud beta network-services service-lb-policies delete diff --git a/gcloud/alpha/network-services/service-lb-policies/describe b/gcloud/alpha/network-services/service-lb-policies/describe index a0c8f0fb8..f452b4835 100644 --- a/gcloud/alpha/network-services/service-lb-policies/describe +++ b/gcloud/alpha/network-services/service-lb-policies/describe @@ -63,7 +63,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud network-services service-lb-policies describe $ gcloud beta network-services service-lb-policies describe diff --git a/gcloud/alpha/network-services/service-lb-policies/export b/gcloud/alpha/network-services/service-lb-policies/export index d9ff256a9..5feb71f68 100644 --- a/gcloud/alpha/network-services/service-lb-policies/export +++ b/gcloud/alpha/network-services/service-lb-policies/export @@ -74,7 +74,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud network-services service-lb-policies export $ gcloud beta network-services service-lb-policies export diff --git a/gcloud/alpha/network-services/service-lb-policies/help b/gcloud/alpha/network-services/service-lb-policies/help index 258ee47a9..b6a7bfd83 100644 --- a/gcloud/alpha/network-services/service-lb-policies/help +++ b/gcloud/alpha/network-services/service-lb-policies/help @@ -42,7 +42,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud network-services service-lb-policies $ gcloud beta network-services service-lb-policies diff --git a/gcloud/alpha/network-services/service-lb-policies/import b/gcloud/alpha/network-services/service-lb-policies/import index 86905f293..f69847eab 100644 --- a/gcloud/alpha/network-services/service-lb-policies/import +++ b/gcloud/alpha/network-services/service-lb-policies/import @@ -81,7 +81,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud network-services service-lb-policies import $ gcloud beta network-services service-lb-policies import diff --git a/gcloud/alpha/network-services/service-lb-policies/list b/gcloud/alpha/network-services/service-lb-policies/list index fa77580f2..476dfa86c 100644 --- a/gcloud/alpha/network-services/service-lb-policies/list +++ b/gcloud/alpha/network-services/service-lb-policies/list @@ -84,7 +84,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud network-services service-lb-policies list $ gcloud beta network-services service-lb-policies list diff --git a/gcloud/alpha/network-services/service-lb-policies/update b/gcloud/alpha/network-services/service-lb-policies/update index 256075c49..de9c17e63 100644 --- a/gcloud/alpha/network-services/service-lb-policies/update +++ b/gcloud/alpha/network-services/service-lb-policies/update @@ -112,7 +112,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. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud network-services service-lb-policies update $ gcloud beta network-services service-lb-policies update diff --git a/gcloud/alpha/pam/check-onboarding-status b/gcloud/alpha/pam/check-onboarding-status new file mode 100644 index 000000000..c68ea2ae1 --- /dev/null +++ b/gcloud/alpha/pam/check-onboarding-status @@ -0,0 +1,98 @@ +NAME + gcloud alpha pam check-onboarding-status - check Privileged Access Manager + onboarding status for a resource + +SYNOPSIS + gcloud alpha pam check-onboarding-status + (--location=LOCATION : --folder=FOLDER --organization=ORGANIZATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Check Privileged Access Manager (PAM) onboarding status for a + project/organization/folder location. + +EXAMPLES + The following command checks the PAM onboarding status for a project + sample-project and location global: + + $ gcloud alpha pam check-onboarding-status \ + --project=sample-project --location=global + + The following command checks the PAM onboarding status for a folder + sample-folder and location global: + + $ gcloud alpha pam check-onboarding-status --folder=sample-folder \ + --location=global + + The following command checks the PAM onboarding status for an organization + sample-organization and location global: + + $ gcloud alpha pam check-onboarding-status \ + --organization=sample-organization --location=global + +REQUIRED FLAGS + Location resource - The project/organization/folder location for which the + onboarding status is to be checked. 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 --location on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: [privilegedaccessmanager.projects.locations, + privilegedaccessmanager.folders.locations, + privilegedaccessmanager.organizations.locations]. + + 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. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations]. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations]. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam check-onboarding-status + diff --git a/gcloud/alpha/pam/entitlements/create b/gcloud/alpha/pam/entitlements/create new file mode 100644 index 000000000..60e94204b --- /dev/null +++ b/gcloud/alpha/pam/entitlements/create @@ -0,0 +1,125 @@ +NAME + gcloud alpha pam entitlements create - create a new Privileged Access + Manager entitlement + +SYNOPSIS + gcloud alpha pam entitlements create + (ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + --entitlement-file=ENTITLEMENT_FILE [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a new Privileged Access Manager (PAM) entitlement under a + project/folder/organization location. + +EXAMPLES + The following command creates a new entitlement with the name + sample-entitlement, under a project sample-project, location global and the + entitlement body present in the sample-entitlement.yaml file: + + $ gcloud alpha pam entitlements create sample-entitlement \ + --project=sample-project --location=global \ + --entitlement-file=sample-entitlement.yaml + + The following command creates a new entitlement with the name + sample-entitlement, under a folder sample-folder, location global and the + entitlement body present in the sample-entitlement.yaml file: + + $ gcloud alpha pam entitlements create sample-entitlement \ + --folder=sample-folder --location=global \ + --entitlement-file=sample-entitlement.yaml + + The following command creates a new entitlement with the name + sample-entitlement, under an organization sample-organization, location + global and the entitlement body present in the sample-entitlement.yaml + file: + + $ gcloud alpha pam entitlements create sample-entitlement \ + --organization=sample-organization --location=global \ + --entitlement-file=sample-entitlement.yaml + +POSITIONAL ARGUMENTS + Entitlement resource - Name of the entitlement 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 entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument entitlement on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +REQUIRED FLAGS + --entitlement-file=ENTITLEMENT_FILE + YAML file containing the body of the entitlement to be created. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam entitlements create + diff --git a/gcloud/alpha/pam/entitlements/delete b/gcloud/alpha/pam/entitlements/delete new file mode 100644 index 000000000..45b8efc99 --- /dev/null +++ b/gcloud/alpha/pam/entitlements/delete @@ -0,0 +1,104 @@ +NAME + gcloud alpha pam entitlements delete - delete a Privileged Access Manager + entitlement + +SYNOPSIS + gcloud alpha pam entitlements delete + (ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Privileged Access Manager (PAM) entitlement along with all + grants under it. + + This command can fail for the following reasons: + ▪ There are non-terminal grants under the entitlement. + +EXAMPLES + The following command deletes an entitlement with the full name + ENTITLEMENT_NAME along with all grants under it: + + $ gcloud alpha pam entitlements delete ENTITLEMENT_NAME + +POSITIONAL ARGUMENTS + Entitlement resource - Name of the entitlement 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 entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument entitlement on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam entitlements delete + diff --git a/gcloud/alpha/pam/entitlements/describe b/gcloud/alpha/pam/entitlements/describe new file mode 100644 index 000000000..025b1e916 --- /dev/null +++ b/gcloud/alpha/pam/entitlements/describe @@ -0,0 +1,95 @@ +NAME + gcloud alpha pam entitlements describe - show details of a Privileged + Access Manager entitlement + +SYNOPSIS + gcloud alpha pam entitlements describe + (ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Show details of a Privileged Access Manager (PAM) entitlement. + +EXAMPLES + The following command describes an entitlement with the full name + ENTITLEMENT_NAME: + + $ gcloud alpha pam entitlements describe ENTITLEMENT_NAME + +POSITIONAL ARGUMENTS + Entitlement resource - Name of the entitlement 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 entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument entitlement on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam entitlements describe + diff --git a/gcloud/alpha/pam/entitlements/export b/gcloud/alpha/pam/entitlements/export new file mode 100644 index 000000000..6723dcc71 --- /dev/null +++ b/gcloud/alpha/pam/entitlements/export @@ -0,0 +1,105 @@ +NAME + gcloud alpha pam entitlements export - export a Privileged Access Manager + entitlement into a local YAML file + +SYNOPSIS + gcloud alpha pam entitlements export + (ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--destination=DESTINATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Export a Privileged Access Manager (PAM) entitlement into a local + YAML file. + +EXAMPLES + The following command exports an entitlement with the full name + ENTITLEMENT_NAME to a local YAML file entitlement-file.yaml: + + $ gcloud alpha pam entitlements export ENTITLEMENT_NAME \ + --destination=entitlement-file.yaml + +POSITIONAL ARGUMENTS + Entitlement resource - Name of the entitlement 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 entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument entitlement on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +FLAGS + --destination=DESTINATION + Path to a YAML file where the configuration will be exported. The + exported data will not contain any output-only fields. Alternatively, + you may omit this flag to write to standard output. For a schema + describing the export/import format, see + $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam entitlements export + diff --git a/gcloud/alpha/pam/entitlements/help b/gcloud/alpha/pam/entitlements/help new file mode 100644 index 000000000..33d419a8f --- /dev/null +++ b/gcloud/alpha/pam/entitlements/help @@ -0,0 +1,154 @@ +NAME + gcloud alpha pam entitlements - manage Privileged Access Manager + Entitlements + +SYNOPSIS + gcloud alpha pam entitlements COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) The gcloud pam entitlements command group lets you manage + Privileged Access Manager (PAM) Entitlements. + +EXAMPLES + To create a new entitlement with the name sample-entitlement, under a + project sample-project, location global and the entitlement body present in + the sample-entitlement.yaml file, run: + + $ gcloud alpha pam entitlements create sample-entitlement \ + --project=sample-project --location=global \ + --entitlement-file=sample-entitlement.yaml + + To create a new entitlement with the name sample-entitlement, under a + folder sample-folder, location global and the entitlement body present in + the sample-entitlement.yaml file, run: + + $ gcloud alpha pam entitlements create sample-entitlement \ + --folder=sample-folder --location=global \ + --entitlement-file=sample-entitlement.yaml + + To create a new entitlement with the name sample-entitlement, under an + organization sample-organization, location global and the entitlement body + present in the sample-entitlement.yaml file, run: + + $ gcloud alpha pam entitlements create sample-entitlement \ + --organization=sample-organization --location=global \ + --entitlement-file=sample-entitlement.yaml + + To update an entitlement with the full name ENTITLEMENT_NAME and the new + entitlement body present in the sample-entitlement.yaml file, run: + + $ gcloud alpha pam entitlements update ENTITLEMENT_NAME \ + --entitlement-file=sample-entitlement.yaml + + To describe an entitlement with the full name ENTITLEMENT_NAME, run: + + $ gcloud alpha pam entitlements describe ENTITLEMENT_NAME + + To search and list all entitlements under a project sample-project and + location global for which you are a requester, run: + + $ gcloud alpha pam entitlements search --project=sample-project \ + --location=global --caller-access-type=grant-requester + + To search and list all entitlements under a project sample-project and + location global for which you are an approver, run: + + $ gcloud alpha pam entitlements search --project=sample-project \ + --location=global --caller-access-type=grant-approver + + To search and list all entitlements under a folder sample-folder and + location global for which you are a requester, run: + + $ gcloud alpha pam entitlements search --folder=sample-folder \ + --location=global --caller-access-type=grant-requester + + To search and list all entitlements under a folder sample-folder and + location global for which you are an approver, run: + + $ gcloud alpha pam entitlements search --folder=sample-folder \ + --location=global --caller-access-type=grant-approver + + To search and list all entitlements under an organization + sample-organization and location global for which you are a requester, run: + + $ gcloud alpha pam entitlements search \ + --organization=sample-organization --location=global \ + --caller-access-type=grant-requester + + To search and list all entitlements under an organization + sample-organization and location global for which you are an approver, run: + + $ gcloud alpha pam entitlements search \ + --organization=sample-organization --location=global \ + --caller-access-type=grant-approver + + To list all entitlement under a project sample-project and location global, + run: + + $ gcloud alpha pam entitlements list --project=sample-project \ + --location=global + + To list all entitlement under a folder sample-folder and location global, + run: + + $ gcloud alpha pam entitlements list --folder=sample-folder \ + --location=global + + To list all entitlement under an organization sample-organization and + location global, run: + + $ gcloud alpha pam entitlements list \ + --organization=sample-organization --location=global + + To delete an entitlement with the full name ENTITLEMENT_NAME along with all + grants under it, run: + + $ gcloud alpha pam entitlements delete ENTITLEMENT_NAME + + To export an entitlement with the full name ENTITLEMENT_NAME to a local + YAML file entitlement-file.yaml, run: + + $ gcloud alpha pam entitlements export ENTITLEMENT_NAME \ + --destination=entitlement-file.yaml + +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 a new Privileged Access Manager (PAM) entitlement. + + delete + (ALPHA) Delete a Privileged Access Manager (PAM) entitlement. + + describe + (ALPHA) Show details of a Privileged Access Manager (PAM) entitlement. + + export + (ALPHA) Export a Privileged Access Manager (PAM) entitlement into a + local YAML file. + + list + (ALPHA) List all Privileged Access Manager (PAM) entitlements under a + parent. + + search + (ALPHA) Search and list all Privileged Access Manager (PAM) + entitlements under a parent for which you are either a requester or an + approver. + + update + (ALPHA) Update an existing Privileged Access Manager (PAM) entitlement. + +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 pam entitlements + diff --git a/gcloud/alpha/pam/entitlements/list b/gcloud/alpha/pam/entitlements/list new file mode 100644 index 000000000..5e0bc5c8b --- /dev/null +++ b/gcloud/alpha/pam/entitlements/list @@ -0,0 +1,125 @@ +NAME + gcloud alpha pam entitlements list - list all Privileged Access Manager + entitlements under a parent + +SYNOPSIS + gcloud alpha pam entitlements list + (--location=LOCATION : --folder=FOLDER --organization=ORGANIZATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List all Privileged Access Manager (PAM) entitlements under a + project/folder/organization location. + +EXAMPLES + The following command lists all entitlement under a project sample-project + and location global: + + $ gcloud alpha pam entitlements list --project=sample-project \ + --location=global + + The following command lists all entitlement under a folder sample-folder + and location global: + + $ gcloud alpha pam entitlements list --folder=sample-folder \ + --location=global + + The following command lists all entitlement under an organization + sample-organization and location global: + + $ gcloud alpha pam entitlements list \ + --organization=sample-organization --location=global + +REQUIRED FLAGS + Location resource - Location under which the entitlements are to be + listed. 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 --location on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: [privilegedaccessmanager.projects.locations, + privilegedaccessmanager.folders.locations, + privilegedaccessmanager.organizations.locations]. + + 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. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations]. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.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. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam entitlements list + diff --git a/gcloud/alpha/pam/entitlements/search b/gcloud/alpha/pam/entitlements/search new file mode 100644 index 000000000..f921ac08c --- /dev/null +++ b/gcloud/alpha/pam/entitlements/search @@ -0,0 +1,155 @@ +NAME + gcloud alpha pam entitlements search - search and list all Privileged + Access Manager entitlements under a parent for which you are either a + requester or an approver + +SYNOPSIS + gcloud alpha pam entitlements search + --caller-access-type=CALLER_ACCESS_TYPE + (--location=LOCATION : --folder=FOLDER --organization=ORGANIZATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Search and list all Privileged Access Manager (PAM) entitlements + under a project/folder/organization location for which you are either a + requester or an approver. + +EXAMPLES + The following command searches and lists all entitlements under a project + sample-project and location global for which you are a requester: + + $ gcloud alpha pam entitlements search --project=sample-project \ + --location=global --caller-access-type=grant-requester + + The following command searches and lists all entitlements under a project + sample-project and location global for which you are an approver: + + $ gcloud alpha pam entitlements search --project=sample-project \ + --location=global --caller-access-type=grant-approver + + The following command searches and lists all entitlements under a folder + sample-folder and location global for which you are a requester: + + $ gcloud alpha pam entitlements search --folder=sample-folder \ + --location=global --caller-access-type=grant-requester + + The following command searches and lists all entitlements under a folder + sample-folder and location global for which you are an approver: + + $ gcloud alpha pam entitlements search --folder=sample-folder \ + --location=global --caller-access-type=grant-approver + + The following command searches and lists all entitlements under an + organization sample-organization and location global for which you are a + requester: + + $ gcloud alpha pam entitlements search \ + --organization=sample-organization --location=global \ + --caller-access-type=grant-requester + + The following command searches and lists all entitlements under an + organization sample-organization and location global for which you are an + approver: + + $ gcloud alpha pam entitlements search \ + --organization=sample-organization --location=global \ + --caller-access-type=grant-approver + +REQUIRED FLAGS + --caller-access-type=CALLER_ACCESS_TYPE + Whether to search the entitlements for which you are a requester or + approver. CALLER_ACCESS_TYPE must be one of: grant-approver, + grant-requester. + + Location resource - Location under which the entitlements are to be + listed. 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 --location on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: [privilegedaccessmanager.projects.locations, + privilegedaccessmanager.folders.locations, + privilegedaccessmanager.organizations.locations]. + + 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. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations]. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.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. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam entitlements search + diff --git a/gcloud/alpha/pam/entitlements/update b/gcloud/alpha/pam/entitlements/update new file mode 100644 index 000000000..e0a7279d9 --- /dev/null +++ b/gcloud/alpha/pam/entitlements/update @@ -0,0 +1,106 @@ +NAME + gcloud alpha pam entitlements update - update an existing Privileged Access + Manager entitlement + +SYNOPSIS + gcloud alpha pam entitlements update + (ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + --entitlement-file=ENTITLEMENT_FILE [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update an existing Privileged Access Manager (PAM) entitlement. + +EXAMPLES + The following command updates an entitlement with the full name + ENTITLEMENT_NAME and the new entitlement body present in the + sample-entitlement.yaml file: + + $ gcloud alpha pam entitlements update ENTITLEMENT_NAME \ + --entitlement-file=sample-entitlement.yaml + +POSITIONAL ARGUMENTS + Entitlement resource - Name of the entitlement 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 entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument entitlement on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +REQUIRED FLAGS + --entitlement-file=ENTITLEMENT_FILE + YAML file containing the new body of the entitlement. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam entitlements update + diff --git a/gcloud/alpha/pam/grants/approve b/gcloud/alpha/pam/grants/approve new file mode 100644 index 000000000..79c348b41 --- /dev/null +++ b/gcloud/alpha/pam/grants/approve @@ -0,0 +1,106 @@ +NAME + gcloud alpha pam grants approve - approve a Privileged Access Manager grant + +SYNOPSIS + gcloud alpha pam grants approve + (GRANT : --entitlement=ENTITLEMENT + --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--reason=REASON] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Approve a Privileged Access Manager (PAM) grant with a reason. + +EXAMPLES + The following command approves a grant with the full name GRANT_NAME and a + reason approval reason: + + $ gcloud alpha pam grants approve GRANT_NAME \ + --reason="approval reason" + +POSITIONAL ARGUMENTS + Grant resource - Name of the grant to approve. 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 grant on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements.grants, + privilegedaccessmanager.folders.locations.entitlements.grants, + privilegedaccessmanager.organizations.locations.entitlements.grants]. + + This must be specified. + + GRANT + ID of the grant or fully qualified identifier for the grant. + + To set the grant attribute: + ▸ provide the argument grant on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --entitlement=ENTITLEMENT + The entitlement id + + To set the entitlement attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --entitlement on the command line. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements.grants]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements.grants]. + +FLAGS + --reason=REASON + Reason for approving the grant. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam grants approve + diff --git a/gcloud/alpha/pam/grants/create b/gcloud/alpha/pam/grants/create new file mode 100644 index 000000000..434096506 --- /dev/null +++ b/gcloud/alpha/pam/grants/create @@ -0,0 +1,113 @@ +NAME + gcloud alpha pam grants create - create a new Privileged Access Manager + grant + +SYNOPSIS + gcloud alpha pam grants create --requested-duration=REQUESTED_DURATION + (--entitlement=ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--additional-email-recipients=[ADDITIONAL_EMAIL_RECIPIENTS,...]] + [--justification=JUSTIFICATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a new Privileged Access Manager (PAM) grant under an + entitlement. + +EXAMPLES + The following command creates a new grant under an entitlement with the + full name ENTITLEMENT_NAME, with requested duration 1 hour 30 minutes, a + justification some justification and two additional email recipients + abc@example.com and xyz@example.com: + + $ gcloud alpha pam grants create --entitlement=ENTITLEMENT_NAME \ + --requested-duration=5400s \ + --justification="some justification" \ + --additional-email-recipients=abc@example.com,xyz@example.com + +REQUIRED FLAGS + --requested-duration=REQUESTED_DURATION + Duration of the grant being created. + + Entitlement resource - Entitlement under which the grant is to be created + 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 --entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + --entitlement=ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument --entitlement on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +OPTIONAL FLAGS + --additional-email-recipients=[ADDITIONAL_EMAIL_RECIPIENTS,...] + Additional email addresses who will be notified for all the actions + performed on the grant. + + --justification=JUSTIFICATION + Justification for the grant. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam grants create + diff --git a/gcloud/alpha/pam/grants/deny b/gcloud/alpha/pam/grants/deny new file mode 100644 index 000000000..aa0c15c9c --- /dev/null +++ b/gcloud/alpha/pam/grants/deny @@ -0,0 +1,105 @@ +NAME + gcloud alpha pam grants deny - deny a Privileged Access Manager grant + +SYNOPSIS + gcloud alpha pam grants deny + (GRANT : --entitlement=ENTITLEMENT + --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--reason=REASON] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Deny a Privileged Access Manager (PAM) grant with a reason. + +EXAMPLES + The following command denies a grant with the full name GRANT_NAME and a + reason denial reason: + + $ gcloud alpha pam grants deny GRANT_NAME --reason="denial reason" + +POSITIONAL ARGUMENTS + Grant resource - Name of the grant to deny. 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 grant on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements.grants, + privilegedaccessmanager.folders.locations.entitlements.grants, + privilegedaccessmanager.organizations.locations.entitlements.grants]. + + This must be specified. + + GRANT + ID of the grant or fully qualified identifier for the grant. + + To set the grant attribute: + ▸ provide the argument grant on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --entitlement=ENTITLEMENT + The entitlement id + + To set the entitlement attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --entitlement on the command line. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements.grants]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements.grants]. + +FLAGS + --reason=REASON + Reason for denying the grant. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam grants deny + diff --git a/gcloud/alpha/pam/grants/describe b/gcloud/alpha/pam/grants/describe new file mode 100644 index 000000000..0bd49fd91 --- /dev/null +++ b/gcloud/alpha/pam/grants/describe @@ -0,0 +1,101 @@ +NAME + gcloud alpha pam grants describe - show details of a Privileged Access + Manager grant + +SYNOPSIS + gcloud alpha pam grants describe + (GRANT : --entitlement=ENTITLEMENT + --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Show details of a Privileged Access Manager (PAM) grant. + +EXAMPLES + The following command describes a grant with the full name GRANT_NAME: + + $ gcloud alpha pam grants describe GRANT_NAME + +POSITIONAL ARGUMENTS + Grant resource - Name of the grant 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 grant on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements.grants, + privilegedaccessmanager.folders.locations.entitlements.grants, + privilegedaccessmanager.organizations.locations.entitlements.grants]. + + This must be specified. + + GRANT + ID of the grant or fully qualified identifier for the grant. + + To set the grant attribute: + ▸ provide the argument grant on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --entitlement=ENTITLEMENT + The entitlement id + + To set the entitlement attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --entitlement on the command line. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements.grants]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements.grants]. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam grants describe + diff --git a/gcloud/alpha/pam/grants/help b/gcloud/alpha/pam/grants/help new file mode 100644 index 000000000..475634806 --- /dev/null +++ b/gcloud/alpha/pam/grants/help @@ -0,0 +1,104 @@ +NAME + gcloud alpha pam grants - manage Privileged Access Manager Grants + +SYNOPSIS + gcloud alpha pam grants COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) The gcloud pam grants command group lets you manage Privileged + Access Manager (PAM) Grants. + +EXAMPLES + To create a new grant under an entitlement with the full name + ENTITLEMENT_NAME, with requested duration 1 hour 30 minutes, a + justification some justification and two additional email recipients + abc@example.com and xyz@example.com, run: + + $ gcloud alpha pam grants create --entitlement=ENTITLEMENT_NAME \ + --requested-duration=5400s \ + --justification="some justification" \ + --additional-email-recipients=abc@example.com,xyz@example.com + + To describe a grant with the full name GRANT_NAME, run: + + $ gcloud alpha pam grants describe GRANT_NAME + + To list all grants under an entitlement with the full name + ENTITLEMENT_NAME, run: + + $ gcloud alpha pam grants list --entitlement=ENTITLEMENT_NAME + + To deny a grant with the full name GRANT_NAME and a reason denial reason, + run: + + $ gcloud alpha pam grants deny GRANT_NAME --reason="denial reason" + + To approve a grant with the full name GRANT_NAME and a reason approval + reason, run: + + $ gcloud alpha pam grants approve GRANT_NAME \ + --reason="approval reason" + + To revoke a grant with the full name GRANT_NAME and a reason revoke reason, + run: + + $ gcloud alpha pam grants revoke GRANT_NAME --reason="revoke reason" + + To search and list all grants under an entitlement with the full name + ENTITLEMENT_NAME, which you had created, run: + + $ gcloud alpha pam grants search --entitlement=ENTITLEMENT_NAME \ + --caller-relationship=had-created + + To search and list all grants under an entitlement with the full name + ENTITLEMENT_NAME, which you had approved or denied, run: + + $ gcloud alpha pam grants search --entitlement=ENTITLEMENT_NAME \ + --caller-relationship=had-approved + + To search and list all grants under an entitlement with the full name + ENTITLEMENT_NAME, which you can approve, run: + + $ gcloud alpha pam grants search --entitlement=ENTITLEMENT_NAME \ + --caller-relationship=can-approve + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + approve + (ALPHA) Approve a Privileged Access Manager (PAM) grant. + + create + (ALPHA) Create a new Privileged Access Manager (PAM) grant. + + deny + (ALPHA) Deny a Privileged Access Manager (PAM) grant. + + describe + (ALPHA) Show details of a Privileged Access Manager (PAM) grant. + + list + (ALPHA) List all Privileged Access Manager (PAM) grants under an + entitlement. + + revoke + (ALPHA) Revoke a Privileged Access Manager (PAM) grant. + + search + (ALPHA) Search and list all Privileged Access Manager (PAM) grants + under an entitlement which you had created, had approved or can + approve. + +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 pam grants + diff --git a/gcloud/alpha/pam/grants/list b/gcloud/alpha/pam/grants/list new file mode 100644 index 000000000..9b0254d18 --- /dev/null +++ b/gcloud/alpha/pam/grants/list @@ -0,0 +1,123 @@ +NAME + gcloud alpha pam grants list - list all Privileged Access Manager grants + under an entitlement + +SYNOPSIS + gcloud alpha pam grants list + (--entitlement=ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List all Privileged Access Manager (PAM) grants under an + entitlement. + +EXAMPLES + The following command lists all grants under an entitlement with the full + name ENTITLEMENT_NAME: + + $ gcloud alpha pam grants list --entitlement=ENTITLEMENT_NAME + +REQUIRED FLAGS + Entitlement resource - Entitlement under which the grants are to be + listed. 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 --entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + --entitlement=ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument --entitlement on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam grants list + diff --git a/gcloud/alpha/pam/grants/revoke b/gcloud/alpha/pam/grants/revoke new file mode 100644 index 000000000..d8ad03de7 --- /dev/null +++ b/gcloud/alpha/pam/grants/revoke @@ -0,0 +1,109 @@ +NAME + gcloud alpha pam grants revoke - revoke a Privileged Access Manager grant + +SYNOPSIS + gcloud alpha pam grants revoke + (GRANT : --entitlement=ENTITLEMENT + --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--async] [--reason=REASON] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Revoke a Privileged Access Manager (PAM) grant with a reason. + +EXAMPLES + The following command revokes a grant with the full name GRANT_NAME and a + reason revoke reason: + + $ gcloud alpha pam grants revoke GRANT_NAME --reason="revoke reason" + +POSITIONAL ARGUMENTS + Grant resource - Name of the grant to revoke. 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 grant on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements.grants, + privilegedaccessmanager.folders.locations.entitlements.grants, + privilegedaccessmanager.organizations.locations.entitlements.grants]. + + This must be specified. + + GRANT + ID of the grant or fully qualified identifier for the grant. + + To set the grant attribute: + ▸ provide the argument grant on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --entitlement=ENTITLEMENT + The entitlement id + + To set the entitlement attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --entitlement on the command line. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements.grants]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements.grants]. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --reason=REASON + Reason for revoking the grant. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam grants revoke + diff --git a/gcloud/alpha/pam/grants/search b/gcloud/alpha/pam/grants/search new file mode 100644 index 000000000..bd76d99d7 --- /dev/null +++ b/gcloud/alpha/pam/grants/search @@ -0,0 +1,142 @@ +NAME + gcloud alpha pam grants search - search and list all Privileged Access + Manager grants under an entitlement which you had created, had approved + or can approve + +SYNOPSIS + gcloud alpha pam grants search --caller-relationship=CALLER_RELATIONSHIP + (--entitlement=ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Search and list all Privileged Access Manager (PAM) grants under an + entitlement which you had created, had approved or can approve. + +EXAMPLES + The following command searches and lists all grants under an entitlement + with the full name ENTITLEMENT_NAME, which you had created: + + $ gcloud alpha pam grants search --entitlement=ENTITLEMENT_NAME \ + --caller-relationship=had-created + + The following command searches and lists all grants under an entitlement + with the full name ENTITLEMENT_NAME, which you had approved or denied: + + $ gcloud alpha pam grants search --entitlement=ENTITLEMENT_NAME \ + --caller-relationship=had-approved + + The following command searches and lists all grants under an entitlement + with the full name ENTITLEMENT_NAME, which you can approve: + + $ gcloud alpha pam grants search --entitlement=ENTITLEMENT_NAME \ + --caller-relationship=can-approve + +REQUIRED FLAGS + --caller-relationship=CALLER_RELATIONSHIP + Whether to search the grants which you had created, had approved or can + approve. CALLER_RELATIONSHIP must be one of: can-approve, had-approved, + had-created. + + Entitlement resource - Entitlement under which the grants are to be + listed. 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 --entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + --entitlement=ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument --entitlement on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam grants search + diff --git a/gcloud/alpha/pam/help b/gcloud/alpha/pam/help new file mode 100644 index 000000000..0066c37cb --- /dev/null +++ b/gcloud/alpha/pam/help @@ -0,0 +1,61 @@ +NAME + gcloud alpha pam - manage Privileged Access Manager Entitlements and Grants + +SYNOPSIS + gcloud alpha pam GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) The gcloud pam command group lets you manage Privileged Access + Manager (PAM) Entitlements and Grants. + +EXAMPLES + To check the PAM onboarding status for a project sample-project and + location global, run: + + $ gcloud alpha pam check-onboarding-status \ + --project=sample-project --location=global + + To check the PAM onboarding status for a folder sample-folder and location + global, run: + + $ gcloud alpha pam check-onboarding-status --folder=sample-folder \ + --location=global + + To check the PAM onboarding status for an organization sample-organization + and location global, run: + + $ gcloud alpha pam check-onboarding-status \ + --organization=sample-organization --location=global + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + entitlements + (ALPHA) Manage Privileged Access Manager (PAM) Entitlements. + + grants + (ALPHA) Manage Privileged Access Manager (PAM) Grants. + + operations + (ALPHA) Manage Privileged Access Manager (PAM) Long Running Operations. + +COMMANDS + COMMAND is one of the following: + + check-onboarding-status + (ALPHA) Check Privileged Access Manager (PAM) onboarding status for a + resource. + +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 pam + diff --git a/gcloud/alpha/pam/operations/delete b/gcloud/alpha/pam/operations/delete new file mode 100644 index 000000000..6214b2f64 --- /dev/null +++ b/gcloud/alpha/pam/operations/delete @@ -0,0 +1,94 @@ +NAME + gcloud alpha pam operations delete - delete a Privileged Access Manager + long running operation + +SYNOPSIS + gcloud alpha pam operations delete + (OPERATION + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Privileged Access Manager (PAM) long running operation. + +EXAMPLES + The following command deletes an operation with the full name + OPERATION_NAME: + + $ gcloud alpha pam operations delete OPERATION_NAME + +POSITIONAL ARGUMENTS + Operation resource - Name of the operation 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 operation on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.operations, + privilegedaccessmanager.folders.locations.operations, + privilegedaccessmanager.organizations.locations.operations]. + + This must be specified. + + OPERATION + ID of the operation or fully qualified identifier for the operation. + + To set the operation attribute: + ▸ provide the argument operation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.operations]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.operations]. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam operations delete + diff --git a/gcloud/alpha/pam/operations/describe b/gcloud/alpha/pam/operations/describe new file mode 100644 index 000000000..f4adc226e --- /dev/null +++ b/gcloud/alpha/pam/operations/describe @@ -0,0 +1,95 @@ +NAME + gcloud alpha pam operations describe - show details of a Privileged Access + Manager long running operation + +SYNOPSIS + gcloud alpha pam operations describe + (OPERATION + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Show details of a Privileged Access Manager (PAM) long running + operation. + +EXAMPLES + The following command describes an operation with the full name + OPERATION_NAME: + + $ gcloud alpha pam operations describe OPERATION_NAME + +POSITIONAL ARGUMENTS + Operation resource - Name of the operation 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 operation on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.operations, + privilegedaccessmanager.folders.locations.operations, + privilegedaccessmanager.organizations.locations.operations]. + + This must be specified. + + OPERATION + ID of the operation or fully qualified identifier for the operation. + + To set the operation attribute: + ▸ provide the argument operation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.operations]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.operations]. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam operations describe + diff --git a/gcloud/alpha/pam/operations/help b/gcloud/alpha/pam/operations/help new file mode 100644 index 000000000..1c4e0abab --- /dev/null +++ b/gcloud/alpha/pam/operations/help @@ -0,0 +1,73 @@ +NAME + gcloud alpha pam operations - manage Privileged Access Manager Long Running + Operations + +SYNOPSIS + gcloud alpha pam operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) The gcloud pam operations command group lets you manage Privileged + Access Manager (PAM) Operations. + +EXAMPLES + To describe an operation with the full name OPERATION_NAME, run: + + $ gcloud alpha pam operations describe OPERATION_NAME + + To list all operations under a project sample-project and location global, + run: + + $ gcloud alpha pam operations list --project=sample-project \ + --location=global + + To list all operations under a folder sample-folder and location global, + run: + + $ gcloud alpha pam operations list --folder=sample-folder \ + --location=global + + To list all operations under an organization sample-organization and + location global, run: + + $ gcloud alpha pam operations list \ + --organization=sample-organization --location=global + + To delete an operation with the full name OPERATION_NAME, run: + + $ gcloud alpha pam operations delete OPERATION_NAME + + To poll an operation with the full name OPERATION_NAME, run: + + $ gcloud alpha pam operations wait OPERATION_NAME + +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 Privileged Access Manager (PAM) long running + operation. + + describe + (ALPHA) Show details of a Privileged Access Manager (PAM) long running + operation. + + list + (ALPHA) List all Privileged Access Manager (PAM) long running + operations under a location. + + wait + (ALPHA) Poll a Privileged Access Manager (PAM) long running operation. + +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 pam operations + diff --git a/gcloud/alpha/pam/operations/list b/gcloud/alpha/pam/operations/list new file mode 100644 index 000000000..3398c91d4 --- /dev/null +++ b/gcloud/alpha/pam/operations/list @@ -0,0 +1,125 @@ +NAME + gcloud alpha pam operations list - list all Privileged Access Manager long + running operations under a location + +SYNOPSIS + gcloud alpha pam operations list + (--location=LOCATION : --folder=FOLDER --organization=ORGANIZATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List all Privileged Access Manager (PAM) long running operations + under a project/folder/organization location. + +EXAMPLES + The following command lists all operations under a project sample-project + and location global: + + $ gcloud alpha pam operations list --project=sample-project \ + --location=global + + The following command list all operations under a folder sample-folder and + location global: + + $ gcloud alpha pam operations list --folder=sample-folder \ + --location=global + + The following command list all operations under an organization + sample-organization and location global: + + $ gcloud alpha pam operations list \ + --organization=sample-organization --location=global + +REQUIRED FLAGS + Location resource - Location under which the operations are to be listed. + 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 --location on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: [privilegedaccessmanager.projects.locations, + privilegedaccessmanager.folders.locations, + privilegedaccessmanager.organizations.locations]. + + 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. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations]. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.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. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam operations list + diff --git a/gcloud/alpha/pam/operations/wait b/gcloud/alpha/pam/operations/wait new file mode 100644 index 000000000..04a3eb80a --- /dev/null +++ b/gcloud/alpha/pam/operations/wait @@ -0,0 +1,94 @@ +NAME + gcloud alpha pam operations wait - poll a Privileged Access Manager long + running operation + +SYNOPSIS + gcloud alpha pam operations wait + (OPERATION + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Poll a Privileged Access Manager (PAM) long running operation until + it completes and then display its result. + +EXAMPLES + The following command polls an operation with the full name OPERATION_NAME: + + $ gcloud alpha pam operations wait OPERATION_NAME + +POSITIONAL ARGUMENTS + Operation resource - Name of the operation to poll. 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 operation on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.operations, + privilegedaccessmanager.folders.locations.operations, + privilegedaccessmanager.organizations.locations.operations]. + + This must be specified. + + OPERATION + ID of the operation or fully qualified identifier for the operation. + + To set the operation attribute: + ▸ provide the argument operation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.operations]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.operations]. + +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 privilegedaccessmanager/v1alpha API. The full + documentation for this API can be found at: https://cloud.google.com/ + +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 pam operations wait + diff --git a/gcloud/alpha/run/deploy b/gcloud/alpha/run/deploy index 5c9cbb72e..8ee2beebf 100644 --- a/gcloud/alpha/run/deploy +++ b/gcloud/alpha/run/deploy @@ -28,8 +28,8 @@ SYNOPSIS --[no-]default-url --[no-]deploy-health-check --description=DESCRIPTION --execution-environment=EXECUTION_ENVIRONMENT - --[no-]invoker-iam-check --remove-containers=[CONTAINER,...] - --revision-suffix=REVISION_SUFFIX + --[no-]invoker-iam-check --max-surge=MAX_SURGE + --remove-containers=[CONTAINER,...] --revision-suffix=REVISION_SUFFIX --service-min-instances=SERVICE_MIN_INSTANCES --[no-]session-affinity --vpc-connector=VPC_CONNECTOR --vpc-egress=VPC_EGRESS --add-cloudsql-instances=[CLOUDSQL-INSTANCES,...] @@ -467,6 +467,11 @@ FLAGS available in all projects. Use --invoker-iam-check to enable and --no-invoker-iam-check to disable. + --max-surge=MAX_SURGE + A maximum percentage of instances that will be moved in each step of + traffic split changes. Use "default" to unset the limit and use the + platform default. + --remove-containers=[CONTAINER,...] List of containers to remove. diff --git a/gcloud/alpha/run/services/update b/gcloud/alpha/run/services/update index 4228bc868..ea8ab159b 100644 --- a/gcloud/alpha/run/services/update +++ b/gcloud/alpha/run/services/update @@ -23,8 +23,8 @@ SYNOPSIS --[no-]cpu-throttling --[no-]default-url --[no-]deploy-health-check --description=DESCRIPTION --execution-environment=EXECUTION_ENVIRONMENT - --[no-]invoker-iam-check --remove-containers=[CONTAINER,...] - --revision-suffix=REVISION_SUFFIX + --[no-]invoker-iam-check --max-surge=MAX_SURGE + --remove-containers=[CONTAINER,...] --revision-suffix=REVISION_SUFFIX --service-min-instances=SERVICE_MIN_INSTANCES --[no-]session-affinity --vpc-connector=VPC_CONNECTOR --vpc-egress=VPC_EGRESS --add-cloudsql-instances=[CLOUDSQL-INSTANCES,...] @@ -353,6 +353,11 @@ FLAGS available in all projects. Use --invoker-iam-check to enable and --no-invoker-iam-check to disable. + --max-surge=MAX_SURGE + A maximum percentage of instances that will be moved in each step of + traffic split changes. Use "default" to unset the limit and use the + platform default. + --remove-containers=[CONTAINER,...] List of containers to remove. diff --git a/gcloud/alpha/scc/help b/gcloud/alpha/scc/help index 29cc03b72..0b6eaf2a2 100644 --- a/gcloud/alpha/scc/help +++ b/gcloud/alpha/scc/help @@ -25,6 +25,10 @@ GROUPS findings (ALPHA) Manage Cloud SCC (Security Command Center) findings. + iac-validation-reports + (ALPHA) Manage Cloud SCC (Security Command Center) + iac-validation-reports. + manage (ALPHA) Manage Cloud SCC (Security Command Center) settings. diff --git a/gcloud/alpha/scc/iac-validation-reports/create b/gcloud/alpha/scc/iac-validation-reports/create new file mode 100644 index 000000000..7795b79e8 --- /dev/null +++ b/gcloud/alpha/scc/iac-validation-reports/create @@ -0,0 +1,57 @@ +NAME + gcloud alpha scc iac-validation-reports create - create a Cloud Security + Command Center IaC Validation Report + +SYNOPSIS + gcloud alpha scc iac-validation-reports create PARENT + --tf-plan-file=TF_PLAN_FILE [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Cloud Security Command Center (SCC) IaC Validation Report. + First argument is the parent of the IaC defined in the plan file. It is + followed by path of the terraform plan file in JSON format. + + LRO operation ID is returned as the response of the command. + +EXAMPLES + Create an Iac Validation report on parent + organizations/123/locations/global: + + $ gcloud alpha scc iac-validation-reports create \ + organizations/123/locations/global --tf-plan-file=planFile.json + +POSITIONAL ARGUMENTS + PARENT + Name of the organization where IaC Validation Report is to be created. + Format: organizations//locations/ + +REQUIRED FLAGS + --tf-plan-file=TF_PLAN_FILE + Path to a JSON file containing the IaC plan to be validated. + +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 securityposture/v1alpha API. The full documentation + for this API can be found at: + https://cloud.google.com/security-command-center + +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 scc iac-validation-reports create + diff --git a/gcloud/alpha/scc/iac-validation-reports/help b/gcloud/alpha/scc/iac-validation-reports/help new file mode 100644 index 000000000..0f93c627a --- /dev/null +++ b/gcloud/alpha/scc/iac-validation-reports/help @@ -0,0 +1,30 @@ +NAME + gcloud alpha scc iac-validation-reports - manage Cloud SCC + (Security Command Center) iac-validation-reports + +SYNOPSIS + gcloud alpha scc iac-validation-reports COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Cloud SCC (Security Command Center) iac-validation-reports. + +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 a Cloud Security Command Center (SCC) IaC Validation + Report. + +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 scc iac-validation-reports + diff --git a/gcloud/artifacts/generic/download b/gcloud/artifacts/generic/download new file mode 100644 index 000000000..6daa62d4d --- /dev/null +++ b/gcloud/artifacts/generic/download @@ -0,0 +1,89 @@ +NAME + gcloud artifacts generic download - download a generic artifact from a + generic artifact repository + +SYNOPSIS + gcloud artifacts generic download --destination=DESTINATION + --package=ARTIFACT --version=VERSION [--name=NAME] + [--location=LOCATION --repository=REPOSITORY] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Download a generic artifact from a generic artifact repository. + +EXAMPLES + To download version v0.1.0 of myfile.txt located in a repository in + "us-central1" to /path/to/destination/: + + $ gcloud artifacts generic download --location=us-central1 \ + --project=myproject --repository=myrepo --package=mypackage \ + --version=v0.1.0 --destination=/path/to/destination/ \ + --name=myfile.txt + + To download all files of version v0.1.0 and package mypackage located in a + repository in "us-central1" to /path/to/destination/ while maintaining the + folder hierarchy: + + $ gcloud artifacts generic download --location=us-central1 \ + --project=myproject --repository=myrepo --package=mypackage \ + --version=v0.1.0 --destination=/path/to/destination/ + +REQUIRED FLAGS + --destination=DESTINATION + The path where you want to save the downloaded file. + + --package=ARTIFACT + The artifact to download. + + --version=VERSION + The version of the artifact to download. + +OPTIONAL FLAGS + --name=NAME + If specified, the file name within the artifact to download. + + Repository resource - The Artifact Registry repository. If not specified, + the current artifacts/repository is used. 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 --repository on the command line with a fully + specified name; + ◆ set the property artifacts/repository with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + Location of the repository. + + To set the location attribute: + ▸ provide the argument --repository on the command line with a + fully specified name; + ▸ set the property artifacts/repository with a fully specified + name; + ▸ provide the argument --location on the command line; + ▸ set the property artifacts/location. + + --repository=REPOSITORY + ID of the repository or fully qualified identifier for the + repository. + + To set the repository attribute: + ▸ provide the argument --repository on the command line; + ▸ set the property artifacts/repository. + +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 artifacts generic download + + $ gcloud beta artifacts generic download + diff --git a/gcloud/artifacts/generic/help b/gcloud/artifacts/generic/help new file mode 100644 index 000000000..8e0f14f78 --- /dev/null +++ b/gcloud/artifacts/generic/help @@ -0,0 +1,30 @@ +NAME + gcloud artifacts generic - manage Artifact Registry generic artifacts + +SYNOPSIS + gcloud artifacts generic COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Artifact Registry generic artifacts. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + download + Download a generic artifact from a generic artifact repository. + + upload + Uploads an artifact to a generic repository. + +NOTES + These variants are also available: + + $ gcloud alpha artifacts generic + + $ gcloud beta artifacts generic + diff --git a/gcloud/artifacts/generic/upload b/gcloud/artifacts/generic/upload new file mode 100644 index 000000000..b2df3e88a --- /dev/null +++ b/gcloud/artifacts/generic/upload @@ -0,0 +1,104 @@ +NAME + gcloud artifacts generic upload - uploads an artifact to a generic + repository + +SYNOPSIS + gcloud artifacts generic upload --package=PACKAGE --version=VERSION + (--source=SOURCE | --source-directory=SOURCE_DIRECTORY) [--async] + [--destination-path=DESTINATION_PATH] [--skip-existing] + [--location=LOCATION --repository=REPOSITORY] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Uploads an artifact to a generic repository. + +EXAMPLES + To upload version v0.1.0 of a generic artifact located in /path/to/file/ to + a repository in "us-central1": + + $ gcloud artifacts generic upload --location=us-central1 \ + --project=myproject --repository=myrepo --package=mypackage \ + --version=v0.1.0 --source=/path/to/file/ + + To upload version v0.1.0 of a generic artifact located in /path/to/file/ to + a repository in "us-central1" within a folder structure: + + $ gcloud artifacts generic upload --location=us-central1 \ + --project=myproject --repository=myrepo --package=mypackage \ + --version=v0.1.0 --source=/path/to/file/ \ + --destination-path=folder/file + +REQUIRED FLAGS + --package=PACKAGE + The package to upload. + + --version=VERSION + The version of the package. You cannot overwrite an existing version in + the repository. + + Exactly one of these must be specified: + + --source=SOURCE + The path to the file you are uploading. + + --source-directory=SOURCE_DIRECTORY + The directory you are uploading. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --destination-path=DESTINATION_PATH + Use to specify the path to upload a generic artifact to within a folder + structure. + + --skip-existing + If specified, skip uploading files that already exist in the + repository, and continue to upload the remaining files. + + Repository resource - The Artifact Registry repository. If not specified, + the current artifacts/repository is used. 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 --repository on the command line with a fully + specified name; + ◆ set the property artifacts/repository with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + Location of the repository. + + To set the location attribute: + ▸ provide the argument --repository on the command line with a + fully specified name; + ▸ set the property artifacts/repository with a fully specified + name; + ▸ provide the argument --location on the command line; + ▸ set the property artifacts/location. + + --repository=REPOSITORY + ID of the repository or fully qualified identifier for the + repository. + + To set the repository attribute: + ▸ provide the argument --repository on the command line; + ▸ set the property artifacts/repository. + +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 artifacts generic upload + + $ gcloud beta artifacts generic upload + diff --git a/gcloud/artifacts/help b/gcloud/artifacts/help index b2a4db688..e3f603865 100644 --- a/gcloud/artifacts/help +++ b/gcloud/artifacts/help @@ -24,6 +24,9 @@ GROUPS files Manage Artifact Registry files. + generic + Manage Artifact Registry generic artifacts. + go Manage Artifact Registry Go modules. diff --git a/gcloud/beta/ai/endpoints/deploy-model b/gcloud/beta/ai/endpoints/deploy-model index 2b9c95c8c..6feb2c46d 100644 --- a/gcloud/beta/ai/endpoints/deploy-model +++ b/gcloud/beta/ai/endpoints/deploy-model @@ -11,7 +11,7 @@ SYNOPSIS [--enable-container-logging] [--machine-type=MACHINE_TYPE] [--max-replica-count=MAX_REPLICA_COUNT] [--min-replica-count=MIN_REPLICA_COUNT] - [--service-account=SERVICE_ACCOUNT] + [--service-account=SERVICE_ACCOUNT] [--tpu-topology=TPU_TOPOLOGY] [--traffic-split=[DEPLOYED_MODEL_ID=VALUE,...]] [--shared-resources=SHARED_RESOURCES : --shared-resources-region=SHARED_RESOURCES_REGION] @@ -136,6 +136,11 @@ OPTIONAL FLAGS not specified, the container runs as a service account that doesn't have access to the resource project. + --tpu-topology=TPU_TOPOLOGY + CloudTPU topology to use for this deployment. Required for multihost + CloudTPU deployments: + https://cloud.google.com/kubernetes-engine/docs/concepts/tpus#topology. + --traffic-split=[DEPLOYED_MODEL_ID=VALUE,...] List of pairs of deployed model id and value to set as traffic split. diff --git a/gcloud/beta/alloydb/clusters/create b/gcloud/beta/alloydb/clusters/create index 7ce9fff0d..41967f40c 100644 --- a/gcloud/beta/alloydb/clusters/create +++ b/gcloud/beta/alloydb/clusters/create @@ -19,6 +19,8 @@ SYNOPSIS : --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT] --automated-backup-retention-count=RETENTION_COUNT | --automated-backup-retention-period=RETENTION_PERIOD]] [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] + [--maintenance-window-day=MAINTENANCE_WINDOW_DAY + --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -254,6 +256,22 @@ OPTIONAL FLAGS ▸ provide the argument --kms-project on the command line; ▸ set the property core/project. + Specify preferred day and time for maintenance. + + --maintenance-window-day=MAINTENANCE_WINDOW_DAY + Day of week for maintenance window, in UTC time zone. + MAINTENANCE_WINDOW_DAY must be one of: MONDAY, TUESDAY, WEDNESDAY, + THURSDAY, FRIDAY, SATURDAY, SUNDAY. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR + Hour of day for maintenance window, in UTC time zone. + + This flag argument must be specified if any of the other arguments in + this group are specified. + 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/alloydb/clusters/create-secondary b/gcloud/beta/alloydb/clusters/create-secondary index 4e9f6fa66..0bd4c2b82 100644 --- a/gcloud/beta/alloydb/clusters/create-secondary +++ b/gcloud/beta/alloydb/clusters/create-secondary @@ -6,6 +6,11 @@ SYNOPSIS gcloud beta alloydb clusters create-secondary CLUSTER --primary-cluster=PRIMARY_CLUSTER --region=REGION [--allocated-ip-range-name=ALLOCATED_IP_RANGE_NAME] [--async] + [--automated-backup-days-of-week=[DAYS_OF_WEEK,...] + --automated-backup-start-times=[START_TIMES,...] + --automated-backup-window=TIMEOUT_PERIOD --enable-automated-backup + [--automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY + : --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT] --automated-backup-retention-count=RETENTION_COUNT | --automated-backup-retention-period=RETENTION_PERIOD] [--continuous-backup-recovery-window-days=RECOVERY_PERIOD --enable-continuous-backup [--continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY @@ -50,6 +55,88 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. + Automated backup policy. If unspecified, automated backups are copied from + the associated primary cluster. + + --automated-backup-days-of-week=[DAYS_OF_WEEK,...] + Comma-separated list of days of the week to perform a backup. At + least one day of the week must be provided. (e.g., + --automated-backup-days-of-week=MONDAY,WEDNESDAY,SUNDAY). + DAYS_OF_WEEK must be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, + FRIDAY, SATURDAY, SUNDAY. + + --automated-backup-start-times=[START_TIMES,...] + Comma-separated list of times during the day to start a backup. At + least one start time must be provided. The start times are assumed to + be in UTC and required to be an exact hour in the format HH:00. + (e.g., --automated-backup-start-times=01:00,13:00) + + --automated-backup-window=TIMEOUT_PERIOD + The length of the time window beginning at start time during which a + backup can be taken. If a backup does not succeed within this time + window, it will be canceled and considered failed. The backup window + must be at least 5 minutes long. There is no upper bound on the + window. If not set, it will default to 1 hour. + + --enable-automated-backup + Enables Automated Backups on the cluster. + + Key resource - The Cloud KMS (Key Management Service) cryptokey that + will be used to protect the automated backups. The 'AlloyDB 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. + + --automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY + ID of the key or fully qualified identifier for the key. + + To set the kms-key attribute: + ▫ provide the argument --automated-backup-encryption-key on the + command line. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING + The KMS keyring of the key. + + To set the kms-keyring attribute: + ▫ provide the argument --automated-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --automated-backup-encryption-key-keyring + on the command line. + + --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION + The Google Cloud location for the key. + + To set the kms-location attribute: + ▫ provide the argument --automated-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --automated-backup-encryption-key-location + on the command line. + + --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT + The Google Cloud project for the key. + + To set the kms-project attribute: + ▫ provide the argument --automated-backup-encryption-key on the + command line with a fully specified name; + ▫ provide the argument --automated-backup-encryption-key-project + on the command line; + ▫ set the property core/project. + + Retention policy. If no retention policy is provided, all automated + backups will be retained. + + At most one of these can be specified: + + --automated-backup-retention-count=RETENTION_COUNT + Number of most recent successful backups retained. + + --automated-backup-retention-period=RETENTION_PERIOD + Retention period of the backup relative to creation time. See $ + gcloud topic datetimes for information on duration formats. + Continuous Backup configuration. If unspecified, continuous backups are copied from the associated primary cluster. diff --git a/gcloud/beta/alloydb/clusters/update b/gcloud/beta/alloydb/clusters/update index 0ecdab708..21c24ec9c 100644 --- a/gcloud/beta/alloydb/clusters/update +++ b/gcloud/beta/alloydb/clusters/update @@ -13,6 +13,9 @@ SYNOPSIS [--continuous-backup-recovery-window-days=RECOVERY_PERIOD --enable-continuous-backup --clear-continuous-backup-encryption-key | [--continuous-backup-encryption-key=CONTINUOUS_BACKUP_ENCRYPTION_KEY : --continuous-backup-encryption-key-keyring=CONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING --continuous-backup-encryption-key-location=CONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION --continuous-backup-encryption-key-project=CONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT]] + [--maintenance-window-any + | --maintenance-window-day=MAINTENANCE_WINDOW_DAY + --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -191,6 +194,29 @@ OPTIONAL FLAGS --continuous-backup-encryption-key-project on the command line; ◇ set the property core/project. + Configure a preferred maintenance window. + + At most one of these can be specified: + + --maintenance-window-any + Remove the user-specified maintenance window. + + Specify preferred day and time for maintenance. + + --maintenance-window-day=MAINTENANCE_WINDOW_DAY + Day of week for maintenance window, in UTC time zone. + MAINTENANCE_WINDOW_DAY must be one of: MONDAY, TUESDAY, WEDNESDAY, + THURSDAY, FRIDAY, SATURDAY, SUNDAY. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR + Hour of day for maintenance window, in UTC time zone. + + This flag argument must be specified if any of the other arguments + in this group are specified. + 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/artifacts/generic/download b/gcloud/beta/artifacts/generic/download new file mode 100644 index 000000000..e07f9f8a7 --- /dev/null +++ b/gcloud/beta/artifacts/generic/download @@ -0,0 +1,90 @@ +NAME + gcloud beta artifacts generic download - download a generic artifact from a + generic artifact repository + +SYNOPSIS + gcloud beta artifacts generic download --destination=DESTINATION + --package=ARTIFACT --version=VERSION [--name=NAME] + [--location=LOCATION --repository=REPOSITORY] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Download a generic artifact from a generic artifact repository. + +EXAMPLES + To download version v0.1.0 of myfile.txt located in a repository in + "us-central1" to /path/to/destination/: + + $ gcloud beta artifacts generic download --location=us-central1 \ + --project=myproject --repository=myrepo --package=mypackage \ + --version=v0.1.0 --destination=/path/to/destination/ \ + --name=myfile.txt + + To download all files of version v0.1.0 and package mypackage located in a + repository in "us-central1" to /path/to/destination/ while maintaining the + folder hierarchy: + + $ gcloud beta artifacts generic download --location=us-central1 \ + --project=myproject --repository=myrepo --package=mypackage \ + --version=v0.1.0 --destination=/path/to/destination/ + +REQUIRED FLAGS + --destination=DESTINATION + The path where you want to save the downloaded file. + + --package=ARTIFACT + The artifact to download. + + --version=VERSION + The version of the artifact to download. + +OPTIONAL FLAGS + --name=NAME + If specified, the file name within the artifact to download. + + Repository resource - The Artifact Registry repository. If not specified, + the current artifacts/repository is used. 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 --repository on the command line with a fully + specified name; + ◆ set the property artifacts/repository with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + Location of the repository. + + To set the location attribute: + ▸ provide the argument --repository on the command line with a + fully specified name; + ▸ set the property artifacts/repository with a fully specified + name; + ▸ provide the argument --location on the command line; + ▸ set the property artifacts/location. + + --repository=REPOSITORY + ID of the repository or fully qualified identifier for the + repository. + + To set the repository attribute: + ▸ provide the argument --repository on the command line; + ▸ set the property artifacts/repository. + +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 artifacts generic download + + $ gcloud alpha artifacts generic download + diff --git a/gcloud/beta/artifacts/generic/help b/gcloud/beta/artifacts/generic/help new file mode 100644 index 000000000..bce80401e --- /dev/null +++ b/gcloud/beta/artifacts/generic/help @@ -0,0 +1,31 @@ +NAME + gcloud beta artifacts generic - manage Artifact Registry generic artifacts + +SYNOPSIS + gcloud beta artifacts generic COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Manage Artifact Registry generic artifacts. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + download + (BETA) Download a generic artifact from a generic artifact repository. + + upload + (BETA) Uploads an artifact to a generic repository. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud artifacts generic + + $ gcloud alpha artifacts generic + diff --git a/gcloud/beta/artifacts/generic/upload b/gcloud/beta/artifacts/generic/upload new file mode 100644 index 000000000..4367ea1f2 --- /dev/null +++ b/gcloud/beta/artifacts/generic/upload @@ -0,0 +1,105 @@ +NAME + gcloud beta artifacts generic upload - uploads an artifact to a generic + repository + +SYNOPSIS + gcloud beta artifacts generic upload --package=PACKAGE --version=VERSION + (--source=SOURCE | --source-directory=SOURCE_DIRECTORY) [--async] + [--destination-path=DESTINATION_PATH] [--skip-existing] + [--location=LOCATION --repository=REPOSITORY] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Uploads an artifact to a generic repository. + +EXAMPLES + To upload version v0.1.0 of a generic artifact located in /path/to/file/ to + a repository in "us-central1": + + $ gcloud beta artifacts generic upload --location=us-central1 \ + --project=myproject --repository=myrepo --package=mypackage \ + --version=v0.1.0 --source=/path/to/file/ + + To upload version v0.1.0 of a generic artifact located in /path/to/file/ to + a repository in "us-central1" within a folder structure: + + $ gcloud beta artifacts generic upload --location=us-central1 \ + --project=myproject --repository=myrepo --package=mypackage \ + --version=v0.1.0 --source=/path/to/file/ \ + --destination-path=folder/file + +REQUIRED FLAGS + --package=PACKAGE + The package to upload. + + --version=VERSION + The version of the package. You cannot overwrite an existing version in + the repository. + + Exactly one of these must be specified: + + --source=SOURCE + The path to the file you are uploading. + + --source-directory=SOURCE_DIRECTORY + The directory you are uploading. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --destination-path=DESTINATION_PATH + Use to specify the path to upload a generic artifact to within a folder + structure. + + --skip-existing + If specified, skip uploading files that already exist in the + repository, and continue to upload the remaining files. + + Repository resource - The Artifact Registry repository. If not specified, + the current artifacts/repository is used. 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 --repository on the command line with a fully + specified name; + ◆ set the property artifacts/repository with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + Location of the repository. + + To set the location attribute: + ▸ provide the argument --repository on the command line with a + fully specified name; + ▸ set the property artifacts/repository with a fully specified + name; + ▸ provide the argument --location on the command line; + ▸ set the property artifacts/location. + + --repository=REPOSITORY + ID of the repository or fully qualified identifier for the + repository. + + To set the repository attribute: + ▸ provide the argument --repository on the command line; + ▸ set the property artifacts/repository. + +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 artifacts generic upload + + $ gcloud alpha artifacts generic upload + diff --git a/gcloud/beta/artifacts/help b/gcloud/beta/artifacts/help index 12f42a589..336afe1ce 100644 --- a/gcloud/beta/artifacts/help +++ b/gcloud/beta/artifacts/help @@ -24,6 +24,9 @@ GROUPS files (BETA) Manage Artifact Registry files. + generic + (BETA) Manage Artifact Registry generic artifacts. + go (BETA) Manage Artifact Registry Go modules. diff --git a/gcloud/beta/compute/backend-buckets/add-iam-policy-binding b/gcloud/beta/compute/backend-buckets/add-iam-policy-binding index bb2fedfe4..c93c0a4c8 100644 --- a/gcloud/beta/compute/backend-buckets/add-iam-policy-binding +++ b/gcloud/beta/compute/backend-buckets/add-iam-policy-binding @@ -75,8 +75,10 @@ API REFERENCE can be found at: https://cloud.google.com/compute/ NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute backend-buckets add-iam-policy-binding $ gcloud alpha compute backend-buckets add-iam-policy-binding diff --git a/gcloud/beta/compute/backend-buckets/get-iam-policy b/gcloud/beta/compute/backend-buckets/get-iam-policy index e61009af8..9ec82347b 100644 --- a/gcloud/beta/compute/backend-buckets/get-iam-policy +++ b/gcloud/beta/compute/backend-buckets/get-iam-policy @@ -80,8 +80,10 @@ API REFERENCE can be found at: https://cloud.google.com/compute/ NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute backend-buckets get-iam-policy $ gcloud alpha compute backend-buckets get-iam-policy diff --git a/gcloud/beta/compute/backend-buckets/remove-iam-policy-binding b/gcloud/beta/compute/backend-buckets/remove-iam-policy-binding index 2dd01e88d..8b0bf1d8d 100644 --- a/gcloud/beta/compute/backend-buckets/remove-iam-policy-binding +++ b/gcloud/beta/compute/backend-buckets/remove-iam-policy-binding @@ -76,8 +76,10 @@ API REFERENCE can be found at: https://cloud.google.com/compute/ NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute backend-buckets remove-iam-policy-binding $ gcloud alpha compute backend-buckets remove-iam-policy-binding diff --git a/gcloud/beta/compute/backend-buckets/set-iam-policy b/gcloud/beta/compute/backend-buckets/set-iam-policy index bcf771220..3ece463cf 100644 --- a/gcloud/beta/compute/backend-buckets/set-iam-policy +++ b/gcloud/beta/compute/backend-buckets/set-iam-policy @@ -61,8 +61,10 @@ API REFERENCE can be found at: https://cloud.google.com/compute/ NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute backend-buckets set-iam-policy $ gcloud alpha compute backend-buckets set-iam-policy diff --git a/gcloud/beta/compute/instance-templates/create b/gcloud/beta/compute/instance-templates/create index ecbb46c77..77fc7c0a1 100644 --- a/gcloud/beta/compute/instance-templates/create +++ b/gcloud/beta/compute/instance-templates/create @@ -38,6 +38,8 @@ SYNOPSIS [--network=NETWORK] [--network-interface=[PROPERTY=VALUE,...]] [--network-performance-configs=[PROPERTY=VALUE,...]] [--network-tier=NETWORK_TIER] + [--partner-metadata=[NAMESPACE/KEY=VALUE,...]] + [--partner-metadata-from-file=LOCAL_FILE_PATH] [--post-key-revocation-action-type=POLICY] [--preemptible] [--private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE] [--private-network-ip=PRIVATE_NETWORK_IP] @@ -338,18 +340,17 @@ FLAGS Specifies a textual description for the instance template. --discard-local-ssds-at-termination-timestamp=DISCARD_LOCAL_SSDS_AT_TERMINATION_TIMESTAMP - Required and only allowed for VMs that have one or more local SSDs, use - --termination-action=STOP (default), and use either --max-run-duration - or --termination-time. This flag indicates whether you want Compute - Engine to discard (true) or preserve (false) local SSD data when the - VM's terminationTimestamp is reached. + Required to be set to true and only allowed for VMs that have one or + more local SSDs, use --instance-termination-action=STOP, and use either + --max-run-duration or --termination-time. - If set to false, Compute Engine will preserve local SSD data by - including the --discard-local-ssd=false flag in the automatic - termination command. The --discard-local-ssd=false flag preserves local - SSD data by migrating it to persistent storage until you rerun the VM. - Importantly, preserving local SSD data incurs costs and is subject to - restrictions. For more information, see + This flag indicates the value that you want Compute Engine to use for + the --discard-local-ssd flag in the automatic gcloud compute instances + stop command. This flag only supports the true value, which discards + local SSD data when automatically stopping this VM during its + terminationTimestamp. + + For more information about the --discard-local-ssd flag, see https://cloud.google.com/compute/docs/disks/local-ssd#stop_instance. --disk=[auto-delete=AUTO-DELETE],[boot=BOOT],[device-name=DEVICE-NAME],[mode=MODE],[name=NAME] @@ -415,15 +416,16 @@ FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM preemption - (--provisioning-model=SPOT or --preemptible) or automatic instance - termination (--max-run-duration or --termination-time). + (--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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. --internal-ipv6-address=INTERNAL_IPV6_ADDRESS Assigns the given internal IPv6 address or range to the instance that @@ -517,7 +519,7 @@ FLAGS --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration - relative to the VM instance's most-recent start time. Format the + relative to the last time when the VM began running. Format the duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and seconds followed by d, h, m, and s respectively. For example, specify 30m for a duration of 30 minutes or specify 1d2h3m4s for a duration of @@ -527,13 +529,15 @@ FLAGS If neither --max-run-duration nor --termination-time is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --max-run-duration, the VM instance - is automatically terminated when the VM's current runtime reaches - MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or - suspended, --max-run-duration and (unless the VM uses - --provisioning-model=SPOT) --instance-termination-action are - automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped or + suspended and redefined whenever the VM is rerun. For + --max-run-duration specifically, the terminationTimestamp is the sum of + MAX_RUN_DURATION and the time when the VM last entered the RUNNING + state, which changes whenever the VM is rerun. --mesh=[gke-cluster=GKE-CLUSTER],[workload=WORKLOAD] Controls whether the Anthos Service Mesh service proxy (Envoy) and @@ -709,6 +713,13 @@ FLAGS NETWORK_TIER must be one of: PREMIUM, STANDARD, FIXED_STANDARD. The default value is PREMIUM. + --partner-metadata=[NAMESPACE/KEY=VALUE,...] + Partner metadata specifying namespace and its entries. The entries can + be key-value pairs or in json format. + + --partner-metadata-from-file=LOCAL_FILE_PATH + Path to a local json file containing partner metadata. + --post-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 noop. POLICY must be one of: @@ -861,12 +872,15 @@ FLAGS If neither --termination-time nor --max-run-duration is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --termination-time, the VM instance - is automatically terminated at the specified timestamp. Note: Anytime - the VM instance is stopped or suspended, --termination-time and (unless - the VM uses --provisioning-model=SPOT) --instance-termination-action - are automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped or + suspended and redefined whenever the VM is rerun. For + --termination-time specifically, the terminationTimestamp remains the + same whenever the VM is rerun, but any requests to rerun the VM fail if + the specified timestamp is in the past. --threads-per-core=THREADS_PER_CORE The number of visible threads per physical core. To disable diff --git a/gcloud/beta/compute/instance-templates/describe b/gcloud/beta/compute/instance-templates/describe index 135c254e5..6ea060df0 100644 --- a/gcloud/beta/compute/instance-templates/describe +++ b/gcloud/beta/compute/instance-templates/describe @@ -3,7 +3,7 @@ NAME machine instance template SYNOPSIS - gcloud beta compute instance-templates describe NAME + gcloud beta compute instance-templates describe NAME [--view=VIEW] [--global | --region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -20,6 +20,17 @@ POSITIONAL ARGUMENTS Name of the instance template to describe. FLAGS + --view=VIEW + Specifies the information that the output should contain. VIEW must be + one of: + + BASIC + Default output view. Output contains all configuration details of + the instance template, except partner metadata. + FULL + Output contains all configuration details of the instance template, + including partner metadata. + At most one of these can be specified: --global diff --git a/gcloud/beta/compute/instance-templates/list b/gcloud/beta/compute/instance-templates/list index 172f0823e..26f06fcf7 100644 --- a/gcloud/beta/compute/instance-templates/list +++ b/gcloud/beta/compute/instance-templates/list @@ -4,14 +4,19 @@ NAME SYNOPSIS gcloud beta compute instance-templates list [NAME ...] - [--regexp=REGEXP, -r REGEXP] [--global | --regions=[REGION,...]] - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + [--regexp=REGEXP, -r REGEXP] [--view=VIEW] + [--global | --regions=[REGION,...]] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) gcloud beta compute instance-templates list displays all Google Compute Engine instance templates in a project. + By default, global instance templates and instance templates from all + regions are listed. The results can be narrowed down by providing the + --global or --regions flag. + EXAMPLES To list all instance templates in a project in table form, run: @@ -21,6 +26,16 @@ EXAMPLES $ gcloud beta compute instance-templates list --uri + To list all global instance templates in a project, run: + + $ gcloud beta compute instance-templates list --global + + To list all instance templates in the us-central1 and europe-west1 regions, + given they are regional resources, run: + + $ gcloud beta compute instance-templates list \ + --filter="region:( europe-west1 us-central1 )" + POSITIONAL ARGUMENTS [NAME ...] (DEPRECATED) If provided, show details for the specified names and/or @@ -37,6 +52,17 @@ FLAGS Flag --regexp is deprecated. Use --filter="name~'REGEXP'" instead. + --view=VIEW + Specifies the information that the output should contain. VIEW must be + one of: + + BASIC + Default output view. Output contains all configuration details of + the instance template, except partner metadata. + FULL + Output contains all configuration details of the instance template, + including partner metadata. + At most one of these can be specified: --global diff --git a/gcloud/beta/compute/instances/add-partner-metadata b/gcloud/beta/compute/instances/add-partner-metadata new file mode 100644 index 000000000..4b64a8beb --- /dev/null +++ b/gcloud/beta/compute/instances/add-partner-metadata @@ -0,0 +1,94 @@ +NAME + gcloud beta compute instances add-partner-metadata - add or update partner + metadata + +SYNOPSIS + gcloud beta compute instances add-partner-metadata INSTANCE_NAME + [--partner-metadata=[NAMESPACE/KEY=VALUE,...]] + [--partner-metadata-from-file=LOCAL_FILE_PATH] [--zone=ZONE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) gcloud beta compute instances add-partner-metadata can be used to + add or update or patch partner metadata of a virtual machine instance. + Every instance has access to a metadata server that can be used to query + partner metadata that has been set through this tool. For information on + metadata, see About VM metadata + (https://cloud.google.com/compute/docs/metadata/overview). + + Only namespaces keys that are provided are mutated. Existing Namespaces + entries will remain unaffected. + + In order to retrieve partner metadata, run: + + $ gcloud compute instances describe example-instance --zone + us-central1-a --view=FULL --format="value(partnerMetadata)" + + where example-instance is the name of the virtual machine instance you're + querying partner metadata from. + +EXAMPLES + To add partner metadata under namespace test.compute.googleapis.com to + instance TEST_INSTANCE run: + + $ gcloud beta compute instances add-partner-metadata TEST_INSTANCE \ + --partner-metadata=test.compute.googleapis.com/entries="{ \ + "engine": { "type": V8 } }" + + To add partner metadata from a file: + + $ gcloud beta compute instances add-partner-metadata TEST_INSTANCE \ + --partner-metadata-from-file=examples/engine.json + +POSITIONAL ARGUMENTS + INSTANCE_NAME + Name of the instance to set partner metadata on. For details on valid + instance names, refer to the criteria documented under the field 'name' + at: https://cloud.google.com/compute/docs/reference/rest/v1/instances + +FLAGS + --partner-metadata=[NAMESPACE/KEY=VALUE,...] + Partner metadata specifying namespace and its entries. The entries can + be key-value pairs or in json format. + + --partner-metadata-from-file=LOCAL_FILE_PATH + Path to a local json file containing partner metadata. + + --zone=ZONE + Zone of the instance to set partner metadata on. If not specified, you + might be prompted to select a zone (interactive mode only). gcloud + attempts to identify the appropriate zone by searching for resources in + your currently active project. If the zone cannot be determined, gcloud + prompts you for a selection with all available Google Cloud Platform + zones. + + To avoid prompting when this flag is omitted, the user 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. This + variant is also available: + + $ gcloud alpha compute instances add-partner-metadata + diff --git a/gcloud/beta/compute/instances/bulk/create b/gcloud/beta/compute/instances/bulk/create index f0db9d215..97a4f231b 100644 --- a/gcloud/beta/compute/instances/bulk/create +++ b/gcloud/beta/compute/instances/bulk/create @@ -379,18 +379,17 @@ OPTIONAL FLAGS Specifies a textual description of the instances. --discard-local-ssds-at-termination-timestamp=DISCARD_LOCAL_SSDS_AT_TERMINATION_TIMESTAMP - Required and only allowed for VMs that have one or more local SSDs, use - --termination-action=STOP (default), and use either --max-run-duration - or --termination-time. This flag indicates whether you want Compute - Engine to discard (true) or preserve (false) local SSD data when the - VM's terminationTimestamp is reached. + Required to be set to true and only allowed for VMs that have one or + more local SSDs, use --instance-termination-action=STOP, and use either + --max-run-duration or --termination-time. - If set to false, Compute Engine will preserve local SSD data by - including the --discard-local-ssd=false flag in the automatic - termination command. The --discard-local-ssd=false flag preserves local - SSD data by migrating it to persistent storage until you rerun the VM. - Importantly, preserving local SSD data incurs costs and is subject to - restrictions. For more information, see + This flag indicates the value that you want Compute Engine to use for + the --discard-local-ssd flag in the automatic gcloud compute instances + stop command. This flag only supports the true value, which discards + local SSD data when automatically stopping this VM during its + terminationTimestamp. + + For more information about the --discard-local-ssd flag, see https://cloud.google.com/compute/docs/disks/local-ssd#stop_instance. --disk=[boot=BOOT],[device-name=DEVICE-NAME],[name=NAME],[scope=SCOPE] @@ -441,15 +440,16 @@ OPTIONAL FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM preemption - (--provisioning-model=SPOT or --preemptible) or automatic instance - termination (--max-run-duration or --termination-time). + (--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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. @@ -516,7 +516,7 @@ OPTIONAL FLAGS --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration - relative to the VM instance's most-recent start time. Format the + relative to the last time when the VM began running. Format the duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and seconds followed by d, h, m, and s respectively. For example, specify 30m for a duration of 30 minutes or specify 1d2h3m4s for a duration of @@ -526,13 +526,15 @@ OPTIONAL FLAGS If neither --max-run-duration nor --termination-time is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --max-run-duration, the VM instance - is automatically terminated when the VM's current runtime reaches - MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or - suspended, --max-run-duration and (unless the VM uses - --provisioning-model=SPOT) --instance-termination-action are - automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped or + suspended and redefined whenever the VM is rerun. For + --max-run-duration specifically, the terminationTimestamp is the sum of + MAX_RUN_DURATION and the time when the VM last entered the RUNNING + state, which changes whenever the VM is rerun. --metadata=KEY=VALUE,[KEY=VALUE,...] Metadata to be made available to the guest operating system running on @@ -794,12 +796,15 @@ OPTIONAL FLAGS If neither --termination-time nor --max-run-duration is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --termination-time, the VM instance - is automatically terminated at the specified timestamp. Note: Anytime - the VM instance is stopped or suspended, --termination-time and (unless - the VM uses --provisioning-model=SPOT) --instance-termination-action - are automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped or + suspended and redefined whenever the VM is rerun. For + --termination-time specifically, the terminationTimestamp remains the + same whenever the VM is rerun, but any requests to rerun the VM fail if + the specified timestamp is in the past. --threads-per-core=THREADS_PER_CORE The number of visible threads per physical core. To disable diff --git a/gcloud/beta/compute/instances/create b/gcloud/beta/compute/instances/create index bcca1d1d5..2166099f1 100644 --- a/gcloud/beta/compute/instances/create +++ b/gcloud/beta/compute/instances/create @@ -39,6 +39,8 @@ SYNOPSIS [--network=NETWORK] [--network-interface=[PROPERTY=VALUE,...]] [--network-performance-configs=[PROPERTY=VALUE,...]] [--network-tier=NETWORK_TIER] [--node-project=NODE_PROJECT] + [--partner-metadata=[NAMESPACE/KEY=VALUE,...]] + [--partner-metadata-from-file=LOCAL_FILE_PATH] [--post-key-revocation-action-type=POLICY] [--preemptible] [--private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE] [--private-network-ip=PRIVATE_NETWORK_IP] @@ -384,18 +386,17 @@ FLAGS Specifies a textual description of the instances. --discard-local-ssds-at-termination-timestamp=DISCARD_LOCAL_SSDS_AT_TERMINATION_TIMESTAMP - Required and only allowed for VMs that have one or more local SSDs, use - --termination-action=STOP (default), and use either --max-run-duration - or --termination-time. This flag indicates whether you want Compute - Engine to discard (true) or preserve (false) local SSD data when the - VM's terminationTimestamp is reached. + Required to be set to true and only allowed for VMs that have one or + more local SSDs, use --instance-termination-action=STOP, and use either + --max-run-duration or --termination-time. - If set to false, Compute Engine will preserve local SSD data by - including the --discard-local-ssd=false flag in the automatic - termination command. The --discard-local-ssd=false flag preserves local - SSD data by migrating it to persistent storage until you rerun the VM. - Importantly, preserving local SSD data incurs costs and is subject to - restrictions. For more information, see + This flag indicates the value that you want Compute Engine to use for + the --discard-local-ssd flag in the automatic gcloud compute instances + stop command. This flag only supports the true value, which discards + local SSD data when automatically stopping this VM during its + terminationTimestamp. + + For more information about the --discard-local-ssd flag, see https://cloud.google.com/compute/docs/disks/local-ssd#stop_instance. --disk=[auto-delete=AUTO-DELETE],[boot=BOOT],[device-name=DEVICE-NAME],[force-attach=FORCE-ATTACH],[mode=MODE],[name=NAME],[scope=SCOPE] @@ -483,15 +484,16 @@ FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM preemption - (--provisioning-model=SPOT or --preemptible) or automatic instance - termination (--max-run-duration or --termination-time). + (--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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. --internal-ipv6-address=INTERNAL_IPV6_ADDRESS Assigns the given internal IPv6 address or range to the instance that @@ -584,7 +586,7 @@ FLAGS --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration - relative to the VM instance's most-recent start time. Format the + relative to the last time when the VM began running. Format the duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and seconds followed by d, h, m, and s respectively. For example, specify 30m for a duration of 30 minutes or specify 1d2h3m4s for a duration of @@ -594,13 +596,15 @@ FLAGS If neither --max-run-duration nor --termination-time is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --max-run-duration, the VM instance - is automatically terminated when the VM's current runtime reaches - MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or - suspended, --max-run-duration and (unless the VM uses - --provisioning-model=SPOT) --instance-termination-action are - automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped or + suspended and redefined whenever the VM is rerun. For + --max-run-duration specifically, the terminationTimestamp is the sum of + MAX_RUN_DURATION and the time when the VM last entered the RUNNING + state, which changes whenever the VM is rerun. --metadata=KEY=VALUE,[KEY=VALUE,...] Metadata to be made available to the guest operating system running on @@ -770,6 +774,13 @@ FLAGS The name of the project with shared sole tenant node groups to create an instance in. + --partner-metadata=[NAMESPACE/KEY=VALUE,...] + Partner metadata specifying namespace and its entries. The entries can + be key-value pairs or in json format. + + --partner-metadata-from-file=LOCAL_FILE_PATH + Path to a local json file containing partner metadata. + --post-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 noop. POLICY must be one of: @@ -918,12 +929,15 @@ FLAGS If neither --termination-time nor --max-run-duration is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --termination-time, the VM instance - is automatically terminated at the specified timestamp. Note: Anytime - the VM instance is stopped or suspended, --termination-time and (unless - the VM uses --provisioning-model=SPOT) --instance-termination-action - are automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped or + suspended and redefined whenever the VM is rerun. For + --termination-time specifically, the terminationTimestamp remains the + same whenever the VM is rerun, but any requests to rerun the VM fail if + the specified timestamp is in the past. --threads-per-core=THREADS_PER_CORE The number of visible threads per physical core. To disable diff --git a/gcloud/beta/compute/instances/create-with-container b/gcloud/beta/compute/instances/create-with-container index f4da4e4bc..8d493d0dd 100644 --- a/gcloud/beta/compute/instances/create-with-container +++ b/gcloud/beta/compute/instances/create-with-container @@ -445,15 +445,16 @@ FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM preemption - (--provisioning-model=SPOT or --preemptible) or automatic instance - termination (--max-run-duration or --termination-time). + (--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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. diff --git a/gcloud/beta/compute/instances/describe b/gcloud/beta/compute/instances/describe index cc3f87119..6a89ea144 100644 --- a/gcloud/beta/compute/instances/describe +++ b/gcloud/beta/compute/instances/describe @@ -3,8 +3,8 @@ NAME instance SYNOPSIS - gcloud beta compute instances describe INSTANCE_NAME [--zone=ZONE] - [GCLOUD_WIDE_FLAG ...] + gcloud beta compute instances describe INSTANCE_NAME [--view=VIEW] + [--zone=ZONE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) gcloud beta compute instances describe displays all data associated @@ -32,6 +32,17 @@ POSITIONAL ARGUMENTS https://cloud.google.com/compute/docs/reference/rest/v1/instances FLAGS + --view=VIEW + Specifies the information that the output should contain. VIEW must be + one of: + + BASIC + Default output view. Output contains all configuration details of + the instance, except partner metadata. + FULL + Output contains all configuration details of the instance, + including partner metadata. + --zone=ZONE Zone of the instance to describe. If not specified, you might be prompted to select a zone (interactive mode only). gcloud attempts to diff --git a/gcloud/beta/compute/instances/help b/gcloud/beta/compute/instances/help index 55b31bfa7..def998a3a 100644 --- a/gcloud/beta/compute/instances/help +++ b/gcloud/beta/compute/instances/help @@ -53,6 +53,9 @@ COMMANDS add-metadata (BETA) Add or update instance metadata. + add-partner-metadata + (BETA) Add or update partner metadata. + add-resource-policies (BETA) Add resource policies to Compute Engine VM instances. @@ -113,6 +116,9 @@ COMMANDS (BETA) Move an instance and its attached persistent disks between zones. + patch-partner-metadata + (BETA) Patch partner metadata. + perform-maintenance (BETA) Perform maintenance of Google Compute Engine instance. @@ -126,6 +132,9 @@ COMMANDS remove-metadata (BETA) Remove instance metadata. + remove-partner-metadata + (BETA) Remove partner metadata. + remove-resource-policies (BETA) Remove resource policies from Compute Engine VM instances. diff --git a/gcloud/beta/compute/instances/list b/gcloud/beta/compute/instances/list index 03bd6aadb..49a545236 100644 --- a/gcloud/beta/compute/instances/list +++ b/gcloud/beta/compute/instances/list @@ -3,8 +3,8 @@ NAME SYNOPSIS gcloud beta compute instances list [NAME ...] [--regexp=REGEXP, -r REGEXP] - [--zones=ZONE,[ZONE,...]] [--filter=EXPRESSION] [--limit=LIMIT] - [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [--view=VIEW] [--zones=ZONE,[ZONE,...]] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -45,6 +45,17 @@ FLAGS Flag --regexp is deprecated. Use --filter="name~'REGEXP'" instead. + --view=VIEW + Specifies the information that the output should contain. VIEW must be + one of: + + BASIC + Default output view. Output contains all configuration details of + the instance, except partner metadata. + FULL + Output contains all configuration details of the instance, + including partner metadata. + --zones=ZONE,[ZONE,...] If provided, only resources from the given zones are queried. diff --git a/gcloud/beta/compute/instances/patch-partner-metadata b/gcloud/beta/compute/instances/patch-partner-metadata new file mode 100644 index 000000000..0c331a6a3 --- /dev/null +++ b/gcloud/beta/compute/instances/patch-partner-metadata @@ -0,0 +1,94 @@ +NAME + gcloud beta compute instances patch-partner-metadata - patch partner + metadata + +SYNOPSIS + gcloud beta compute instances patch-partner-metadata INSTANCE_NAME + [--partner-metadata=[NAMESPACE/KEY=VALUE,...]] + [--partner-metadata-from-file=LOCAL_FILE_PATH] [--zone=ZONE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) gcloud beta compute instances patch-partner-metadata can be used to + patch partner metadata of a virtual machine instance. Every instance has + access to a metadata server that can be used to query partner metadata that + has been set through this tool. For information on metadata, see About VM + metadata (https://cloud.google.com/compute/docs/metadata/overview). + + Only namespaces keys that are provided are mutated. Existing Namespaces + entries will remain unaffected. + + In order to retrieve partner metadata, run: + + $ gcloud compute instances describe example-instance --zone + us-central1-a --view=FULL --format="value(partnerMetadata)" + + where example-instance is the name of the virtual machine instance you're + querying partner metadata from. + +EXAMPLES + To add partner metadata under namespace test.compute.googleapis.com to + instance TEST_INSTANCE run: + + $ gcloud beta compute instances patch-partner-metadata \ + TEST_INSTANCE \ + --partner-metadata=test.compute.googleapis.com/entries/\ + engine="{ "engine": { "type": V8 } }" + + To add partner metadata from a file: + + $ gcloud beta compute instances patch-partner-metadata \ + TEST_INSTANCE --partner-metadata-from-file=examples/engine.json + +POSITIONAL ARGUMENTS + INSTANCE_NAME + Name of the instance to set partner metadata on. For details on valid + instance names, refer to the criteria documented under the field 'name' + at: https://cloud.google.com/compute/docs/reference/rest/v1/instances + +FLAGS + --partner-metadata=[NAMESPACE/KEY=VALUE,...] + Partner metadata specifying namespace and its entries. The entries can + be key-value pairs or in json format. + + --partner-metadata-from-file=LOCAL_FILE_PATH + Path to a local json file containing partner metadata. + + --zone=ZONE + Zone of the instance to set partner metadata on. If not specified, you + might be prompted to select a zone (interactive mode only). gcloud + attempts to identify the appropriate zone by searching for resources in + your currently active project. If the zone cannot be determined, gcloud + prompts you for a selection with all available Google Cloud Platform + zones. + + To avoid prompting when this flag is omitted, the user 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. This + variant is also available: + + $ gcloud alpha compute instances patch-partner-metadata + diff --git a/gcloud/beta/compute/instances/remove-partner-metadata b/gcloud/beta/compute/instances/remove-partner-metadata new file mode 100644 index 000000000..558a2bea8 --- /dev/null +++ b/gcloud/beta/compute/instances/remove-partner-metadata @@ -0,0 +1,80 @@ +NAME + gcloud beta compute instances remove-partner-metadata - remove partner + metadata + +SYNOPSIS + gcloud beta compute instances remove-partner-metadata INSTANCE_NAME + [--zone=ZONE] [--all | --keys=KEY,[KEY,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) gcloud beta compute instances remove-partner-metadata can be used to + remove a specific entry in a namespace, a specific namespace, or all + namespaces. + +EXAMPLES + To remove partner metadata specific entry in a namespace + test.compute.googleapis.com/entries/engine an instance named INSTANCE_NAME, + run: + + $ gcloud beta compute instances remove-partner-metadata \ + INSTANCE_NAME --keys=test.compute.googleapis.com/entries/engine + + To remove specific namespace with its data, run: $ gcloud beta compute instances remove-partner-metadata \ + INSTANCE_NAME --keys=test.compute.googleapis.com + + To remove all namespaces, run: $ gcloud beta compute instances remove-partner-metadata \ + INSTANCE_NAME --all + +POSITIONAL ARGUMENTS + INSTANCE_NAME + Name of the instance to set partner metadata on. For details on valid + instance names, refer to the criteria documented under the field 'name' + at: https://cloud.google.com/compute/docs/reference/rest/v1/instances + +FLAGS + --zone=ZONE + Zone of the instance to set partner metadata on. If not specified, you + might be prompted to select a zone (interactive mode only). gcloud + attempts to identify the appropriate zone by searching for resources in + your currently active project. If the zone cannot be determined, gcloud + prompts you for a selection with all available Google Cloud Platform + zones. + + To avoid prompting when this flag is omitted, the user 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. + + At most one of these can be specified: + + --all + If provided, all partner metadata namespaces are removed. + + --keys=KEY,[KEY,...] + The namespaces partner metadata to remove. + +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 compute instances remove-partner-metadata + diff --git a/gcloud/beta/compute/instances/set-scheduling b/gcloud/beta/compute/instances/set-scheduling index 20bf7a8de..dea01d68f 100644 --- a/gcloud/beta/compute/instances/set-scheduling +++ b/gcloud/beta/compute/instances/set-scheduling @@ -130,18 +130,17 @@ FLAGS the scheduling options. --discard-local-ssds-at-termination-timestamp=DISCARD_LOCAL_SSDS_AT_TERMINATION_TIMESTAMP - Required and only allowed for VMs that have one or more local SSDs, - use --termination-action=STOP (default), and use either - --max-run-duration or --termination-time. This flag indicates whether - you want Compute Engine to discard (true) or preserve (false) local - SSD data when the VM's terminationTimestamp is reached. + Required to be set to true and only allowed for VMs that have one or + more local SSDs, use --instance-termination-action=STOP, and use + either --max-run-duration or --termination-time. - If set to false, Compute Engine will preserve local SSD data by - including the --discard-local-ssd=false flag in the automatic - termination command. The --discard-local-ssd=false flag preserves - local SSD data by migrating it to persistent storage until you rerun - the VM. Importantly, preserving local SSD data incurs costs and is - subject to restrictions. For more information, see + This flag indicates the value that you want Compute Engine to use for + the --discard-local-ssd flag in the automatic gcloud compute + instances stop command. This flag only supports the true value, which + discards local SSD data when automatically stopping this VM during + its terminationTimestamp. + + For more information about the --discard-local-ssd flag, see https://cloud.google.com/compute/docs/disks/local-ssd#stop_instance. Instance Termination Action @@ -159,15 +158,16 @@ FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM - preemption (--provisioning-model=SPOT or --preemptible) or automatic - instance termination (--max-run-duration or --termination-time). + 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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. Max Run Duration @@ -178,7 +178,7 @@ FLAGS --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration - relative to the VM instance's most-recent start time. Format the + relative to the last time when the VM began running. Format the duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and seconds followed by d, h, m, and s respectively. For example, specify 30m for a duration of 30 minutes or specify 1d2h3m4s for a @@ -188,13 +188,15 @@ FLAGS If neither --max-run-duration nor --termination-time is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --max-run-duration, the VM - instance is automatically terminated when the VM's current runtime - reaches MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or - suspended, --max-run-duration and (unless the VM uses - --provisioning-model=SPOT) --instance-termination-action are - automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped + or suspended and redefined whenever the VM is rerun. For + --max-run-duration specifically, the terminationTimestamp is the sum + of MAX_RUN_DURATION and the time when the VM last entered the RUNNING + state, which changes whenever the VM is rerun. Sole Tenancy. @@ -248,12 +250,15 @@ FLAGS If neither --termination-time nor --max-run-duration is specified (default), the VM instance runs until prompted by a user action or system event. If either is specified, the VM instance is scheduled to - be automatically terminated using the action specified by - --instance-termination-action. For --termination-time, the VM - instance is automatically terminated at the specified timestamp. - Note: Anytime the VM instance is stopped or suspended, - --termination-time and (unless the VM uses --provisioning-model=SPOT) - --instance-termination-action are automatically removed from the VM. + be automatically terminated at the VM's termination timestamp + (terminationTimestamp) using the action specified by + --instance-termination-action. + + Note: The terminationTimestamp is removed whenever the VM is stopped + or suspended and redefined whenever the VM is rerun. For + --termination-time specifically, the terminationTimestamp remains the + same whenever the VM is rerun, but any requests to rerun the VM fail + if the specified timestamp is in the past. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/compute/instances/update b/gcloud/beta/compute/instances/update index 4961b642a..fa869fbcf 100644 --- a/gcloud/beta/compute/instances/update +++ b/gcloud/beta/compute/instances/update @@ -5,7 +5,10 @@ NAME SYNOPSIS gcloud beta compute instances update INSTANCE_NAME [--[no-]deletion-protection] [--[no-]enable-display-device] - [--min-cpu-platform=PLATFORM] [--[no-]shielded-integrity-monitoring] + [--min-cpu-platform=PLATFORM] + [--partner-metadata=[NAMESPACE/KEY=VALUE,...]] + [--partner-metadata-from-file=LOCAL_FILE_PATH] + [--[no-]shielded-integrity-monitoring] [--shielded-learn-integrity-policy] [--[no-]shielded-secure-boot] [--[no-]shielded-vtpm] [--update-labels=[KEY=VALUE,...]] [--zone=ZONE] [--clear-labels | --remove-labels=[KEY,...]] @@ -67,6 +70,13 @@ FLAGS You can find more information on-line: https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform + --partner-metadata=[NAMESPACE/KEY=VALUE,...] + Partner metadata specifying namespace and its entries. The entries can + be key-value pairs or in json format. + + --partner-metadata-from-file=LOCAL_FILE_PATH + Path to a local json file containing partner metadata. + --[no-]shielded-integrity-monitoring Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy diff --git a/gcloud/beta/compute/interconnects/attachments/dedicated/create b/gcloud/beta/compute/interconnects/attachments/dedicated/create index 4e6c804bb..9c6a81216 100644 --- a/gcloud/beta/compute/interconnects/attachments/dedicated/create +++ b/gcloud/beta/compute/interconnects/attachments/dedicated/create @@ -74,10 +74,10 @@ OPTIONAL FLAGS request fails if all candidate subnets are in use at Google's edge. --cloud-router-ipv6-interface-id=INTERFACE_ID - The cloud-router-ipv6-interface-id field is not available. + cloud-router-ipv6-interface-id field is not available. --customer-router-ipv6-interface-id=PEER_INTERFACE_ID - The customer-router-ipv6-interface-id field is not available. + customer-router-ipv6-interface-id field is not available. --description=DESCRIPTION Human-readable plain-text description of attachment. @@ -122,8 +122,8 @@ OPTIONAL FLAGS --mtu=MTU Maximum transmission unit (MTU) is the size of the largest IP packet - passing through this interconnect attachment. Only 1440 and 1500 are - allowed values. If not specified, the value will default to 1440. + passing through this interconnect attachment. Must be one of 1440, + 1460, 1500, or 8896. If not specified, the value will default to 1440. --region=REGION Region of the interconnect attachment to create. If not specified, you @@ -146,8 +146,8 @@ OPTIONAL FLAGS CLOUDSDK_COMPUTE_REGION. --stack-type=STACK_TYPE - The stack type of the protocol(s) enabled on this interconnect - attachment. STACK_TYPE must be one of: + Stack type of the protocol(s) enabled on this interconnect attachment. + STACK_TYPE must be one of: IPV4_IPV6 Both IPv4 and IPv6 protocols are enabled on this attachment. @@ -155,12 +155,12 @@ OPTIONAL FLAGS Only IPv4 protocol is enabled on this attachment. --subnet-length=SUBNET_LENGTH - The length of the IPv4 subnet mask for this attachment. 29 is the - default value, except for attachments on Cross-Cloud Interconnects - whose remote location's "constraints.subnetLengthRange" field specifies - a minimum subnet length of 30. In that case, the default value is 30. - The default value is recommended when there's no requirement on the - subnet length. SUBNET_LENGTH must be one of: 29, 30. + Length of the IPv4 subnet mask for this attachment. 29 is the default + value, except for attachments on Cross-Cloud Interconnects whose remote + location's "constraints.subnetLengthRange" field specifies a minimum + subnet length of 30. In that case, the default value is 30. The default + value is recommended when there's no requirement on the subnet length. + SUBNET_LENGTH must be one of: 29, 30. --vlan=VLAN Desired VLAN for this attachment, in the range 2-4093. If not supplied, diff --git a/gcloud/beta/compute/interconnects/attachments/dedicated/update b/gcloud/beta/compute/interconnects/attachments/dedicated/update index fb36ad741..42e71fe23 100644 --- a/gcloud/beta/compute/interconnects/attachments/dedicated/update +++ b/gcloud/beta/compute/interconnects/attachments/dedicated/update @@ -55,10 +55,10 @@ FLAGS The candididate-ipv6-subnets field is not available. --cloud-router-ipv6-interface-id=INTERFACE_ID - The cloud-router-ipv6-interface-id field is not available. + cloud-router-ipv6-interface-id field is not available. --customer-router-ipv6-interface-id=PEER_INTERFACE_ID - The customer-router-ipv6-interface-id field is not available. + customer-router-ipv6-interface-id field is not available. --description=DESCRIPTION Human-readable plain-text description of attachment. @@ -70,8 +70,8 @@ FLAGS --mtu=MTU Maximum transmission unit (MTU) is the size of the largest IP packet - passing through this interconnect attachment. Only 1440 and 1500 are - allowed values. If not specified, the value will default to 1440. + passing through this interconnect attachment. Must be one of 1440, + 1460, 1500, or 8896. If not specified, the value will default to 1440. --region=REGION Region of the interconnect attachment to patch. If not specified, you @@ -94,8 +94,8 @@ FLAGS CLOUDSDK_COMPUTE_REGION. --stack-type=STACK_TYPE - The stack type of the protocol(s) enabled on this interconnect - attachment. STACK_TYPE must be one of: + Stack type of the protocol(s) enabled on this interconnect attachment. + STACK_TYPE must be one of: IPV4_IPV6 Both IPv4 and IPv6 protocols are enabled on this attachment. diff --git a/gcloud/beta/compute/interconnects/attachments/partner/create b/gcloud/beta/compute/interconnects/attachments/partner/create index c5f6c19e6..d07e8f855 100644 --- a/gcloud/beta/compute/interconnects/attachments/partner/create +++ b/gcloud/beta/compute/interconnects/attachments/partner/create @@ -88,8 +88,8 @@ OPTIONAL FLAGS --mtu=MTU Maximum transmission unit (MTU) is the size of the largest IP packet - passing through this interconnect attachment. Only 1440 and 1500 are - allowed values. If not specified, the value will default to 1440. + passing through this interconnect attachment. Must be one of 1440, + 1460, 1500, or 8896. If not specified, the value will default to 1440. --region=REGION Region of the interconnect attachment to create. If not specified, you @@ -112,8 +112,8 @@ OPTIONAL FLAGS CLOUDSDK_COMPUTE_REGION. --stack-type=STACK_TYPE - The stack type of the protocol(s) enabled on this interconnect - attachment. STACK_TYPE must be one of: + Stack type of the protocol(s) enabled on this interconnect attachment. + STACK_TYPE must be one of: IPV4_IPV6 Both IPv4 and IPv6 protocols are enabled on this attachment. diff --git a/gcloud/beta/compute/interconnects/attachments/partner/update b/gcloud/beta/compute/interconnects/attachments/partner/update index 705773938..20dbb0fb3 100644 --- a/gcloud/beta/compute/interconnects/attachments/partner/update +++ b/gcloud/beta/compute/interconnects/attachments/partner/update @@ -30,8 +30,8 @@ FLAGS --mtu=MTU Maximum transmission unit (MTU) is the size of the largest IP packet - passing through this interconnect attachment. Only 1440 and 1500 are - allowed values. If not specified, the value will default to 1440. + passing through this interconnect attachment. Must be one of 1440, + 1460, 1500, or 8896. If not specified, the value will default to 1440. --region=REGION Region of the interconnect attachment to patch. If not specified, you @@ -54,8 +54,8 @@ FLAGS CLOUDSDK_COMPUTE_REGION. --stack-type=STACK_TYPE - The stack type of the protocol(s) enabled on this interconnect - attachment. STACK_TYPE must be one of: + Stack type of the protocol(s) enabled on this interconnect attachment. + STACK_TYPE must be one of: IPV4_IPV6 Both IPv4 and IPv6 protocols are enabled on this attachment. diff --git a/gcloud/beta/compute/network-endpoint-groups/create b/gcloud/beta/compute/network-endpoint-groups/create index ac80d2cd9..ce09adef4 100644 --- a/gcloud/beta/compute/network-endpoint-groups/create +++ b/gcloud/beta/compute/network-endpoint-groups/create @@ -6,8 +6,8 @@ SYNOPSIS gcloud beta compute network-endpoint-groups create NAME [--default-port=DEFAULT_PORT] [--network=NETWORK] [--network-endpoint-type=NETWORK_ENDPOINT_TYPE; - default="gce-vm-ip-port"] [--psc-target-service=PSC_TARGET_SERVICE] - [--subnet=SUBNET] + default="gce-vm-ip-port"] [--producer-port=PRODUCER_PORT] + [--psc-target-service=PSC_TARGET_SERVICE] [--subnet=SUBNET] [--cloud-function-name=CLOUD_FUNCTION_NAME --cloud-function-url-mask=CLOUD_FUNCTION_URL_MASK | --cloud-run-service=CLOUD_RUN_SERVICE @@ -40,11 +40,11 @@ FLAGS network endpoint. If this flag isn't specified for a NEG with endpoint type - gce-vm-ip-port or non-gcp-private-ip-port, then every network endpoint - in the network endpoint group must have a port specified. For a global - NEG with endpoint type internet-ip-port and internet-fqdn-port if the - default port is not specified, the well-known port for your backend - protocol is used (80 for HTTP, 443 for HTTPS). + gce-vm-ip-port, gce-vm-ip-portmap or non-gcp-private-ip-port, then + every network endpoint in the network endpoint group must have a port + specified. For a global NEG with endpoint type internet-ip-port and + internet-fqdn-port if the default port is not specified, the well-known + port for your backend protocol is used (80 for HTTP, 443 for HTTPS). This flag is not supported for NEGs with endpoint type serverless. @@ -116,6 +116,17 @@ FLAGS internet-ip-port, internet-fqdn-port, non-gcp-private-ip-port, serverless, gce-vm-ip, private-service-connect. + --producer-port=PRODUCER_PORT + The psc producer port to use when consumer PSC NEG connects to a + producer. + + If this flag isn't specified for a PSC NEG with endpoint type + private-service-connect, then PSC NEG will be connected to a first port + in the available pcs producer port range. + + This flag is not supported for NEGs with endpoint type other than + private-service-connect. + --psc-target-service=PSC_TARGET_SERVICE PSC target service name to add to the private service connect network endpoint groups (NEG). diff --git a/gcloud/beta/compute/packet-mirrorings/create b/gcloud/beta/compute/packet-mirrorings/create index 6d48b3ff8..995e82a58 100644 --- a/gcloud/beta/compute/packet-mirrorings/create +++ b/gcloud/beta/compute/packet-mirrorings/create @@ -75,11 +75,12 @@ OPTIONAL FLAGS --no-enable to disable. --filter-cidr-ranges=[CIDR_RANGE,...] - List of IP CIDR ranges that apply as filters on the source or - destination IP in the IP header for packet mirroring traffic. All - traffic between the VM and the IPs listed here will be mirrored using - this configuration. This can be a Public IP as well. If unspecified, - the config applies to all traffic. + One or more IPv4 or IPv6 CIDR ranges that apply as filters on the + source (ingress) or destination (egress) IP in the IP header. If no + ranges are specified, all IPv4 traffic that matches the specified + IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is + specified, all IPv4 traffic is mirrored. To mirror all IPv4 and IPv6 + traffic, use 0.0.0.0/0,::/0 --filter-direction=DIRECTION ◆ For ingress, only ingress traffic is mirrored. diff --git a/gcloud/beta/compute/project-zonal-metadata/add b/gcloud/beta/compute/project-zonal-metadata/add index fba6ea9c2..9a75865f0 100644 --- a/gcloud/beta/compute/project-zonal-metadata/add +++ b/gcloud/beta/compute/project-zonal-metadata/add @@ -46,8 +46,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute project-zonal-metadata add $ gcloud alpha compute project-zonal-metadata add diff --git a/gcloud/beta/compute/project-zonal-metadata/describe b/gcloud/beta/compute/project-zonal-metadata/describe index ae3275d3d..e3e674be8 100644 --- a/gcloud/beta/compute/project-zonal-metadata/describe +++ b/gcloud/beta/compute/project-zonal-metadata/describe @@ -29,8 +29,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute project-zonal-metadata describe $ gcloud alpha compute project-zonal-metadata describe diff --git a/gcloud/beta/compute/project-zonal-metadata/help b/gcloud/beta/compute/project-zonal-metadata/help index 688dba92d..df54cdb08 100644 --- a/gcloud/beta/compute/project-zonal-metadata/help +++ b/gcloud/beta/compute/project-zonal-metadata/help @@ -26,8 +26,10 @@ COMMANDS (BETA) Remove project zonal metadata. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute project-zonal-metadata $ gcloud alpha compute project-zonal-metadata diff --git a/gcloud/beta/compute/project-zonal-metadata/remove b/gcloud/beta/compute/project-zonal-metadata/remove index 891f8d006..e5029cd3e 100644 --- a/gcloud/beta/compute/project-zonal-metadata/remove +++ b/gcloud/beta/compute/project-zonal-metadata/remove @@ -53,8 +53,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute project-zonal-metadata remove $ gcloud alpha compute project-zonal-metadata remove diff --git a/gcloud/beta/compute/service-attachments/create b/gcloud/beta/compute/service-attachments/create index 677e928f7..3b9de9222 100644 --- a/gcloud/beta/compute/service-attachments/create +++ b/gcloud/beta/compute/service-attachments/create @@ -14,6 +14,7 @@ SYNOPSIS [--domain-names=[DOMAIN_NAMES,...]] [--enable-proxy-protocol] [--nat-subnets-region=NAT_SUBNETS_REGION] [--producer-forwarding-rule-region=PRODUCER_FORWARDING_RULE_REGION] + [--propagated-connection-limit=PROPAGATED_CONNECTION_LIMIT] [--reconcile-connections] [--region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -133,6 +134,21 @@ OPTIONAL FLAGS Alternatively, the region can be stored in the environment variable CLOUDSDK_COMPUTE_REGION. + --propagated-connection-limit=PROPAGATED_CONNECTION_LIMIT + The number of consumer spokes that connected Private Service Connect + endpoints can be propagated to through Network Connectivity Center. + This limit lets the service producer limit how many propagated Private + Service Connect connections can be established to this service + attachment from a single consumer. + + If the connection preference of the service attachment is + ACCEPT_MANUAL, the limit applies to each project or network that is + listed in the consumer accept list. If the connection preference of the + service attachment is ACCEPT_AUTOMATIC, the limit applies to each + project that contains a connected endpoint. + + If unspecified, the default propagated connection limit is 250. + --reconcile-connections Determines whether to apply changes to consumer accept or reject lists to existing connections or only to new connections. diff --git a/gcloud/beta/compute/service-attachments/update b/gcloud/beta/compute/service-attachments/update index 95ba0c46d..265b150ad 100644 --- a/gcloud/beta/compute/service-attachments/update +++ b/gcloud/beta/compute/service-attachments/update @@ -10,6 +10,7 @@ SYNOPSIS [--[no-]enable-proxy-protocol] [--nat-subnets=NAT_SUBNETS,[NAT_SUBNETS,...]] [--nat-subnets-region=NAT_SUBNETS_REGION] + [--propagated-connection-limit=PROPAGATED_CONNECTION_LIMIT] [--[no-]reconcile-connections] [--region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -93,6 +94,21 @@ FLAGS set to the region of the service attachment. Overrides the default compute/region property value for this command invocation. + --propagated-connection-limit=PROPAGATED_CONNECTION_LIMIT + The number of consumer spokes that connected Private Service Connect + endpoints can be propagated to through Network Connectivity Center. + This limit lets the service producer limit how many propagated Private + Service Connect connections can be established to this service + attachment from a single consumer. + + If the connection preference of the service attachment is + ACCEPT_MANUAL, the limit applies to each project or network that is + listed in the consumer accept list. If the connection preference of the + service attachment is ACCEPT_AUTOMATIC, the limit applies to each + project that contains a connected endpoint. + + If unspecified, the default propagated connection limit is 250. + --[no-]reconcile-connections Determines whether to apply changes to consumer accept or reject lists to existing connections or only to new connections. diff --git a/gcloud/beta/compute/snapshot-settings/update b/gcloud/beta/compute/snapshot-settings/update index 975d67d54..7ae1794a9 100644 --- a/gcloud/beta/compute/snapshot-settings/update +++ b/gcloud/beta/compute/snapshot-settings/update @@ -35,10 +35,11 @@ FLAGS complete. --storage-location-names=[STORAGE_LOCATION_NAMES,...] - The custom storage locations that you specify for the project's - snapshots. Use this flag only when you use the SPECIFIC_LOCATIONS value - for the --storage-location-policy flag. For more information, refer to - the snapshot settings documentation at + The custom storage location that you specify for the project's + snapshots. You can specify only a single location. Use this flag only + when you use the specific-locations value for the + --storage-location-policy flag. For more information, refer to the + snapshot settings documentation at https://cloud.google.com/compute/docs/disks/snapshot-settings. --storage-location-policy=STORAGE_LOCATION_POLICY diff --git a/gcloud/beta/compute/target-https-proxies/create b/gcloud/beta/compute/target-https-proxies/create index 4f668ca12..dd04d0a80 100644 --- a/gcloud/beta/compute/target-https-proxies/create +++ b/gcloud/beta/compute/target-https-proxies/create @@ -8,6 +8,7 @@ SYNOPSIS [--http-keep-alive-timeout-sec=HTTP_KEEP_ALIVE_TIMEOUT_SEC] [--quic-override=QUIC_OVERRIDE; default="NONE"] [--server-tls-policy=SERVER_TLS_POLICY] [--ssl-policy=SSL_POLICY] + [--tls-early-data=TLS_EARLY_DATA] [--certificate-manager-certificates=[CERTIFICATE_MANAGER_CERTIFICATES, ...] | --ssl-certificates=SSL_CERTIFICATE,[...]] [--global | --region=REGION] @@ -128,6 +129,29 @@ OPTIONAL FLAGS and load balancers that are using the HTTPS proxy. The SSL policy must exist and cannot be deleted while referenced by a target HTTPS proxy. + --tls-early-data=TLS_EARLY_DATA + TLS 1.3 Early Data ("0-RTT" or "zero round trip") allows clients to + include HTTP request data alongside a TLS handshake. This can improve + application performance, especially on networks where connection + interruptions may be common, such as on mobile. This applies to both + HTTP over TCP (ie: HTTP/1.1 and HTTP/2) and HTTP/3 over QUIC. + TLS_EARLY_DATA must be one of: + + DISABLED + TLS 1.3 Early Data is not advertised, and any (invalid) attempts to + send Early Data will be rejected. + PERMISSIVE + Enables TLS 1.3 Early Data for requests with safe HTTP methods + (GET, HEAD, OPTIONS, TRACE). This mode does not enforce any other + limitations for requests with Early Data. The application owner + should validate that Early Data is acceptable for a given request + path. + STRICT + Enables TLS 1.3 Early Data for requests with safe HTTP methods, and + HTTP requests that do not have query parameters. Requests that send + Early Data containing non-idempotent HTTP methods or with query + parameters will be rejected with a HTTP 425. + At most one of these can be specified: Certificate resource - certificate-manager-certificates to attach. This diff --git a/gcloud/beta/compute/target-https-proxies/update b/gcloud/beta/compute/target-https-proxies/update index 66cc94ef9..bb28bb19c 100644 --- a/gcloud/beta/compute/target-https-proxies/update +++ b/gcloud/beta/compute/target-https-proxies/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta compute target-https-proxies update NAME - [--quic-override=QUIC_OVERRIDE] [--url-map=URL_MAP] + [--quic-override=QUIC_OVERRIDE] [--tls-early-data=TLS_EARLY_DATA] + [--url-map=URL_MAP] [--certificate-manager-certificates=[CERTIFICATE_MANAGER_CERTIFICATES, ...] | --clear-ssl-certificates | --ssl-certificates=SSL_CERTIFICATE,[...] --global-ssl-certificates @@ -68,6 +69,29 @@ FLAGS NONE Allows Google to control when QUIC is rolled out. + --tls-early-data=TLS_EARLY_DATA + TLS 1.3 Early Data ("0-RTT" or "zero round trip") allows clients to + include HTTP request data alongside a TLS handshake. This can improve + application performance, especially on networks where connection + interruptions may be common, such as on mobile. This applies to both + HTTP over TCP (ie: HTTP/1.1 and HTTP/2) and HTTP/3 over QUIC. + TLS_EARLY_DATA must be one of: + + DISABLED + TLS 1.3 Early Data is not advertised, and any (invalid) attempts to + send Early Data will be rejected. + PERMISSIVE + Enables TLS 1.3 Early Data for requests with safe HTTP methods + (GET, HEAD, OPTIONS, TRACE). This mode does not enforce any other + limitations for requests with Early Data. The application owner + should validate that Early Data is acceptable for a given request + path. + STRICT + Enables TLS 1.3 Early Data for requests with safe HTTP methods, and + HTTP requests that do not have query parameters. Requests that send + Early Data containing non-idempotent HTTP methods or with query + parameters will be rejected with a HTTP 425. + --url-map=URL_MAP A reference to a URL map resource. A URL map defines the mapping of URLs to backend services. Before you can refer to a URL map, you must diff --git a/gcloud/beta/config/get b/gcloud/beta/config/get index 68747d0e4..1fb27d81a 100644 --- a/gcloud/beta/config/get +++ b/gcloud/beta/config/get @@ -270,8 +270,7 @@ AVAILABLE PROPERTIES to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. Defaults to - https://cloudiot.googleapis.com/ + Overrides API endpoint for gcloud iot command group. cloudkms Overrides API endpoint for gcloud kms command group. Defaults to diff --git a/gcloud/beta/config/help b/gcloud/beta/config/help index 24066c21e..290a8eeb4 100644 --- a/gcloud/beta/config/help +++ b/gcloud/beta/config/help @@ -302,8 +302,7 @@ AVAILABLE PROPERTIES to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. Defaults to - https://cloudiot.googleapis.com/ + Overrides API endpoint for gcloud iot command group. cloudkms Overrides API endpoint for gcloud kms command group. Defaults to diff --git a/gcloud/beta/config/list b/gcloud/beta/config/list index 02d8f4a60..ce27a137c 100644 --- a/gcloud/beta/config/list +++ b/gcloud/beta/config/list @@ -314,8 +314,7 @@ AVAILABLE PROPERTIES to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. Defaults to - https://cloudiot.googleapis.com/ + Overrides API endpoint for gcloud iot command group. cloudkms Overrides API endpoint for gcloud kms command group. Defaults to diff --git a/gcloud/beta/config/set b/gcloud/beta/config/set index ce7e3b761..f50e8aec8 100644 --- a/gcloud/beta/config/set +++ b/gcloud/beta/config/set @@ -317,8 +317,7 @@ AVAILABLE PROPERTIES to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. Defaults to - https://cloudiot.googleapis.com/ + Overrides API endpoint for gcloud iot command group. cloudkms Overrides API endpoint for gcloud kms command group. Defaults to diff --git a/gcloud/beta/config/unset b/gcloud/beta/config/unset index dea1b2ec4..775d6cf4d 100644 --- a/gcloud/beta/config/unset +++ b/gcloud/beta/config/unset @@ -278,8 +278,7 @@ AVAILABLE PROPERTIES to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. Defaults to - https://cloudiot.googleapis.com/ + Overrides API endpoint for gcloud iot command group. cloudkms Overrides API endpoint for gcloud kms command group. Defaults to diff --git a/gcloud/beta/container/backup-restore/backup-plans/create b/gcloud/beta/container/backup-restore/backup-plans/create index b3c34536c..ed97bfee8 100644 --- a/gcloud/beta/container/backup-restore/backup-plans/create +++ b/gcloud/beta/container/backup-restore/backup-plans/create @@ -10,9 +10,12 @@ SYNOPSIS [--deactivated] [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] [--backup-delete-lock-days=BACKUP_DELETE_LOCK_DAYS --backup-retain-days=BACKUP_RETAIN_DAYS --locked] - [--cron-schedule=CRON_SCHEDULE : --paused] [--encryption-key=ENCRYPTION_KEY - --include-secrets --include-volume-data] [GCLOUD_WIDE_FLAG ...] + --include-secrets --include-volume-data] + [--paused --cron-schedule=CRON_SCHEDULE + [--target-rpo-minutes=TARGET_RPO_MINUTES + : --exclusion-windows-file=EXCLUSION_WINDOWS_FILE]] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Create a Backup for GKE backup plan. @@ -130,18 +133,6 @@ OPTIONAL FLAGS If set, subsequent updates are not allowed to the backup plan's retention policy and this value cannot be changed. - --cron-schedule=CRON_SCHEDULE - Schedule on which backups will be automatically created. - - Use standard cron (http://en.wikipedia.org/wiki/Cron#Overview) syntax. - For example, 10 3 * * * will automatically create a backup at 0310 - every day. All times are interpreted as UTC. The minimum interval - between scheduled backups is 10 minutes. - - --paused - If set, automatic backup creation is suppressed. When unset, automatic - backup creation resumes with the next scheduled create event. - --encryption-key=ENCRYPTION_KEY Encryption key used for encrypting the backup. @@ -158,6 +149,27 @@ OPTIONAL FLAGS PersistentVolumeClaims that fall within the scope. If unset, the default is false. + --paused + If set, automatic backup creation is suppressed. When unset, automatic + backup creation resumes with the next scheduled create event. + + --cron-schedule=CRON_SCHEDULE + Schedule on which backups will be automatically created. + + Use standard cron (http://en.wikipedia.org/wiki/Cron#Overview) syntax. + For example, 10 3 * * * will automatically create a backup at 0310 + every day. All times are interpreted as UTC. The minimum interval + between scheduled backups is 10 minutes. + + --target-rpo-minutes=TARGET_RPO_MINUTES + Schedule backups based on target RPO minutes instead of fixed cron + schedules. Cannot be used with --cron-schedule. + + --exclusion-windows-file=EXCLUSION_WINDOWS_FILE + If provided, defines an array of exclusion windows for RPO based + schedules from the given config file in yaml. Only used together with + --target-rpo-minutes for creation and rpo-based plans during update. + 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/container/backup-restore/backup-plans/update b/gcloud/beta/container/backup-restore/backup-plans/update index 4eb0a6c1d..56bd19ccb 100644 --- a/gcloud/beta/container/backup-restore/backup-plans/update +++ b/gcloud/beta/container/backup-restore/backup-plans/update @@ -12,9 +12,11 @@ SYNOPSIS [--backup-delete-lock-days=BACKUP_DELETE_LOCK_DAYS --backup-retain-days=BACKUP_RETAIN_DAYS --locked] [--clear-labels | --remove-labels=[KEY,...]] - [--cron-schedule=CRON_SCHEDULE --paused] [--encryption-key=ENCRYPTION_KEY - --include-secrets --include-volume-data] [GCLOUD_WIDE_FLAG ...] + --include-secrets --include-volume-data] + [--paused --cron-schedule=CRON_SCHEDULE + --exclusion-windows-file=EXCLUSION_WINDOWS_FILE + --target-rpo-minutes=TARGET_RPO_MINUTES] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Update a Backup for GKE backup plan. @@ -147,18 +149,6 @@ FLAGS silently ignored. If --update-labels is also specified then --update-labels is applied first. - --cron-schedule=CRON_SCHEDULE - Schedule on which backups will be automatically created. - - Use standard cron (http://en.wikipedia.org/wiki/Cron#Overview) syntax. - For example, 10 3 * * * will automatically create a backup at 0310 - every day. All times are interpreted as UTC. The minimum interval - between scheduled backups is 10 minutes. - - --paused - If set, automatic backup creation is suppressed. When unset, automatic - backup creation resumes with the next scheduled create event. - --encryption-key=ENCRYPTION_KEY Encryption key used for encrypting the backup. @@ -175,6 +165,27 @@ FLAGS PersistentVolumeClaims that fall within the scope. If unset, the default is false. + --paused + If set, automatic backup creation is suppressed. When unset, automatic + backup creation resumes with the next scheduled create event. + + --cron-schedule=CRON_SCHEDULE + Schedule on which backups will be automatically created. + + Use standard cron (http://en.wikipedia.org/wiki/Cron#Overview) syntax. + For example, 10 3 * * * will automatically create a backup at 0310 + every day. All times are interpreted as UTC. The minimum interval + between scheduled backups is 10 minutes. + + --exclusion-windows-file=EXCLUSION_WINDOWS_FILE + If provided, defines an array of exclusion windows for RPO based + schedules from the given config file in yaml. Only used together with + --target-rpo-minutes for creation and rpo-based plans during update. + + --target-rpo-minutes=TARGET_RPO_MINUTES + Schedule backups based on target RPO minutes instead of fixed cron + schedules. Cannot be used with --cron-schedule. + 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/container/backup-restore/backups/get-backup-index-download-url b/gcloud/beta/container/backup-restore/backups/get-backup-index-download-url new file mode 100644 index 000000000..a532ebec9 --- /dev/null +++ b/gcloud/beta/container/backup-restore/backups/get-backup-index-download-url @@ -0,0 +1,83 @@ +NAME + gcloud beta container backup-restore backups get-backup-index-download-url + - get a backup index download URL + +SYNOPSIS + gcloud beta container backup-restore backups get-backup-index-download-url + (BACKUP : --backup-plan=BACKUP_PLAN --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Get backup index download URL for a Backup for GKE backup. Backup + index displays resources' basic information stored in the backup. + +EXAMPLES + To get the backup index associated with a backup my-backup in backup plan + my-backup-plan in project my-project in location us-central1, run: + + $ gcloud beta container backup-restore backups \ + get-backup-index-download-url my-backup --project=my-project \ + --location=us-central1 --backup-plan=my-backup-plan + +POSITIONAL ARGUMENTS + Backup resource - Name of the backup to create. Once the backup is + created, this name can't be changed. This must be 63 or fewer characters + long and must be unique within the project, location, and backup plan. The + name may be provided either as a relative name, e.g. + projects//locations//backupPlans//backups/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. BACKUP --project= --location= + --backup_plan=. 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-plan=BACKUP_PLAN + Backup Plan name. + + To set the backup-plan attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --backup-plan on the command line; + ▸ set the property gkebackup/backup_plan. + + --location=LOCATION + Google Cloud location. + + 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; + ▸ set the property gkebackup/location. + +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 container backup-restore backups \ + get-backup-index-download-url + diff --git a/gcloud/beta/container/backup-restore/backups/help b/gcloud/beta/container/backup-restore/backups/help index bbd1a1683..79c17b0c1 100644 --- a/gcloud/beta/container/backup-restore/backups/help +++ b/gcloud/beta/container/backup-restore/backups/help @@ -24,6 +24,9 @@ COMMANDS describe (BETA) Describe a backup. + get-backup-index-download-url + (BETA) Get a backup index download URL. + get-iam-policy (BETA) Get the IAM policy for a backup. diff --git a/gcloud/beta/container/clusters/create b/gcloud/beta/container/clusters/create index 5f98861ef..07b8354e0 100644 --- a/gcloud/beta/container/clusters/create +++ b/gcloud/beta/container/clusters/create @@ -18,6 +18,7 @@ SYNOPSIS [--cluster-ipv4-cidr=CLUSTER_IPV4_CIDR] [--cluster-secondary-range-name=NAME] [--cluster-version=CLUSTER_VERSION] + [--containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE] [--create-subnetwork=[KEY=VALUE,...]] [--database-encryption-key=DATABASE_ENCRYPTION_KEY] [--default-max-pods-per-node=DEFAULT_MAX_PODS_PER_NODE] @@ -36,10 +37,10 @@ SYNOPSIS [--enable-l4-ilb-subsetting] [--enable-legacy-authorization] [--enable-logging-monitoring-system-only] [--enable-managed-prometheus] [--enable-master-global-access] [--enable-multi-networking] - [--enable-network-policy] [--enable-pod-security-policy] - [--enable-secret-manager] [--enable-service-externalips] - [--enable-shielded-nodes] [--enable-stackdriver-kubernetes] - [--enable-vertical-pod-autoscaling] + [--enable-nested-virtualization] [--enable-network-policy] + [--enable-pod-security-policy] [--enable-secret-manager] + [--enable-service-externalips] [--enable-shielded-nodes] + [--enable-stackdriver-kubernetes] [--enable-vertical-pod-autoscaling] [--fleet-project=PROJECT_ID_OR_NUMBER] [--gateway-api=GATEWAY_API] [--identity-provider=IDENTITY_PROVIDER] [--image-type=IMAGE_TYPE] [--in-transit-encryption=IN_TRANSIT_ENCRYPTION] @@ -163,10 +164,10 @@ FLAGS (Optional) The NVIDIA driver version to install. GPU_DRIVER_VERSION must be one of: - `default`: Install the default driver version. + `default`: Install the default driver version for this GKE version. - `latest`: Install the latest available driver version. Available only for - nodes that use Container-Optimized OS. + `latest`: Install the latest driver version available for this GKE version. + Can only be used for nodes that use Container-Optimized OS. `disabled`: Skip automatic driver installation. You must manually install a driver after you create the cluster. If you omit the flag `gpu-driver-version`, @@ -295,6 +296,10 @@ FLAGS within VPCs that peer with this cluster. You should specify --cluster-ipv4-cidr to prevent conflicts. + This field is not applicable in a Shared VPC setup where the IP address + range for the pods must be specified with + --cluster-secondary-range-name + --cluster-secondary-range-name=NAME Set the secondary range to be used as the source for pod IPs. Alias ranges will be allocated from this secondary range. NAME must be the @@ -312,6 +317,17 @@ FLAGS $ gcloud container get-server-config + --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + Path of the YAML file that contains containerd configuration entries + like configuring access to private image registries. + + For detailed information on the configuration usage, please refer to + https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration. + + Note: Updating the containerd configuration of an existing cluster or + node pool requires recreation of the existing nodes, which might cause + disruptions in running workloads. + --create-subnetwork=[KEY=VALUE,...] Create a new subnetwork for the cluster. The name and range of the subnetwork can be customized via optional 'name' and 'range' key-value @@ -595,6 +611,12 @@ FLAGS Enables multi-networking on the cluster. Multi-networking is disabled by default. + --enable-nested-virtualization + Enables the use of nested virtualization on the default initial node + pool. Defaults to false. Can only be enabled on UBUNTU_CONTAINERD base + image or COS_CONTAINERD base image with version 1.28.4-gke.1083000 and + above. + --enable-network-policy Enable network policy enforcement for this cluster. If you are enabling network policy on an existing cluster the network policy addon must @@ -1175,9 +1197,9 @@ FLAGS sysctl: net.core.somaxconn: '2048' net.ipv4.tcp_rmem: '4096 87380 6291456' - hugepageConfig: - hugepage_size2m: '1024' - hugepage_size1g: '2' + hugepageConfig: + hugepage_size2m: '1024' + hugepage_size1g: '2' List of supported kubelet configs in 'kubeletConfig'. diff --git a/gcloud/beta/container/clusters/create-auto b/gcloud/beta/container/clusters/create-auto index 6cce4cc32..73a311249 100644 --- a/gcloud/beta/container/clusters/create-auto +++ b/gcloud/beta/container/clusters/create-auto @@ -10,6 +10,7 @@ SYNOPSIS [--cluster-ipv4-cidr=CLUSTER_IPV4_CIDR] [--cluster-secondary-range-name=NAME] [--cluster-version=CLUSTER_VERSION] + [--containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE] [--create-subnetwork=[KEY=VALUE,...]] [--database-encryption-key=DATABASE_ENCRYPTION_KEY] [--enable-backup-restore] [--enable-cilium-clusterwide-network-policy] @@ -124,6 +125,10 @@ FLAGS within VPCs that peer with this cluster. You should specify --cluster-ipv4-cidr to prevent conflicts. + This field is not applicable in a Shared VPC setup where the IP address + range for the pods must be specified with + --cluster-secondary-range-name + --cluster-secondary-range-name=NAME Set the secondary range to be used as the source for pod IPs. Alias ranges will be allocated from this secondary range. NAME must be the @@ -140,6 +145,17 @@ FLAGS $ gcloud container get-server-config + --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + Path of the YAML file that contains containerd configuration entries + like configuring access to private image registries. + + For detailed information on the configuration usage, please refer to + https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration. + + Note: Updating the containerd configuration of an existing cluster or + node pool requires recreation of the existing nodes, which might cause + disruptions in running workloads. + --create-subnetwork=[KEY=VALUE,...] Create a new subnetwork for the cluster. The name and range of the subnetwork can be customized via optional 'name' and 'range' key-value diff --git a/gcloud/beta/container/clusters/update b/gcloud/beta/container/clusters/update index 9e583b04f..f6ab13469 100644 --- a/gcloud/beta/container/clusters/update +++ b/gcloud/beta/container/clusters/update @@ -8,6 +8,7 @@ SYNOPSIS | --autoprovisioning-resource-manager-tags=[KEY=VALUE,...] | --autoscaling-profile=AUTOSCALING_PROFILE | --clear-fleet-project | --complete-credential-rotation | --complete-ip-rotation + | --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE | --database-encryption-key=DATABASE_ENCRYPTION_KEY | --disable-database-encryption | --disable-default-snat | --disable-workload-identity | --enable-autoscaling @@ -198,6 +199,17 @@ REQUIRED FLAGS single IP state. See documentation for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-rotation. + --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + Path of the YAML file that contains containerd configuration entries + like configuring access to private image registries. + + For detailed information on the configuration usage, please refer to + https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration. + + Note: Updating the containerd configuration of an existing cluster or + node pool requires recreation of the existing nodes, which might + cause disruptions in running workloads. + --database-encryption-key=DATABASE_ENCRYPTION_KEY Enable Database Encryption. diff --git a/gcloud/beta/container/fleet/mesh/debug/bug-report b/gcloud/beta/container/fleet/mesh/debug/bug-report new file mode 100644 index 000000000..c0819d43d --- /dev/null +++ b/gcloud/beta/container/fleet/mesh/debug/bug-report @@ -0,0 +1,59 @@ +NAME + gcloud beta container fleet mesh debug bug-report - capture cluster + information and logs into archive to help diagnose problems + +SYNOPSIS + gcloud beta container fleet mesh debug bug-report + (--membership=MEMBERSHIP : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Example: $gcloud beta container fleet mesh debug bug-report + --project=projectId --membership=membershipId --location=location + +REQUIRED FLAGS + Membership resource - The group of arguments defining a membership. 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 --membership 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. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. + + To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. + + To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + +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 container fleet mesh debug bug-report + diff --git a/gcloud/beta/container/fleet/mesh/debug/help b/gcloud/beta/container/fleet/mesh/debug/help new file mode 100644 index 000000000..04ed42030 --- /dev/null +++ b/gcloud/beta/container/fleet/mesh/debug/help @@ -0,0 +1,33 @@ +NAME + gcloud beta container fleet mesh debug - debug Service Mesh memberships + +SYNOPSIS + gcloud beta container fleet mesh debug COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Debug Service Mesh memberships. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + bug-report + (BETA) Capture cluster information and logs into archive to help + diagnose problems. + + proxy-config + (BETA) Retrieve a configuration summary for a given Envoy instance. + + proxy-status + (BETA) Retrieve the envoy configuration sync status. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container fleet mesh debug + diff --git a/gcloud/beta/container/fleet/mesh/debug/proxy-config b/gcloud/beta/container/fleet/mesh/debug/proxy-config new file mode 100644 index 000000000..3dee367a4 --- /dev/null +++ b/gcloud/beta/container/fleet/mesh/debug/proxy-config @@ -0,0 +1,88 @@ +NAME + gcloud beta container fleet mesh debug proxy-config - retrieve a + configuration summary for a given Envoy instance + +SYNOPSIS + gcloud beta container fleet mesh debug proxy-config POD_NAME_NAMESPACE + --type=TYPE (--membership=MEMBERSHIP : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Retrieve a configuration summary for a given Envoy instance. + +EXAMPLES + To retrieve the type cluster config dump for Pod instance pn.default. + + $gcloud beta container fleet mesh debug proxy-config pn.default --type=cluster + --project=projectId + --membership=membershipId + --location=us-central1 + +POSITIONAL ARGUMENTS + POD_NAME_NAMESPACE + Pod to check against. Use in format of + +REQUIRED FLAGS + --type=TYPE + Proxy configuration type, one of + all|clusters|listeners|routes|endpoints|bootstrap|log|secret + + all Retrieves all configuration for the Envoy in the specified pod + bootstrap Retrieves bootstrap configuration for the Envoy in the specified pod + cluster Retrieves cluster configuration for the Envoy in the specified pod + ecds Retrieves typed extension configuration for the Envoy in the specified pod + endpoint Retrieves endpoint configuration for the Envoy in the specified pod + listener Retrieves listener configuration for the Envoy in the specified pod + log Retrieves logging levels of the Envoy in the specified pod + route Retrieves route configuration for the Envoy in the specified pod + secret Retrieves secret configuration for the Envoy in the specified pod + + TYPE must be one of: all, bootstrap, cluster, listeners, routes, + endpoints, listener, log, secret. + + Membership resource - The group of arguments defining a membership. 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 --membership 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. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. + + To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. + + To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + +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 container fleet mesh debug proxy-config + diff --git a/gcloud/beta/container/fleet/mesh/debug/proxy-status b/gcloud/beta/container/fleet/mesh/debug/proxy-status new file mode 100644 index 000000000..723fce3fc --- /dev/null +++ b/gcloud/beta/container/fleet/mesh/debug/proxy-status @@ -0,0 +1,64 @@ +NAME + gcloud beta container fleet mesh debug proxy-status - retrieve the envoy + configuration sync status + +SYNOPSIS + gcloud beta container fleet mesh debug proxy-status + (--membership=MEMBERSHIP : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Retrieve the envoy configuration sync status. + +EXAMPLES + Retrieve the configuration sync status of all the proxies with the control + plane. + + Example: $gcloud beta container fleet mesh debug proxy-status --project=projectId --membership=membershipId --location=us-central1 + +REQUIRED FLAGS + Membership resource - The group of arguments defining a membership. 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 --membership 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. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. + + To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. + + To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + +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 container fleet mesh debug proxy-status + diff --git a/gcloud/beta/container/fleet/mesh/help b/gcloud/beta/container/fleet/mesh/help index 782af6614..fb0f37c8e 100644 --- a/gcloud/beta/container/fleet/mesh/help +++ b/gcloud/beta/container/fleet/mesh/help @@ -2,7 +2,7 @@ NAME gcloud beta container fleet mesh - manage Service Mesh Feature SYNOPSIS - gcloud beta container fleet mesh COMMAND [GCLOUD_WIDE_FLAG ...] + gcloud beta container fleet mesh GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Manage Service Mesh Feature. @@ -12,6 +12,12 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. +GROUPS + GROUP is one of the following: + + debug + (BETA) Debug Service Mesh memberships. + COMMANDS COMMAND is one of the following: diff --git a/gcloud/beta/container/hub/mesh/debug/bug-report b/gcloud/beta/container/hub/mesh/debug/bug-report new file mode 100644 index 000000000..9bea9a309 --- /dev/null +++ b/gcloud/beta/container/hub/mesh/debug/bug-report @@ -0,0 +1,59 @@ +NAME + gcloud beta container hub mesh debug bug-report - capture cluster + information and logs into archive to help diagnose problems + +SYNOPSIS + gcloud beta container hub mesh debug bug-report + (--membership=MEMBERSHIP : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Example: $gcloud beta container hub mesh debug bug-report + --project=projectId --membership=membershipId --location=location + +REQUIRED FLAGS + Membership resource - The group of arguments defining a membership. 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 --membership 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. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. + + To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. + + To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + +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 container hub mesh debug bug-report + diff --git a/gcloud/beta/container/hub/mesh/debug/help b/gcloud/beta/container/hub/mesh/debug/help new file mode 100644 index 000000000..032e45e5f --- /dev/null +++ b/gcloud/beta/container/hub/mesh/debug/help @@ -0,0 +1,33 @@ +NAME + gcloud beta container hub mesh debug - debug Service Mesh memberships + +SYNOPSIS + gcloud beta container hub mesh debug COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Debug Service Mesh memberships. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + bug-report + (BETA) Capture cluster information and logs into archive to help + diagnose problems. + + proxy-config + (BETA) Retrieve a configuration summary for a given Envoy instance. + + proxy-status + (BETA) Retrieve the envoy configuration sync status. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container hub mesh debug + diff --git a/gcloud/beta/container/hub/mesh/debug/proxy-config b/gcloud/beta/container/hub/mesh/debug/proxy-config new file mode 100644 index 000000000..3a72fabee --- /dev/null +++ b/gcloud/beta/container/hub/mesh/debug/proxy-config @@ -0,0 +1,88 @@ +NAME + gcloud beta container hub mesh debug proxy-config - retrieve a + configuration summary for a given Envoy instance + +SYNOPSIS + gcloud beta container hub mesh debug proxy-config POD_NAME_NAMESPACE + --type=TYPE (--membership=MEMBERSHIP : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Retrieve a configuration summary for a given Envoy instance. + +EXAMPLES + To retrieve the type cluster config dump for Pod instance pn.default. + + $gcloud beta container hub mesh debug proxy-config pn.default --type=cluster + --project=projectId + --membership=membershipId + --location=us-central1 + +POSITIONAL ARGUMENTS + POD_NAME_NAMESPACE + Pod to check against. Use in format of + +REQUIRED FLAGS + --type=TYPE + Proxy configuration type, one of + all|clusters|listeners|routes|endpoints|bootstrap|log|secret + + all Retrieves all configuration for the Envoy in the specified pod + bootstrap Retrieves bootstrap configuration for the Envoy in the specified pod + cluster Retrieves cluster configuration for the Envoy in the specified pod + ecds Retrieves typed extension configuration for the Envoy in the specified pod + endpoint Retrieves endpoint configuration for the Envoy in the specified pod + listener Retrieves listener configuration for the Envoy in the specified pod + log Retrieves logging levels of the Envoy in the specified pod + route Retrieves route configuration for the Envoy in the specified pod + secret Retrieves secret configuration for the Envoy in the specified pod + + TYPE must be one of: all, bootstrap, cluster, listeners, routes, + endpoints, listener, log, secret. + + Membership resource - The group of arguments defining a membership. 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 --membership 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. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. + + To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. + + To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + +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 container hub mesh debug proxy-config + diff --git a/gcloud/beta/container/hub/mesh/debug/proxy-status b/gcloud/beta/container/hub/mesh/debug/proxy-status new file mode 100644 index 000000000..5b804dfae --- /dev/null +++ b/gcloud/beta/container/hub/mesh/debug/proxy-status @@ -0,0 +1,64 @@ +NAME + gcloud beta container hub mesh debug proxy-status - retrieve the envoy + configuration sync status + +SYNOPSIS + gcloud beta container hub mesh debug proxy-status + (--membership=MEMBERSHIP : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Retrieve the envoy configuration sync status. + +EXAMPLES + Retrieve the configuration sync status of all the proxies with the control + plane. + + Example: $gcloud beta container hub mesh debug proxy-status --project=projectId --membership=membershipId --location=us-central1 + +REQUIRED FLAGS + Membership resource - The group of arguments defining a membership. 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 --membership 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. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. + + To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. + + To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + +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 container hub mesh debug proxy-status + diff --git a/gcloud/beta/container/hub/mesh/help b/gcloud/beta/container/hub/mesh/help index 4b73dfa62..8c640552b 100644 --- a/gcloud/beta/container/hub/mesh/help +++ b/gcloud/beta/container/hub/mesh/help @@ -2,7 +2,7 @@ NAME gcloud beta container hub mesh - manage Service Mesh Feature SYNOPSIS - gcloud beta container hub mesh COMMAND [GCLOUD_WIDE_FLAG ...] + gcloud beta container hub mesh GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Manage Service Mesh Feature. @@ -12,6 +12,12 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. +GROUPS + GROUP is one of the following: + + debug + (BETA) Debug Service Mesh memberships. + COMMANDS COMMAND is one of the following: diff --git a/gcloud/beta/container/node-pools/create b/gcloud/beta/container/node-pools/create index 8da64b2e9..3b5729bf0 100644 --- a/gcloud/beta/container/node-pools/create +++ b/gcloud/beta/container/node-pools/create @@ -15,15 +15,16 @@ SYNOPSIS pod-ipv4-range=SECONDARY_RANGE_NAME, [max-pods-per-node=NUM_PODS],...]] [--async] [--boot-disk-kms-key=BOOT_DISK_KMS_KEY] [--cluster=CLUSTER] + [--containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE] [--disable-pod-cidr-overprovision] [--disk-size=DISK_SIZE] [--disk-type=DISK_TYPE] [--enable-autoprovisioning] [--enable-autorepair] [--no-enable-autoupgrade] [--enable-blue-green-upgrade] [--enable-confidential-nodes] [--enable-confidential-storage] [--enable-gvnic] - [--enable-image-streaming] [--enable-private-nodes] - [--enable-queued-provisioning] [--enable-surge-upgrade] - [--image-type=IMAGE_TYPE] [--labels=[KEY=VALUE,...]] - [--logging-variant=LOGGING_VARIANT] + [--enable-image-streaming] [--enable-nested-virtualization] + [--enable-private-nodes] [--enable-queued-provisioning] + [--enable-surge-upgrade] [--image-type=IMAGE_TYPE] + [--labels=[KEY=VALUE,...]] [--logging-variant=LOGGING_VARIANT] [--machine-type=MACHINE_TYPE, -m MACHINE_TYPE] [--max-pods-per-node=MAX_PODS_PER_NODE] [--max-surge-upgrade=MAX_SURGE_UPGRADE; default=1] @@ -39,8 +40,9 @@ SYNOPSIS [--num-nodes=NUM_NODES; default=3] [--placement-policy=PLACEMENT_POLICY] [--placement-type=PLACEMENT_TYPE] [--preemptible] [--resource-manager-tags=[KEY=VALUE,...]] - [--sandbox=[type=TYPE]] [--shielded-integrity-monitoring] - [--shielded-secure-boot] + [--sandbox=[type=TYPE]] + [--secondary-boot-disk=[disk-image=DISK_IMAGE,[mode=MODE],...]] + [--shielded-integrity-monitoring] [--shielded-secure-boot] [--sole-tenant-node-affinity-file=SOLE_TENANT_NODE_AFFINITY_FILE] [--spot] [--standard-rollout-policy=[batch-node-count=BATCH_NODE_COUNT, @@ -109,10 +111,10 @@ FLAGS (Optional) The NVIDIA driver version to install. GPU_DRIVER_VERSION must be one of: - `default`: Install the default driver version. + `default`: Install the default driver version for this GKE version. - `latest`: Install the latest available driver version. Available only for - nodes that use Container-Optimized OS. + `latest`: Install the latest driver version available for this GKE version. + Can only be used for nodes that use Container-Optimized OS. `disabled`: Skip automatic driver installation. You must manually install a driver after you create the cluster. If you omit the flag `gpu-driver-version`, @@ -183,6 +185,17 @@ FLAGS The cluster to add the node pool to. Overrides the default container/cluster property value for this command invocation. + --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + Path of the YAML file that contains containerd configuration entries + like configuring access to private image registries. + + For detailed information on the configuration usage, please refer to + https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration. + + Note: Updating the containerd configuration of an existing cluster or + node pool requires recreation of the existing nodes, which might cause + disruptions in running workloads. + --disable-pod-cidr-overprovision Disables pod cidr overprovision on nodes. Pod cidr overprovisioning is enabled by default. @@ -247,6 +260,11 @@ FLAGS --enable-image-streaming Specifies whether to enable image streaming on node pool. + --enable-nested-virtualization + Enables the use of nested virtualization on the node pool. Defaults to + false. Can only be enabled on UBUNTU_CONTAINERD base image or + COS_CONTAINERD base image with version 1.28.4-gke.1083000 and above. + --enable-private-nodes Enables provisioning nodes with private IP addresses only. @@ -564,6 +582,17 @@ FLAGS The only supported type is 'gvisor'. + --secondary-boot-disk=[disk-image=DISK_IMAGE,[mode=MODE],...] + Attaches secondary boot disks to all nodes. + + disk-image + (Required) The full resource path to the source disk image to + create the secondary boot disks from. + + mode + (Optional) The configuration mode for the secondary boot disks. The + default value is "CONTAINER_IMAGE_CACHE". + --shielded-integrity-monitoring Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy @@ -636,9 +665,9 @@ FLAGS sysctl: net.core.somaxconn: '2048' net.ipv4.tcp_rmem: '4096 87380 6291456' - hugepageConfig: - hugepage_size2m: '1024' - hugepage_size1g: '2' + hugepageConfig: + hugepage_size2m: '1024' + hugepage_size1g: '2' List of supported kubelet configs in 'kubeletConfig'. diff --git a/gcloud/beta/container/node-pools/update b/gcloud/beta/container/node-pools/update index 20eb3aee0..89f0092b4 100644 --- a/gcloud/beta/container/node-pools/update +++ b/gcloud/beta/container/node-pools/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta container node-pools update NAME - (--enable-confidential-nodes | --enable-gvnic + (--containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + | --enable-confidential-nodes | --enable-gvnic | --enable-image-streaming | --enable-private-nodes | --enable-queued-provisioning | --labels=[KEY=VALUE,...] | --logging-variant=LOGGING_VARIANT @@ -49,6 +50,17 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS Exactly one of these must be specified: + --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + Path of the YAML file that contains containerd configuration entries + like configuring access to private image registries. + + For detailed information on the configuration usage, please refer to + https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration. + + Note: Updating the containerd configuration of an existing cluster or + node pool requires recreation of the existing nodes, which might + cause disruptions in running workloads. + --enable-confidential-nodes Recreate all the nodes in the node pool to be confidential VM https://cloud.google.com/compute/confidential-vm/docs/about-cvm. @@ -192,9 +204,9 @@ REQUIRED FLAGS sysctl: net.core.somaxconn: '2048' net.ipv4.tcp_rmem: '4096 87380 6291456' - hugepageConfig: - hugepage_size2m: '1024' - hugepage_size1g: '2' + hugepageConfig: + hugepage_size2m: '1024' + hugepage_size1g: '2' List of supported kubelet configs in 'kubeletConfig'. diff --git a/gcloud/beta/dataproc/batches/submit/help b/gcloud/beta/dataproc/batches/submit/help index 486be3153..f05fa956d 100644 --- a/gcloud/beta/dataproc/batches/submit/help +++ b/gcloud/beta/dataproc/batches/submit/help @@ -38,6 +38,12 @@ EXAMPLES 'my-sql-script.sql' --region='us-central1' \ --deps-bucket=gs://my-bucket --vars='variable=value' + To submit a Ray job, run: + + $ gcloud beta dataproc batches submit ray my-ray.py \ + --location='us-central1' --deps-bucket=gs://my-bucket -- ARG1 \ + ARG2 + FLAGS --async Return immediately without waiting for the operation in progress to @@ -107,7 +113,7 @@ FLAGS --request-id=REQUEST_ID A unique ID that identifies the request. If the service receives two batch create requests with the same request_id, the second request is - ignored and the operation that corresponds to the first Batch created + ignored and the operation that corresponds to the first batch created and stored in the backend is returned. Recommendation: Always set this value to a UUID. The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (), and hyphens (-). The maximum length is diff --git a/gcloud/beta/dataproc/batches/submit/pyspark b/gcloud/beta/dataproc/batches/submit/pyspark index c57f9eec8..db63a01b5 100644 --- a/gcloud/beta/dataproc/batches/submit/pyspark +++ b/gcloud/beta/dataproc/batches/submit/pyspark @@ -123,7 +123,7 @@ FLAGS --request-id=REQUEST_ID A unique ID that identifies the request. If the service receives two batch create requests with the same request_id, the second request is - ignored and the operation that corresponds to the first Batch created + ignored and the operation that corresponds to the first batch created and stored in the backend is returned. Recommendation: Always set this value to a UUID. The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (), and hyphens (-). The maximum length is diff --git a/gcloud/beta/dataproc/batches/submit/spark b/gcloud/beta/dataproc/batches/submit/spark index 4384f1b11..029b23b42 100644 --- a/gcloud/beta/dataproc/batches/submit/spark +++ b/gcloud/beta/dataproc/batches/submit/spark @@ -137,7 +137,7 @@ OPTIONAL FLAGS --request-id=REQUEST_ID A unique ID that identifies the request. If the service receives two batch create requests with the same request_id, the second request is - ignored and the operation that corresponds to the first Batch created + ignored and the operation that corresponds to the first batch created and stored in the backend is returned. Recommendation: Always set this value to a UUID. The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (), and hyphens (-). The maximum length is diff --git a/gcloud/beta/dataproc/batches/submit/spark-r b/gcloud/beta/dataproc/batches/submit/spark-r index 7e121fc1e..92496edd3 100644 --- a/gcloud/beta/dataproc/batches/submit/spark-r +++ b/gcloud/beta/dataproc/batches/submit/spark-r @@ -114,7 +114,7 @@ FLAGS --request-id=REQUEST_ID A unique ID that identifies the request. If the service receives two batch create requests with the same request_id, the second request is - ignored and the operation that corresponds to the first Batch created + ignored and the operation that corresponds to the first batch created and stored in the backend is returned. Recommendation: Always set this value to a UUID. The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (), and hyphens (-). The maximum length is diff --git a/gcloud/beta/dataproc/batches/submit/spark-sql b/gcloud/beta/dataproc/batches/submit/spark-sql index 5e994d7f7..86fa6a175 100644 --- a/gcloud/beta/dataproc/batches/submit/spark-sql +++ b/gcloud/beta/dataproc/batches/submit/spark-sql @@ -105,7 +105,7 @@ FLAGS --request-id=REQUEST_ID A unique ID that identifies the request. If the service receives two batch create requests with the same request_id, the second request is - ignored and the operation that corresponds to the first Batch created + ignored and the operation that corresponds to the first batch created and stored in the backend is returned. Recommendation: Always set this value to a UUID. The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (), and hyphens (-). The maximum length is diff --git a/gcloud/beta/dns/managed-zones/create b/gcloud/beta/dns/managed-zones/create index 8008e573a..8d9fd8db5 100644 --- a/gcloud/beta/dns/managed-zones/create +++ b/gcloud/beta/dns/managed-zones/create @@ -2,8 +2,8 @@ NAME gcloud beta dns managed-zones create - create a Cloud DNS managed-zone SYNOPSIS - gcloud beta dns managed-zones create ZONE_NAME --description=DESCRIPTION - --dns-name=DNS_NAME [--denial-of-existence=DENIAL_OF_EXISTENCE] + gcloud beta dns managed-zones create ZONE_NAME --dns-name=DNS_NAME + [--denial-of-existence=DENIAL_OF_EXISTENCE] [--description=DESCRIPTION] [--dnssec-state=DNSSEC_STATE] [--forwarding-targets=[IP_ADDRESSES,...]] [--gkeclusters=[GKECLUSTERS,...]] [--ksk-algorithm=KSK_ALGORITHM] [--ksk-key-length=KSK_KEY_LENGTH] [--labels=[KEY=VALUE,...]] @@ -43,9 +43,6 @@ POSITIONAL ARGUMENTS The name of the managed-zone to be created. REQUIRED FLAGS - --description=DESCRIPTION - Short description for the managed-zone. - --dns-name=DNS_NAME The DNS name suffix that will be managed with the created zone. @@ -54,6 +51,9 @@ OPTIONAL FLAGS Requires DNSSEC enabled. DENIAL_OF_EXISTENCE must be one of: nsec, nsec3. + --description=DESCRIPTION + Short description for the managed zone. + --dnssec-state=DNSSEC_STATE The DNSSEC state for this managed zone. DNSSEC_STATE must be one of: diff --git a/gcloud/beta/dns/managed-zones/update b/gcloud/beta/dns/managed-zones/update index 6056bffd1..814d7ef5a 100644 --- a/gcloud/beta/dns/managed-zones/update +++ b/gcloud/beta/dns/managed-zones/update @@ -60,7 +60,7 @@ FLAGS nsec3. --description=DESCRIPTION - Short description for the managed-zone. + Short description for the managed zone. --dnssec-state=DNSSEC_STATE The DNSSEC state for this managed zone. DNSSEC_STATE must be one of: diff --git a/gcloud/beta/domains/registrations/configure/dns b/gcloud/beta/domains/registrations/configure/dns index f527d06ec..a0d4cfd98 100644 --- a/gcloud/beta/domains/registrations/configure/dns +++ b/gcloud/beta/domains/registrations/configure/dns @@ -18,10 +18,6 @@ DESCRIPTION servers and DNSSEC options for the given domain. However, advanced options like glue records are available. - When using Cloud DNS Zone or Google Domains name servers, DNSSEC will be - enabled by default where possible. You can disable it using the - --disable-dnssec flag. - EXAMPLES To start an interactive flow to configure DNS settings for example.com, run: @@ -33,7 +29,14 @@ EXAMPLES $ gcloud beta domains registrations configure dns example.com \ --cloud-dns-zone=example-zone - If the managed-zone is signed, DNSSEC will be enabled for the domain. + DNSSEC will not be enabled as it may not be safe to enable it (e.g. when + the Cloud DNS managed-zone was signed less than 24h ago). + + To use a signed Cloud DNS managed-zone example-zone for example.com and + enable DNSSEC, run: + + $ gcloud beta domains registrations configure dns example.com \ + --cloud-dns-zone=example-zone --no-disable-dnssec To change DNS settings for example.com according to information from a YAML file dns_settings.yaml, run: @@ -90,8 +93,6 @@ COMMONLY USED FLAGS for the domain. If it's in the same project, you can use short name. If not, use the full resource name, e.g.: --cloud-dns-zone=projects/example-project/managedZones/example-zone. - If the zone is signed, DNSSEC will be enabled by default unless you - pass --disable-dnssec. --dns-settings-from-file=DNS_SETTINGS_FILE_NAME A YAML file containing the required DNS settings. If specified, its @@ -129,9 +130,7 @@ COMMONLY USED FLAGS List of DNS name servers for the domain. --use-google-domains-dns - (DEPRECATED) Use free name servers provided by Google Domains. If - the zone is signed, DNSSEC will be enabled by default unless you - pass --disable-dnssec. + (DEPRECATED) Use free name servers provided by Google Domains. The --use-google-domains-dns option is deprecated; See https://cloud.google.com/domains/docs/deprecations/feature-deprecations. @@ -146,8 +145,12 @@ OTHER FLAGS to a Cloud DNS Zone or Google Domains nameservers. --unsafe-dns-update - Use this flag to allow DNS changes that may make your domain stop - serving. + (DEPRECATED) Use this flag to allow DNS changes that may make your + domain stop serving. + + The --unsafe-dns-update option is deprecated. To complete an unsafe DNS + operation first disable DNSSEC, then change name servers, then + (optionally) enable DNSSEC. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/domains/registrations/register b/gcloud/beta/domains/registrations/register index 684588d03..9c23a912a 100644 --- a/gcloud/beta/domains/registrations/register +++ b/gcloud/beta/domains/registrations/register @@ -23,9 +23,9 @@ DESCRIPTION Also in rare cases, the domain may end up in state REGISTRATION_FAILED. In that case, delete the registration resource and try again. - When using Cloud DNS Zone or Google Domains name servers, DNSSEC will be - enabled by default where possible. You can choose to not enable DNSSEC by - using the --disable-dnssec flag. + When using Cloud DNS Zone DNSSEC will be enabled by default whenever the + Zone is DNSSEC signed. You can choose to not enable DNSSEC by using the + --disable-dnssec flag. EXAMPLES To register example.com interactively, run: diff --git a/gcloud/beta/iam/workforce-pools/providers/create-oidc b/gcloud/beta/iam/workforce-pools/providers/create-oidc index 709c3d809..e1a4e4ab3 100644 --- a/gcloud/beta/iam/workforce-pools/providers/create-oidc +++ b/gcloud/beta/iam/workforce-pools/providers/create-oidc @@ -13,7 +13,10 @@ SYNOPSIS [--async] [--attribute-condition=ATTRIBUTE_CONDITION] [--client-secret-value=CLIENT_SECRET_VALUE] [--description=DESCRIPTION] [--disabled] [--display-name=DISPLAY_NAME] - [--jwk-json-path=JWK_JSON_PATH] [GCLOUD_WIDE_FLAG ...] + [--jwk-json-path=JWK_JSON_PATH] + [--extra-attributes-client-id=EXTRA_ATTRIBUTES_CLIENT_ID + --extra-attributes-client-secret-value=EXTRA_ATTRIBUTES_CLIENT_SECRET_VALUE --extra-attributes-issuer-uri=EXTRA_ATTRIBUTES_ISSUER_URI --extra-attributes-type=EXTRA_ATTRIBUTES_TYPE : --extra-attributes-filter=EXTRA_ATTRIBUTES_FILTER] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Create a new OIDC workforce pool provider. @@ -266,6 +269,34 @@ OPTIONAL FLAGS ] } + --extra-attributes-client-id=EXTRA_ATTRIBUTES_CLIENT_ID + The OAuth 2.0 client ID for retrieving extra attributes from the + identity provider. Required to get the Access Token using client + credentials grant flow. + + --extra-attributes-client-secret-value=EXTRA_ATTRIBUTES_CLIENT_SECRET_VALUE + The OAuth 2.0 client secret for retrieving extra attributes from the + identity provider. Required to get the Access Token using client + credentials grant flow. + + --extra-attributes-issuer-uri=EXTRA_ATTRIBUTES_ISSUER_URI + OIDC identity provider's issuer URI. Must be a valid URI using the + 'https' scheme. Required to get the OIDC discovery document. + + --extra-attributes-type=EXTRA_ATTRIBUTES_TYPE + Represents the identity provider and type of claims that should be + fetched. EXTRA_ATTRIBUTES_TYPE must be one of: + attributes-type-unspecified, azure-ad-groups-mail. + + --extra-attributes-filter=EXTRA_ATTRIBUTES_FILTER + The filter used to request specific records from IdP. In case of + attributes type as AZURE_AD_GROUPS_MAIL, it represents the filter used + to request specific groups for users from IdP. By default all the + groups associated with the user are fetched. The groups that are used + should be mail enabled and security enabled. See + https://learn.microsoft.com/en-us/graph/search-query-parameter for more + details. + 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/iam/workforce-pools/providers/update-oidc b/gcloud/beta/iam/workforce-pools/providers/update-oidc index ca137be0b..fa9b6724c 100644 --- a/gcloud/beta/iam/workforce-pools/providers/update-oidc +++ b/gcloud/beta/iam/workforce-pools/providers/update-oidc @@ -13,6 +13,9 @@ SYNOPSIS [--web-sso-assertion-claims-behavior=WEB_SSO_ASSERTION_CLAIMS_BEHAVIOR] [--web-sso-response-type=WEB_SSO_RESPONSE_TYPE] [--clear-client-secret | --client-secret-value=CLIENT_SECRET_VALUE] + [--clear-extra-attributes-config + | --extra-attributes-client-id=EXTRA_ATTRIBUTES_CLIENT_ID + --extra-attributes-client-secret-value=EXTRA_ATTRIBUTES_CLIENT_SECRET_VALUE --extra-attributes-filter=EXTRA_ATTRIBUTES_FILTER --extra-attributes-issuer-uri=EXTRA_ATTRIBUTES_ISSUER_URI --extra-attributes-type=EXTRA_ATTRIBUTES_TYPE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -253,6 +256,39 @@ FLAGS The OIDC client secret. Required to enable Authorization Code flow for web sign-in. + At most one of these can be specified: + + --clear-extra-attributes-config + Clear the extra attributes configuration + + --extra-attributes-client-id=EXTRA_ATTRIBUTES_CLIENT_ID + The OAuth 2.0 client ID for retrieving extra attributes from the + identity provider. Required to get the Access Token using client + credentials grant flow. + + --extra-attributes-client-secret-value=EXTRA_ATTRIBUTES_CLIENT_SECRET_VALUE + The OAuth 2.0 client secret for retrieving extra attributes from the + identity provider. Required to get the Access Token using client + credentials grant flow. + + --extra-attributes-filter=EXTRA_ATTRIBUTES_FILTER + The filter used to request specific records from IdP. In case of + attributes type as AZURE_AD_GROUPS_MAIL, it represents the filter + used to request specific groups for users from IdP. By default all + the groups associated with the user are fetched. The groups that are + used should be mail enabled and security enabled. See + https://learn.microsoft.com/en-us/graph/search-query-parameter for + more details. + + --extra-attributes-issuer-uri=EXTRA_ATTRIBUTES_ISSUER_URI + OIDC identity provider's issuer URI. Must be a valid URI using the + 'https' scheme. Required to get the OIDC discovery document. + + --extra-attributes-type=EXTRA_ATTRIBUTES_TYPE + Represents the identity provider and type of claims that should be + fetched. EXTRA_ATTRIBUTES_TYPE must be one of: + attributes-type-unspecified, azure-ad-groups-mail. + 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/iot/devices/commands/help b/gcloud/beta/iot/devices/commands/help deleted file mode 100644 index 19b7cc72f..000000000 --- a/gcloud/beta/iot/devices/commands/help +++ /dev/null @@ -1,30 +0,0 @@ -NAME - gcloud beta iot devices commands - manage commands for Cloud IoT devices - -SYNOPSIS - gcloud beta iot devices commands COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Manage commands for Cloud IoT devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - send - (BETA) (DEPRECATED) Sends a command to a device. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices commands - - $ gcloud alpha iot devices commands - diff --git a/gcloud/beta/iot/devices/commands/send b/gcloud/beta/iot/devices/commands/send deleted file mode 100644 index f95efe459..000000000 --- a/gcloud/beta/iot/devices/commands/send +++ /dev/null @@ -1,107 +0,0 @@ -NAME - gcloud beta iot devices commands send - sends a command to a device - -SYNOPSIS - gcloud beta iot devices commands send - (--command-data=COMMAND_DATA | --command-file=COMMAND_FILE) - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--subfolder=SUBFOLDER] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Sends a command to a device. - -EXAMPLES - To send a simple command to a device in 'my-registry' and region - 'us-central1' using a special command subfolder, run: - - $ gcloud beta iot devices commands send --region=us-central1 \ - --registry=my-registry --device=my-device \ - --command-data="restart job" \ - --subfolder="/jobs/metric_collector" - - To send a command containing special characters to a device in - 'my-registry' and region 'us-central1', run: - - $ gcloud beta iot devices commands send --region=us-central1 \ - --registry=my-registry --device=my-device \ - --command-file=/path/to/command.file - -REQUIRED FLAGS - Exactly one of these must be specified: - - --command-data=COMMAND_DATA - The data for this command, as a string. For any values that contain - special characters (in the context of your shell), use the - --command-file flag instead. - - --command-file=COMMAND_FILE - Path to a local file containing the data for this command. - - Device resource - The device you want to send commands to. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The name of the Cloud IoT registry. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -OPTIONAL FLAGS - --subfolder=SUBFOLDER - The commands subfolder to append to the topic path. - - This field must not have more than 256 characters, and must not contain - any MQTT wildcards ("+" or "#") or null 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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices commands send - - $ gcloud alpha iot devices commands send - diff --git a/gcloud/beta/iot/devices/configs/describe b/gcloud/beta/iot/devices/configs/describe deleted file mode 100644 index 5fae7e1d0..000000000 --- a/gcloud/beta/iot/devices/configs/describe +++ /dev/null @@ -1,77 +0,0 @@ -NAME - gcloud beta iot devices configs describe - show details about the latest - configuration for a device - -SYNOPSIS - gcloud beta iot devices configs describe - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Show details about the latest configuration for a - device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To show the details of the latest configuration for a device in region - 'us-central1', run: - - $ gcloud beta iot devices configs describe --region=us-central1 \ - --registry=my-registry --device=my-device - -REQUIRED FLAGS - Device resource - The device for the configuration 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices configs describe - - $ gcloud alpha iot devices configs describe - diff --git a/gcloud/beta/iot/devices/configs/get-value b/gcloud/beta/iot/devices/configs/get-value deleted file mode 100644 index c736339b5..000000000 --- a/gcloud/beta/iot/devices/configs/get-value +++ /dev/null @@ -1,77 +0,0 @@ -NAME - gcloud beta iot devices configs get-value - show the binary data of a - device's latest configuration - -SYNOPSIS - gcloud beta iot devices configs get-value - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Show the binary data of a device's latest - configuration. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To show the binary data of the latest configuration of a device in region - 'us-central1', run: - - $ gcloud beta iot devices configs get-value --region=us-central1 \ - --registry=my-registry --device=my-device - -REQUIRED FLAGS - Device resource - The device for the configuration to get the value 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices configs get-value - - $ gcloud alpha iot devices configs get-value - diff --git a/gcloud/beta/iot/devices/configs/help b/gcloud/beta/iot/devices/configs/help deleted file mode 100644 index ae4388234..000000000 --- a/gcloud/beta/iot/devices/configs/help +++ /dev/null @@ -1,44 +0,0 @@ -NAME - gcloud beta iot devices configs - manage configurations for Cloud IoT - devices - -SYNOPSIS - gcloud beta iot devices configs COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Manage configurations for Cloud IoT devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing configurations for Google Cloud IoT devices. - -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) (DEPRECATED) Show details about the latest configuration for a - device. - - get-value - (BETA) (DEPRECATED) Show the binary data of a device's latest - configuration. - - list - (BETA) (DEPRECATED) List configs for a device. - - update - (BETA) (DEPRECATED) Update a specific device configuration. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices configs - - $ gcloud alpha iot devices configs - diff --git a/gcloud/beta/iot/devices/configs/list b/gcloud/beta/iot/devices/configs/list deleted file mode 100644 index 46c26c9bf..000000000 --- a/gcloud/beta/iot/devices/configs/list +++ /dev/null @@ -1,99 +0,0 @@ -NAME - gcloud beta iot devices configs list - list configs for a device - -SYNOPSIS - gcloud beta iot devices configs list - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--filter=EXPRESSION] [--limit=LIMIT] [--sort-by=[FIELD,...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) List configs for a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - - This command lists all available configurations in the history of the - device. Up to 10 are kept; you may restrict the output to fewer via the - --limit flag. - -EXAMPLES - To list the 3 latest configurations of a device in region 'us-central1', - run: - - $ gcloud beta iot devices configs list --region=us-central1 \ - --registry=my-registry --device=my-device --limit=3 - -REQUIRED FLAGS - Device resource - The device for which to list configs. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices configs list - - $ gcloud alpha iot devices configs list - diff --git a/gcloud/beta/iot/devices/configs/update b/gcloud/beta/iot/devices/configs/update deleted file mode 100644 index 73c01135d..000000000 --- a/gcloud/beta/iot/devices/configs/update +++ /dev/null @@ -1,109 +0,0 @@ -NAME - gcloud beta iot devices configs update - update a specific device - configuration - -SYNOPSIS - gcloud beta iot devices configs update - (--config-data=CONFIG_DATA | --config-file=CONFIG_FILE) - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--version-to-update=VERSION_TO_UPDATE] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Update a specific device configuration. - - This command is deprecated. Google Cloud IoT Core has been retired. - - This command updates the current configuration of the device. - - It always creates a new config with a new version number; if - --version-to-update is provided, the config at that version is used as a - base. - -EXAMPLES - To update the latest configuration of a device in region 'us-central1', - run: - - $ gcloud beta iot devices configs update --region=us-central1 \ - --registry=my-registry --device=my-device \ - --config-data="job_timeout:300" - - To update the latest configuration of a device in region 'us-central1' only - if the latest configuration version is 11, run: - - $ gcloud beta iot devices configs update --region=us-central1 \ - --registry=my-registry --device=my-device \ - --config-file=/path/to/config.base64 --version-to-update=11 - -REQUIRED FLAGS - Exactly one of these must be specified: - - --config-data=CONFIG_DATA - The data for this configuration, as a string. For any values that - contain special characters (in the context of your shell), use the - --config-file flag instead. - - --config-file=CONFIG_FILE - Path to a local file containing the data for this configuration. - - Device resource - The device for the configuration 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -OPTIONAL FLAGS - --version-to-update=VERSION_TO_UPDATE - The version number to update. If this value is 0 or unspecified, it - will not check the version number of the server and will always update - the current version; otherwise, this update will fail if the version - number provided does not match the latest version on the server. This - is used to detect conflicts with simultaneous updates. - -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 iot devices configs update - - $ gcloud alpha iot devices configs update - diff --git a/gcloud/beta/iot/devices/create b/gcloud/beta/iot/devices/create deleted file mode 100644 index c859ceef1..000000000 --- a/gcloud/beta/iot/devices/create +++ /dev/null @@ -1,195 +0,0 @@ -NAME - gcloud beta iot devices create - create a new device - -SYNOPSIS - gcloud beta iot devices create - (DEVICE : --region=REGION --registry=REGISTRY) - [--auth-method=AUTH_METHOD] [--blocked] [--device-type=DEVICE_TYPE] - [--log-level=LOG_LEVEL] [--metadata=[KEY=VALUE,...]] - [--metadata-from-file=[KEY=PATH,...]] - [--public-key=[path=PATH, - type=TYPE,[expiration-time=EXPIRATION-TIME],...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Create a new device. - -EXAMPLES - To create a new device 'my-device' in device registry 'my-registry' and - region 'us-central1', run: - - $ gcloud beta iot devices create my-device --region=us-central1 \ - --registry=my-registry - - The following command creates a new non-gateway device 'my-device' in - device registry 'my-registry' and region 'us-central1', blocks the device, - and sets metadata values. - - $ gcloud beta iot devices create my-device --region=us-central1 \ - --registry=my-registry --blocked --device-type=non-gateway \ - --metadata=key1=value1,key2=value2 - -POSITIONAL ARGUMENTS - Device resource - The device you want 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 device 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. - - DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument device 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The name of the Cloud IoT registry. - - To set the registry attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -FLAGS - --auth-method=AUTH_METHOD - The authorization/authentication method used by devices in relation to - the gateway. This property is set only on gateways. If left - unspecified, devices will not be able to access the gateway. - AUTH_METHOD must be one of: - - association-and-device-auth-token - The device is authenticated through both device credentials and - gateway association. - association-only - The device is authenticated through the gateway association only. - Device credentials are ignored if provided. - device-auth-token-only - The device is authenticated through its own credentials. Gateway - association is not checked. - - --blocked - If blocked, connections from this device will fail. - - Can be used to temporarily prevent the device from connecting if, for - example, the sensor is generating bad data and needs maintenance. - - Connections to device is not blocked by default. - - --device-type=DEVICE_TYPE - Whether this device is a gateway. If unspecified, non-gateway is - assumed. DEVICE_TYPE must be one of: gateway, non-gateway. - - --log-level=LOG_LEVEL - The default logging verbosity for activity from devices in this - registry. The verbosity level can be overridden by setting a specific - device's log level. LOG_LEVEL must be one of: - - debug - All events will be logged. - error - Error events will be logged. - info - Informational events will be logged, such as connections and - disconnections. Also includes error events. - none - Disables logging. - - --metadata=[KEY=VALUE,...] - The metadata key/value pairs assigned to devices. This metadata is not - interpreted or indexed by Cloud IoT Core. It can be used to add - contextual information for the device. - - Keys should only contain the following characters [a-zA-Z0-9-_] and be - fewer than 128 bytes in length. Values are free-form strings. Each - value must be fewer than or equal to 32 KB in size. - - The total size of all keys and values must be less than 256 KB, and the - maximum number of key-value pairs is 500. - - --metadata-from-file=[KEY=PATH,...] - Same as --metadata, but the metadata values will be read from the file - specified by path. - - --public-key=[path=PATH,type=TYPE,[expiration-time=EXPIRATION-TIME],...] - Specify a public key. - - Supports four key types: - - ◆ rsa-x509-pem: As RSA_PEM, but wrapped in an X.509v3 certificate - (RFC5280 (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, - and wrapped by -----BEGIN CERTIFICATE----- and -----END - CERTIFICATE-----. - ◆ rsa-pem: An RSA public key encoded in base64, and wrapped by - -----BEGIN PUBLIC KEY----- and -----END PUBLIC KEY-----. This can be - used to verify RS256 signatures in JWT tokens (RFC7518 - (https://www.ietf.org/rfc/rfc7518.txt)). - ◆ rs256: Deprecated name for rsa-x509-pem - ◆ es256-x509-pem: As ES256_PEM, but wrapped in an X.509v3 certificate - (RFC5280 (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, - and wrapped by -----BEGIN CERTIFICATE----- and -----END - CERTIFICATE-----. - ◆ es256-pem: Public key for the ECDSA algorithm using P-256 and - SHA-256, encoded in base64, and wrapped by -----BEGIN PUBLIC KEY----- - and -----END PUBLIC KEY-----. This can be used to verify JWT tokens - with the ES256 algorithm (RFC7518 - (https://www.ietf.org/rfc/rfc7518.txt)). This curve is defined in - OpenSSL (https://www.openssl.org/) as the prime256v1 curve. - ◆ es256: Deprecated nmame for es256-pem - - The key specification is given via the following sub-arguments: - - ◆ path: Required. The path on disk to the file containing the key. - ◆ type: Required. One of [es256, es256-pem, es256-x509-pem, rs256, - rsa-pem, rsa-x509-pem]. The type of the key. - ◆ expiration-time: Optional. The expiration time for the key. See $ - gcloud topic datetimes for information on time formats. - - For example: - - --public-key \ - path=/path/to/id_rsa.pem,type=RSA_PEM,expiration-time=2017-01-01T00:00-05 - - This flag may be provide multiple times to provide multiple keys - (maximum 3). - -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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices create - - $ gcloud alpha iot devices create - diff --git a/gcloud/beta/iot/devices/credentials/clear b/gcloud/beta/iot/devices/credentials/clear deleted file mode 100644 index f841e2344..000000000 --- a/gcloud/beta/iot/devices/credentials/clear +++ /dev/null @@ -1,75 +0,0 @@ -NAME - gcloud beta iot devices credentials clear - delete all credentials from a - device - -SYNOPSIS - gcloud beta iot devices credentials clear - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Delete all credentials from a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete all credentials from a device in region 'us-central1', run: - - $ gcloud beta iot devices credentials clear --region=us-central1 \ - --registry=my-registry --device=my-device - -REQUIRED FLAGS - Device resource - The device for which to clear credentials. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices credentials clear - - $ gcloud alpha iot devices credentials clear - diff --git a/gcloud/beta/iot/devices/credentials/create b/gcloud/beta/iot/devices/credentials/create deleted file mode 100644 index 5f51bb64c..000000000 --- a/gcloud/beta/iot/devices/credentials/create +++ /dev/null @@ -1,123 +0,0 @@ -NAME - gcloud beta iot devices credentials create - add a new credential to a - device - -SYNOPSIS - gcloud beta iot devices credentials create --path=PATH --type=TYPE - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--expiration-time=EXPIRATION_TIME] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Add a new credential to a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - - A device may have at most 3 credentials. - -EXAMPLES - To add an RSA public key wrapped in an X.509v3 certificate to a device, - run: - - $ gcloud beta iot devices credentials create --region=us-central1 \ - --registry=my-registry --device=my-device \ - --path=/path/to/cert.pem --type=rsa-x509-pem - - To add a public key for the ECDSA algorithm to a device, run: - - $ gcloud beta iot devices credentials create --region=us-central1 \ - --registry=my-registry --device=my-device \ - --path=/path/to/ec_public.pem --type=es256-pem - -REQUIRED FLAGS - --path=PATH - The path on disk to the file containing the key. - - --type=TYPE - The type of the key. TYPE must be one of: - - es256 - Deprecated nmame for es256-pem - es256-pem - Public key for the ECDSA algorithm using P-256 and SHA-256, encoded - in base64, and wrapped by -----BEGIN PUBLIC KEY----- and -----END - PUBLIC KEY-----. This can be used to verify JWT tokens with the - ES256 algorithm (RFC7518 (https://www.ietf.org/rfc/rfc7518.txt)). - This curve is defined in OpenSSL (https://www.openssl.org/) as the - prime256v1 curve. - es256-x509-pem - As ES256_PEM, but wrapped in an X.509v3 certificate (RFC5280 - (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and - wrapped by -----BEGIN CERTIFICATE----- and -----END - CERTIFICATE-----. - rs256 - Deprecated name for rsa-x509-pem - rsa-pem - An RSA public key encoded in base64, and wrapped by -----BEGIN - PUBLIC KEY----- and -----END PUBLIC KEY-----. This can be used to - verify RS256 signatures in JWT tokens (RFC7518 - (https://www.ietf.org/rfc/rfc7518.txt)). - rsa-x509-pem - As RSA_PEM, but wrapped in an X.509v3 certificate (RFC5280 - (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and - wrapped by -----BEGIN CERTIFICATE----- and -----END - CERTIFICATE-----. - - Device resource - The device for which to create credentials. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -OPTIONAL FLAGS - --expiration-time=EXPIRATION_TIME - The expiration time for the key. See $ gcloud topic datetimes for - information on time formats. - -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 iot devices credentials create - - $ gcloud alpha iot devices credentials create - diff --git a/gcloud/beta/iot/devices/credentials/delete b/gcloud/beta/iot/devices/credentials/delete deleted file mode 100644 index 172f9f391..000000000 --- a/gcloud/beta/iot/devices/credentials/delete +++ /dev/null @@ -1,79 +0,0 @@ -NAME - gcloud beta iot devices credentials delete - delete a credential from a - device - -SYNOPSIS - gcloud beta iot devices credentials delete INDEX - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Delete a credential from a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete the first credential from a device in region 'us-central1', run: - - $ gcloud beta iot devices credentials delete --region=us-central1 \ - --registry=my-registry --device=my-device 0 - -POSITIONAL ARGUMENTS - INDEX - The index (zero-based) of the credential to delete. - -REQUIRED FLAGS - Device resource - The device from which to delete credentials. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices credentials delete - - $ gcloud alpha iot devices credentials delete - diff --git a/gcloud/beta/iot/devices/credentials/describe b/gcloud/beta/iot/devices/credentials/describe deleted file mode 100644 index 52a453b37..000000000 --- a/gcloud/beta/iot/devices/credentials/describe +++ /dev/null @@ -1,79 +0,0 @@ -NAME - gcloud beta iot devices credentials describe - show details about a - specific device credential - -SYNOPSIS - gcloud beta iot devices credentials describe INDEX - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Show details about a specific device credential. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To describe the first credential of a device in region 'us-central1', run: - - $ gcloud beta iot devices credentials describe \ - --region=us-central1 --registry=my-registry --device=my-device 0 - -POSITIONAL ARGUMENTS - INDEX - The index (zero-based) of the credential to describe. - -REQUIRED FLAGS - Device resource - The device to which the credential belongs. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices credentials describe - - $ gcloud alpha iot devices credentials describe - diff --git a/gcloud/beta/iot/devices/credentials/help b/gcloud/beta/iot/devices/credentials/help deleted file mode 100644 index 09b6f7b7d..000000000 --- a/gcloud/beta/iot/devices/credentials/help +++ /dev/null @@ -1,48 +0,0 @@ -NAME - gcloud beta iot devices credentials - manage credentials for Cloud IoT - devices - -SYNOPSIS - gcloud beta iot devices credentials COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Manage credentials for Cloud IoT devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing credentials for Google Cloud IoT devices. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - clear - (BETA) (DEPRECATED) Delete all credentials from a device. - - create - (BETA) (DEPRECATED) Add a new credential to a device. - - delete - (BETA) (DEPRECATED) Delete a credential from a device. - - describe - (BETA) (DEPRECATED) Show details about a specific device credential. - - list - (BETA) (DEPRECATED) List credentials for a device. - - update - (BETA) (DEPRECATED) Update a specific device credential. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices credentials - - $ gcloud alpha iot devices credentials - diff --git a/gcloud/beta/iot/devices/credentials/list b/gcloud/beta/iot/devices/credentials/list deleted file mode 100644 index 07ffa5d79..000000000 --- a/gcloud/beta/iot/devices/credentials/list +++ /dev/null @@ -1,94 +0,0 @@ -NAME - gcloud beta iot devices credentials list - list credentials for a device - -SYNOPSIS - gcloud beta iot devices credentials list - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--filter=EXPRESSION] [--limit=LIMIT] [--sort-by=[FIELD,...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) List credentials for a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To list the credentials of a device in region 'us-central1', run: - - $ gcloud beta iot devices credentials list --region=us-central1 \ - --registry=my-registry --device=my-device - -REQUIRED FLAGS - Device resource - The device for which to list credentials. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices credentials list - - $ gcloud alpha iot devices credentials list - diff --git a/gcloud/beta/iot/devices/credentials/update b/gcloud/beta/iot/devices/credentials/update deleted file mode 100644 index d24652a46..000000000 --- a/gcloud/beta/iot/devices/credentials/update +++ /dev/null @@ -1,86 +0,0 @@ -NAME - gcloud beta iot devices credentials update - update a specific device - credential - -SYNOPSIS - gcloud beta iot devices credentials update INDEX - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--expiration-time=EXPIRATION_TIME] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Update a specific device credential. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To update the expiration time of the first credential of a device in region - 'us-central1', run: - - $ gcloud beta iot devices credentials update --region=us-central1 \ - --registry=my-registry --device=my-device \ - --expiration-time=2020-12-30T10:50:22Z 0 - -POSITIONAL ARGUMENTS - INDEX - The index (zero-based) of the credential to update. - -REQUIRED FLAGS - Device resource - The device for which to update credentials. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -OPTIONAL FLAGS - --expiration-time=EXPIRATION_TIME - The expiration time for the key. See $ gcloud topic datetimes for - information on time formats. - -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 iot devices credentials update - - $ gcloud alpha iot devices credentials update - diff --git a/gcloud/beta/iot/devices/delete b/gcloud/beta/iot/devices/delete deleted file mode 100644 index dd26e430e..000000000 --- a/gcloud/beta/iot/devices/delete +++ /dev/null @@ -1,75 +0,0 @@ -NAME - gcloud beta iot devices delete - delete a device - -SYNOPSIS - gcloud beta iot devices delete - (DEVICE : --region=REGION --registry=REGISTRY) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - (BETA) (DEPRECATED) Delete a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete a device from device registry 'my-registry', run: - - $ gcloud beta iot devices delete my-device --region=us-central1 \ - --registry=my-registry - -POSITIONAL ARGUMENTS - Device resource - The device 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 device 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. - - DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument device on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices delete - - $ gcloud alpha iot devices delete - diff --git a/gcloud/beta/iot/devices/describe b/gcloud/beta/iot/devices/describe deleted file mode 100644 index 60f354e46..000000000 --- a/gcloud/beta/iot/devices/describe +++ /dev/null @@ -1,75 +0,0 @@ -NAME - gcloud beta iot devices describe - show details about a device - -SYNOPSIS - gcloud beta iot devices describe - (DEVICE : --region=REGION --registry=REGISTRY) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - (BETA) (DEPRECATED) Show details about a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To show details about a device, run: - - $ gcloud beta iot devices describe my-device --region=us-central1 \ - --registry=my-registry - -POSITIONAL ARGUMENTS - Device resource - The device 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 device 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. - - DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument device on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices describe - - $ gcloud alpha iot devices describe - diff --git a/gcloud/beta/iot/devices/gateways/bind b/gcloud/beta/iot/devices/gateways/bind deleted file mode 100644 index 323ed4330..000000000 --- a/gcloud/beta/iot/devices/gateways/bind +++ /dev/null @@ -1,123 +0,0 @@ -NAME - gcloud beta iot devices gateways bind - associate a device with a gateway - -SYNOPSIS - gcloud beta iot devices gateways bind - (--device=DEVICE - : --device-region=DEVICE_REGION --device-registry=DEVICE_REGISTRY) - (--gateway=GATEWAY : --gateway-region=GATEWAY_REGION - --gateway-registry=GATEWAY_REGISTRY) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Associate a device with a gateway. - -EXAMPLES - To associate 'my-device' with 'my-gateway' in region 'us-central1', run: - - $ gcloud beta iot devices gateways bind --device=my-device \ - --device-region=us-central1 --device-registry=my-registry \ - --gateway=my-gateway --gateway-region=us-central1 \ - --gateway-registry=my-registry - -REQUIRED FLAGS - Device resource - The device to bind to the gateway. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --device-region=DEVICE_REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --device-region on the command line. - - --device-registry=DEVICE_REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --device-registry on the command line; - ▸ provide the argument --gateway-registry on the command line. - - Gateway resource - The gateway device to bind to. 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 --gateway 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. - - --gateway=GATEWAY - ID of the gateway or fully qualified identifier for the gateway. - - To set the gateway attribute: - ▸ provide the argument --gateway on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --gateway-region=GATEWAY_REGION - The Cloud region for the gateway. - - To set the region attribute: - ▸ provide the argument --gateway on the command line with a fully - specified name; - ▸ provide the argument --gateway-region on the command line. - - --gateway-registry=GATEWAY_REGISTRY - The device registry for the gateway. - - To set the registry attribute: - ▸ provide the argument --gateway on the command line with a fully - specified name; - ▸ provide the argument --gateway-registry on the command line; - ▸ provide the argument --device-registry 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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices gateways bind - - $ gcloud alpha iot devices gateways bind - diff --git a/gcloud/beta/iot/devices/gateways/help b/gcloud/beta/iot/devices/gateways/help deleted file mode 100644 index 262577053..000000000 --- a/gcloud/beta/iot/devices/gateways/help +++ /dev/null @@ -1,38 +0,0 @@ -NAME - gcloud beta iot devices gateways - manage Cloud IoT Core Gateway - Associations - -SYNOPSIS - gcloud beta iot devices gateways COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Manage Cloud IoT Core Gateway Associations. - - This command is deprecated. Google Cloud IoT Core has been retired. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - bind - (BETA) (DEPRECATED) Associate a device with a gateway. - - list-bound-devices - (BETA) (DEPRECATED) Lists all of the devices bound to the gateway. - - unbind - (BETA) (DEPRECATED) Remove the association between a device and a - gateway. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices gateways - - $ gcloud alpha iot devices gateways - diff --git a/gcloud/beta/iot/devices/gateways/list-bound-devices b/gcloud/beta/iot/devices/gateways/list-bound-devices deleted file mode 100644 index 1703e1544..000000000 --- a/gcloud/beta/iot/devices/gateways/list-bound-devices +++ /dev/null @@ -1,103 +0,0 @@ -NAME - gcloud beta iot devices gateways list-bound-devices - lists all of the - devices bound to the gateway - -SYNOPSIS - gcloud beta iot devices gateways list-bound-devices --gateway=GATEWAY - (--registry=REGISTRY : --region=REGION) [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Lists all of the devices bound to the gateway. - -EXAMPLES - To list all of the devices bound to the gateway 'my-gateway' in region - 'us-central1' and in registry 'my-registry', run: - - $ gcloud beta iot devices gateways list-bound-devices \ - --gateway=my-gateway --region=us-central1 --registry=my-registry - -REQUIRED FLAGS - --gateway=GATEWAY - The gateway id or numeric id you want to list bound devices for. - - Registry resource - The registry you want to list bound devices 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - - --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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices gateways list-bound-devices - - $ gcloud alpha iot devices gateways list-bound-devices - diff --git a/gcloud/beta/iot/devices/gateways/unbind b/gcloud/beta/iot/devices/gateways/unbind deleted file mode 100644 index 08299b516..000000000 --- a/gcloud/beta/iot/devices/gateways/unbind +++ /dev/null @@ -1,125 +0,0 @@ -NAME - gcloud beta iot devices gateways unbind - remove the association between a - device and a gateway - -SYNOPSIS - gcloud beta iot devices gateways unbind - (--device=DEVICE - : --device-region=DEVICE_REGION --device-registry=DEVICE_REGISTRY) - (--gateway=GATEWAY : --gateway-region=GATEWAY_REGION - --gateway-registry=GATEWAY_REGISTRY) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Remove the association between a device and a gateway. - -EXAMPLES - To remove the association between 'my-device' and 'my-gateway' in region - 'us-central1', run: - - $ gcloud beta iot devices gateways unbind --device=my-device \ - --device-region=us-central1 --device-registry=my-registry \ - --gateway=my-gateway --gateway-region=us-central1 \ - --gateway-registry=my-registry - -REQUIRED FLAGS - Device resource - The device to unbind from the gateway. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --device-region=DEVICE_REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --device-region on the command line. - - --device-registry=DEVICE_REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --device-registry on the command line; - ▸ provide the argument --gateway-registry on the command line. - - Gateway resource - The gateway device to unbind 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 --gateway 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. - - --gateway=GATEWAY - ID of the gateway or fully qualified identifier for the gateway. - - To set the gateway attribute: - ▸ provide the argument --gateway on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --gateway-region=GATEWAY_REGION - The Cloud region for the gateway. - - To set the region attribute: - ▸ provide the argument --gateway on the command line with a fully - specified name; - ▸ provide the argument --gateway-region on the command line. - - --gateway-registry=GATEWAY_REGISTRY - The device registry for the gateway. - - To set the registry attribute: - ▸ provide the argument --gateway on the command line with a fully - specified name; - ▸ provide the argument --gateway-registry on the command line; - ▸ provide the argument --device-registry 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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices gateways unbind - - $ gcloud alpha iot devices gateways unbind - diff --git a/gcloud/beta/iot/devices/help b/gcloud/beta/iot/devices/help deleted file mode 100644 index 99f03e93d..000000000 --- a/gcloud/beta/iot/devices/help +++ /dev/null @@ -1,62 +0,0 @@ -NAME - gcloud beta iot devices - manage Cloud IoT Devices - -SYNOPSIS - gcloud beta iot devices GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Manage Cloud IoT Devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing Google Cloud IoT Devices. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -GROUPS - GROUP is one of the following: - - commands - (BETA) (DEPRECATED) Manage commands for Cloud IoT devices. - - configs - (BETA) (DEPRECATED) Manage configurations for Cloud IoT devices. - - credentials - (BETA) (DEPRECATED) Manage credentials for Cloud IoT devices. - - gateways - (BETA) (DEPRECATED) Manage Cloud IoT Core Gateway Associations. - - states - (BETA) (DEPRECATED) Manage states for Cloud IoT devices. - -COMMANDS - COMMAND is one of the following: - - create - (BETA) (DEPRECATED) Create a new device. - - delete - (BETA) (DEPRECATED) Delete a device. - - describe - (BETA) (DEPRECATED) Show details about a device. - - list - (BETA) (DEPRECATED) List devices. - - update - (BETA) (DEPRECATED) Update an existing device. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices - - $ gcloud alpha iot devices - diff --git a/gcloud/beta/iot/devices/list b/gcloud/beta/iot/devices/list deleted file mode 100644 index 4f7ba7135..000000000 --- a/gcloud/beta/iot/devices/list +++ /dev/null @@ -1,124 +0,0 @@ -NAME - gcloud beta iot devices list - list devices - -SYNOPSIS - gcloud beta iot devices list (--registry=REGISTRY : --region=REGION) - [--device-field-mask=DEVICE_FIELD_MASK; - default="blocked,gatewayConfig"] [--device-ids=[DEVICE_IDS,...]] - [--device-num-ids=[DEVICE_NUM_IDS,...]] [--device-type=DEVICE_TYPE] - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - List devices. - -EXAMPLES - To list all devices in the device registry 'my-registry' and region - 'us-central1', run: - - $ gcloud beta iot devices list --region=us-central1 \ - --registry=my-registry - -REQUIRED FLAGS - Registry resource - The registry you want to list the devices 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --device-field-mask=DEVICE_FIELD_MASK; default="blocked,gatewayConfig" - If given, returns all specified device fields instead of the default - set. The value is a comma-separated list of field names. Example: - "lastErrorStatus,config,metadata". See full list of device fields at: - https://cloud.google.com/iot/docs/reference/cloudiot/rest/v1/projects.locations.registries.devices - - --device-ids=[DEVICE_IDS,...] - If given, show only devices with one of the provided IDs. - - --device-num-ids=[DEVICE_NUM_IDS,...] - If given, show only devices with one of the provided numerical IDs. - - --device-type=DEVICE_TYPE - If specified, show only devices of that type. If left unspecified, show - devices of any type. DEVICE_TYPE must be one of: gateway, non-gateway. - -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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices list - - $ gcloud alpha iot devices list - diff --git a/gcloud/beta/iot/devices/states/help b/gcloud/beta/iot/devices/states/help deleted file mode 100644 index 738686af7..000000000 --- a/gcloud/beta/iot/devices/states/help +++ /dev/null @@ -1,32 +0,0 @@ -NAME - gcloud beta iot devices states - manage states for Cloud IoT devices - -SYNOPSIS - gcloud beta iot devices states COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Manage states for Cloud IoT devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing states for Google Cloud IoT devices. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - list - (BETA) (DEPRECATED) List states for a device. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices states - - $ gcloud alpha iot devices states - diff --git a/gcloud/beta/iot/devices/states/list b/gcloud/beta/iot/devices/states/list deleted file mode 100644 index fab13c8cc..000000000 --- a/gcloud/beta/iot/devices/states/list +++ /dev/null @@ -1,101 +0,0 @@ -NAME - gcloud beta iot devices states list - list states for a device - -SYNOPSIS - gcloud beta iot devices states list - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--filter=EXPRESSION] [--limit=LIMIT] [--sort-by=[FIELD,...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - (BETA) (DEPRECATED) List states for a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - - This command lists all available states in the history of the device. Up to - 10 are kept; you may restrict the output to fewer via the --limit flag. - -EXAMPLES - To list states for the device 'my-device' in region 'us-central1' and in - registry 'my-registry', run: - - $ gcloud beta iot devices states list --device=my-device \ - --region=us-central1 --registry=my-registry - -REQUIRED FLAGS - Device resource - The device for which to list configs. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot devices states list - - $ gcloud alpha iot devices states list - diff --git a/gcloud/beta/iot/devices/update b/gcloud/beta/iot/devices/update deleted file mode 100644 index f1e20e670..000000000 --- a/gcloud/beta/iot/devices/update +++ /dev/null @@ -1,139 +0,0 @@ -NAME - gcloud beta iot devices update - update an existing device - -SYNOPSIS - gcloud beta iot devices update - (DEVICE : --region=REGION --registry=REGISTRY) - [--auth-method=AUTH_METHOD] [--blocked] [--log-level=LOG_LEVEL] - [--metadata=[KEY=VALUE,...]] [--metadata-from-file=[KEY=PATH,...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - (BETA) (DEPRECATED) Update an existing device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - The following command updates the device 'my-device' in device registry - 'my-registry' in region 'us-central1'. It blocks the device and sets - metadata values. - - $ gcloud beta iot devices update my-device --region=us-central1 \ - --registry=my-registry --blocked \ - --metadata=key1=value1,key2=value2 - -POSITIONAL ARGUMENTS - Device resource - The device 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 device 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. - - DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument device on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -FLAGS - --auth-method=AUTH_METHOD - The authorization/authentication method used by devices in relation to - the gateway. This property is set only on gateways. If left - unspecified, devices will not be able to access the gateway. - AUTH_METHOD must be one of: - - association-and-device-auth-token - The device is authenticated through both device credentials and - gateway association. - association-only - The device is authenticated through the gateway association only. - Device credentials are ignored if provided. - device-auth-token-only - The device is authenticated through its own credentials. Gateway - association is not checked. - - --blocked - If blocked, connections from this device will fail. - - Can be used to temporarily prevent the device from connecting if, for - example, the sensor is generating bad data and needs maintenance. - - Use --no-blocked to enable connections and --blocked to disable. - - --log-level=LOG_LEVEL - The default logging verbosity for activity from devices in this - registry. The verbosity level can be overridden by setting a specific - device's log level. - - LOG_LEVEL must be one of: - - debug - All events will be logged - error - Error events will be logged. - info - Informational events will be logged, such as connections and - disconnections. Also includes error events. - none - Disables logging. - - --metadata=[KEY=VALUE,...] - The metadata key/value pairs assigned to devices. This metadata is not - interpreted or indexed by Cloud IoT Core. It can be used to add - contextual information for the device. - - Keys should only contain the following characters [a-zA-Z0-9-_] and be - fewer than 128 bytes in length. Values are free-form strings. Each - value must be fewer than or equal to 32 KB in size. - - The total size of all keys and values must be less than 256 KB, and the - maximum number of key-value pairs is 500. - - --metadata-from-file=[KEY=PATH,...] - Same as --metadata, but the metadata values will be read from the file - specified by path. - -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 iot devices update - - $ gcloud alpha iot devices update - diff --git a/gcloud/beta/iot/help b/gcloud/beta/iot/help deleted file mode 100644 index fe2daedd0..000000000 --- a/gcloud/beta/iot/help +++ /dev/null @@ -1,35 +0,0 @@ -NAME - gcloud beta iot - manage Cloud IoT resources - -SYNOPSIS - gcloud beta iot GROUP [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Manage Cloud IoT resources. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing Google Cloud IoT resources. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -GROUPS - GROUP is one of the following: - - devices - (BETA) (DEPRECATED) Manage Cloud IoT Devices. - - registries - (BETA) (DEPRECATED) Manage Cloud IoT Registries. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot - - $ gcloud alpha iot - diff --git a/gcloud/beta/iot/registries/add-iam-policy-binding b/gcloud/beta/iot/registries/add-iam-policy-binding deleted file mode 100644 index b9e9b472b..000000000 --- a/gcloud/beta/iot/registries/add-iam-policy-binding +++ /dev/null @@ -1,97 +0,0 @@ -NAME - gcloud beta iot registries add-iam-policy-binding - add IAM policy binding - to a device registry - -SYNOPSIS - gcloud beta iot registries add-iam-policy-binding - (REGISTRY : --region=REGION) --member=PRINCIPAL --role=ROLE - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Add an IAM policy binding to a device registry. - -EXAMPLES - To add an IAM policy binding for the role of 'roles/editor' for the user - 'test-user@gmail.com' with registry 'my-registry' and region 'us-central1', - run: - - $ gcloud beta iot registries add-iam-policy-binding my-registry \ - --region='us-central1' --member='user:test-user@gmail.com' \ - --role='roles/editor' - - See https://cloud.google.com/iam/docs/managing-policies for details of - policy role and member types. - -POSITIONAL ARGUMENTS - Registry resource - The device registry for which to add IAM policy - binding to. 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - -REQUIRED FLAGS - --member=PRINCIPAL - The principal to add the binding for. Should be of the form - user|group|serviceAccount:email or domain:domain. - - Examples: user:test-user@gmail.com, group:admins@example.com, - serviceAccount:test123@example.domain.com, or - domain:example.domain.com. - - Some resources also accept the following special values: - ◆ allUsers - Special identifier that represents anyone who is on the - internet, with or without a Google account. - ◆ allAuthenticatedUsers - Special identifier that represents anyone - who is authenticated with a Google account or a service account. - - --role=ROLE - Role name to assign to the principal. The role name is the complete - path of a predefined role, such as roles/logging.viewer, or the role ID - for a custom role, such as - organizations/{ORGANIZATION_ID}/roles/logging.viewer. - -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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in beta and might change without notice. This - variant is also available: - - $ gcloud alpha iot registries add-iam-policy-binding - diff --git a/gcloud/beta/iot/registries/create b/gcloud/beta/iot/registries/create deleted file mode 100644 index 8426baba7..000000000 --- a/gcloud/beta/iot/registries/create +++ /dev/null @@ -1,127 +0,0 @@ -NAME - gcloud beta iot registries create - create a new device registry - -SYNOPSIS - gcloud beta iot registries create (REGISTRY : --region=REGION) - [--no-enable-http-config] [--no-enable-mqtt-config] - [--event-notification-config=[subfolder=SUBFOLDER],[topic=TOPIC]] - [--log-level=LOG_LEVEL] [--public-key-path=PUBLIC_KEY_PATH] - [--state-pubsub-topic=STATE_PUBSUB_TOPIC] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Create a new device registry. - -EXAMPLES - To create a new device registry 'my-registry' in region 'us-central1', run: - - $ gcloud beta iot registries create --region=us-central1 my-registry - - The following command creates a new device registry 'my-registry' in region - 'us-central1', enables MQTT and HTTP connections, and sets - 'pubsub-topic-name' as the Cloud Pub/Sub topic for state notifications. - - $ gcloud beta iot registries create my-registry \ - --region=us-central1 --enable-http-config --enable-mqtt-config \ - --state-pubsub-topic=pubsub-topic-name - -POSITIONAL ARGUMENTS - Registry resource - The registry you want 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --enable-http-config - Whether to allow device connections to the HTTP bridge. Enabled by - default, use --no-enable-http-config to disable. - - --enable-mqtt-config - Whether to allow MQTT connections to this device registry. Enabled by - default, use --no-enable-mqtt-config to disable. - - --event-notification-config=[subfolder=SUBFOLDER],[topic=TOPIC] - The configuration for notification of telemetry events received from - the device. This flag can be specified multiple times to add multiple - configs to the device registry. Configs are added to the registry in - the order the flags are specified. Only one config with an empty - subfolder field is allowed and must be specified last. - - topic - A Google Cloud Pub/Sub topic name for event notifications - - subfolder - If the subfolder name matches this string exactly, this - configuration will be used to publish telemetry events. If empty - all strings are matched. - - --log-level=LOG_LEVEL - The default logging verbosity for activity from devices in this - registry. The verbosity level can be overridden by setting a specific - device's log level. LOG_LEVEL must be one of: - - debug - All events will be logged. - error - Error events will be logged. - info - Informational events will be logged, such as connections and - disconnections. Also includes error events. - none - Disables logging. - - --public-key-path=PUBLIC_KEY_PATH - Path to a file containing an X.509v3 certificate (RFC5280 - (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped - by -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----. - - --state-pubsub-topic=STATE_PUBSUB_TOPIC - A Google Cloud Pub/Sub topic name for state notifications. - -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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot registries create - - $ gcloud alpha iot registries create - diff --git a/gcloud/beta/iot/registries/credentials/clear b/gcloud/beta/iot/registries/credentials/clear deleted file mode 100644 index 28bc7c501..000000000 --- a/gcloud/beta/iot/registries/credentials/clear +++ /dev/null @@ -1,66 +0,0 @@ -NAME - gcloud beta iot registries credentials clear - delete all credentials from - a registry - -SYNOPSIS - gcloud beta iot registries credentials clear - (--registry=REGISTRY : --region=REGION) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Delete all credentials from a registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete all credentials from a registry in region 'us-central1', run: - - $ gcloud beta iot registries credentials clear \ - --region=us-central1 --registry=my-registry - -REQUIRED FLAGS - Registry resource - The device registry for which to clear credentials. - 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot registries credentials clear - - $ gcloud alpha iot registries credentials clear - diff --git a/gcloud/beta/iot/registries/credentials/create b/gcloud/beta/iot/registries/credentials/create deleted file mode 100644 index 837e3731a..000000000 --- a/gcloud/beta/iot/registries/credentials/create +++ /dev/null @@ -1,77 +0,0 @@ -NAME - gcloud beta iot registries credentials create - add a new credential to a - registry - -SYNOPSIS - gcloud beta iot registries credentials create --path=PATH - (--registry=REGISTRY : --region=REGION) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - (BETA) (DEPRECATED) Add a new credential to a registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - - A registry may have at most 10 credentials. - -EXAMPLES - To add a credential located in '/path/to/cert.pem' to a registry, run: - - $ gcloud beta iot registries credentials create \ - --region=us-central1 --registry=my-registry \ - --path=/path/to/cert.pem - -REQUIRED FLAGS - --path=PATH - Path to a file containing an X.509v3 certificate (RFC5280 - (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped - by -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----. - - Registry resource - The device registry for which to create credentials. - 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot registries credentials create - - $ gcloud alpha iot registries credentials create - diff --git a/gcloud/beta/iot/registries/credentials/delete b/gcloud/beta/iot/registries/credentials/delete deleted file mode 100644 index ccb18109d..000000000 --- a/gcloud/beta/iot/registries/credentials/delete +++ /dev/null @@ -1,70 +0,0 @@ -NAME - gcloud beta iot registries credentials delete - delete a credential from a - registry - -SYNOPSIS - gcloud beta iot registries credentials delete INDEX - (--registry=REGISTRY : --region=REGION) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Delete a credential from a registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete the first credential from a registry, run: - - $ gcloud beta iot registries credentials delete \ - --region=us-central1 --registry=my-registry 0 - -POSITIONAL ARGUMENTS - INDEX - The index (zero-based) of the credential to delete. - -REQUIRED FLAGS - Registry resource - The device registry from which to delete credentials. - 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot registries credentials delete - - $ gcloud alpha iot registries credentials delete - diff --git a/gcloud/beta/iot/registries/credentials/describe b/gcloud/beta/iot/registries/credentials/describe deleted file mode 100644 index 5dd0ed348..000000000 --- a/gcloud/beta/iot/registries/credentials/describe +++ /dev/null @@ -1,71 +0,0 @@ -NAME - gcloud beta iot registries credentials describe - show details about a - specific registry credential - -SYNOPSIS - gcloud beta iot registries credentials describe INDEX - (--registry=REGISTRY : --region=REGION) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Show details about a specific registry credential. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To describe the first credential of a registry in region 'us-central1', - run: - - $ gcloud beta iot registries credentials describe \ - --region=us-central1 --registry=my-registry 0 - -POSITIONAL ARGUMENTS - INDEX - The index (zero-based) of the credential to describe. - -REQUIRED FLAGS - Registry resource - The device registry to which the credential belongs. - 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot registries credentials describe - - $ gcloud alpha iot registries credentials describe - diff --git a/gcloud/beta/iot/registries/credentials/help b/gcloud/beta/iot/registries/credentials/help deleted file mode 100644 index 232072e87..000000000 --- a/gcloud/beta/iot/registries/credentials/help +++ /dev/null @@ -1,45 +0,0 @@ -NAME - gcloud beta iot registries credentials - manage credentials for Cloud IoT - devices - -SYNOPSIS - gcloud beta iot registries credentials COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Manage credentials for Cloud IoT devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing credentials for Google Cloud IoT devices. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - clear - (BETA) (DEPRECATED) Delete all credentials from a registry. - - create - (BETA) (DEPRECATED) Add a new credential to a registry. - - delete - (BETA) (DEPRECATED) Delete a credential from a registry. - - describe - (BETA) (DEPRECATED) Show details about a specific registry credential. - - list - (BETA) (DEPRECATED) List credentials for a registry. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot registries credentials - - $ gcloud alpha iot registries credentials - diff --git a/gcloud/beta/iot/registries/credentials/list b/gcloud/beta/iot/registries/credentials/list deleted file mode 100644 index 8dcfabd43..000000000 --- a/gcloud/beta/iot/registries/credentials/list +++ /dev/null @@ -1,86 +0,0 @@ -NAME - gcloud beta iot registries credentials list - list credentials for a - registry - -SYNOPSIS - gcloud beta iot registries credentials list - (--registry=REGISTRY : --region=REGION) [--filter=EXPRESSION] - [--limit=LIMIT] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) List credentials for a registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To list the credentials of a registry, run: - - $ gcloud beta iot registries credentials list --region=us-central1 \ - --registry=my-registry - -REQUIRED FLAGS - Registry resource - The device registry for which to list credentials. 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot registries credentials list - - $ gcloud alpha iot registries credentials list - diff --git a/gcloud/beta/iot/registries/delete b/gcloud/beta/iot/registries/delete deleted file mode 100644 index b7eaad3d3..000000000 --- a/gcloud/beta/iot/registries/delete +++ /dev/null @@ -1,67 +0,0 @@ -NAME - gcloud beta iot registries delete - delete a device registry - -SYNOPSIS - gcloud beta iot registries delete (REGISTRY : --region=REGION) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - (BETA) (DEPRECATED) Delete a device registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete a device registry, run: - - $ gcloud beta iot registries delete my-registry --region=us-central1 - -POSITIONAL ARGUMENTS - Registry resource - The device registry 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot registries delete - - $ gcloud alpha iot registries delete - diff --git a/gcloud/beta/iot/registries/describe b/gcloud/beta/iot/registries/describe deleted file mode 100644 index 1dd9e45de..000000000 --- a/gcloud/beta/iot/registries/describe +++ /dev/null @@ -1,68 +0,0 @@ -NAME - gcloud beta iot registries describe - show details about a device registry - -SYNOPSIS - gcloud beta iot registries describe (REGISTRY : --region=REGION) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - (BETA) (DEPRECATED) Show details about a device registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To show details about a device registry, run: - - $ gcloud beta iot registries describe my-registry \ - --region=us-central1 - -POSITIONAL ARGUMENTS - Registry resource - The device registry 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot registries describe - - $ gcloud alpha iot registries describe - diff --git a/gcloud/beta/iot/registries/get-iam-policy b/gcloud/beta/iot/registries/get-iam-policy deleted file mode 100644 index 4559cd801..000000000 --- a/gcloud/beta/iot/registries/get-iam-policy +++ /dev/null @@ -1,102 +0,0 @@ -NAME - gcloud beta iot registries get-iam-policy - get the IAM policy for a device - registry - -SYNOPSIS - gcloud beta iot registries get-iam-policy (REGISTRY : --region=REGION) - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - (BETA) (DEPRECATED) Get the IAM policy for a device registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - - This command gets the IAM policy for a device registry. If formatted as - JSON, the output can be edited and used as a policy file for - set-iam-policy. The output includes an "etag" field identifying the version - emitted and allowing detection of concurrent policy updates; see $ gcloud - iot registries set-iam-policy for additional details. - -EXAMPLES - To print the IAM policy for a given device registry, run: - - $ gcloud beta iot registries get-iam-policy --region=us-central1 \ - my-registry - -POSITIONAL ARGUMENTS - Registry resource - The device registry for which to get IAM policy. 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - - --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. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot registries get-iam-policy - - $ gcloud alpha iot registries get-iam-policy - diff --git a/gcloud/beta/iot/registries/help b/gcloud/beta/iot/registries/help deleted file mode 100644 index fadd87411..000000000 --- a/gcloud/beta/iot/registries/help +++ /dev/null @@ -1,62 +0,0 @@ -NAME - gcloud beta iot registries - manage Cloud IoT Registries - -SYNOPSIS - gcloud beta iot registries GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) Manage Cloud IoT Registries. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing Google Cloud IoT Registries. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -GROUPS - GROUP is one of the following: - - credentials - (BETA) (DEPRECATED) Manage credentials for Cloud IoT devices. - -COMMANDS - COMMAND is one of the following: - - add-iam-policy-binding - (BETA) (DEPRECATED) Add IAM policy binding to a device registry. - - create - (BETA) (DEPRECATED) Create a new device registry. - - delete - (BETA) (DEPRECATED) Delete a device registry. - - describe - (BETA) (DEPRECATED) Show details about a device registry. - - get-iam-policy - (BETA) (DEPRECATED) Get the IAM policy for a device registry. - - list - (BETA) (DEPRECATED) List device registries. - - remove-iam-policy-binding - (BETA) (DEPRECATED) Remove IAM policy binding of a device registry. - - set-iam-policy - (BETA) (DEPRECATED) Set IAM policy for a device registry. - - update - (BETA) (DEPRECATED) Update a device registry. - -NOTES - This command is currently in beta and might change without notice. These - variants are also available: - - $ gcloud iot registries - - $ gcloud alpha iot registries - diff --git a/gcloud/beta/iot/registries/list b/gcloud/beta/iot/registries/list deleted file mode 100644 index 540ba7ad8..000000000 --- a/gcloud/beta/iot/registries/list +++ /dev/null @@ -1,88 +0,0 @@ -NAME - gcloud beta iot registries list - list device registries - -SYNOPSIS - gcloud beta iot registries list --region=REGION [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - (BETA) (DEPRECATED) List device registries. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To list all device registries in a project and region 'us-central1', run: - - $ gcloud beta iot registries list --region=us-central1 - -REQUIRED FLAGS - Region resource - The Cloud region to list registries 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 --region 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. - - --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. - -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 beta and might change without notice. These - variants are also available: - - $ gcloud iot registries list - - $ gcloud alpha iot registries list - diff --git a/gcloud/beta/iot/registries/remove-iam-policy-binding b/gcloud/beta/iot/registries/remove-iam-policy-binding deleted file mode 100644 index 4b8cfda9f..000000000 --- a/gcloud/beta/iot/registries/remove-iam-policy-binding +++ /dev/null @@ -1,98 +0,0 @@ -NAME - gcloud beta iot registries remove-iam-policy-binding - remove IAM policy - binding of a device registry - -SYNOPSIS - gcloud beta iot registries remove-iam-policy-binding - (REGISTRY : --region=REGION) --member=PRINCIPAL --role=ROLE - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - Remove an IAM policy binding of a device registry. - -EXAMPLES - To Remove an IAM policy binding for the role of 'roles/editor' for the user - 'test-user@gmail.com' with registry 'my-registry' and region 'us-central1', - run: - - $ gcloud beta iot registries remove-iam-policy-binding my-registry \ - --region='us-central1' --member='user:test-user@gmail.com' \ - --role='roles/editor' - - See https://cloud.google.com/iam/docs/managing-policies for details of - policy role and member types. - -POSITIONAL ARGUMENTS - Registry resource - The device registry for which to remove IAM policy - binding 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - -REQUIRED FLAGS - --member=PRINCIPAL - The principal to remove the binding for. Should be of the form - user|group|serviceAccount:email or domain:domain. - - Examples: user:test-user@gmail.com, group:admins@example.com, - serviceAccount:test123@example.domain.com, or - domain:example.domain.com. - - Deleted principals have an additional deleted: prefix and a ?uid=UID - suffix, where UID is a unique identifier for the principal. Example: - deleted:user:test-user@gmail.com?uid=123456789012345678901. - - Some resources also accept the following special values: - ◆ allUsers - Special identifier that represents anyone who is on the - internet, with or without a Google account. - ◆ allAuthenticatedUsers - Special identifier that represents anyone - who is authenticated with a Google account or a service account. - - --role=ROLE - The role to remove the principal from. - -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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - This command is currently in beta and might change without notice. This - variant is also available: - - $ gcloud alpha iot registries remove-iam-policy-binding - diff --git a/gcloud/beta/iot/registries/set-iam-policy b/gcloud/beta/iot/registries/set-iam-policy deleted file mode 100644 index 7f4a3642f..000000000 --- a/gcloud/beta/iot/registries/set-iam-policy +++ /dev/null @@ -1,85 +0,0 @@ -NAME - gcloud beta iot registries set-iam-policy - set IAM policy for a device - registry - -SYNOPSIS - gcloud beta iot registries set-iam-policy (REGISTRY : --region=REGION) - POLICY_FILE [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - (BETA) (DEPRECATED) Set IAM policy for a device registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - - This command replaces the existing IAM policy for a device registry, given - a REGISTRY and a file encoded in JSON or YAML that contains the IAM policy. - If the given policy file specifies an "etag" value, then the replacement - will succeed only if the policy already in place matches that etag. (An - etag obtained via $ gcloud iot registries get-iam-policy will prevent the - replacement if the policy for the device registry has been subsequently - updated.) A policy file that does not contain an etag value will replace - any existing policy for the device registry. - -EXAMPLES - The following command will read an IAM policy from 'policy.json' and set it - for a device registry with 'my-registry' as the identifier: - - $ gcloud beta iot registries set-iam-policy --region=us-central1 \ - my-registry policy.json - - See https://cloud.google.com/iam/docs/managing-policies for details of the - policy file format and contents. - -POSITIONAL ARGUMENTS - Registry resource - The device registry for which to set IAM policy. 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - POLICY_FILE - JSON or YAML file with the IAM policy - -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 iot registries set-iam-policy - - $ gcloud alpha iot registries set-iam-policy - diff --git a/gcloud/beta/iot/registries/update b/gcloud/beta/iot/registries/update deleted file mode 100644 index 4a9f30019..000000000 --- a/gcloud/beta/iot/registries/update +++ /dev/null @@ -1,116 +0,0 @@ -NAME - gcloud beta iot registries update - update a device registry - -SYNOPSIS - gcloud beta iot registries update (REGISTRY : --region=REGION) - [--enable-http-config] [--enable-mqtt-config] - [--event-notification-config=[subfolder=SUBFOLDER],[topic=TOPIC]] - [--log-level=LOG_LEVEL] [--state-pubsub-topic=STATE_PUBSUB_TOPIC] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (BETA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - (BETA) (DEPRECATED) Update a device registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - The following command updates the device registry 'my-registry' in region - 'us-central1'. It enables MQTT and HTTP connections and sets - 'pubsub-topic-name' as the Cloud Pub/Sub topic for state notifications. - - $ gcloud beta iot registries update my-registry \ - --region=us-central1 --enable-http-config --enable-mqtt-config \ - --state-pubsub-topic=pubsub-topic-name - -POSITIONAL ARGUMENTS - Registry resource - The device registry 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --enable-http-config - Whether to allow device connections to the HTTP bridge. - - --enable-mqtt-config - Whether to allow MQTT connections to this device registry. - - --event-notification-config=[subfolder=SUBFOLDER],[topic=TOPIC] - The configuration for notification of telemetry events received from - the device. This flag can be specified multiple times to add multiple - configs to the device registry. Configs are added to the registry in - the order the flags are specified. Only one config with an empty - subfolder field is allowed and must be specified last. - - topic - A Google Cloud Pub/Sub topic name for event notifications - - subfolder - If the subfolder name matches this string exactly, this - configuration will be used to publish telemetry events. If empty - all strings are matched. - - --log-level=LOG_LEVEL - The default logging verbosity for activity from devices in this - registry. The verbosity level can be overridden by setting a specific - device's log level. - - LOG_LEVEL must be one of: - - debug - All events will be logged - error - Error events will be logged. - info - Informational events will be logged, such as connections and - disconnections. Also includes error events. - none - Disables logging. - - --state-pubsub-topic=STATE_PUBSUB_TOPIC - A Google Cloud Pub/Sub topic name for state notifications. - -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 iot registries update - - $ gcloud alpha iot registries update - diff --git a/gcloud/beta/logging/settings/update b/gcloud/beta/logging/settings/update index 88144c869..e7ed750d1 100644 --- a/gcloud/beta/logging/settings/update +++ b/gcloud/beta/logging/settings/update @@ -12,8 +12,9 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Use this command to update the --kms-key-name, --storage-location - and --disable-default-sink associated with the Cloud Logging Logs Router. + (BETA) Use this command to update the --kms-key-name, --storage-location, + --disable-default-sink and --analytics-mode associated with the Cloud + Logging Logs Router. The Cloud KMS key must already exist and Cloud Logging must have permission to access it. @@ -58,6 +59,12 @@ EXAMPLES $ gcloud beta logging settings update \ --organization=[ORGANIZATION_ID] --disable-default-sink=false + To enable analytics for the log buckets under an organization, run: + + $ gcloud beta logging settings update \ + --organization=[ORGANIZATION_ID] --disable-default-sink=false \ + --analytics-mode=enabled + REQUIRED FLAGS Exactly one of these must be specified: diff --git a/gcloud/beta/monitoring/uptime/create b/gcloud/beta/monitoring/uptime/create index 4fcbebf6e..9de90641f 100644 --- a/gcloud/beta/monitoring/uptime/create +++ b/gcloud/beta/monitoring/uptime/create @@ -12,7 +12,8 @@ SYNOPSIS --custom-content-type=CUSTOM_CONTENT_TYPE --headers=[KEY=VALUE,...] --mask-headers=MASK_HEADERS --password=PASSWORD --path=PATH --pings-count=PINGS_COUNT --port=PORT --protocol=PROTOCOL - --request-method=REQUEST_METHOD --username=USERNAME + --request-method=REQUEST_METHOD + --service-agent-auth=SERVICE_AGENT_AUTH --username=USERNAME --validate-ssl=VALIDATE_SSL --status-classes=[status-class,...] | --status-codes=[status-code,...]] [--matcher-content=MATCHER_CONTENT @@ -175,6 +176,17 @@ OPTIONAL FLAGS post HTTP POST method + Uptime check service agent authorization. + + --service-agent-auth=SERVICE_AGENT_AUTH + The type of authentication to use for the HTTP request. Can only be + set if --protocol is https. + + SERVICE_AGENT_AUTH must be (only one value is supported): + + oidc-token + OIDC Token authentication + --username=USERNAME The username to use when authenticating with the HTTP server. Can only be set if --protocol is http or https. diff --git a/gcloud/beta/monitoring/uptime/update b/gcloud/beta/monitoring/uptime/update index b7034b251..388e96019 100644 --- a/gcloud/beta/monitoring/uptime/update +++ b/gcloud/beta/monitoring/uptime/update @@ -7,7 +7,8 @@ SYNOPSIS [--body=BODY --content-type=CONTENT_TYPE --custom-content-type=CUSTOM_CONTENT_TYPE --mask-headers=MASK_HEADERS --password=PASSWORD --path=PATH --pings-count=PINGS_COUNT --port=PORT - --request-method=REQUEST_METHOD --username=USERNAME + --request-method=REQUEST_METHOD + --service-agent-auth=SERVICE_AGENT_AUTH --username=USERNAME --validate-ssl=VALIDATE_SSL --add-status-classes=[status-class,...] | --clear-status-classes=CLEAR_STATUS_CLASSES | --remove-status-classes=[status-class,...] @@ -120,6 +121,17 @@ FLAGS post HTTP POST method + Uptime check service agent authorization. + + --service-agent-auth=SERVICE_AGENT_AUTH + The type of authentication to use for the HTTP request. Can only be + set if --protocol is https. + + SERVICE_AGENT_AUTH must be (only one value is supported): + + oidc-token + OIDC Token authentication + --username=USERNAME The username to use when authenticating with the HTTP server. Can only be set if --protocol is http or https. diff --git a/gcloud/beta/netapp/storage-pools/create b/gcloud/beta/netapp/storage-pools/create index c3617aeff..6e0f0800f 100644 --- a/gcloud/beta/netapp/storage-pools/create +++ b/gcloud/beta/netapp/storage-pools/create @@ -99,16 +99,20 @@ REQUIRED FLAGS extreme Extreme Service Level for Cloud NetApp Storage Pool. The Extreme - Service Level has a throughput per TiB of allocated volume size of - 128 MiB/s. + Service Level has a throughput per GiB of allocated volume size of + 128 KiB/s. + flex + Flex Service Level for Cloud NetApp Storage Pool. The Flex Service + Level has a throughput per GiB of allocated volume size of 16 + KiB/s. premium Premium Service Level for Cloud NetApp Storage Pool. The Premium - Service Level has a throughput per TiB of allocated volume size of - 64 MiB/s. + Service Level has a throughput per GiB of allocated volume size of + 64 KiB/s. standard Standard Service Level for Cloud NetApp Storage Pool. The Standard - Service Level has a throughput per TiB of allocated volume size of - 128 MiB/s. + Service Level has a throughput per GiB of allocated volume size of + 16 KiB/s. OPTIONAL FLAGS Active directory resource - The Active Directory to attach to the Storage diff --git a/gcloud/beta/network-services/service-lb-policies/create b/gcloud/beta/network-services/service-lb-policies/create index f90f05f3b..d89ae16c9 100644 --- a/gcloud/beta/network-services/service-lb-policies/create +++ b/gcloud/beta/network-services/service-lb-policies/create @@ -110,8 +110,10 @@ API REFERENCE for this API can be found at: https://cloud.google.com/networking NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud network-services service-lb-policies create $ gcloud alpha network-services service-lb-policies create diff --git a/gcloud/beta/network-services/service-lb-policies/delete b/gcloud/beta/network-services/service-lb-policies/delete index 49930e348..a6678afb2 100644 --- a/gcloud/beta/network-services/service-lb-policies/delete +++ b/gcloud/beta/network-services/service-lb-policies/delete @@ -66,8 +66,10 @@ API REFERENCE for this API can be found at: https://cloud.google.com/networking NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud network-services service-lb-policies delete $ gcloud alpha network-services service-lb-policies delete diff --git a/gcloud/beta/network-services/service-lb-policies/describe b/gcloud/beta/network-services/service-lb-policies/describe index 3734035e6..1bb77e5cf 100644 --- a/gcloud/beta/network-services/service-lb-policies/describe +++ b/gcloud/beta/network-services/service-lb-policies/describe @@ -60,8 +60,10 @@ API REFERENCE for this API can be found at: https://cloud.google.com/networking NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud network-services service-lb-policies describe $ gcloud alpha network-services service-lb-policies describe diff --git a/gcloud/beta/network-services/service-lb-policies/export b/gcloud/beta/network-services/service-lb-policies/export index a7d0c0de4..4ea484a2a 100644 --- a/gcloud/beta/network-services/service-lb-policies/export +++ b/gcloud/beta/network-services/service-lb-policies/export @@ -71,8 +71,10 @@ API REFERENCE for this API can be found at: https://cloud.google.com/networking NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud network-services service-lb-policies export $ gcloud alpha network-services service-lb-policies export diff --git a/gcloud/beta/network-services/service-lb-policies/help b/gcloud/beta/network-services/service-lb-policies/help index 2317a74eb..4d7895f2b 100644 --- a/gcloud/beta/network-services/service-lb-policies/help +++ b/gcloud/beta/network-services/service-lb-policies/help @@ -39,8 +39,10 @@ COMMANDS (BETA) Update a service LB policy. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud network-services service-lb-policies $ gcloud alpha network-services service-lb-policies diff --git a/gcloud/beta/network-services/service-lb-policies/import b/gcloud/beta/network-services/service-lb-policies/import index 02c7e70e4..304a5e915 100644 --- a/gcloud/beta/network-services/service-lb-policies/import +++ b/gcloud/beta/network-services/service-lb-policies/import @@ -78,8 +78,10 @@ API REFERENCE for this API can be found at: https://cloud.google.com/networking NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud network-services service-lb-policies import $ gcloud alpha network-services service-lb-policies import diff --git a/gcloud/beta/network-services/service-lb-policies/list b/gcloud/beta/network-services/service-lb-policies/list index 3f87aa9d8..80973ee00 100644 --- a/gcloud/beta/network-services/service-lb-policies/list +++ b/gcloud/beta/network-services/service-lb-policies/list @@ -81,8 +81,10 @@ API REFERENCE for this API can be found at: https://cloud.google.com/networking NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud network-services service-lb-policies list $ gcloud alpha network-services service-lb-policies list diff --git a/gcloud/beta/network-services/service-lb-policies/update b/gcloud/beta/network-services/service-lb-policies/update index 0f9d10686..0175d4d46 100644 --- a/gcloud/beta/network-services/service-lb-policies/update +++ b/gcloud/beta/network-services/service-lb-policies/update @@ -109,8 +109,10 @@ API REFERENCE for this API can be found at: https://cloud.google.com/networking NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud network-services service-lb-policies update $ gcloud alpha network-services service-lb-policies update diff --git a/gcloud/beta/pam/check-onboarding-status b/gcloud/beta/pam/check-onboarding-status new file mode 100644 index 000000000..134190639 --- /dev/null +++ b/gcloud/beta/pam/check-onboarding-status @@ -0,0 +1,96 @@ +NAME + gcloud beta pam check-onboarding-status - check Privileged Access Manager + onboarding status for a resource + +SYNOPSIS + gcloud beta pam check-onboarding-status + (--location=LOCATION : --folder=FOLDER --organization=ORGANIZATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Check Privileged Access Manager (PAM) onboarding status for a + project/organization/folder location. + +EXAMPLES + The following command checks the PAM onboarding status for a project + sample-project and location global: + + $ gcloud beta pam check-onboarding-status --project=sample-project \ + --location=global + + The following command checks the PAM onboarding status for a folder + sample-folder and location global: + + $ gcloud beta pam check-onboarding-status --folder=sample-folder \ + --location=global + + The following command checks the PAM onboarding status for an organization + sample-organization and location global: + + $ gcloud beta pam check-onboarding-status \ + --organization=sample-organization --location=global + +REQUIRED FLAGS + Location resource - The project/organization/folder location for which the + onboarding status is to be checked. 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 --location on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: [privilegedaccessmanager.projects.locations, + privilegedaccessmanager.folders.locations, + privilegedaccessmanager.organizations.locations]. + + 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. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations]. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations]. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam check-onboarding-status + diff --git a/gcloud/beta/pam/entitlements/create b/gcloud/beta/pam/entitlements/create new file mode 100644 index 000000000..4a24953b5 --- /dev/null +++ b/gcloud/beta/pam/entitlements/create @@ -0,0 +1,123 @@ +NAME + gcloud beta pam entitlements create - create a new Privileged Access + Manager entitlement + +SYNOPSIS + gcloud beta pam entitlements create + (ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + --entitlement-file=ENTITLEMENT_FILE [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a new Privileged Access Manager (PAM) entitlement under a + project/folder/organization location. + +EXAMPLES + The following command creates a new entitlement with the name + sample-entitlement, under a project sample-project, location global and the + entitlement body present in the sample-entitlement.yaml file: + + $ gcloud beta pam entitlements create sample-entitlement \ + --project=sample-project --location=global \ + --entitlement-file=sample-entitlement.yaml + + The following command creates a new entitlement with the name + sample-entitlement, under a folder sample-folder, location global and the + entitlement body present in the sample-entitlement.yaml file: + + $ gcloud beta pam entitlements create sample-entitlement \ + --folder=sample-folder --location=global \ + --entitlement-file=sample-entitlement.yaml + + The following command creates a new entitlement with the name + sample-entitlement, under an organization sample-organization, location + global and the entitlement body present in the sample-entitlement.yaml + file: + + $ gcloud beta pam entitlements create sample-entitlement \ + --organization=sample-organization --location=global \ + --entitlement-file=sample-entitlement.yaml + +POSITIONAL ARGUMENTS + Entitlement resource - Name of the entitlement 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 entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument entitlement on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +REQUIRED FLAGS + --entitlement-file=ENTITLEMENT_FILE + YAML file containing the body of the entitlement to be created. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam entitlements create + diff --git a/gcloud/beta/pam/entitlements/delete b/gcloud/beta/pam/entitlements/delete new file mode 100644 index 000000000..fbdb6474e --- /dev/null +++ b/gcloud/beta/pam/entitlements/delete @@ -0,0 +1,102 @@ +NAME + gcloud beta pam entitlements delete - delete a Privileged Access Manager + entitlement + +SYNOPSIS + gcloud beta pam entitlements delete + (ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a Privileged Access Manager (PAM) entitlement along with all + grants under it. + + This command can fail for the following reasons: + ▪ There are non-terminal grants under the entitlement. + +EXAMPLES + The following command deletes an entitlement with the full name + ENTITLEMENT_NAME along with all grants under it: + + $ gcloud beta pam entitlements delete ENTITLEMENT_NAME + +POSITIONAL ARGUMENTS + Entitlement resource - Name of the entitlement 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 entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument entitlement on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam entitlements delete + diff --git a/gcloud/beta/pam/entitlements/describe b/gcloud/beta/pam/entitlements/describe new file mode 100644 index 000000000..b04c5a3d9 --- /dev/null +++ b/gcloud/beta/pam/entitlements/describe @@ -0,0 +1,93 @@ +NAME + gcloud beta pam entitlements describe - show details of a Privileged Access + Manager entitlement + +SYNOPSIS + gcloud beta pam entitlements describe + (ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Show details of a Privileged Access Manager (PAM) entitlement. + +EXAMPLES + The following command describes an entitlement with the full name + ENTITLEMENT_NAME: + + $ gcloud beta pam entitlements describe ENTITLEMENT_NAME + +POSITIONAL ARGUMENTS + Entitlement resource - Name of the entitlement 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 entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument entitlement on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam entitlements describe + diff --git a/gcloud/beta/pam/entitlements/export b/gcloud/beta/pam/entitlements/export new file mode 100644 index 000000000..4b701a20d --- /dev/null +++ b/gcloud/beta/pam/entitlements/export @@ -0,0 +1,103 @@ +NAME + gcloud beta pam entitlements export - export a Privileged Access Manager + entitlement into a local YAML file + +SYNOPSIS + gcloud beta pam entitlements export + (ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--destination=DESTINATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Export a Privileged Access Manager (PAM) entitlement into a local + YAML file. + +EXAMPLES + The following command exports an entitlement with the full name + ENTITLEMENT_NAME to a local YAML file entitlement-file.yaml: + + $ gcloud beta pam entitlements export ENTITLEMENT_NAME \ + --destination=entitlement-file.yaml + +POSITIONAL ARGUMENTS + Entitlement resource - Name of the entitlement 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 entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument entitlement on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +FLAGS + --destination=DESTINATION + Path to a YAML file where the configuration will be exported. The + exported data will not contain any output-only fields. Alternatively, + you may omit this flag to write to standard output. For a schema + describing the export/import format, see + $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam entitlements export + diff --git a/gcloud/beta/pam/entitlements/help b/gcloud/beta/pam/entitlements/help new file mode 100644 index 000000000..466cea9e2 --- /dev/null +++ b/gcloud/beta/pam/entitlements/help @@ -0,0 +1,151 @@ +NAME + gcloud beta pam entitlements - manage Privileged Access Manager + Entitlements + +SYNOPSIS + gcloud beta pam entitlements COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) The gcloud pam entitlements command group lets you manage Privileged + Access Manager (PAM) Entitlements. + +EXAMPLES + To create a new entitlement with the name sample-entitlement, under a + project sample-project, location global and the entitlement body present in + the sample-entitlement.yaml file, run: + + $ gcloud beta pam entitlements create sample-entitlement \ + --project=sample-project --location=global \ + --entitlement-file=sample-entitlement.yaml + + To create a new entitlement with the name sample-entitlement, under a + folder sample-folder, location global and the entitlement body present in + the sample-entitlement.yaml file, run: + + $ gcloud beta pam entitlements create sample-entitlement \ + --folder=sample-folder --location=global \ + --entitlement-file=sample-entitlement.yaml + + To create a new entitlement with the name sample-entitlement, under an + organization sample-organization, location global and the entitlement body + present in the sample-entitlement.yaml file, run: + + $ gcloud beta pam entitlements create sample-entitlement \ + --organization=sample-organization --location=global \ + --entitlement-file=sample-entitlement.yaml + + To update an entitlement with the full name ENTITLEMENT_NAME and the new + entitlement body present in the sample-entitlement.yaml file, run: + + $ gcloud beta pam entitlements update ENTITLEMENT_NAME \ + --entitlement-file=sample-entitlement.yaml + + To describe an entitlement with the full name ENTITLEMENT_NAME, run: + + $ gcloud beta pam entitlements describe ENTITLEMENT_NAME + + To search and list all entitlements under a project sample-project and + location global for which you are a requester, run: + + $ gcloud beta pam entitlements search --project=sample-project \ + --location=global --caller-access-type=grant-requester + + To search and list all entitlements under a project sample-project and + location global for which you are an approver, run: + + $ gcloud beta pam entitlements search --project=sample-project \ + --location=global --caller-access-type=grant-approver + + To search and list all entitlements under a folder sample-folder and + location global for which you are a requester, run: + + $ gcloud beta pam entitlements search --folder=sample-folder \ + --location=global --caller-access-type=grant-requester + + To search and list all entitlements under a folder sample-folder and + location global for which you are an approver, run: + + $ gcloud beta pam entitlements search --folder=sample-folder \ + --location=global --caller-access-type=grant-approver + + To search and list all entitlements under an organization + sample-organization and location global for which you are a requester, run: + + $ gcloud beta pam entitlements search \ + --organization=sample-organization --location=global \ + --caller-access-type=grant-requester + + To search and list all entitlements under an organization + sample-organization and location global for which you are an approver, run: + + $ gcloud beta pam entitlements search \ + --organization=sample-organization --location=global \ + --caller-access-type=grant-approver + + To list all entitlement under a project sample-project and location global, + run: + + $ gcloud beta pam entitlements list --project=sample-project \ + --location=global + + To list all entitlement under a folder sample-folder and location global, + run: + + $ gcloud beta pam entitlements list --folder=sample-folder \ + --location=global + + To list all entitlement under an organization sample-organization and + location global, run: + + $ gcloud beta pam entitlements list \ + --organization=sample-organization --location=global + + To delete an entitlement with the full name ENTITLEMENT_NAME along with all + grants under it, run: + + $ gcloud beta pam entitlements delete ENTITLEMENT_NAME + + To export an entitlement with the full name ENTITLEMENT_NAME to a local + YAML file entitlement-file.yaml, run: + + $ gcloud beta pam entitlements export ENTITLEMENT_NAME \ + --destination=entitlement-file.yaml + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (BETA) Create a new Privileged Access Manager (PAM) entitlement. + + delete + (BETA) Delete a Privileged Access Manager (PAM) entitlement. + + describe + (BETA) Show details of a Privileged Access Manager (PAM) entitlement. + + export + (BETA) Export a Privileged Access Manager (PAM) entitlement into a + local YAML file. + + list + (BETA) List all Privileged Access Manager (PAM) entitlements under a + parent. + + search + (BETA) Search and list all Privileged Access Manager (PAM) entitlements + under a parent for which you are either a requester or an approver. + + update + (BETA) Update an existing Privileged Access Manager (PAM) entitlement. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam entitlements + diff --git a/gcloud/beta/pam/entitlements/list b/gcloud/beta/pam/entitlements/list new file mode 100644 index 000000000..bccafbf5f --- /dev/null +++ b/gcloud/beta/pam/entitlements/list @@ -0,0 +1,123 @@ +NAME + gcloud beta pam entitlements list - list all Privileged Access Manager + entitlements under a parent + +SYNOPSIS + gcloud beta pam entitlements list + (--location=LOCATION : --folder=FOLDER --organization=ORGANIZATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List all Privileged Access Manager (PAM) entitlements under a + project/folder/organization location. + +EXAMPLES + The following command lists all entitlement under a project sample-project + and location global: + + $ gcloud beta pam entitlements list --project=sample-project \ + --location=global + + The following command lists all entitlement under a folder sample-folder + and location global: + + $ gcloud beta pam entitlements list --folder=sample-folder \ + --location=global + + The following command lists all entitlement under an organization + sample-organization and location global: + + $ gcloud beta pam entitlements list \ + --organization=sample-organization --location=global + +REQUIRED FLAGS + Location resource - Location under which the entitlements are to be + listed. 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 --location on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: [privilegedaccessmanager.projects.locations, + privilegedaccessmanager.folders.locations, + privilegedaccessmanager.organizations.locations]. + + 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. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations]. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.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. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam entitlements list + diff --git a/gcloud/beta/pam/entitlements/search b/gcloud/beta/pam/entitlements/search new file mode 100644 index 000000000..6a81bd7d5 --- /dev/null +++ b/gcloud/beta/pam/entitlements/search @@ -0,0 +1,152 @@ +NAME + gcloud beta pam entitlements search - search and list all Privileged Access + Manager entitlements under a parent for which you are either a + requester or an approver + +SYNOPSIS + gcloud beta pam entitlements search --caller-access-type=CALLER_ACCESS_TYPE + (--location=LOCATION : --folder=FOLDER --organization=ORGANIZATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Search and list all Privileged Access Manager (PAM) entitlements + under a project/folder/organization location for which you are either a + requester or an approver. + +EXAMPLES + The following command searches and lists all entitlements under a project + sample-project and location global for which you are a requester: + + $ gcloud beta pam entitlements search --project=sample-project \ + --location=global --caller-access-type=grant-requester + + The following command searches and lists all entitlements under a project + sample-project and location global for which you are an approver: + + $ gcloud beta pam entitlements search --project=sample-project \ + --location=global --caller-access-type=grant-approver + + The following command searches and lists all entitlements under a folder + sample-folder and location global for which you are a requester: + + $ gcloud beta pam entitlements search --folder=sample-folder \ + --location=global --caller-access-type=grant-requester + + The following command searches and lists all entitlements under a folder + sample-folder and location global for which you are an approver: + + $ gcloud beta pam entitlements search --folder=sample-folder \ + --location=global --caller-access-type=grant-approver + + The following command searches and lists all entitlements under an + organization sample-organization and location global for which you are a + requester: + + $ gcloud beta pam entitlements search \ + --organization=sample-organization --location=global \ + --caller-access-type=grant-requester + + The following command searches and lists all entitlements under an + organization sample-organization and location global for which you are an + approver: + + $ gcloud beta pam entitlements search \ + --organization=sample-organization --location=global \ + --caller-access-type=grant-approver + +REQUIRED FLAGS + --caller-access-type=CALLER_ACCESS_TYPE + Whether to search the entitlements for which you are a requester or + approver. CALLER_ACCESS_TYPE must be one of: grant-approver, + grant-requester. + + Location resource - Location under which the entitlements are to be + listed. 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 --location on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: [privilegedaccessmanager.projects.locations, + privilegedaccessmanager.folders.locations, + privilegedaccessmanager.organizations.locations]. + + 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. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations]. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.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. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam entitlements search + diff --git a/gcloud/beta/pam/entitlements/update b/gcloud/beta/pam/entitlements/update new file mode 100644 index 000000000..d441dedfe --- /dev/null +++ b/gcloud/beta/pam/entitlements/update @@ -0,0 +1,104 @@ +NAME + gcloud beta pam entitlements update - update an existing Privileged Access + Manager entitlement + +SYNOPSIS + gcloud beta pam entitlements update + (ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + --entitlement-file=ENTITLEMENT_FILE [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update an existing Privileged Access Manager (PAM) entitlement. + +EXAMPLES + The following command updates an entitlement with the full name + ENTITLEMENT_NAME and the new entitlement body present in the + sample-entitlement.yaml file: + + $ gcloud beta pam entitlements update ENTITLEMENT_NAME \ + --entitlement-file=sample-entitlement.yaml + +POSITIONAL ARGUMENTS + Entitlement resource - Name of the entitlement 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 entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument entitlement on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument entitlement on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +REQUIRED FLAGS + --entitlement-file=ENTITLEMENT_FILE + YAML file containing the new body of the entitlement. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam entitlements update + diff --git a/gcloud/beta/pam/grants/approve b/gcloud/beta/pam/grants/approve new file mode 100644 index 000000000..e6bc50eaf --- /dev/null +++ b/gcloud/beta/pam/grants/approve @@ -0,0 +1,104 @@ +NAME + gcloud beta pam grants approve - approve a Privileged Access Manager grant + +SYNOPSIS + gcloud beta pam grants approve + (GRANT : --entitlement=ENTITLEMENT + --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--reason=REASON] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Approve a Privileged Access Manager (PAM) grant with a reason. + +EXAMPLES + The following command approves a grant with the full name GRANT_NAME and a + reason approval reason: + + $ gcloud beta pam grants approve GRANT_NAME \ + --reason="approval reason" + +POSITIONAL ARGUMENTS + Grant resource - Name of the grant to approve. 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 grant on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements.grants, + privilegedaccessmanager.folders.locations.entitlements.grants, + privilegedaccessmanager.organizations.locations.entitlements.grants]. + + This must be specified. + + GRANT + ID of the grant or fully qualified identifier for the grant. + + To set the grant attribute: + ▸ provide the argument grant on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --entitlement=ENTITLEMENT + The entitlement id + + To set the entitlement attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --entitlement on the command line. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements.grants]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements.grants]. + +FLAGS + --reason=REASON + Reason for approving the grant. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam grants approve + diff --git a/gcloud/beta/pam/grants/create b/gcloud/beta/pam/grants/create new file mode 100644 index 000000000..48aaa09d2 --- /dev/null +++ b/gcloud/beta/pam/grants/create @@ -0,0 +1,111 @@ +NAME + gcloud beta pam grants create - create a new Privileged Access Manager + grant + +SYNOPSIS + gcloud beta pam grants create --requested-duration=REQUESTED_DURATION + (--entitlement=ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--additional-email-recipients=[ADDITIONAL_EMAIL_RECIPIENTS,...]] + [--justification=JUSTIFICATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a new Privileged Access Manager (PAM) grant under an + entitlement. + +EXAMPLES + The following command creates a new grant under an entitlement with the + full name ENTITLEMENT_NAME, with requested duration 1 hour 30 minutes, a + justification some justification and two additional email recipients + abc@example.com and xyz@example.com: + + $ gcloud beta pam grants create --entitlement=ENTITLEMENT_NAME \ + --requested-duration=5400s \ + --justification="some justification" \ + --additional-email-recipients=abc@example.com,xyz@example.com + +REQUIRED FLAGS + --requested-duration=REQUESTED_DURATION + Duration of the grant being created. + + Entitlement resource - Entitlement under which the grant is to be created + 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 --entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + --entitlement=ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument --entitlement on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +OPTIONAL FLAGS + --additional-email-recipients=[ADDITIONAL_EMAIL_RECIPIENTS,...] + Additional email addresses who will be notified for all the actions + performed on the grant. + + --justification=JUSTIFICATION + Justification for the grant. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam grants create + diff --git a/gcloud/beta/pam/grants/deny b/gcloud/beta/pam/grants/deny new file mode 100644 index 000000000..bd08fd97d --- /dev/null +++ b/gcloud/beta/pam/grants/deny @@ -0,0 +1,103 @@ +NAME + gcloud beta pam grants deny - deny a Privileged Access Manager grant + +SYNOPSIS + gcloud beta pam grants deny + (GRANT : --entitlement=ENTITLEMENT + --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--reason=REASON] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Deny a Privileged Access Manager (PAM) grant with a reason. + +EXAMPLES + The following command denies a grant with the full name GRANT_NAME and a + reason denial reason: + + $ gcloud beta pam grants deny GRANT_NAME --reason="denial reason" + +POSITIONAL ARGUMENTS + Grant resource - Name of the grant to deny. 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 grant on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements.grants, + privilegedaccessmanager.folders.locations.entitlements.grants, + privilegedaccessmanager.organizations.locations.entitlements.grants]. + + This must be specified. + + GRANT + ID of the grant or fully qualified identifier for the grant. + + To set the grant attribute: + ▸ provide the argument grant on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --entitlement=ENTITLEMENT + The entitlement id + + To set the entitlement attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --entitlement on the command line. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements.grants]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements.grants]. + +FLAGS + --reason=REASON + Reason for denying the grant. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam grants deny + diff --git a/gcloud/beta/pam/grants/describe b/gcloud/beta/pam/grants/describe new file mode 100644 index 000000000..4cfc9e579 --- /dev/null +++ b/gcloud/beta/pam/grants/describe @@ -0,0 +1,99 @@ +NAME + gcloud beta pam grants describe - show details of a Privileged Access + Manager grant + +SYNOPSIS + gcloud beta pam grants describe + (GRANT : --entitlement=ENTITLEMENT + --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Show details of a Privileged Access Manager (PAM) grant. + +EXAMPLES + The following command describes a grant with the full name GRANT_NAME: + + $ gcloud beta pam grants describe GRANT_NAME + +POSITIONAL ARGUMENTS + Grant resource - Name of the grant 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 grant on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements.grants, + privilegedaccessmanager.folders.locations.entitlements.grants, + privilegedaccessmanager.organizations.locations.entitlements.grants]. + + This must be specified. + + GRANT + ID of the grant or fully qualified identifier for the grant. + + To set the grant attribute: + ▸ provide the argument grant on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --entitlement=ENTITLEMENT + The entitlement id + + To set the entitlement attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --entitlement on the command line. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements.grants]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements.grants]. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam grants describe + diff --git a/gcloud/beta/pam/grants/help b/gcloud/beta/pam/grants/help new file mode 100644 index 000000000..449cdbfb7 --- /dev/null +++ b/gcloud/beta/pam/grants/help @@ -0,0 +1,101 @@ +NAME + gcloud beta pam grants - manage Privileged Access Manager Grants + +SYNOPSIS + gcloud beta pam grants COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) The gcloud pam grants command group lets you manage Privileged + Access Manager (PAM) Grants. + +EXAMPLES + To create a new grant under an entitlement with the full name + ENTITLEMENT_NAME, with requested duration 1 hour 30 minutes, a + justification some justification and two additional email recipients + abc@example.com and xyz@example.com, run: + + $ gcloud beta pam grants create --entitlement=ENTITLEMENT_NAME \ + --requested-duration=5400s \ + --justification="some justification" \ + --additional-email-recipients=abc@example.com,xyz@example.com + + To describe a grant with the full name GRANT_NAME, run: + + $ gcloud beta pam grants describe GRANT_NAME + + To list all grants under an entitlement with the full name + ENTITLEMENT_NAME, run: + + $ gcloud beta pam grants list --entitlement=ENTITLEMENT_NAME + + To deny a grant with the full name GRANT_NAME and a reason denial reason, + run: + + $ gcloud beta pam grants deny GRANT_NAME --reason="denial reason" + + To approve a grant with the full name GRANT_NAME and a reason approval + reason, run: + + $ gcloud beta pam grants approve GRANT_NAME \ + --reason="approval reason" + + To revoke a grant with the full name GRANT_NAME and a reason revoke reason, + run: + + $ gcloud beta pam grants revoke GRANT_NAME --reason="revoke reason" + + To search and list all grants under an entitlement with the full name + ENTITLEMENT_NAME, which you had created, run: + + $ gcloud beta pam grants search --entitlement=ENTITLEMENT_NAME \ + --caller-relationship=had-created + + To search and list all grants under an entitlement with the full name + ENTITLEMENT_NAME, which you had approved or denied, run: + + $ gcloud beta pam grants search --entitlement=ENTITLEMENT_NAME \ + --caller-relationship=had-approved + + To search and list all grants under an entitlement with the full name + ENTITLEMENT_NAME, which you can approve, run: + + $ gcloud beta pam grants search --entitlement=ENTITLEMENT_NAME \ + --caller-relationship=can-approve + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + approve + (BETA) Approve a Privileged Access Manager (PAM) grant. + + create + (BETA) Create a new Privileged Access Manager (PAM) grant. + + deny + (BETA) Deny a Privileged Access Manager (PAM) grant. + + describe + (BETA) Show details of a Privileged Access Manager (PAM) grant. + + list + (BETA) List all Privileged Access Manager (PAM) grants under an + entitlement. + + revoke + (BETA) Revoke a Privileged Access Manager (PAM) grant. + + search + (BETA) Search and list all Privileged Access Manager (PAM) grants under + an entitlement which you had created, had approved or can approve. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam grants + diff --git a/gcloud/beta/pam/grants/list b/gcloud/beta/pam/grants/list new file mode 100644 index 000000000..408b7a3bb --- /dev/null +++ b/gcloud/beta/pam/grants/list @@ -0,0 +1,121 @@ +NAME + gcloud beta pam grants list - list all Privileged Access Manager grants + under an entitlement + +SYNOPSIS + gcloud beta pam grants list + (--entitlement=ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List all Privileged Access Manager (PAM) grants under an + entitlement. + +EXAMPLES + The following command lists all grants under an entitlement with the full + name ENTITLEMENT_NAME: + + $ gcloud beta pam grants list --entitlement=ENTITLEMENT_NAME + +REQUIRED FLAGS + Entitlement resource - Entitlement under which the grants are to be + listed. 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 --entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + --entitlement=ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument --entitlement on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam grants list + diff --git a/gcloud/beta/pam/grants/revoke b/gcloud/beta/pam/grants/revoke new file mode 100644 index 000000000..2cc3224f1 --- /dev/null +++ b/gcloud/beta/pam/grants/revoke @@ -0,0 +1,107 @@ +NAME + gcloud beta pam grants revoke - revoke a Privileged Access Manager grant + +SYNOPSIS + gcloud beta pam grants revoke + (GRANT : --entitlement=ENTITLEMENT + --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--async] [--reason=REASON] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Revoke a Privileged Access Manager (PAM) grant with a reason. + +EXAMPLES + The following command revokes a grant with the full name GRANT_NAME and a + reason revoke reason: + + $ gcloud beta pam grants revoke GRANT_NAME --reason="revoke reason" + +POSITIONAL ARGUMENTS + Grant resource - Name of the grant to revoke. 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 grant on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements.grants, + privilegedaccessmanager.folders.locations.entitlements.grants, + privilegedaccessmanager.organizations.locations.entitlements.grants]. + + This must be specified. + + GRANT + ID of the grant or fully qualified identifier for the grant. + + To set the grant attribute: + ▸ provide the argument grant on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --entitlement=ENTITLEMENT + The entitlement id + + To set the entitlement attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --entitlement on the command line. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements.grants]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument grant on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements.grants]. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --reason=REASON + Reason for revoking the grant. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam grants revoke + diff --git a/gcloud/beta/pam/grants/search b/gcloud/beta/pam/grants/search new file mode 100644 index 000000000..4bbe3bdff --- /dev/null +++ b/gcloud/beta/pam/grants/search @@ -0,0 +1,140 @@ +NAME + gcloud beta pam grants search - search and list all Privileged Access + Manager grants under an entitlement which you had created, had approved + or can approve + +SYNOPSIS + gcloud beta pam grants search --caller-relationship=CALLER_RELATIONSHIP + (--entitlement=ENTITLEMENT + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Search and list all Privileged Access Manager (PAM) grants under an + entitlement which you had created, had approved or can approve. + +EXAMPLES + The following command searches and lists all grants under an entitlement + with the full name ENTITLEMENT_NAME, which you had created: + + $ gcloud beta pam grants search --entitlement=ENTITLEMENT_NAME \ + --caller-relationship=had-created + + The following command searches and lists all grants under an entitlement + with the full name ENTITLEMENT_NAME, which you had approved or denied: + + $ gcloud beta pam grants search --entitlement=ENTITLEMENT_NAME \ + --caller-relationship=had-approved + + The following command searches and lists all grants under an entitlement + with the full name ENTITLEMENT_NAME, which you can approve: + + $ gcloud beta pam grants search --entitlement=ENTITLEMENT_NAME \ + --caller-relationship=can-approve + +REQUIRED FLAGS + --caller-relationship=CALLER_RELATIONSHIP + Whether to search the grants which you had created, had approved or can + approve. CALLER_RELATIONSHIP must be one of: can-approve, had-approved, + had-created. + + Entitlement resource - Entitlement under which the grants are to be + listed. 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 --entitlement on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.entitlements, + privilegedaccessmanager.folders.locations.entitlements, + privilegedaccessmanager.organizations.locations.entitlements]. + + This must be specified. + + --entitlement=ENTITLEMENT + ID of the entitlement or fully qualified identifier for the + entitlement. + + To set the entitlement attribute: + ▸ provide the argument --entitlement on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.entitlements]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument --entitlement on the command line with a + fully specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.entitlements]. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam grants search + diff --git a/gcloud/beta/pam/help b/gcloud/beta/pam/help new file mode 100644 index 000000000..77b9d5146 --- /dev/null +++ b/gcloud/beta/pam/help @@ -0,0 +1,59 @@ +NAME + gcloud beta pam - manage Privileged Access Manager Entitlements and Grants + +SYNOPSIS + gcloud beta pam GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) The gcloud pam command group lets you manage Privileged Access + Manager (PAM) Entitlements and Grants. + +EXAMPLES + To check the PAM onboarding status for a project sample-project and + location global, run: + + $ gcloud beta pam check-onboarding-status --project=sample-project \ + --location=global + + To check the PAM onboarding status for a folder sample-folder and location + global, run: + + $ gcloud beta pam check-onboarding-status --folder=sample-folder \ + --location=global + + To check the PAM onboarding status for an organization sample-organization + and location global, run: + + $ gcloud beta pam check-onboarding-status \ + --organization=sample-organization --location=global + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + entitlements + (BETA) Manage Privileged Access Manager (PAM) Entitlements. + + grants + (BETA) Manage Privileged Access Manager (PAM) Grants. + + operations + (BETA) Manage Privileged Access Manager (PAM) Long Running Operations. + +COMMANDS + COMMAND is one of the following: + + check-onboarding-status + (BETA) Check Privileged Access Manager (PAM) onboarding status for a + resource. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam + diff --git a/gcloud/beta/pam/operations/delete b/gcloud/beta/pam/operations/delete new file mode 100644 index 000000000..547bd6892 --- /dev/null +++ b/gcloud/beta/pam/operations/delete @@ -0,0 +1,92 @@ +NAME + gcloud beta pam operations delete - delete a Privileged Access Manager long + running operation + +SYNOPSIS + gcloud beta pam operations delete + (OPERATION + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a Privileged Access Manager (PAM) long running operation. + +EXAMPLES + The following command deletes an operation with the full name + OPERATION_NAME: + + $ gcloud beta pam operations delete OPERATION_NAME + +POSITIONAL ARGUMENTS + Operation resource - Name of the operation 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 operation on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.operations, + privilegedaccessmanager.folders.locations.operations, + privilegedaccessmanager.organizations.locations.operations]. + + This must be specified. + + OPERATION + ID of the operation or fully qualified identifier for the operation. + + To set the operation attribute: + ▸ provide the argument operation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.operations]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.operations]. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam operations delete + diff --git a/gcloud/beta/pam/operations/describe b/gcloud/beta/pam/operations/describe new file mode 100644 index 000000000..3c2291f99 --- /dev/null +++ b/gcloud/beta/pam/operations/describe @@ -0,0 +1,93 @@ +NAME + gcloud beta pam operations describe - show details of a Privileged Access + Manager long running operation + +SYNOPSIS + gcloud beta pam operations describe + (OPERATION + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Show details of a Privileged Access Manager (PAM) long running + operation. + +EXAMPLES + The following command describes an operation with the full name + OPERATION_NAME: + + $ gcloud beta pam operations describe OPERATION_NAME + +POSITIONAL ARGUMENTS + Operation resource - Name of the operation 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 operation on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.operations, + privilegedaccessmanager.folders.locations.operations, + privilegedaccessmanager.organizations.locations.operations]. + + This must be specified. + + OPERATION + ID of the operation or fully qualified identifier for the operation. + + To set the operation attribute: + ▸ provide the argument operation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.operations]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.operations]. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam operations describe + diff --git a/gcloud/beta/pam/operations/help b/gcloud/beta/pam/operations/help new file mode 100644 index 000000000..8cbb4b161 --- /dev/null +++ b/gcloud/beta/pam/operations/help @@ -0,0 +1,70 @@ +NAME + gcloud beta pam operations - manage Privileged Access Manager Long Running + Operations + +SYNOPSIS + gcloud beta pam operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) The gcloud pam operations command group lets you manage Privileged + Access Manager (PAM) Operations. + +EXAMPLES + To describe an operation with the full name OPERATION_NAME, run: + + $ gcloud beta pam operations describe OPERATION_NAME + + To list all operations under a project sample-project and location global, + run: + + $ gcloud beta pam operations list --project=sample-project \ + --location=global + + To list all operations under a folder sample-folder and location global, + run: + + $ gcloud beta pam operations list --folder=sample-folder \ + --location=global + + To list all operations under an organization sample-organization and + location global, run: + + $ gcloud beta pam operations list \ + --organization=sample-organization --location=global + + To delete an operation with the full name OPERATION_NAME, run: + + $ gcloud beta pam operations delete OPERATION_NAME + + To poll an operation with the full name OPERATION_NAME, run: + + $ gcloud beta pam operations wait OPERATION_NAME + +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 Privileged Access Manager (PAM) long running operation. + + describe + (BETA) Show details of a Privileged Access Manager (PAM) long running + operation. + + list + (BETA) List all Privileged Access Manager (PAM) long running operations + under a location. + + wait + (BETA) Poll a Privileged Access Manager (PAM) long running operation. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam operations + diff --git a/gcloud/beta/pam/operations/list b/gcloud/beta/pam/operations/list new file mode 100644 index 000000000..8a5501a59 --- /dev/null +++ b/gcloud/beta/pam/operations/list @@ -0,0 +1,123 @@ +NAME + gcloud beta pam operations list - list all Privileged Access Manager long + running operations under a location + +SYNOPSIS + gcloud beta pam operations list + (--location=LOCATION : --folder=FOLDER --organization=ORGANIZATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List all Privileged Access Manager (PAM) long running operations + under a project/folder/organization location. + +EXAMPLES + The following command lists all operations under a project sample-project + and location global: + + $ gcloud beta pam operations list --project=sample-project \ + --location=global + + The following command list all operations under a folder sample-folder and + location global: + + $ gcloud beta pam operations list --folder=sample-folder \ + --location=global + + The following command list all operations under an organization + sample-organization and location global: + + $ gcloud beta pam operations list \ + --organization=sample-organization --location=global + +REQUIRED FLAGS + Location resource - Location under which the operations are to be listed. + 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 --location on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: [privilegedaccessmanager.projects.locations, + privilegedaccessmanager.folders.locations, + privilegedaccessmanager.organizations.locations]. + + 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. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations]. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument --location on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.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. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam operations list + diff --git a/gcloud/beta/pam/operations/wait b/gcloud/beta/pam/operations/wait new file mode 100644 index 000000000..8ff2f0f1e --- /dev/null +++ b/gcloud/beta/pam/operations/wait @@ -0,0 +1,92 @@ +NAME + gcloud beta pam operations wait - poll a Privileged Access Manager long + running operation + +SYNOPSIS + gcloud beta pam operations wait + (OPERATION + : --folder=FOLDER --location=LOCATION --organization=ORGANIZATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Poll a Privileged Access Manager (PAM) long running operation until + it completes and then display its result. + +EXAMPLES + The following command polls an operation with the full name OPERATION_NAME: + + $ gcloud beta pam operations wait OPERATION_NAME + +POSITIONAL ARGUMENTS + Operation resource - Name of the operation to poll. 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 operation on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: + [privilegedaccessmanager.projects.locations.operations, + privilegedaccessmanager.folders.locations.operations, + privilegedaccessmanager.organizations.locations.operations]. + + This must be specified. + + OPERATION + ID of the operation or fully qualified identifier for the operation. + + To set the operation attribute: + ▸ provide the argument operation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The name of the folder + + To set the folder attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [privilegedaccessmanager.folders.locations.operations]. + + --location=LOCATION + The resource location + + To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --organization=ORGANIZATION + The name of the organization + + To set the organization attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --organization on the command line. Must be + specified for resource of type + [privilegedaccessmanager.organizations.locations.operations]. + +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 privilegedaccessmanager/v1beta API. The full + documentation for this API can be found at: https://cloud.google.com/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha pam operations wait + diff --git a/gcloud/composer/environments/update b/gcloud/composer/environments/update index 445b19b17..52fa6f263 100644 --- a/gcloud/composer/environments/update +++ b/gcloud/composer/environments/update @@ -7,7 +7,8 @@ SYNOPSIS (--cloud-sql-machine-type=CLOUD_SQL_MACHINE_TYPE | --disable-high-resilience | --disable-logs-in-cloud-logging-only | --enable-high-resilience | --enable-logs-in-cloud-logging-only - | --environment-size=ENVIRONMENT_SIZE | --node-count=NODE_COUNT + | --environment-size=ENVIRONMENT_SIZE | --image-version=IMAGE_VERSION + | --node-count=NODE_COUNT | --web-server-machine-type=WEB_SERVER_MACHINE_TYPE | --clear-maintenance-window | --maintenance-window-end=MAINTENANCE_WINDOW_END @@ -119,6 +120,28 @@ REQUIRED FLAGS will be chosen. ENVIRONMENT_SIZE must be one of: large, medium, small, unspecified. + Group of arguments for performing in-place environment upgrades. + + --image-version=IMAGE_VERSION + Upgrade the environment to a later version in-place. + + The image version encapsulates the versions of both Cloud Composer + and Apache Airflow. Must be of the form + composer-A[.B.C[-D.E]]-airflow-X[.Y[.Z]], where [] denotes optional + fragments. + + Examples: composer-2-airflow-2, composer-2-airflow-2.2, + composer-2.1.2-airflow-2.3.4. + + The Cloud Composer portion of the image version is a semantic + version or an alias in the form of major version number or latest, + resolved to the current Cloud Composer version. The Apache Airflow + portion of the image version is a semantic version or an alias in + the form of major or major.minor version numbers, resolved to the + latest matching Apache Airflow version supported in the given Cloud + Composer version. The resolved versions are stored in the upgraded + environment. + --node-count=NODE_COUNT The new number of nodes running the environment. Must be >= 3. diff --git a/gcloud/compute/backend-buckets/add-iam-policy-binding b/gcloud/compute/backend-buckets/add-iam-policy-binding new file mode 100644 index 000000000..62f55a115 --- /dev/null +++ b/gcloud/compute/backend-buckets/add-iam-policy-binding @@ -0,0 +1,83 @@ +NAME + gcloud compute backend-buckets add-iam-policy-binding - add an IAM policy + binding to a Compute Engine backend bucket + +SYNOPSIS + gcloud compute backend-buckets add-iam-policy-binding BACKEND_BUCKET + --member=PRINCIPAL --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Add an IAM policy binding to a Compute Engine backend bucket. + +EXAMPLES + To add an IAM policy binding for the role of + 'compute.loadBalancerServiceUser' for the user 'test-user@gmail.com' with + backend bucket 'my-backend-bucket' run: + + $ gcloud compute backend-buckets add-iam-policy-binding \ + my-backend-bucket --member='user:test-user@gmail.com' \ + --role='roles/compute.loadBalancerServiceUser' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + Backend bucket resource - The backend bucket for which to add the IAM + policy to. 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 backend_bucket on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKEND_BUCKET + ID of the backend bucket or fully qualified identifier for the + backend bucket. + + To set the backend_bucket attribute: + ▸ provide the argument backend_bucket on the command line. + +REQUIRED FLAGS + --member=PRINCIPAL + The principal to add the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + Role name to assign to the principal. The role name is the complete + path of a predefined role, such as roles/logging.viewer, or the role ID + for a custom role, such as + organizations/{ORGANIZATION_ID}/roles/logging.viewer. + +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 compute/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/compute/ + +NOTES + These variants are also available: + + $ gcloud alpha compute backend-buckets add-iam-policy-binding + + $ gcloud beta compute backend-buckets add-iam-policy-binding + diff --git a/gcloud/alpha/iot/registries/list b/gcloud/compute/backend-buckets/get-iam-policy similarity index 53% rename from gcloud/alpha/iot/registries/list rename to gcloud/compute/backend-buckets/get-iam-policy index 2aabcdc7b..bf8eecd63 100644 --- a/gcloud/alpha/iot/registries/list +++ b/gcloud/compute/backend-buckets/get-iam-policy @@ -1,40 +1,44 @@ NAME - gcloud alpha iot registries list - list device registries + gcloud compute backend-buckets get-iam-policy - get the IAM policy for a + Compute Engine backend bucket SYNOPSIS - gcloud alpha iot registries list --region=REGION [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + gcloud compute backend-buckets get-iam-policy BACKEND_BUCKET + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) (DEPRECATED) This command is deprecated. Google Cloud IoT Core has - been retired. - - List device registries. + gcloud compute backend-buckets get-iam-policy displays the IAM policy + associated with a Compute Engine backend bucket in a project. If formatted + as JSON, the output can be edited and used as a policy file for + set-iam-policy. The output includes an "etag" field identifying the version + emitted and allowing detection of concurrent policy updates; see $ {parent} + set-iam-policy for additional details. EXAMPLES - To list all device registries in a project and region 'us-central1', run: + To print the IAM policy for a given backend bucket, run: - $ gcloud alpha iot registries list --region=us-central1 + $ gcloud compute backend-buckets get-iam-policy my-backend-bucket -REQUIRED FLAGS - Region resource - The location you want to list the registries for. This +POSITIONAL ARGUMENTS + Backend bucket resource - The network to display the IAM policy 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 --region on the command line with a fully + ◆ provide the argument backend_bucket on the command line with a fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. + ◆ set the property core/project; + ◆ provide the argument --project on the command line. This must be specified. - --region=REGION - ID of the region or fully qualified identifier for the region. + BACKEND_BUCKET + ID of the backend bucket or fully qualified identifier for the + backend bucket. - To set the region attribute: - ▸ provide the argument --region on the command line. + To set the backend_bucket attribute: + ▸ provide the argument backend_bucket on the command line. LIST COMMAND FLAGS --filter=EXPRESSION @@ -62,12 +66,6 @@ LIST COMMAND FLAGS 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, @@ -77,16 +75,13 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. API REFERENCE - This command uses the cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot + This command uses the compute/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/compute/ NOTES - This command is currently in alpha and might change without notice. If this - command fails with API permission errors despite specifying the correct - project, you might be trying to access an API with an invitation-only early - access allowlist. These variants are also available: + These variants are also available: - $ gcloud iot registries list + $ gcloud alpha compute backend-buckets get-iam-policy - $ gcloud beta iot registries list + $ gcloud beta compute backend-buckets get-iam-policy diff --git a/gcloud/compute/backend-buckets/help b/gcloud/compute/backend-buckets/help index ecd8c770d..e620c94b8 100644 --- a/gcloud/compute/backend-buckets/help +++ b/gcloud/compute/backend-buckets/help @@ -24,6 +24,9 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + add-iam-policy-binding + Add an IAM policy binding to a Compute Engine backend bucket. + add-signed-url-key Add Cloud CDN Signed URL key to a backend bucket. @@ -39,9 +42,18 @@ COMMANDS describe Describe a backend bucket. + get-iam-policy + Get the IAM policy for a Compute Engine backend bucket. + list List Google Compute Engine backend buckets. + remove-iam-policy-binding + Remove an IAM policy binding from a Compute Engine backend bucket. + + set-iam-policy + Set the IAM policy binding for a Compute Engine backend bucket. + update Update a backend bucket. diff --git a/gcloud/compute/backend-buckets/remove-iam-policy-binding b/gcloud/compute/backend-buckets/remove-iam-policy-binding new file mode 100644 index 000000000..ed25cc1e4 --- /dev/null +++ b/gcloud/compute/backend-buckets/remove-iam-policy-binding @@ -0,0 +1,84 @@ +NAME + gcloud compute backend-buckets remove-iam-policy-binding - remove an IAM + policy binding from a Compute Engine backend bucket + +SYNOPSIS + gcloud compute backend-buckets remove-iam-policy-binding BACKEND_BUCKET + --member=PRINCIPAL --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Remove an IAM policy binding from a Compute Engine backend bucket. + +EXAMPLES + To remove an IAM policy binding for the role of + 'roles/compute.loadBalancerServiceUser' for the user 'test-user@gmail.com' + with backend bucket 'my-backend-bucket' run: + + $ gcloud compute backend-buckets remove-iam-policy-binding \ + my-backend-bucket --member='user:test-user@gmail.com' \ + --role='roles/compute.loadBalancerServiceUser' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + Backend bucket resource - The backend bucket for which to remove the IAM + policy from. 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 backend_bucket on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKEND_BUCKET + ID of the backend bucket or fully qualified identifier for the + backend bucket. + + To set the backend_bucket attribute: + ▸ provide the argument backend_bucket on the command line. + +REQUIRED FLAGS + --member=PRINCIPAL + The principal to remove the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Deleted principals have an additional deleted: prefix and a ?uid=UID + suffix, where UID is a unique identifier for the principal. Example: + deleted:user:test-user@gmail.com?uid=123456789012345678901. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + The role to remove the principal from. + +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 compute/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/compute/ + +NOTES + These variants are also available: + + $ gcloud alpha compute backend-buckets remove-iam-policy-binding + + $ gcloud beta compute backend-buckets remove-iam-policy-binding + diff --git a/gcloud/compute/backend-buckets/set-iam-policy b/gcloud/compute/backend-buckets/set-iam-policy new file mode 100644 index 000000000..170b86157 --- /dev/null +++ b/gcloud/compute/backend-buckets/set-iam-policy @@ -0,0 +1,69 @@ +NAME + gcloud compute backend-buckets set-iam-policy - set the IAM policy binding + for a Compute Engine backend bucket + +SYNOPSIS + gcloud compute backend-buckets set-iam-policy BACKEND_BUCKET POLICY_FILE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Sets the IAM policy for the given backend bucket as defined in a JSON or + YAML file. + +EXAMPLES + The following command reads an IAM policy defined in a JSON file called + 'policy.json' and sets it for the backend bucket called + 'my-backend-bucket': + + $ gcloud compute backend-buckets set-iam-policy my-backend-bucket \ + policy.json + + See https://cloud.google.com/iam/docs/managing-policies for details of the + policy file format and contents. + +POSITIONAL ARGUMENTS + Backend bucket resource - The backend bucket to set the IAM policy 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 backend_bucket on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKEND_BUCKET + ID of the backend bucket or fully qualified identifier for the + backend bucket. + + To set the backend_bucket attribute: + ▸ provide the argument backend_bucket on the command line. + + POLICY_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + + The output of the get-iam-policy command is a valid file, as is any + JSON or YAML file conforming to the structure of a Policy + (https://cloud.google.com/iam/reference/rest/v1/Policy). + +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 compute/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/compute/ + +NOTES + These variants are also available: + + $ gcloud alpha compute backend-buckets set-iam-policy + + $ gcloud beta compute backend-buckets set-iam-policy + diff --git a/gcloud/compute/help b/gcloud/compute/help index 0bdc4029d..9c88a608d 100644 --- a/gcloud/compute/help +++ b/gcloud/compute/help @@ -123,6 +123,9 @@ GROUPS project-info Read and manipulate project-level data like quotas and metadata. + project-zonal-metadata + Describe and update project zonal metadata. + public-advertised-prefixes Manage public advertised prefix resources. diff --git a/gcloud/compute/instance-templates/create b/gcloud/compute/instance-templates/create index bef1aa335..6da62d339 100644 --- a/gcloud/compute/instance-templates/create +++ b/gcloud/compute/instance-templates/create @@ -379,15 +379,16 @@ FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM preemption - (--provisioning-model=SPOT or --preemptible) or automatic instance - termination (--max-run-duration or --termination-time). + (--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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. --internal-ipv6-address=INTERNAL_IPV6_ADDRESS Assigns the given internal IPv6 address or range to the instance that diff --git a/gcloud/compute/instances/bulk/create b/gcloud/compute/instances/bulk/create index 30b83595b..5c88bcf33 100644 --- a/gcloud/compute/instances/bulk/create +++ b/gcloud/compute/instances/bulk/create @@ -415,15 +415,16 @@ OPTIONAL FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM preemption - (--provisioning-model=SPOT or --preemptible) or automatic instance - termination (--max-run-duration or --termination-time). + (--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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. diff --git a/gcloud/compute/instances/create b/gcloud/compute/instances/create index 5f61cac55..edb4621a7 100644 --- a/gcloud/compute/instances/create +++ b/gcloud/compute/instances/create @@ -455,15 +455,16 @@ FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM preemption - (--provisioning-model=SPOT or --preemptible) or automatic instance - termination (--max-run-duration or --termination-time). + (--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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. --internal-ipv6-address=INTERNAL_IPV6_ADDRESS Assigns the given internal IPv6 address or range to the instance that diff --git a/gcloud/compute/instances/create-with-container b/gcloud/compute/instances/create-with-container index 55e9911be..8e07f79cf 100644 --- a/gcloud/compute/instances/create-with-container +++ b/gcloud/compute/instances/create-with-container @@ -434,15 +434,16 @@ FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM preemption - (--provisioning-model=SPOT or --preemptible) or automatic instance - termination (--max-run-duration or --termination-time). + (--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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. diff --git a/gcloud/compute/instances/set-scheduling b/gcloud/compute/instances/set-scheduling index 622ee1a9a..96b51a769 100644 --- a/gcloud/compute/instances/set-scheduling +++ b/gcloud/compute/instances/set-scheduling @@ -126,15 +126,16 @@ FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM - preemption (--provisioning-model=SPOT or --preemptible) or automatic - instance termination (--max-run-duration or --termination-time). + 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. Stop the VM without preserving memory. The VM can be - restarted later. + Default only for Spot VMs. Stop the VM without preserving memory. + The VM can be restarted later. Sole Tenancy. diff --git a/gcloud/compute/interconnects/attachments/dedicated/create b/gcloud/compute/interconnects/attachments/dedicated/create index b9f2d9548..c31e93dbc 100644 --- a/gcloud/compute/interconnects/attachments/dedicated/create +++ b/gcloud/compute/interconnects/attachments/dedicated/create @@ -74,10 +74,10 @@ OPTIONAL FLAGS request fails if all candidate subnets are in use at Google's edge. --cloud-router-ipv6-interface-id=INTERFACE_ID - The cloud-router-ipv6-interface-id field is not available. + cloud-router-ipv6-interface-id field is not available. --customer-router-ipv6-interface-id=PEER_INTERFACE_ID - The customer-router-ipv6-interface-id field is not available. + customer-router-ipv6-interface-id field is not available. --description=DESCRIPTION Human-readable plain-text description of attachment. @@ -122,8 +122,8 @@ OPTIONAL FLAGS --mtu=MTU Maximum transmission unit (MTU) is the size of the largest IP packet - passing through this interconnect attachment. Only 1440 and 1500 are - allowed values. If not specified, the value will default to 1440. + passing through this interconnect attachment. Must be one of 1440, + 1460, 1500, or 8896. If not specified, the value will default to 1440. --region=REGION Region of the interconnect attachment to create. If not specified, you @@ -146,8 +146,8 @@ OPTIONAL FLAGS CLOUDSDK_COMPUTE_REGION. --stack-type=STACK_TYPE - The stack type of the protocol(s) enabled on this interconnect - attachment. STACK_TYPE must be one of: + Stack type of the protocol(s) enabled on this interconnect attachment. + STACK_TYPE must be one of: IPV4_IPV6 Both IPv4 and IPv6 protocols are enabled on this attachment. @@ -155,12 +155,12 @@ OPTIONAL FLAGS Only IPv4 protocol is enabled on this attachment. --subnet-length=SUBNET_LENGTH - The length of the IPv4 subnet mask for this attachment. 29 is the - default value, except for attachments on Cross-Cloud Interconnects - whose remote location's "constraints.subnetLengthRange" field specifies - a minimum subnet length of 30. In that case, the default value is 30. - The default value is recommended when there's no requirement on the - subnet length. SUBNET_LENGTH must be one of: 29, 30. + Length of the IPv4 subnet mask for this attachment. 29 is the default + value, except for attachments on Cross-Cloud Interconnects whose remote + location's "constraints.subnetLengthRange" field specifies a minimum + subnet length of 30. In that case, the default value is 30. The default + value is recommended when there's no requirement on the subnet length. + SUBNET_LENGTH must be one of: 29, 30. --vlan=VLAN Desired VLAN for this attachment, in the range 2-4093. If not supplied, diff --git a/gcloud/compute/interconnects/attachments/dedicated/update b/gcloud/compute/interconnects/attachments/dedicated/update index 6d7691179..865d244a7 100644 --- a/gcloud/compute/interconnects/attachments/dedicated/update +++ b/gcloud/compute/interconnects/attachments/dedicated/update @@ -53,10 +53,10 @@ FLAGS The candididate-ipv6-subnets field is not available. --cloud-router-ipv6-interface-id=INTERFACE_ID - The cloud-router-ipv6-interface-id field is not available. + cloud-router-ipv6-interface-id field is not available. --customer-router-ipv6-interface-id=PEER_INTERFACE_ID - The customer-router-ipv6-interface-id field is not available. + customer-router-ipv6-interface-id field is not available. --description=DESCRIPTION Human-readable plain-text description of attachment. @@ -68,8 +68,8 @@ FLAGS --mtu=MTU Maximum transmission unit (MTU) is the size of the largest IP packet - passing through this interconnect attachment. Only 1440 and 1500 are - allowed values. If not specified, the value will default to 1440. + passing through this interconnect attachment. Must be one of 1440, + 1460, 1500, or 8896. If not specified, the value will default to 1440. --region=REGION Region of the interconnect attachment to patch. If not specified, you @@ -92,8 +92,8 @@ FLAGS CLOUDSDK_COMPUTE_REGION. --stack-type=STACK_TYPE - The stack type of the protocol(s) enabled on this interconnect - attachment. STACK_TYPE must be one of: + Stack type of the protocol(s) enabled on this interconnect attachment. + STACK_TYPE must be one of: IPV4_IPV6 Both IPv4 and IPv6 protocols are enabled on this attachment. diff --git a/gcloud/compute/interconnects/attachments/partner/create b/gcloud/compute/interconnects/attachments/partner/create index 92c9465fd..c7ec80e16 100644 --- a/gcloud/compute/interconnects/attachments/partner/create +++ b/gcloud/compute/interconnects/attachments/partner/create @@ -7,7 +7,7 @@ SYNOPSIS --edge-availability-domain=AVAILABILITY_DOMAIN --router=ROUTER [--description=DESCRIPTION] [--enable-admin] [--encryption=ENCRYPTION] [--ipsec-internal-addresses=[ADDRESSES]] [--mtu=MTU] [--region=REGION] - [GCLOUD_WIDE_FLAG ...] + [--stack-type=STACK_TYPE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION gcloud compute interconnects attachments partner create is used to create @@ -88,8 +88,8 @@ OPTIONAL FLAGS --mtu=MTU Maximum transmission unit (MTU) is the size of the largest IP packet - passing through this interconnect attachment. Only 1440 and 1500 are - allowed values. If not specified, the value will default to 1440. + passing through this interconnect attachment. Must be one of 1440, + 1460, 1500, or 8896. If not specified, the value will default to 1440. --region=REGION Region of the interconnect attachment to create. If not specified, you @@ -111,6 +111,15 @@ OPTIONAL FLAGS Alternatively, the region can be stored in the environment variable CLOUDSDK_COMPUTE_REGION. + --stack-type=STACK_TYPE + Stack type of the protocol(s) enabled on this interconnect attachment. + STACK_TYPE must be one of: + + IPV4_IPV6 + Both IPv4 and IPv6 protocols are enabled on this attachment. + IPV4_ONLY + Only IPv4 protocol is enabled on this attachment. + 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/compute/interconnects/attachments/partner/update b/gcloud/compute/interconnects/attachments/partner/update index ccf2d914c..039e6928a 100644 --- a/gcloud/compute/interconnects/attachments/partner/update +++ b/gcloud/compute/interconnects/attachments/partner/update @@ -5,7 +5,7 @@ NAME SYNOPSIS gcloud compute interconnects attachments partner update NAME [--description=DESCRIPTION] [--enable-admin] [--mtu=MTU] - [--region=REGION] [GCLOUD_WIDE_FLAG ...] + [--region=REGION] [--stack-type=STACK_TYPE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION gcloud compute interconnects attachments partner update is used to update @@ -28,8 +28,8 @@ FLAGS --mtu=MTU Maximum transmission unit (MTU) is the size of the largest IP packet - passing through this interconnect attachment. Only 1440 and 1500 are - allowed values. If not specified, the value will default to 1440. + passing through this interconnect attachment. Must be one of 1440, + 1460, 1500, or 8896. If not specified, the value will default to 1440. --region=REGION Region of the interconnect attachment to patch. If not specified, you @@ -51,6 +51,15 @@ FLAGS Alternatively, the region can be stored in the environment variable CLOUDSDK_COMPUTE_REGION. + --stack-type=STACK_TYPE + Stack type of the protocol(s) enabled on this interconnect attachment. + STACK_TYPE must be one of: + + IPV4_IPV6 + Both IPv4 and IPv6 protocols are enabled on this attachment. + IPV4_ONLY + Only IPv4 protocol is enabled on this attachment. + 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/compute/network-endpoint-groups/create b/gcloud/compute/network-endpoint-groups/create index 71d8e7a9b..6fe417623 100644 --- a/gcloud/compute/network-endpoint-groups/create +++ b/gcloud/compute/network-endpoint-groups/create @@ -6,8 +6,8 @@ SYNOPSIS gcloud compute network-endpoint-groups create NAME [--default-port=DEFAULT_PORT] [--network=NETWORK] [--network-endpoint-type=NETWORK_ENDPOINT_TYPE; - default="gce-vm-ip-port"] [--psc-target-service=PSC_TARGET_SERVICE] - [--subnet=SUBNET] + default="gce-vm-ip-port"] [--producer-port=PRODUCER_PORT] + [--psc-target-service=PSC_TARGET_SERVICE] [--subnet=SUBNET] [--cloud-function-name=CLOUD_FUNCTION_NAME --cloud-function-url-mask=CLOUD_FUNCTION_URL_MASK | --cloud-run-service=CLOUD_RUN_SERVICE @@ -36,11 +36,11 @@ FLAGS network endpoint. If this flag isn't specified for a NEG with endpoint type - gce-vm-ip-port or non-gcp-private-ip-port, then every network endpoint - in the network endpoint group must have a port specified. For a global - NEG with endpoint type internet-ip-port and internet-fqdn-port if the - default port is not specified, the well-known port for your backend - protocol is used (80 for HTTP, 443 for HTTPS). + gce-vm-ip-port, gce-vm-ip-portmap or non-gcp-private-ip-port, then + every network endpoint in the network endpoint group must have a port + specified. For a global NEG with endpoint type internet-ip-port and + internet-fqdn-port if the default port is not specified, the well-known + port for your backend protocol is used (80 for HTTP, 443 for HTTPS). This flag is not supported for NEGs with endpoint type serverless. @@ -112,6 +112,17 @@ FLAGS internet-ip-port, internet-fqdn-port, non-gcp-private-ip-port, serverless, gce-vm-ip, private-service-connect. + --producer-port=PRODUCER_PORT + The psc producer port to use when consumer PSC NEG connects to a + producer. + + If this flag isn't specified for a PSC NEG with endpoint type + private-service-connect, then PSC NEG will be connected to a first port + in the available pcs producer port range. + + This flag is not supported for NEGs with endpoint type other than + private-service-connect. + --psc-target-service=PSC_TARGET_SERVICE PSC target service name to add to the private service connect network endpoint groups (NEG). diff --git a/gcloud/compute/packet-mirrorings/create b/gcloud/compute/packet-mirrorings/create index db0205ab1..2691bf395 100644 --- a/gcloud/compute/packet-mirrorings/create +++ b/gcloud/compute/packet-mirrorings/create @@ -74,11 +74,12 @@ OPTIONAL FLAGS --no-enable to disable. --filter-cidr-ranges=[CIDR_RANGE,...] - List of IP CIDR ranges that apply as filters on the source or - destination IP in the IP header for packet mirroring traffic. All - traffic between the VM and the IPs listed here will be mirrored using - this configuration. This can be a Public IP as well. If unspecified, - the config applies to all traffic. + One or more IPv4 or IPv6 CIDR ranges that apply as filters on the + source (ingress) or destination (egress) IP in the IP header. If no + ranges are specified, all IPv4 traffic that matches the specified + IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is + specified, all IPv4 traffic is mirrored. To mirror all IPv4 and IPv6 + traffic, use 0.0.0.0/0,::/0 --filter-direction=DIRECTION ◆ For ingress, only ingress traffic is mirrored. diff --git a/gcloud/compute/project-zonal-metadata/add b/gcloud/compute/project-zonal-metadata/add new file mode 100644 index 000000000..70a6f9b3c --- /dev/null +++ b/gcloud/compute/project-zonal-metadata/add @@ -0,0 +1,53 @@ +NAME + gcloud compute project-zonal-metadata add - add or update project zonal + metadata + +SYNOPSIS + gcloud compute project-zonal-metadata add + --metadata=KEY=VALUE,[KEY=VALUE,...] --zone=ZONE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + gcloud compute project-zonal-metadata add is used to add or update project + zonal metadata for your VM instances. Project zonal metadata values + propagate to all VMs within the specified zone. Every VM has access to a + metadata server that you can use to query the configured project zonal + metadata values. To set metadata for individual instances, use gcloud + compute instances add-metadata. For information about metadata, see + https://cloud.google.com/compute/docs/metadata. + + Only the metadata keys that you provide in the command get mutated. All + other existing metadata entries remain the same. + +EXAMPLES + To set the project zonal metadata with key=value in the zone us-central1-a + for the project my-gcp-project, run: + + $ gcloud compute project-zonal-metadata add --metadata=key=value \ + --zone=us-central1-a --project=my-gcp-project + + For more information and examples for setting project zonal metadata, see + https://cloud.google.com/compute/docs/metadata/setting-custom-metadata#set-custom-project-zonal-metadata + +REQUIRED FLAGS + --metadata=KEY=VALUE,[KEY=VALUE,...] + The project zonal metadata key-value pairs that you want to add or + update + + --zone=ZONE + The zone in which you want to add or update project zonal metadata + +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 project-zonal-metadata add + + $ gcloud beta compute project-zonal-metadata add + diff --git a/gcloud/compute/project-zonal-metadata/describe b/gcloud/compute/project-zonal-metadata/describe new file mode 100644 index 000000000..b7aaacb98 --- /dev/null +++ b/gcloud/compute/project-zonal-metadata/describe @@ -0,0 +1,37 @@ +NAME + gcloud compute project-zonal-metadata describe - describe project zonal + metadata + +SYNOPSIS + gcloud compute project-zonal-metadata describe --zone=ZONE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe project zonal metadata. + +EXAMPLES + To describe the project zonal metadata in the zone us-central1-a for the + project my-gcp-project, run: + + $ gcloud compute project-zonal-metadata describe \ + --zone=us-central1-a --project=my-gcp-project + +REQUIRED FLAGS + --zone=ZONE + Zone for project zonal metadata + +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 project-zonal-metadata describe + + $ gcloud beta compute project-zonal-metadata describe + diff --git a/gcloud/compute/project-zonal-metadata/help b/gcloud/compute/project-zonal-metadata/help new file mode 100644 index 000000000..aafd5184d --- /dev/null +++ b/gcloud/compute/project-zonal-metadata/help @@ -0,0 +1,34 @@ +NAME + gcloud compute project-zonal-metadata - describe and update project zonal + metadata + +SYNOPSIS + gcloud compute project-zonal-metadata COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe and update Compute Engine project zonal metadata. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + add + Add or update project zonal metadata. + + describe + Describe project zonal metadata. + + remove + Remove project zonal metadata. + +NOTES + These variants are also available: + + $ gcloud alpha compute project-zonal-metadata + + $ gcloud beta compute project-zonal-metadata + diff --git a/gcloud/compute/project-zonal-metadata/remove b/gcloud/compute/project-zonal-metadata/remove new file mode 100644 index 000000000..cc10a90e8 --- /dev/null +++ b/gcloud/compute/project-zonal-metadata/remove @@ -0,0 +1,60 @@ +NAME + gcloud compute project-zonal-metadata remove - remove project zonal + metadata + +SYNOPSIS + gcloud compute project-zonal-metadata remove --zone=ZONE + [--all | --keys=KEY,[KEY,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + gcloud compute project-zonal-metadata remove is used to remove project + zonal metadata from all VMs within the specified zone. For information + about metadata, see https://cloud.google.com/compute/docs/metadata. + + Only the metadata keys that you provide in the command get removed. All + other existing metadata entries remain the same. + + After you remove a specific project zonal metadata entry, if that metadata + key has any project-wide value configured, then the VMs in the zone + automatically inherit that project-wide value. + +EXAMPLES + To remove the project zonal metadata with key=value in the zone + us-central1-a for the project my-gcp-project, run: + + $ gcloud compute project-zonal-metadata remove --keys=key \ + --zone=us-central1-a --project=my-gcp-project + + For more information and examples about how to remove project zonal + metadata, see + https://cloud.google.com/compute/docs/metadata/setting-custom-metadata#remove-custom-project-zonal-metadata + +REQUIRED FLAGS + --zone=ZONE + The zone in which you want to remove project zonal metadata + +OPTIONAL FLAGS + At most one of these can be specified: + + --all + If provided, all project zonal metadata entries are removed from VM + instances in the zone. + + --keys=KEY,[KEY,...] + The keys for which you want to remove project zonal metadata + +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 project-zonal-metadata remove + + $ gcloud beta compute project-zonal-metadata remove + diff --git a/gcloud/compute/snapshot-settings/update b/gcloud/compute/snapshot-settings/update index 27c75c1a9..c8268b2fb 100644 --- a/gcloud/compute/snapshot-settings/update +++ b/gcloud/compute/snapshot-settings/update @@ -35,10 +35,11 @@ FLAGS complete. --storage-location-names=[STORAGE_LOCATION_NAMES,...] - The custom storage locations that you specify for the project's - snapshots. Use this flag only when you use the SPECIFIC_LOCATIONS value - for the --storage-location-policy flag. For more information, refer to - the snapshot settings documentation at + The custom storage location that you specify for the project's + snapshots. You can specify only a single location. Use this flag only + when you use the specific-locations value for the + --storage-location-policy flag. For more information, refer to the + snapshot settings documentation at https://cloud.google.com/compute/docs/disks/snapshot-settings. --storage-location-policy=STORAGE_LOCATION_POLICY diff --git a/gcloud/config/get b/gcloud/config/get index 61627d298..33f4bc09e 100644 --- a/gcloud/config/get +++ b/gcloud/config/get @@ -270,8 +270,7 @@ AVAILABLE PROPERTIES to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. Defaults to - https://cloudiot.googleapis.com/ + Overrides API endpoint for gcloud iot command group. cloudkms Overrides API endpoint for gcloud kms command group. Defaults to diff --git a/gcloud/config/help b/gcloud/config/help index d140f7a6a..bc95fe9d9 100644 --- a/gcloud/config/help +++ b/gcloud/config/help @@ -302,8 +302,7 @@ AVAILABLE PROPERTIES to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. Defaults to - https://cloudiot.googleapis.com/ + Overrides API endpoint for gcloud iot command group. cloudkms Overrides API endpoint for gcloud kms command group. Defaults to diff --git a/gcloud/config/list b/gcloud/config/list index d5e77319b..4d7089038 100644 --- a/gcloud/config/list +++ b/gcloud/config/list @@ -314,8 +314,7 @@ AVAILABLE PROPERTIES to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. Defaults to - https://cloudiot.googleapis.com/ + Overrides API endpoint for gcloud iot command group. cloudkms Overrides API endpoint for gcloud kms command group. Defaults to diff --git a/gcloud/config/set b/gcloud/config/set index 14ce1cbad..2e8215e55 100644 --- a/gcloud/config/set +++ b/gcloud/config/set @@ -317,8 +317,7 @@ AVAILABLE PROPERTIES to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. Defaults to - https://cloudiot.googleapis.com/ + Overrides API endpoint for gcloud iot command group. cloudkms Overrides API endpoint for gcloud kms command group. Defaults to diff --git a/gcloud/config/unset b/gcloud/config/unset index 1d98801fb..844276d21 100644 --- a/gcloud/config/unset +++ b/gcloud/config/unset @@ -278,8 +278,7 @@ AVAILABLE PROPERTIES to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. Defaults to - https://cloudiot.googleapis.com/ + Overrides API endpoint for gcloud iot command group. cloudkms Overrides API endpoint for gcloud kms command group. Defaults to diff --git a/gcloud/container/clusters/create b/gcloud/container/clusters/create index 4bf10d85a..7891b7c0e 100644 --- a/gcloud/container/clusters/create +++ b/gcloud/container/clusters/create @@ -17,6 +17,7 @@ SYNOPSIS [--cluster-ipv4-cidr=CLUSTER_IPV4_CIDR] [--cluster-secondary-range-name=NAME] [--cluster-version=CLUSTER_VERSION] + [--containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE] [--create-subnetwork=[KEY=VALUE,...]] [--database-encryption-key=DATABASE_ENCRYPTION_KEY] [--default-max-pods-per-node=DEFAULT_MAX_PODS_PER_NODE] @@ -33,9 +34,10 @@ SYNOPSIS [--enable-kubernetes-unstable-apis=API,[API,...]] [--enable-l4-ilb-subsetting] [--enable-legacy-authorization] [--enable-managed-prometheus] [--enable-master-global-access] - [--enable-multi-networking] [--enable-network-policy] - [--enable-service-externalips] [--enable-shielded-nodes] - [--enable-stackdriver-kubernetes] [--enable-vertical-pod-autoscaling] + [--enable-multi-networking] [--enable-nested-virtualization] + [--enable-network-policy] [--enable-service-externalips] + [--enable-shielded-nodes] [--enable-stackdriver-kubernetes] + [--enable-vertical-pod-autoscaling] [--fleet-project=PROJECT_ID_OR_NUMBER] [--gateway-api=GATEWAY_API] [--image-type=IMAGE_TYPE] [--in-transit-encryption=IN_TRANSIT_ENCRYPTION] @@ -153,10 +155,10 @@ FLAGS (Optional) The NVIDIA driver version to install. GPU_DRIVER_VERSION must be one of: - `default`: Install the default driver version. + `default`: Install the default driver version for this GKE version. - `latest`: Install the latest available driver version. Available only for - nodes that use Container-Optimized OS. + `latest`: Install the latest driver version available for this GKE version. + Can only be used for nodes that use Container-Optimized OS. `disabled`: Skip automatic driver installation. You must manually install a driver after you create the cluster. If you omit the flag `gpu-driver-version`, @@ -292,6 +294,10 @@ FLAGS within VPCs that peer with this cluster. You should specify --cluster-ipv4-cidr to prevent conflicts. + This field is not applicable in a Shared VPC setup where the IP address + range for the pods must be specified with + --cluster-secondary-range-name + --cluster-secondary-range-name=NAME Set the secondary range to be used as the source for pod IPs. Alias ranges will be allocated from this secondary range. NAME must be the @@ -309,6 +315,17 @@ FLAGS $ gcloud container get-server-config + --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + Path of the YAML file that contains containerd configuration entries + like configuring access to private image registries. + + For detailed information on the configuration usage, please refer to + https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration. + + Note: Updating the containerd configuration of an existing cluster or + node pool requires recreation of the existing nodes, which might cause + disruptions in running workloads. + --create-subnetwork=[KEY=VALUE,...] Create a new subnetwork for the cluster. The name and range of the subnetwork can be customized via optional 'name' and 'range' key-value @@ -560,6 +577,12 @@ FLAGS Enables multi-networking on the cluster. Multi-networking is disabled by default. + --enable-nested-virtualization + Enables the use of nested virtualization on the default initial node + pool. Defaults to false. Can only be enabled on UBUNTU_CONTAINERD base + image or COS_CONTAINERD base image with version 1.28.4-gke.1083000 and + above. + --enable-network-policy Enable network policy enforcement for this cluster. If you are enabling network policy on an existing cluster the network policy addon must @@ -1114,9 +1137,9 @@ FLAGS sysctl: net.core.somaxconn: '2048' net.ipv4.tcp_rmem: '4096 87380 6291456' - hugepageConfig: - hugepage_size2m: '1024' - hugepage_size1g: '2' + hugepageConfig: + hugepage_size2m: '1024' + hugepage_size1g: '2' List of supported kubelet configs in 'kubeletConfig'. diff --git a/gcloud/container/clusters/create-auto b/gcloud/container/clusters/create-auto index 9d9b4e1f4..c4ca367db 100644 --- a/gcloud/container/clusters/create-auto +++ b/gcloud/container/clusters/create-auto @@ -11,6 +11,7 @@ SYNOPSIS [--cluster-ipv4-cidr=CLUSTER_IPV4_CIDR] [--cluster-secondary-range-name=NAME] [--cluster-version=CLUSTER_VERSION] + [--containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE] [--create-subnetwork=[KEY=VALUE,...]] [--database-encryption-key=DATABASE_ENCRYPTION_KEY] [--enable-backup-restore] [--enable-cilium-clusterwide-network-policy] @@ -127,6 +128,10 @@ FLAGS within VPCs that peer with this cluster. You should specify --cluster-ipv4-cidr to prevent conflicts. + This field is not applicable in a Shared VPC setup where the IP address + range for the pods must be specified with + --cluster-secondary-range-name + --cluster-secondary-range-name=NAME Set the secondary range to be used as the source for pod IPs. Alias ranges will be allocated from this secondary range. NAME must be the @@ -143,6 +148,17 @@ FLAGS $ gcloud container get-server-config + --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + Path of the YAML file that contains containerd configuration entries + like configuring access to private image registries. + + For detailed information on the configuration usage, please refer to + https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration. + + Note: Updating the containerd configuration of an existing cluster or + node pool requires recreation of the existing nodes, which might cause + disruptions in running workloads. + --create-subnetwork=[KEY=VALUE,...] Create a new subnetwork for the cluster. The name and range of the subnetwork can be customized via optional 'name' and 'range' key-value diff --git a/gcloud/container/clusters/update b/gcloud/container/clusters/update index 02fbf1e0e..c75a4d79d 100644 --- a/gcloud/container/clusters/update +++ b/gcloud/container/clusters/update @@ -8,6 +8,7 @@ SYNOPSIS | --autoprovisioning-resource-manager-tags=[KEY=VALUE,...] | --autoscaling-profile=AUTOSCALING_PROFILE | --clear-fleet-project | --complete-credential-rotation | --complete-ip-rotation + | --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE | --database-encryption-key=DATABASE_ENCRYPTION_KEY | --disable-database-encryption | --disable-default-snat | --disable-workload-identity | --enable-autoscaling @@ -190,6 +191,17 @@ REQUIRED FLAGS single IP state. See documentation for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-rotation. + --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + Path of the YAML file that contains containerd configuration entries + like configuring access to private image registries. + + For detailed information on the configuration usage, please refer to + https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration. + + Note: Updating the containerd configuration of an existing cluster or + node pool requires recreation of the existing nodes, which might + cause disruptions in running workloads. + --database-encryption-key=DATABASE_ENCRYPTION_KEY Enable Database Encryption. diff --git a/gcloud/container/node-pools/create b/gcloud/container/node-pools/create index e61f5f107..3c34b86cb 100644 --- a/gcloud/container/node-pools/create +++ b/gcloud/container/node-pools/create @@ -15,14 +15,15 @@ SYNOPSIS pod-ipv4-range=SECONDARY_RANGE_NAME, [max-pods-per-node=NUM_PODS],...]] [--async] [--boot-disk-kms-key=BOOT_DISK_KMS_KEY] [--cluster=CLUSTER] + [--containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE] [--disk-size=DISK_SIZE] [--disk-type=DISK_TYPE] [--enable-autoprovisioning] [--enable-autorepair] [--no-enable-autoupgrade] [--enable-blue-green-upgrade] [--enable-confidential-nodes] [--enable-gvnic] - [--enable-image-streaming] [--enable-private-nodes] - [--enable-queued-provisioning] [--enable-surge-upgrade] - [--image-type=IMAGE_TYPE] [--labels=[KEY=VALUE,...]] - [--logging-variant=LOGGING_VARIANT] + [--enable-image-streaming] [--enable-nested-virtualization] + [--enable-private-nodes] [--enable-queued-provisioning] + [--enable-surge-upgrade] [--image-type=IMAGE_TYPE] + [--labels=[KEY=VALUE,...]] [--logging-variant=LOGGING_VARIANT] [--machine-type=MACHINE_TYPE, -m MACHINE_TYPE] [--max-pods-per-node=MAX_PODS_PER_NODE] [--max-surge-upgrade=MAX_SURGE_UPGRADE; default=1] @@ -38,8 +39,9 @@ SYNOPSIS [--num-nodes=NUM_NODES; default=3] [--placement-policy=PLACEMENT_POLICY] [--placement-type=PLACEMENT_TYPE] [--preemptible] [--resource-manager-tags=[KEY=VALUE,...]] - [--sandbox=[type=TYPE]] [--shielded-integrity-monitoring] - [--shielded-secure-boot] + [--sandbox=[type=TYPE]] + [--secondary-boot-disk=[disk-image=DISK_IMAGE,[mode=MODE],...]] + [--shielded-integrity-monitoring] [--shielded-secure-boot] [--sole-tenant-node-affinity-file=SOLE_TENANT_NODE_AFFINITY_FILE] [--spot] [--standard-rollout-policy=[batch-node-count=BATCH_NODE_COUNT, @@ -106,10 +108,10 @@ FLAGS (Optional) The NVIDIA driver version to install. GPU_DRIVER_VERSION must be one of: - `default`: Install the default driver version. + `default`: Install the default driver version for this GKE version. - `latest`: Install the latest available driver version. Available only for - nodes that use Container-Optimized OS. + `latest`: Install the latest driver version available for this GKE version. + Can only be used for nodes that use Container-Optimized OS. `disabled`: Skip automatic driver installation. You must manually install a driver after you create the cluster. If you omit the flag `gpu-driver-version`, @@ -180,6 +182,17 @@ FLAGS The cluster to add the node pool to. Overrides the default container/cluster property value for this command invocation. + --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + Path of the YAML file that contains containerd configuration entries + like configuring access to private image registries. + + For detailed information on the configuration usage, please refer to + https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration. + + Note: Updating the containerd configuration of an existing cluster or + node pool requires recreation of the existing nodes, which might cause + disruptions in running workloads. + --disk-size=DISK_SIZE Size for node VM boot disks in GB. Defaults to 100GB. @@ -236,6 +249,11 @@ FLAGS --enable-image-streaming Specifies whether to enable image streaming on node pool. + --enable-nested-virtualization + Enables the use of nested virtualization on the node pool. Defaults to + false. Can only be enabled on UBUNTU_CONTAINERD base image or + COS_CONTAINERD base image with version 1.28.4-gke.1083000 and above. + --enable-private-nodes Enables provisioning nodes with private IP addresses only. @@ -553,6 +571,17 @@ FLAGS The only supported type is 'gvisor'. + --secondary-boot-disk=[disk-image=DISK_IMAGE,[mode=MODE],...] + Attaches secondary boot disks to all nodes. + + disk-image + (Required) The full resource path to the source disk image to + create the secondary boot disks from. + + mode + (Optional) The configuration mode for the secondary boot disks. The + default value is "CONTAINER_IMAGE_CACHE". + --shielded-integrity-monitoring Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy @@ -618,9 +647,9 @@ FLAGS sysctl: net.core.somaxconn: '2048' net.ipv4.tcp_rmem: '4096 87380 6291456' - hugepageConfig: - hugepage_size2m: '1024' - hugepage_size1g: '2' + hugepageConfig: + hugepage_size2m: '1024' + hugepage_size1g: '2' List of supported kubelet configs in 'kubeletConfig'. diff --git a/gcloud/container/node-pools/update b/gcloud/container/node-pools/update index 294a66326..f9f8fea29 100644 --- a/gcloud/container/node-pools/update +++ b/gcloud/container/node-pools/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud container node-pools update NAME - (--enable-confidential-nodes | --enable-gvnic + (--containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + | --enable-confidential-nodes | --enable-gvnic | --enable-image-streaming | --enable-private-nodes | --enable-queued-provisioning | --labels=[KEY=VALUE,...] | --logging-variant=LOGGING_VARIANT @@ -50,6 +51,17 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS Exactly one of these must be specified: + --containerd-config-from-file=CONTAINERD_CONFIG_FROM_FILE + Path of the YAML file that contains containerd configuration entries + like configuring access to private image registries. + + For detailed information on the configuration usage, please refer to + https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration. + + Note: Updating the containerd configuration of an existing cluster or + node pool requires recreation of the existing nodes, which might + cause disruptions in running workloads. + --enable-confidential-nodes Recreate all the nodes in the node pool to be confidential VM https://cloud.google.com/compute/confidential-vm/docs/about-cvm. @@ -193,9 +205,9 @@ REQUIRED FLAGS sysctl: net.core.somaxconn: '2048' net.ipv4.tcp_rmem: '4096 87380 6291456' - hugepageConfig: - hugepage_size2m: '1024' - hugepage_size1g: '2' + hugepageConfig: + hugepage_size2m: '1024' + hugepage_size1g: '2' List of supported kubelet configs in 'kubeletConfig'. diff --git a/gcloud/dataproc/batches/submit/help b/gcloud/dataproc/batches/submit/help index 2948c63c1..7d9be4483 100644 --- a/gcloud/dataproc/batches/submit/help +++ b/gcloud/dataproc/batches/submit/help @@ -38,6 +38,12 @@ EXAMPLES --region='us-central1' --deps-bucket=gs://my-bucket \ --vars='variable=value' + To submit a Ray job, run: + + $ gcloud dataproc batches submit ray my-ray.py \ + --location='us-central1' --deps-bucket=gs://my-bucket -- ARG1 \ + ARG2 + FLAGS --async Return immediately without waiting for the operation in progress to @@ -107,7 +113,7 @@ FLAGS --request-id=REQUEST_ID A unique ID that identifies the request. If the service receives two batch create requests with the same request_id, the second request is - ignored and the operation that corresponds to the first Batch created + ignored and the operation that corresponds to the first batch created and stored in the backend is returned. Recommendation: Always set this value to a UUID. The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (), and hyphens (-). The maximum length is diff --git a/gcloud/dataproc/batches/submit/pyspark b/gcloud/dataproc/batches/submit/pyspark index 57e79792d..d6c65a0b4 100644 --- a/gcloud/dataproc/batches/submit/pyspark +++ b/gcloud/dataproc/batches/submit/pyspark @@ -123,7 +123,7 @@ FLAGS --request-id=REQUEST_ID A unique ID that identifies the request. If the service receives two batch create requests with the same request_id, the second request is - ignored and the operation that corresponds to the first Batch created + ignored and the operation that corresponds to the first batch created and stored in the backend is returned. Recommendation: Always set this value to a UUID. The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (), and hyphens (-). The maximum length is diff --git a/gcloud/dataproc/batches/submit/spark b/gcloud/dataproc/batches/submit/spark index c152d263d..58d54cabe 100644 --- a/gcloud/dataproc/batches/submit/spark +++ b/gcloud/dataproc/batches/submit/spark @@ -136,7 +136,7 @@ OPTIONAL FLAGS --request-id=REQUEST_ID A unique ID that identifies the request. If the service receives two batch create requests with the same request_id, the second request is - ignored and the operation that corresponds to the first Batch created + ignored and the operation that corresponds to the first batch created and stored in the backend is returned. Recommendation: Always set this value to a UUID. The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (), and hyphens (-). The maximum length is diff --git a/gcloud/dataproc/batches/submit/spark-r b/gcloud/dataproc/batches/submit/spark-r index 7c105e81c..2456b72c3 100644 --- a/gcloud/dataproc/batches/submit/spark-r +++ b/gcloud/dataproc/batches/submit/spark-r @@ -114,7 +114,7 @@ FLAGS --request-id=REQUEST_ID A unique ID that identifies the request. If the service receives two batch create requests with the same request_id, the second request is - ignored and the operation that corresponds to the first Batch created + ignored and the operation that corresponds to the first batch created and stored in the backend is returned. Recommendation: Always set this value to a UUID. The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (), and hyphens (-). The maximum length is diff --git a/gcloud/dataproc/batches/submit/spark-sql b/gcloud/dataproc/batches/submit/spark-sql index 8dcdd0742..d08ce75d3 100644 --- a/gcloud/dataproc/batches/submit/spark-sql +++ b/gcloud/dataproc/batches/submit/spark-sql @@ -104,7 +104,7 @@ FLAGS --request-id=REQUEST_ID A unique ID that identifies the request. If the service receives two batch create requests with the same request_id, the second request is - ignored and the operation that corresponds to the first Batch created + ignored and the operation that corresponds to the first batch created and stored in the backend is returned. Recommendation: Always set this value to a UUID. The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (), and hyphens (-). The maximum length is diff --git a/gcloud/dns/managed-zones/create b/gcloud/dns/managed-zones/create index c94ebbba5..acc8bcce2 100644 --- a/gcloud/dns/managed-zones/create +++ b/gcloud/dns/managed-zones/create @@ -2,8 +2,8 @@ NAME gcloud dns managed-zones create - create a Cloud DNS managed-zone SYNOPSIS - gcloud dns managed-zones create ZONE_NAME --description=DESCRIPTION - --dns-name=DNS_NAME [--denial-of-existence=DENIAL_OF_EXISTENCE] + gcloud dns managed-zones create ZONE_NAME --dns-name=DNS_NAME + [--denial-of-existence=DENIAL_OF_EXISTENCE] [--description=DESCRIPTION] [--dnssec-state=DNSSEC_STATE] [--forwarding-targets=[IP_ADDRESSES,...]] [--gkeclusters=[GKECLUSTERS,...]] [--ksk-algorithm=KSK_ALGORITHM] [--ksk-key-length=KSK_KEY_LENGTH] [--labels=[KEY=VALUE,...]] @@ -43,9 +43,6 @@ POSITIONAL ARGUMENTS The name of the managed-zone to be created. REQUIRED FLAGS - --description=DESCRIPTION - Short description for the managed-zone. - --dns-name=DNS_NAME The DNS name suffix that will be managed with the created zone. @@ -54,6 +51,9 @@ OPTIONAL FLAGS Requires DNSSEC enabled. DENIAL_OF_EXISTENCE must be one of: nsec, nsec3. + --description=DESCRIPTION + Short description for the managed zone. + --dnssec-state=DNSSEC_STATE The DNSSEC state for this managed zone. DNSSEC_STATE must be one of: diff --git a/gcloud/dns/managed-zones/update b/gcloud/dns/managed-zones/update index 6498b3398..645a81a8c 100644 --- a/gcloud/dns/managed-zones/update +++ b/gcloud/dns/managed-zones/update @@ -59,7 +59,7 @@ FLAGS nsec3. --description=DESCRIPTION - Short description for the managed-zone. + Short description for the managed zone. --dnssec-state=DNSSEC_STATE The DNSSEC state for this managed zone. DNSSEC_STATE must be one of: diff --git a/gcloud/domains/registrations/configure/dns b/gcloud/domains/registrations/configure/dns index 0dc2e8a0b..dba322bcc 100644 --- a/gcloud/domains/registrations/configure/dns +++ b/gcloud/domains/registrations/configure/dns @@ -17,10 +17,6 @@ DESCRIPTION servers and DNSSEC options for the given domain. However, advanced options like glue records are available. - When using Cloud DNS Zone or Google Domains name servers, DNSSEC will be - enabled by default where possible. You can disable it using the - --disable-dnssec flag. - EXAMPLES To start an interactive flow to configure DNS settings for example.com, run: @@ -32,7 +28,14 @@ EXAMPLES $ gcloud domains registrations configure dns example.com \ --cloud-dns-zone=example-zone - If the managed-zone is signed, DNSSEC will be enabled for the domain. + DNSSEC will not be enabled as it may not be safe to enable it (e.g. when + the Cloud DNS managed-zone was signed less than 24h ago). + + To use a signed Cloud DNS managed-zone example-zone for example.com and + enable DNSSEC, run: + + $ gcloud domains registrations configure dns example.com \ + --cloud-dns-zone=example-zone --no-disable-dnssec To change DNS settings for example.com according to information from a YAML file dns_settings.yaml, run: @@ -89,8 +92,6 @@ COMMONLY USED FLAGS for the domain. If it's in the same project, you can use short name. If not, use the full resource name, e.g.: --cloud-dns-zone=projects/example-project/managedZones/example-zone. - If the zone is signed, DNSSEC will be enabled by default unless you - pass --disable-dnssec. --dns-settings-from-file=DNS_SETTINGS_FILE_NAME A YAML file containing the required DNS settings. If specified, its @@ -128,9 +129,7 @@ COMMONLY USED FLAGS List of DNS name servers for the domain. --use-google-domains-dns - (DEPRECATED) Use free name servers provided by Google Domains. If - the zone is signed, DNSSEC will be enabled by default unless you - pass --disable-dnssec. + (DEPRECATED) Use free name servers provided by Google Domains. The --use-google-domains-dns option is deprecated; See https://cloud.google.com/domains/docs/deprecations/feature-deprecations. @@ -145,8 +144,12 @@ OTHER FLAGS to a Cloud DNS Zone or Google Domains nameservers. --unsafe-dns-update - Use this flag to allow DNS changes that may make your domain stop - serving. + (DEPRECATED) Use this flag to allow DNS changes that may make your + domain stop serving. + + The --unsafe-dns-update option is deprecated. To complete an unsafe DNS + operation first disable DNSSEC, then change name servers, then + (optionally) enable DNSSEC. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/domains/registrations/register b/gcloud/domains/registrations/register index 96f82b7aa..1d7a319a5 100644 --- a/gcloud/domains/registrations/register +++ b/gcloud/domains/registrations/register @@ -23,9 +23,9 @@ DESCRIPTION Also in rare cases, the domain may end up in state REGISTRATION_FAILED. In that case, delete the registration resource and try again. - When using Cloud DNS Zone or Google Domains name servers, DNSSEC will be - enabled by default where possible. You can choose to not enable DNSSEC by - using the --disable-dnssec flag. + When using Cloud DNS Zone DNSSEC will be enabled by default whenever the + Zone is DNSSEC signed. You can choose to not enable DNSSEC by using the + --disable-dnssec flag. EXAMPLES To register example.com interactively, run: diff --git a/gcloud/firebase/test/android/run b/gcloud/firebase/test/android/run index 7496d789d..4bbb50c12 100644 --- a/gcloud/firebase/test/android/run +++ b/gcloud/firebase/test/android/run @@ -20,7 +20,7 @@ SYNOPSIS [--scenario-numbers=int,[int,...]] [--test-package=TEST_PACKAGE] [--test-runner-class=TEST_RUNNER_CLASS] [--test-targets=TEST_TARGET,[TEST_TARGET,...]] [--use-orchestrator] - [--robo-directives=[TYPE:RESOURCE_NAME=INPUT,...]] + [--resign] [--robo-directives=[TYPE:RESOURCE_NAME=INPUT,...]] [--robo-script=ROBO_SCRIPT] [--device-ids=MODEL_ID,[MODEL_ID,...], -d MODEL_ID,[MODEL_ID,...]] [--locales=LOCALE,[LOCALE,...], -l LOCALE,[LOCALE,...]] @@ -405,6 +405,17 @@ ANDROID INSTRUMENTATION TEST FLAGS for more information about Android Test Orchestrator. ANDROID ROBO TEST FLAGS + --resign + Make Robo re-sign the app-under-test APK for a higher quality crawl. If + your app cannot properly function when re-signed, disable this feature. + When an app-under-test APK is not re-signed, Robo crawl is slower and + Robo has access to less information about the state of the crawled app, + which reduces crawl quality. Consequently, if your Roboscript has + actions on elements of RecyclerView or AdapterView, and you disable APK + re-signing, those actions might require manual tweaking because Robo + does not identify RecyclerView and AdapterView in this mode. Enabled by + default, use --no-resign to disable. + --robo-directives=[TYPE:RESOURCE_NAME=INPUT,...] A comma-separated (:=) map of robo_directives that you can use to customize the behavior of Robo test. The type specifies diff --git a/gcloud/iam/workforce-pools/providers/create-oidc b/gcloud/iam/workforce-pools/providers/create-oidc index 3a8420886..d5decfb9e 100644 --- a/gcloud/iam/workforce-pools/providers/create-oidc +++ b/gcloud/iam/workforce-pools/providers/create-oidc @@ -13,7 +13,10 @@ SYNOPSIS [--async] [--attribute-condition=ATTRIBUTE_CONDITION] [--client-secret-value=CLIENT_SECRET_VALUE] [--description=DESCRIPTION] [--disabled] [--display-name=DISPLAY_NAME] - [--jwk-json-path=JWK_JSON_PATH] [GCLOUD_WIDE_FLAG ...] + [--jwk-json-path=JWK_JSON_PATH] + [--extra-attributes-client-id=EXTRA_ATTRIBUTES_CLIENT_ID + --extra-attributes-client-secret-value=EXTRA_ATTRIBUTES_CLIENT_SECRET_VALUE --extra-attributes-issuer-uri=EXTRA_ATTRIBUTES_ISSUER_URI --extra-attributes-type=EXTRA_ATTRIBUTES_TYPE : --extra-attributes-filter=EXTRA_ATTRIBUTES_FILTER] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Create a new OIDC workforce pool provider. @@ -266,6 +269,34 @@ OPTIONAL FLAGS ] } + --extra-attributes-client-id=EXTRA_ATTRIBUTES_CLIENT_ID + The OAuth 2.0 client ID for retrieving extra attributes from the + identity provider. Required to get the Access Token using client + credentials grant flow. + + --extra-attributes-client-secret-value=EXTRA_ATTRIBUTES_CLIENT_SECRET_VALUE + The OAuth 2.0 client secret for retrieving extra attributes from the + identity provider. Required to get the Access Token using client + credentials grant flow. + + --extra-attributes-issuer-uri=EXTRA_ATTRIBUTES_ISSUER_URI + OIDC identity provider's issuer URI. Must be a valid URI using the + 'https' scheme. Required to get the OIDC discovery document. + + --extra-attributes-type=EXTRA_ATTRIBUTES_TYPE + Represents the identity provider and type of claims that should be + fetched. EXTRA_ATTRIBUTES_TYPE must be one of: + attributes-type-unspecified, azure-ad-groups-mail. + + --extra-attributes-filter=EXTRA_ATTRIBUTES_FILTER + The filter used to request specific records from IdP. In case of + attributes type as AZURE_AD_GROUPS_MAIL, it represents the filter used + to request specific groups for users from IdP. By default all the + groups associated with the user are fetched. The groups that are used + should be mail enabled and security enabled. See + https://learn.microsoft.com/en-us/graph/search-query-parameter for more + details. + 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/iam/workforce-pools/providers/update-oidc b/gcloud/iam/workforce-pools/providers/update-oidc index 596bc671f..54b037a31 100644 --- a/gcloud/iam/workforce-pools/providers/update-oidc +++ b/gcloud/iam/workforce-pools/providers/update-oidc @@ -13,6 +13,9 @@ SYNOPSIS [--web-sso-assertion-claims-behavior=WEB_SSO_ASSERTION_CLAIMS_BEHAVIOR] [--web-sso-response-type=WEB_SSO_RESPONSE_TYPE] [--clear-client-secret | --client-secret-value=CLIENT_SECRET_VALUE] + [--clear-extra-attributes-config + | --extra-attributes-client-id=EXTRA_ATTRIBUTES_CLIENT_ID + --extra-attributes-client-secret-value=EXTRA_ATTRIBUTES_CLIENT_SECRET_VALUE --extra-attributes-filter=EXTRA_ATTRIBUTES_FILTER --extra-attributes-issuer-uri=EXTRA_ATTRIBUTES_ISSUER_URI --extra-attributes-type=EXTRA_ATTRIBUTES_TYPE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -253,6 +256,39 @@ FLAGS The OIDC client secret. Required to enable Authorization Code flow for web sign-in. + At most one of these can be specified: + + --clear-extra-attributes-config + Clear the extra attributes configuration + + --extra-attributes-client-id=EXTRA_ATTRIBUTES_CLIENT_ID + The OAuth 2.0 client ID for retrieving extra attributes from the + identity provider. Required to get the Access Token using client + credentials grant flow. + + --extra-attributes-client-secret-value=EXTRA_ATTRIBUTES_CLIENT_SECRET_VALUE + The OAuth 2.0 client secret for retrieving extra attributes from the + identity provider. Required to get the Access Token using client + credentials grant flow. + + --extra-attributes-filter=EXTRA_ATTRIBUTES_FILTER + The filter used to request specific records from IdP. In case of + attributes type as AZURE_AD_GROUPS_MAIL, it represents the filter + used to request specific groups for users from IdP. By default all + the groups associated with the user are fetched. The groups that are + used should be mail enabled and security enabled. See + https://learn.microsoft.com/en-us/graph/search-query-parameter for + more details. + + --extra-attributes-issuer-uri=EXTRA_ATTRIBUTES_ISSUER_URI + OIDC identity provider's issuer URI. Must be a valid URI using the + 'https' scheme. Required to get the OIDC discovery document. + + --extra-attributes-type=EXTRA_ATTRIBUTES_TYPE + Represents the identity provider and type of claims that should be + fetched. EXTRA_ATTRIBUTES_TYPE must be one of: + attributes-type-unspecified, azure-ad-groups-mail. + 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/iot/devices/commands/help b/gcloud/iot/devices/commands/help deleted file mode 100644 index 96b297a89..000000000 --- a/gcloud/iot/devices/commands/help +++ /dev/null @@ -1,29 +0,0 @@ -NAME - gcloud iot devices commands - manage commands for Cloud IoT devices - -SYNOPSIS - gcloud iot devices commands COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Manage commands for Cloud IoT devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - send - (DEPRECATED) Sends a command to a device. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices commands - - $ gcloud beta iot devices commands - diff --git a/gcloud/iot/devices/commands/send b/gcloud/iot/devices/commands/send deleted file mode 100644 index 78e128dcb..000000000 --- a/gcloud/iot/devices/commands/send +++ /dev/null @@ -1,106 +0,0 @@ -NAME - gcloud iot devices commands send - sends a command to a device - -SYNOPSIS - gcloud iot devices commands send - (--command-data=COMMAND_DATA | --command-file=COMMAND_FILE) - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--subfolder=SUBFOLDER] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - Sends a command to a device. - -EXAMPLES - To send a simple command to a device in 'my-registry' and region - 'us-central1' using a special command subfolder, run: - - $ gcloud iot devices commands send --region=us-central1 \ - --registry=my-registry --device=my-device \ - --command-data="restart job" \ - --subfolder="/jobs/metric_collector" - - To send a command containing special characters to a device in - 'my-registry' and region 'us-central1', run: - - $ gcloud iot devices commands send --region=us-central1 \ - --registry=my-registry --device=my-device \ - --command-file=/path/to/command.file - -REQUIRED FLAGS - Exactly one of these must be specified: - - --command-data=COMMAND_DATA - The data for this command, as a string. For any values that contain - special characters (in the context of your shell), use the - --command-file flag instead. - - --command-file=COMMAND_FILE - Path to a local file containing the data for this command. - - Device resource - The device you want to send commands to. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The name of the Cloud IoT registry. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -OPTIONAL FLAGS - --subfolder=SUBFOLDER - The commands subfolder to append to the topic path. - - This field must not have more than 256 characters, and must not contain - any MQTT wildcards ("+" or "#") or null 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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - These variants are also available: - - $ gcloud alpha iot devices commands send - - $ gcloud beta iot devices commands send - diff --git a/gcloud/iot/devices/configs/describe b/gcloud/iot/devices/configs/describe deleted file mode 100644 index c8c301521..000000000 --- a/gcloud/iot/devices/configs/describe +++ /dev/null @@ -1,75 +0,0 @@ -NAME - gcloud iot devices configs describe - show details about the latest - configuration for a device - -SYNOPSIS - gcloud iot devices configs describe - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Show details about the latest configuration for a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To show the details of the latest configuration for a device in region - 'us-central1', run: - - $ gcloud iot devices configs describe --region=us-central1 \ - --registry=my-registry --device=my-device - -REQUIRED FLAGS - Device resource - The device for the configuration 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices configs describe - - $ gcloud beta iot devices configs describe - diff --git a/gcloud/iot/devices/configs/get-value b/gcloud/iot/devices/configs/get-value deleted file mode 100644 index 998647b20..000000000 --- a/gcloud/iot/devices/configs/get-value +++ /dev/null @@ -1,75 +0,0 @@ -NAME - gcloud iot devices configs get-value - show the binary data of a device's - latest configuration - -SYNOPSIS - gcloud iot devices configs get-value - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Show the binary data of a device's latest configuration. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To show the binary data of the latest configuration of a device in region - 'us-central1', run: - - $ gcloud iot devices configs get-value --region=us-central1 \ - --registry=my-registry --device=my-device - -REQUIRED FLAGS - Device resource - The device for the configuration to get the value 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices configs get-value - - $ gcloud beta iot devices configs get-value - diff --git a/gcloud/iot/devices/configs/help b/gcloud/iot/devices/configs/help deleted file mode 100644 index 738ea4e4a..000000000 --- a/gcloud/iot/devices/configs/help +++ /dev/null @@ -1,40 +0,0 @@ -NAME - gcloud iot devices configs - manage configurations for Cloud IoT devices - -SYNOPSIS - gcloud iot devices configs COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Manage configurations for Cloud IoT devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing configurations for Google Cloud IoT devices. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - describe - (DEPRECATED) Show details about the latest configuration for a device. - - get-value - (DEPRECATED) Show the binary data of a device's latest configuration. - - list - (DEPRECATED) List configs for a device. - - update - (DEPRECATED) Update a specific device configuration. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices configs - - $ gcloud beta iot devices configs - diff --git a/gcloud/iot/devices/configs/list b/gcloud/iot/devices/configs/list deleted file mode 100644 index 0dad1e069..000000000 --- a/gcloud/iot/devices/configs/list +++ /dev/null @@ -1,98 +0,0 @@ -NAME - gcloud iot devices configs list - list configs for a device - -SYNOPSIS - gcloud iot devices configs list - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--filter=EXPRESSION] [--limit=LIMIT] [--sort-by=[FIELD,...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) List configs for a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - - This command lists all available configurations in the history of the - device. Up to 10 are kept; you may restrict the output to fewer via the - --limit flag. - -EXAMPLES - To list the 3 latest configurations of a device in region 'us-central1', - run: - - $ gcloud iot devices configs list --region=us-central1 \ - --registry=my-registry --device=my-device --limit=3 - -REQUIRED FLAGS - Device resource - The device for which to list configs. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices configs list - - $ gcloud beta iot devices configs list - diff --git a/gcloud/iot/devices/configs/update b/gcloud/iot/devices/configs/update deleted file mode 100644 index c25ac3038..000000000 --- a/gcloud/iot/devices/configs/update +++ /dev/null @@ -1,107 +0,0 @@ -NAME - gcloud iot devices configs update - update a specific device configuration - -SYNOPSIS - gcloud iot devices configs update - (--config-data=CONFIG_DATA | --config-file=CONFIG_FILE) - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--version-to-update=VERSION_TO_UPDATE] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Update a specific device configuration. - - This command is deprecated. Google Cloud IoT Core has been retired. - - This command updates the current configuration of the device. - - It always creates a new config with a new version number; if - --version-to-update is provided, the config at that version is used as a - base. - -EXAMPLES - To update the latest configuration of a device in region 'us-central1', - run: - - $ gcloud iot devices configs update --region=us-central1 \ - --registry=my-registry --device=my-device \ - --config-data="job_timeout:300" - - To update the latest configuration of a device in region 'us-central1' only - if the latest configuration version is 11, run: - - $ gcloud iot devices configs update --region=us-central1 \ - --registry=my-registry --device=my-device \ - --config-file=/path/to/config.base64 --version-to-update=11 - -REQUIRED FLAGS - Exactly one of these must be specified: - - --config-data=CONFIG_DATA - The data for this configuration, as a string. For any values that - contain special characters (in the context of your shell), use the - --config-file flag instead. - - --config-file=CONFIG_FILE - Path to a local file containing the data for this configuration. - - Device resource - The device for the configuration 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -OPTIONAL FLAGS - --version-to-update=VERSION_TO_UPDATE - The version number to update. If this value is 0 or unspecified, it - will not check the version number of the server and will always update - the current version; otherwise, this update will fail if the version - number provided does not match the latest version on the server. This - is used to detect conflicts with simultaneous updates. - -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 iot devices configs update - - $ gcloud beta iot devices configs update - diff --git a/gcloud/iot/devices/create b/gcloud/iot/devices/create deleted file mode 100644 index 904f2d9ed..000000000 --- a/gcloud/iot/devices/create +++ /dev/null @@ -1,193 +0,0 @@ -NAME - gcloud iot devices create - create a new device - -SYNOPSIS - gcloud iot devices create (DEVICE : --region=REGION --registry=REGISTRY) - [--auth-method=AUTH_METHOD] [--blocked] [--device-type=DEVICE_TYPE] - [--log-level=LOG_LEVEL] [--metadata=[KEY=VALUE,...]] - [--metadata-from-file=[KEY=PATH,...]] - [--public-key=[path=PATH, - type=TYPE,[expiration-time=EXPIRATION-TIME],...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - Create a new device. - -EXAMPLES - To create a new device 'my-device' in device registry 'my-registry' and - region 'us-central1', run: - - $ gcloud iot devices create my-device --region=us-central1 \ - --registry=my-registry - - The following command creates a new non-gateway device 'my-device' in - device registry 'my-registry' and region 'us-central1', blocks the device, - and sets metadata values. - - $ gcloud iot devices create my-device --region=us-central1 \ - --registry=my-registry --blocked --device-type=non-gateway \ - --metadata=key1=value1,key2=value2 - -POSITIONAL ARGUMENTS - Device resource - The device you want 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 device 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. - - DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument device 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The name of the Cloud IoT registry. - - To set the registry attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -FLAGS - --auth-method=AUTH_METHOD - The authorization/authentication method used by devices in relation to - the gateway. This property is set only on gateways. If left - unspecified, devices will not be able to access the gateway. - AUTH_METHOD must be one of: - - association-and-device-auth-token - The device is authenticated through both device credentials and - gateway association. - association-only - The device is authenticated through the gateway association only. - Device credentials are ignored if provided. - device-auth-token-only - The device is authenticated through its own credentials. Gateway - association is not checked. - - --blocked - If blocked, connections from this device will fail. - - Can be used to temporarily prevent the device from connecting if, for - example, the sensor is generating bad data and needs maintenance. - - Connections to device is not blocked by default. - - --device-type=DEVICE_TYPE - Whether this device is a gateway. If unspecified, non-gateway is - assumed. DEVICE_TYPE must be one of: gateway, non-gateway. - - --log-level=LOG_LEVEL - The default logging verbosity for activity from devices in this - registry. The verbosity level can be overridden by setting a specific - device's log level. LOG_LEVEL must be one of: - - debug - All events will be logged. - error - Error events will be logged. - info - Informational events will be logged, such as connections and - disconnections. Also includes error events. - none - Disables logging. - - --metadata=[KEY=VALUE,...] - The metadata key/value pairs assigned to devices. This metadata is not - interpreted or indexed by Cloud IoT Core. It can be used to add - contextual information for the device. - - Keys should only contain the following characters [a-zA-Z0-9-_] and be - fewer than 128 bytes in length. Values are free-form strings. Each - value must be fewer than or equal to 32 KB in size. - - The total size of all keys and values must be less than 256 KB, and the - maximum number of key-value pairs is 500. - - --metadata-from-file=[KEY=PATH,...] - Same as --metadata, but the metadata values will be read from the file - specified by path. - - --public-key=[path=PATH,type=TYPE,[expiration-time=EXPIRATION-TIME],...] - Specify a public key. - - Supports four key types: - - ◆ rsa-x509-pem: As RSA_PEM, but wrapped in an X.509v3 certificate - (RFC5280 (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, - and wrapped by -----BEGIN CERTIFICATE----- and -----END - CERTIFICATE-----. - ◆ rsa-pem: An RSA public key encoded in base64, and wrapped by - -----BEGIN PUBLIC KEY----- and -----END PUBLIC KEY-----. This can be - used to verify RS256 signatures in JWT tokens (RFC7518 - (https://www.ietf.org/rfc/rfc7518.txt)). - ◆ rs256: Deprecated name for rsa-x509-pem - ◆ es256-x509-pem: As ES256_PEM, but wrapped in an X.509v3 certificate - (RFC5280 (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, - and wrapped by -----BEGIN CERTIFICATE----- and -----END - CERTIFICATE-----. - ◆ es256-pem: Public key for the ECDSA algorithm using P-256 and - SHA-256, encoded in base64, and wrapped by -----BEGIN PUBLIC KEY----- - and -----END PUBLIC KEY-----. This can be used to verify JWT tokens - with the ES256 algorithm (RFC7518 - (https://www.ietf.org/rfc/rfc7518.txt)). This curve is defined in - OpenSSL (https://www.openssl.org/) as the prime256v1 curve. - ◆ es256: Deprecated nmame for es256-pem - - The key specification is given via the following sub-arguments: - - ◆ path: Required. The path on disk to the file containing the key. - ◆ type: Required. One of [es256, es256-pem, es256-x509-pem, rs256, - rsa-pem, rsa-x509-pem]. The type of the key. - ◆ expiration-time: Optional. The expiration time for the key. See $ - gcloud topic datetimes for information on time formats. - - For example: - - --public-key \ - path=/path/to/id_rsa.pem,type=RSA_PEM,expiration-time=2017-01-01T00:00-05 - - This flag may be provide multiple times to provide multiple keys - (maximum 3). - -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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - These variants are also available: - - $ gcloud alpha iot devices create - - $ gcloud beta iot devices create - diff --git a/gcloud/iot/devices/credentials/clear b/gcloud/iot/devices/credentials/clear deleted file mode 100644 index ec20d6ee5..000000000 --- a/gcloud/iot/devices/credentials/clear +++ /dev/null @@ -1,73 +0,0 @@ -NAME - gcloud iot devices credentials clear - delete all credentials from a device - -SYNOPSIS - gcloud iot devices credentials clear - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Delete all credentials from a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete all credentials from a device in region 'us-central1', run: - - $ gcloud iot devices credentials clear --region=us-central1 \ - --registry=my-registry --device=my-device - -REQUIRED FLAGS - Device resource - The device for which to clear credentials. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices credentials clear - - $ gcloud beta iot devices credentials clear - diff --git a/gcloud/iot/devices/credentials/create b/gcloud/iot/devices/credentials/create deleted file mode 100644 index 7ac5a9b27..000000000 --- a/gcloud/iot/devices/credentials/create +++ /dev/null @@ -1,121 +0,0 @@ -NAME - gcloud iot devices credentials create - add a new credential to a device - -SYNOPSIS - gcloud iot devices credentials create --path=PATH --type=TYPE - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--expiration-time=EXPIRATION_TIME] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Add a new credential to a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - - A device may have at most 3 credentials. - -EXAMPLES - To add an RSA public key wrapped in an X.509v3 certificate to a device, - run: - - $ gcloud iot devices credentials create --region=us-central1 \ - --registry=my-registry --device=my-device \ - --path=/path/to/cert.pem --type=rsa-x509-pem - - To add a public key for the ECDSA algorithm to a device, run: - - $ gcloud iot devices credentials create --region=us-central1 \ - --registry=my-registry --device=my-device \ - --path=/path/to/ec_public.pem --type=es256-pem - -REQUIRED FLAGS - --path=PATH - The path on disk to the file containing the key. - - --type=TYPE - The type of the key. TYPE must be one of: - - es256 - Deprecated nmame for es256-pem - es256-pem - Public key for the ECDSA algorithm using P-256 and SHA-256, encoded - in base64, and wrapped by -----BEGIN PUBLIC KEY----- and -----END - PUBLIC KEY-----. This can be used to verify JWT tokens with the - ES256 algorithm (RFC7518 (https://www.ietf.org/rfc/rfc7518.txt)). - This curve is defined in OpenSSL (https://www.openssl.org/) as the - prime256v1 curve. - es256-x509-pem - As ES256_PEM, but wrapped in an X.509v3 certificate (RFC5280 - (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and - wrapped by -----BEGIN CERTIFICATE----- and -----END - CERTIFICATE-----. - rs256 - Deprecated name for rsa-x509-pem - rsa-pem - An RSA public key encoded in base64, and wrapped by -----BEGIN - PUBLIC KEY----- and -----END PUBLIC KEY-----. This can be used to - verify RS256 signatures in JWT tokens (RFC7518 - (https://www.ietf.org/rfc/rfc7518.txt)). - rsa-x509-pem - As RSA_PEM, but wrapped in an X.509v3 certificate (RFC5280 - (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and - wrapped by -----BEGIN CERTIFICATE----- and -----END - CERTIFICATE-----. - - Device resource - The device for which to create credentials. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -OPTIONAL FLAGS - --expiration-time=EXPIRATION_TIME - The expiration time for the key. See $ gcloud topic datetimes for - information on time formats. - -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 iot devices credentials create - - $ gcloud beta iot devices credentials create - diff --git a/gcloud/iot/devices/credentials/delete b/gcloud/iot/devices/credentials/delete deleted file mode 100644 index 9e663f65f..000000000 --- a/gcloud/iot/devices/credentials/delete +++ /dev/null @@ -1,77 +0,0 @@ -NAME - gcloud iot devices credentials delete - delete a credential from a device - -SYNOPSIS - gcloud iot devices credentials delete INDEX - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Delete a credential from a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete the first credential from a device in region 'us-central1', run: - - $ gcloud iot devices credentials delete --region=us-central1 \ - --registry=my-registry --device=my-device 0 - -POSITIONAL ARGUMENTS - INDEX - The index (zero-based) of the credential to delete. - -REQUIRED FLAGS - Device resource - The device from which to delete credentials. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices credentials delete - - $ gcloud beta iot devices credentials delete - diff --git a/gcloud/iot/devices/credentials/describe b/gcloud/iot/devices/credentials/describe deleted file mode 100644 index 49333393e..000000000 --- a/gcloud/iot/devices/credentials/describe +++ /dev/null @@ -1,78 +0,0 @@ -NAME - gcloud iot devices credentials describe - show details about a specific - device credential - -SYNOPSIS - gcloud iot devices credentials describe INDEX - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Show details about a specific device credential. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To describe the first credential of a device in region 'us-central1', run: - - $ gcloud iot devices credentials describe --region=us-central1 \ - --registry=my-registry --device=my-device 0 - -POSITIONAL ARGUMENTS - INDEX - The index (zero-based) of the credential to describe. - -REQUIRED FLAGS - Device resource - The device to which the credential belongs. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices credentials describe - - $ gcloud beta iot devices credentials describe - diff --git a/gcloud/iot/devices/credentials/help b/gcloud/iot/devices/credentials/help deleted file mode 100644 index ffd0f27c0..000000000 --- a/gcloud/iot/devices/credentials/help +++ /dev/null @@ -1,46 +0,0 @@ -NAME - gcloud iot devices credentials - manage credentials for Cloud IoT devices - -SYNOPSIS - gcloud iot devices credentials COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Manage credentials for Cloud IoT devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing credentials for Google Cloud IoT devices. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - clear - (DEPRECATED) Delete all credentials from a device. - - create - (DEPRECATED) Add a new credential to a device. - - delete - (DEPRECATED) Delete a credential from a device. - - describe - (DEPRECATED) Show details about a specific device credential. - - list - (DEPRECATED) List credentials for a device. - - update - (DEPRECATED) Update a specific device credential. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices credentials - - $ gcloud beta iot devices credentials - diff --git a/gcloud/iot/devices/credentials/list b/gcloud/iot/devices/credentials/list deleted file mode 100644 index b6ed79f5d..000000000 --- a/gcloud/iot/devices/credentials/list +++ /dev/null @@ -1,93 +0,0 @@ -NAME - gcloud iot devices credentials list - list credentials for a device - -SYNOPSIS - gcloud iot devices credentials list - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--filter=EXPRESSION] [--limit=LIMIT] [--sort-by=[FIELD,...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) List credentials for a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To list the credentials of a device in region 'us-central1', run: - - $ gcloud iot devices credentials list --region=us-central1 \ - --registry=my-registry --device=my-device - -REQUIRED FLAGS - Device resource - The device for which to list credentials. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices credentials list - - $ gcloud beta iot devices credentials list - diff --git a/gcloud/iot/devices/credentials/update b/gcloud/iot/devices/credentials/update deleted file mode 100644 index ae1c3aab9..000000000 --- a/gcloud/iot/devices/credentials/update +++ /dev/null @@ -1,84 +0,0 @@ -NAME - gcloud iot devices credentials update - update a specific device credential - -SYNOPSIS - gcloud iot devices credentials update INDEX - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--expiration-time=EXPIRATION_TIME] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Update a specific device credential. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To update the expiration time of the first credential of a device in region - 'us-central1', run: - - $ gcloud iot devices credentials update --region=us-central1 \ - --registry=my-registry --device=my-device \ - --expiration-time=2020-12-30T10:50:22Z 0 - -POSITIONAL ARGUMENTS - INDEX - The index (zero-based) of the credential to update. - -REQUIRED FLAGS - Device resource - The device for which to update credentials. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -OPTIONAL FLAGS - --expiration-time=EXPIRATION_TIME - The expiration time for the key. See $ gcloud topic datetimes for - information on time formats. - -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 iot devices credentials update - - $ gcloud beta iot devices credentials update - diff --git a/gcloud/iot/devices/delete b/gcloud/iot/devices/delete deleted file mode 100644 index 012896c9e..000000000 --- a/gcloud/iot/devices/delete +++ /dev/null @@ -1,74 +0,0 @@ -NAME - gcloud iot devices delete - delete a device - -SYNOPSIS - gcloud iot devices delete (DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - (DEPRECATED) Delete a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete a device from device registry 'my-registry', run: - - $ gcloud iot devices delete my-device --region=us-central1 \ - --registry=my-registry - -POSITIONAL ARGUMENTS - Device resource - The device 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 device 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. - - DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument device on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices delete - - $ gcloud beta iot devices delete - diff --git a/gcloud/iot/devices/describe b/gcloud/iot/devices/describe deleted file mode 100644 index d0ace154d..000000000 --- a/gcloud/iot/devices/describe +++ /dev/null @@ -1,74 +0,0 @@ -NAME - gcloud iot devices describe - show details about a device - -SYNOPSIS - gcloud iot devices describe (DEVICE : --region=REGION --registry=REGISTRY) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - (DEPRECATED) Show details about a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To show details about a device, run: - - $ gcloud iot devices describe my-device --region=us-central1 \ - --registry=my-registry - -POSITIONAL ARGUMENTS - Device resource - The device 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 device 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. - - DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument device on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices describe - - $ gcloud beta iot devices describe - diff --git a/gcloud/iot/devices/gateways/bind b/gcloud/iot/devices/gateways/bind deleted file mode 100644 index 6862bf654..000000000 --- a/gcloud/iot/devices/gateways/bind +++ /dev/null @@ -1,122 +0,0 @@ -NAME - gcloud iot devices gateways bind - associate a device with a gateway - -SYNOPSIS - gcloud iot devices gateways bind - (--device=DEVICE - : --device-region=DEVICE_REGION --device-registry=DEVICE_REGISTRY) - (--gateway=GATEWAY : --gateway-region=GATEWAY_REGION - --gateway-registry=GATEWAY_REGISTRY) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - Associate a device with a gateway. - -EXAMPLES - To associate 'my-device' with 'my-gateway' in region 'us-central1', run: - - $ gcloud iot devices gateways bind --device=my-device \ - --device-region=us-central1 --device-registry=my-registry \ - --gateway=my-gateway --gateway-region=us-central1 \ - --gateway-registry=my-registry - -REQUIRED FLAGS - Device resource - The device to bind to the gateway. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --device-region=DEVICE_REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --device-region on the command line. - - --device-registry=DEVICE_REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --device-registry on the command line; - ▸ provide the argument --gateway-registry on the command line. - - Gateway resource - The gateway device to bind to. 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 --gateway 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. - - --gateway=GATEWAY - ID of the gateway or fully qualified identifier for the gateway. - - To set the gateway attribute: - ▸ provide the argument --gateway on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --gateway-region=GATEWAY_REGION - The Cloud region for the gateway. - - To set the region attribute: - ▸ provide the argument --gateway on the command line with a fully - specified name; - ▸ provide the argument --gateway-region on the command line. - - --gateway-registry=GATEWAY_REGISTRY - The device registry for the gateway. - - To set the registry attribute: - ▸ provide the argument --gateway on the command line with a fully - specified name; - ▸ provide the argument --gateway-registry on the command line; - ▸ provide the argument --device-registry 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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - These variants are also available: - - $ gcloud alpha iot devices gateways bind - - $ gcloud beta iot devices gateways bind - diff --git a/gcloud/iot/devices/gateways/help b/gcloud/iot/devices/gateways/help deleted file mode 100644 index 47268cc2a..000000000 --- a/gcloud/iot/devices/gateways/help +++ /dev/null @@ -1,35 +0,0 @@ -NAME - gcloud iot devices gateways - manage Cloud IoT Core Gateway Associations - -SYNOPSIS - gcloud iot devices gateways COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Manage Cloud IoT Core Gateway Associations. - - This command is deprecated. Google Cloud IoT Core has been retired. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - bind - (DEPRECATED) Associate a device with a gateway. - - list-bound-devices - (DEPRECATED) Lists all of the devices bound to the gateway. - - unbind - (DEPRECATED) Remove the association between a device and a gateway. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices gateways - - $ gcloud beta iot devices gateways - diff --git a/gcloud/iot/devices/gateways/list-bound-devices b/gcloud/iot/devices/gateways/list-bound-devices deleted file mode 100644 index a41724d8e..000000000 --- a/gcloud/iot/devices/gateways/list-bound-devices +++ /dev/null @@ -1,102 +0,0 @@ -NAME - gcloud iot devices gateways list-bound-devices - lists all of the devices - bound to the gateway - -SYNOPSIS - gcloud iot devices gateways list-bound-devices --gateway=GATEWAY - (--registry=REGISTRY : --region=REGION) [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - Lists all of the devices bound to the gateway. - -EXAMPLES - To list all of the devices bound to the gateway 'my-gateway' in region - 'us-central1' and in registry 'my-registry', run: - - $ gcloud iot devices gateways list-bound-devices \ - --gateway=my-gateway --region=us-central1 --registry=my-registry - -REQUIRED FLAGS - --gateway=GATEWAY - The gateway id or numeric id you want to list bound devices for. - - Registry resource - The registry you want to list bound devices 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - - --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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - These variants are also available: - - $ gcloud alpha iot devices gateways list-bound-devices - - $ gcloud beta iot devices gateways list-bound-devices - diff --git a/gcloud/iot/devices/gateways/unbind b/gcloud/iot/devices/gateways/unbind deleted file mode 100644 index f8725d952..000000000 --- a/gcloud/iot/devices/gateways/unbind +++ /dev/null @@ -1,124 +0,0 @@ -NAME - gcloud iot devices gateways unbind - remove the association between a - device and a gateway - -SYNOPSIS - gcloud iot devices gateways unbind - (--device=DEVICE - : --device-region=DEVICE_REGION --device-registry=DEVICE_REGISTRY) - (--gateway=GATEWAY : --gateway-region=GATEWAY_REGION - --gateway-registry=GATEWAY_REGISTRY) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - Remove the association between a device and a gateway. - -EXAMPLES - To remove the association between 'my-device' and 'my-gateway' in region - 'us-central1', run: - - $ gcloud iot devices gateways unbind --device=my-device \ - --device-region=us-central1 --device-registry=my-registry \ - --gateway=my-gateway --gateway-region=us-central1 \ - --gateway-registry=my-registry - -REQUIRED FLAGS - Device resource - The device to unbind from the gateway. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --device-region=DEVICE_REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --device-region on the command line. - - --device-registry=DEVICE_REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --device-registry on the command line; - ▸ provide the argument --gateway-registry on the command line. - - Gateway resource - The gateway device to unbind 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 --gateway 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. - - --gateway=GATEWAY - ID of the gateway or fully qualified identifier for the gateway. - - To set the gateway attribute: - ▸ provide the argument --gateway on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --gateway-region=GATEWAY_REGION - The Cloud region for the gateway. - - To set the region attribute: - ▸ provide the argument --gateway on the command line with a fully - specified name; - ▸ provide the argument --gateway-region on the command line. - - --gateway-registry=GATEWAY_REGISTRY - The device registry for the gateway. - - To set the registry attribute: - ▸ provide the argument --gateway on the command line with a fully - specified name; - ▸ provide the argument --gateway-registry on the command line; - ▸ provide the argument --device-registry 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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - These variants are also available: - - $ gcloud alpha iot devices gateways unbind - - $ gcloud beta iot devices gateways unbind - diff --git a/gcloud/iot/devices/help b/gcloud/iot/devices/help deleted file mode 100644 index e458472c3..000000000 --- a/gcloud/iot/devices/help +++ /dev/null @@ -1,61 +0,0 @@ -NAME - gcloud iot devices - manage Cloud IoT Devices - -SYNOPSIS - gcloud iot devices GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Manage Cloud IoT Devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing Google Cloud IoT Devices. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -GROUPS - GROUP is one of the following: - - commands - (DEPRECATED) Manage commands for Cloud IoT devices. - - configs - (DEPRECATED) Manage configurations for Cloud IoT devices. - - credentials - (DEPRECATED) Manage credentials for Cloud IoT devices. - - gateways - (DEPRECATED) Manage Cloud IoT Core Gateway Associations. - - states - (DEPRECATED) Manage states for Cloud IoT devices. - -COMMANDS - COMMAND is one of the following: - - create - (DEPRECATED) Create a new device. - - delete - (DEPRECATED) Delete a device. - - describe - (DEPRECATED) Show details about a device. - - list - (DEPRECATED) List devices. - - update - (DEPRECATED) Update an existing device. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices - - $ gcloud beta iot devices - diff --git a/gcloud/iot/devices/list b/gcloud/iot/devices/list deleted file mode 100644 index 2875157a2..000000000 --- a/gcloud/iot/devices/list +++ /dev/null @@ -1,122 +0,0 @@ -NAME - gcloud iot devices list - list devices - -SYNOPSIS - gcloud iot devices list (--registry=REGISTRY : --region=REGION) - [--device-field-mask=DEVICE_FIELD_MASK; - default="blocked,gatewayConfig"] [--device-ids=[DEVICE_IDS,...]] - [--device-num-ids=[DEVICE_NUM_IDS,...]] [--device-type=DEVICE_TYPE] - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - List devices. - -EXAMPLES - To list all devices in the device registry 'my-registry' and region - 'us-central1', run: - - $ gcloud iot devices list --region=us-central1 --registry=my-registry - -REQUIRED FLAGS - Registry resource - The registry you want to list the devices 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --device-field-mask=DEVICE_FIELD_MASK; default="blocked,gatewayConfig" - If given, returns all specified device fields instead of the default - set. The value is a comma-separated list of field names. Example: - "lastErrorStatus,config,metadata". See full list of device fields at: - https://cloud.google.com/iot/docs/reference/cloudiot/rest/v1/projects.locations.registries.devices - - --device-ids=[DEVICE_IDS,...] - If given, show only devices with one of the provided IDs. - - --device-num-ids=[DEVICE_NUM_IDS,...] - If given, show only devices with one of the provided numerical IDs. - - --device-type=DEVICE_TYPE - If specified, show only devices of that type. If left unspecified, show - devices of any type. DEVICE_TYPE must be one of: gateway, non-gateway. - -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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - These variants are also available: - - $ gcloud alpha iot devices list - - $ gcloud beta iot devices list - diff --git a/gcloud/iot/devices/states/help b/gcloud/iot/devices/states/help deleted file mode 100644 index 3fdcb7b25..000000000 --- a/gcloud/iot/devices/states/help +++ /dev/null @@ -1,31 +0,0 @@ -NAME - gcloud iot devices states - manage states for Cloud IoT devices - -SYNOPSIS - gcloud iot devices states COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Manage states for Cloud IoT devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing states for Google Cloud IoT devices. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - list - (DEPRECATED) List states for a device. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices states - - $ gcloud beta iot devices states - diff --git a/gcloud/iot/devices/states/list b/gcloud/iot/devices/states/list deleted file mode 100644 index b498cdb29..000000000 --- a/gcloud/iot/devices/states/list +++ /dev/null @@ -1,100 +0,0 @@ -NAME - gcloud iot devices states list - list states for a device - -SYNOPSIS - gcloud iot devices states list - (--device=DEVICE : --region=REGION --registry=REGISTRY) - [--filter=EXPRESSION] [--limit=LIMIT] [--sort-by=[FIELD,...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - (DEPRECATED) List states for a device. - - This command is deprecated. Google Cloud IoT Core has been retired. - - This command lists all available states in the history of the device. Up to - 10 are kept; you may restrict the output to fewer via the --limit flag. - -EXAMPLES - To list states for the device 'my-device' in region 'us-central1' and in - registry 'my-registry', run: - - $ gcloud iot devices states list --device=my-device \ - --region=us-central1 --registry=my-registry - -REQUIRED FLAGS - Device resource - The device for which to list configs. 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 --device 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. - - --device=DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument --device on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument --device on the command line with a fully - specified name; - ▸ provide the argument --registry 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot devices states list - - $ gcloud beta iot devices states list - diff --git a/gcloud/iot/devices/update b/gcloud/iot/devices/update deleted file mode 100644 index a13bc5fe9..000000000 --- a/gcloud/iot/devices/update +++ /dev/null @@ -1,120 +0,0 @@ -NAME - gcloud iot devices update - update an existing device - -SYNOPSIS - gcloud iot devices update (DEVICE : --region=REGION --registry=REGISTRY) - [--blocked] [--log-level=LOG_LEVEL] [--metadata=[KEY=VALUE,...]] - [--metadata-from-file=[KEY=PATH,...]] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - (DEPRECATED) Update an existing device. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - The following command updates the device 'my-device' in device registry - 'my-registry' in region 'us-central1'. It blocks the device and sets - metadata values. - - $ gcloud iot devices update my-device --region=us-central1 \ - --registry=my-registry --blocked \ - --metadata=key1=value1,key2=value2 - -POSITIONAL ARGUMENTS - Device resource - The device 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 device 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. - - DEVICE - ID of the device or fully qualified identifier for the device. - - To set the device attribute: - ▸ provide the argument device on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the device. - - To set the region attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - --registry=REGISTRY - The device registry for the device. - - To set the registry attribute: - ▸ provide the argument device on the command line with a fully - specified name; - ▸ provide the argument --registry on the command line. - -FLAGS - --blocked - If blocked, connections from this device will fail. - - Can be used to temporarily prevent the device from connecting if, for - example, the sensor is generating bad data and needs maintenance. - - Use --no-blocked to enable connections and --blocked to disable. - - --log-level=LOG_LEVEL - The default logging verbosity for activity from devices in this - registry. The verbosity level can be overridden by setting a specific - device's log level. - - LOG_LEVEL must be one of: - - debug - All events will be logged - error - Error events will be logged. - info - Informational events will be logged, such as connections and - disconnections. Also includes error events. - none - Disables logging. - - --metadata=[KEY=VALUE,...] - The metadata key/value pairs assigned to devices. This metadata is not - interpreted or indexed by Cloud IoT Core. It can be used to add - contextual information for the device. - - Keys should only contain the following characters [a-zA-Z0-9-_] and be - fewer than 128 bytes in length. Values are free-form strings. Each - value must be fewer than or equal to 32 KB in size. - - The total size of all keys and values must be less than 256 KB, and the - maximum number of key-value pairs is 500. - - --metadata-from-file=[KEY=PATH,...] - Same as --metadata, but the metadata values will be read from the file - specified by path. - -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 iot devices update - - $ gcloud beta iot devices update - diff --git a/gcloud/iot/help b/gcloud/iot/help deleted file mode 100644 index cd41b5184..000000000 --- a/gcloud/iot/help +++ /dev/null @@ -1,34 +0,0 @@ -NAME - gcloud iot - manage Cloud IoT resources - -SYNOPSIS - gcloud iot GROUP [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Manage Cloud IoT resources. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing Google Cloud IoT resources. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -GROUPS - GROUP is one of the following: - - devices - (DEPRECATED) Manage Cloud IoT Devices. - - registries - (DEPRECATED) Manage Cloud IoT Registries. - -NOTES - These variants are also available: - - $ gcloud alpha iot - - $ gcloud beta iot - diff --git a/gcloud/iot/registries/create b/gcloud/iot/registries/create deleted file mode 100644 index dd2f29990..000000000 --- a/gcloud/iot/registries/create +++ /dev/null @@ -1,126 +0,0 @@ -NAME - gcloud iot registries create - create a new device registry - -SYNOPSIS - gcloud iot registries create (REGISTRY : --region=REGION) - [--no-enable-http-config] [--no-enable-mqtt-config] - [--event-notification-config=[subfolder=SUBFOLDER],[topic=TOPIC]] - [--log-level=LOG_LEVEL] [--public-key-path=PUBLIC_KEY_PATH] - [--state-pubsub-topic=STATE_PUBSUB_TOPIC] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - Create a new device registry. - -EXAMPLES - To create a new device registry 'my-registry' in region 'us-central1', run: - - $ gcloud iot registries create --region=us-central1 my-registry - - The following command creates a new device registry 'my-registry' in region - 'us-central1', enables MQTT and HTTP connections, and sets - 'pubsub-topic-name' as the Cloud Pub/Sub topic for state notifications. - - $ gcloud iot registries create my-registry --region=us-central1 \ - --enable-http-config --enable-mqtt-config \ - --state-pubsub-topic=pubsub-topic-name - -POSITIONAL ARGUMENTS - Registry resource - The registry you want 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry 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 Cloud IoT region. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --enable-http-config - Whether to allow device connections to the HTTP bridge. Enabled by - default, use --no-enable-http-config to disable. - - --enable-mqtt-config - Whether to allow MQTT connections to this device registry. Enabled by - default, use --no-enable-mqtt-config to disable. - - --event-notification-config=[subfolder=SUBFOLDER],[topic=TOPIC] - The configuration for notification of telemetry events received from - the device. This flag can be specified multiple times to add multiple - configs to the device registry. Configs are added to the registry in - the order the flags are specified. Only one config with an empty - subfolder field is allowed and must be specified last. - - topic - A Google Cloud Pub/Sub topic name for event notifications - - subfolder - If the subfolder name matches this string exactly, this - configuration will be used to publish telemetry events. If empty - all strings are matched. - - --log-level=LOG_LEVEL - The default logging verbosity for activity from devices in this - registry. The verbosity level can be overridden by setting a specific - device's log level. LOG_LEVEL must be one of: - - debug - All events will be logged. - error - Error events will be logged. - info - Informational events will be logged, such as connections and - disconnections. Also includes error events. - none - Disables logging. - - --public-key-path=PUBLIC_KEY_PATH - Path to a file containing an X.509v3 certificate (RFC5280 - (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped - by -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----. - - --state-pubsub-topic=STATE_PUBSUB_TOPIC - A Google Cloud Pub/Sub topic name for state notifications. - -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 cloudiot/v1 API. The full documentation for this API - can be found at: https://cloud.google.com/iot - -NOTES - These variants are also available: - - $ gcloud alpha iot registries create - - $ gcloud beta iot registries create - diff --git a/gcloud/iot/registries/credentials/clear b/gcloud/iot/registries/credentials/clear deleted file mode 100644 index e62dd8e20..000000000 --- a/gcloud/iot/registries/credentials/clear +++ /dev/null @@ -1,65 +0,0 @@ -NAME - gcloud iot registries credentials clear - delete all credentials from a - registry - -SYNOPSIS - gcloud iot registries credentials clear - (--registry=REGISTRY : --region=REGION) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Delete all credentials from a registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete all credentials from a registry in region 'us-central1', run: - - $ gcloud iot registries credentials clear --region=us-central1 \ - --registry=my-registry - -REQUIRED FLAGS - Registry resource - The device registry for which to clear credentials. - 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot registries credentials clear - - $ gcloud beta iot registries credentials clear - diff --git a/gcloud/iot/registries/credentials/create b/gcloud/iot/registries/credentials/create deleted file mode 100644 index 2561fb592..000000000 --- a/gcloud/iot/registries/credentials/create +++ /dev/null @@ -1,75 +0,0 @@ -NAME - gcloud iot registries credentials create - add a new credential to a - registry - -SYNOPSIS - gcloud iot registries credentials create --path=PATH - (--registry=REGISTRY : --region=REGION) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - (DEPRECATED) Add a new credential to a registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - - A registry may have at most 10 credentials. - -EXAMPLES - To add a credential located in '/path/to/cert.pem' to a registry, run: - - $ gcloud iot registries credentials create --region=us-central1 \ - --registry=my-registry --path=/path/to/cert.pem - -REQUIRED FLAGS - --path=PATH - Path to a file containing an X.509v3 certificate (RFC5280 - (https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped - by -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----. - - Registry resource - The device registry for which to create credentials. - 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot registries credentials create - - $ gcloud beta iot registries credentials create - diff --git a/gcloud/iot/registries/credentials/delete b/gcloud/iot/registries/credentials/delete deleted file mode 100644 index c9d8e3cf7..000000000 --- a/gcloud/iot/registries/credentials/delete +++ /dev/null @@ -1,69 +0,0 @@ -NAME - gcloud iot registries credentials delete - delete a credential from a - registry - -SYNOPSIS - gcloud iot registries credentials delete INDEX - (--registry=REGISTRY : --region=REGION) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Delete a credential from a registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete the first credential from a registry, run: - - $ gcloud iot registries credentials delete --region=us-central1 \ - --registry=my-registry 0 - -POSITIONAL ARGUMENTS - INDEX - The index (zero-based) of the credential to delete. - -REQUIRED FLAGS - Registry resource - The device registry from which to delete credentials. - 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot registries credentials delete - - $ gcloud beta iot registries credentials delete - diff --git a/gcloud/iot/registries/credentials/describe b/gcloud/iot/registries/credentials/describe deleted file mode 100644 index a3d783ae4..000000000 --- a/gcloud/iot/registries/credentials/describe +++ /dev/null @@ -1,70 +0,0 @@ -NAME - gcloud iot registries credentials describe - show details about a specific - registry credential - -SYNOPSIS - gcloud iot registries credentials describe INDEX - (--registry=REGISTRY : --region=REGION) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Show details about a specific registry credential. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To describe the first credential of a registry in region 'us-central1', - run: - - $ gcloud iot registries credentials describe --region=us-central1 \ - --registry=my-registry 0 - -POSITIONAL ARGUMENTS - INDEX - The index (zero-based) of the credential to describe. - -REQUIRED FLAGS - Registry resource - The device registry to which the credential belongs. - 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot registries credentials describe - - $ gcloud beta iot registries credentials describe - diff --git a/gcloud/iot/registries/credentials/help b/gcloud/iot/registries/credentials/help deleted file mode 100644 index c2f4e7d7b..000000000 --- a/gcloud/iot/registries/credentials/help +++ /dev/null @@ -1,44 +0,0 @@ -NAME - gcloud iot registries credentials - manage credentials for Cloud IoT - devices - -SYNOPSIS - gcloud iot registries credentials COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Manage credentials for Cloud IoT devices. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing credentials for Google Cloud IoT devices. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - clear - (DEPRECATED) Delete all credentials from a registry. - - create - (DEPRECATED) Add a new credential to a registry. - - delete - (DEPRECATED) Delete a credential from a registry. - - describe - (DEPRECATED) Show details about a specific registry credential. - - list - (DEPRECATED) List credentials for a registry. - -NOTES - These variants are also available: - - $ gcloud alpha iot registries credentials - - $ gcloud beta iot registries credentials - diff --git a/gcloud/iot/registries/credentials/list b/gcloud/iot/registries/credentials/list deleted file mode 100644 index 531705a26..000000000 --- a/gcloud/iot/registries/credentials/list +++ /dev/null @@ -1,84 +0,0 @@ -NAME - gcloud iot registries credentials list - list credentials for a registry - -SYNOPSIS - gcloud iot registries credentials list - (--registry=REGISTRY : --region=REGION) [--filter=EXPRESSION] - [--limit=LIMIT] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) List credentials for a registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To list the credentials of a registry, run: - - $ gcloud iot registries credentials list --region=us-central1 \ - --registry=my-registry - -REQUIRED FLAGS - Registry resource - The device registry for which to list credentials. 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 --registry 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. - - --registry=REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument --registry on the command line. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument --registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot registries credentials list - - $ gcloud beta iot registries credentials list - diff --git a/gcloud/iot/registries/delete b/gcloud/iot/registries/delete deleted file mode 100644 index ec5675367..000000000 --- a/gcloud/iot/registries/delete +++ /dev/null @@ -1,66 +0,0 @@ -NAME - gcloud iot registries delete - delete a device registry - -SYNOPSIS - gcloud iot registries delete (REGISTRY : --region=REGION) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - (DEPRECATED) Delete a device registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To delete a device registry, run: - - $ gcloud iot registries delete my-registry --region=us-central1 - -POSITIONAL ARGUMENTS - Registry resource - The device registry 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot registries delete - - $ gcloud beta iot registries delete - diff --git a/gcloud/iot/registries/describe b/gcloud/iot/registries/describe deleted file mode 100644 index 811399911..000000000 --- a/gcloud/iot/registries/describe +++ /dev/null @@ -1,66 +0,0 @@ -NAME - gcloud iot registries describe - show details about a device registry - -SYNOPSIS - gcloud iot registries describe (REGISTRY : --region=REGION) - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - (DEPRECATED) Show details about a device registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - To show details about a device registry, run: - - $ gcloud iot registries describe my-registry --region=us-central1 - -POSITIONAL ARGUMENTS - Registry resource - The device registry 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - -NOTES - These variants are also available: - - $ gcloud alpha iot registries describe - - $ gcloud beta iot registries describe - diff --git a/gcloud/iot/registries/get-iam-policy b/gcloud/iot/registries/get-iam-policy deleted file mode 100644 index eda2aba2a..000000000 --- a/gcloud/iot/registries/get-iam-policy +++ /dev/null @@ -1,101 +0,0 @@ -NAME - gcloud iot registries get-iam-policy - get the IAM policy for a device - registry - -SYNOPSIS - gcloud iot registries get-iam-policy (REGISTRY : --region=REGION) - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - (DEPRECATED) Get the IAM policy for a device registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - - This command gets the IAM policy for a device registry. If formatted as - JSON, the output can be edited and used as a policy file for - set-iam-policy. The output includes an "etag" field identifying the version - emitted and allowing detection of concurrent policy updates; see $ gcloud - iot registries set-iam-policy for additional details. - -EXAMPLES - To print the IAM policy for a given device registry, run: - - $ gcloud iot registries get-iam-policy --region=us-central1 \ - my-registry - -POSITIONAL ARGUMENTS - Registry resource - The device registry for which to get IAM policy. 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region 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. - - --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. - -NOTES - These variants are also available: - - $ gcloud alpha iot registries get-iam-policy - - $ gcloud beta iot registries get-iam-policy - diff --git a/gcloud/iot/registries/help b/gcloud/iot/registries/help deleted file mode 100644 index af0d56b9b..000000000 --- a/gcloud/iot/registries/help +++ /dev/null @@ -1,55 +0,0 @@ -NAME - gcloud iot registries - manage Cloud IoT Registries - -SYNOPSIS - gcloud iot registries GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) Manage Cloud IoT Registries. - - This command is deprecated. Google Cloud IoT Core has been retired. - - Commands for managing Google Cloud IoT Registries. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -GROUPS - GROUP is one of the following: - - credentials - (DEPRECATED) Manage credentials for Cloud IoT devices. - -COMMANDS - COMMAND is one of the following: - - create - (DEPRECATED) Create a new device registry. - - delete - (DEPRECATED) Delete a device registry. - - describe - (DEPRECATED) Show details about a device registry. - - get-iam-policy - (DEPRECATED) Get the IAM policy for a device registry. - - list - (DEPRECATED) List device registries. - - set-iam-policy - (DEPRECATED) Set IAM policy for a device registry. - - update - (DEPRECATED) Update a device registry. - -NOTES - These variants are also available: - - $ gcloud alpha iot registries - - $ gcloud beta iot registries - diff --git a/gcloud/iot/registries/set-iam-policy b/gcloud/iot/registries/set-iam-policy deleted file mode 100644 index da9eb7eec..000000000 --- a/gcloud/iot/registries/set-iam-policy +++ /dev/null @@ -1,83 +0,0 @@ -NAME - gcloud iot registries set-iam-policy - set IAM policy for a device registry - -SYNOPSIS - gcloud iot registries set-iam-policy (REGISTRY : --region=REGION) - POLICY_FILE [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - (DEPRECATED) Set IAM policy for a device registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - - This command replaces the existing IAM policy for a device registry, given - a REGISTRY and a file encoded in JSON or YAML that contains the IAM policy. - If the given policy file specifies an "etag" value, then the replacement - will succeed only if the policy already in place matches that etag. (An - etag obtained via $ gcloud iot registries get-iam-policy will prevent the - replacement if the policy for the device registry has been subsequently - updated.) A policy file that does not contain an etag value will replace - any existing policy for the device registry. - -EXAMPLES - The following command will read an IAM policy from 'policy.json' and set it - for a device registry with 'my-registry' as the identifier: - - $ gcloud iot registries set-iam-policy --region=us-central1 \ - my-registry policy.json - - See https://cloud.google.com/iam/docs/managing-policies for details of the - policy file format and contents. - -POSITIONAL ARGUMENTS - Registry resource - The device registry for which to set IAM policy. 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - - POLICY_FILE - JSON or YAML file with the IAM policy - -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 iot registries set-iam-policy - - $ gcloud beta iot registries set-iam-policy - diff --git a/gcloud/iot/registries/update b/gcloud/iot/registries/update deleted file mode 100644 index c320f9ad0..000000000 --- a/gcloud/iot/registries/update +++ /dev/null @@ -1,115 +0,0 @@ -NAME - gcloud iot registries update - update a device registry - -SYNOPSIS - gcloud iot registries update (REGISTRY : --region=REGION) - [--enable-http-config] [--enable-mqtt-config] - [--event-notification-config=[subfolder=SUBFOLDER],[topic=TOPIC]] - [--log-level=LOG_LEVEL] [--state-pubsub-topic=STATE_PUBSUB_TOPIC] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - (DEPRECATED) Update a device registry. - - This command is deprecated. Google Cloud IoT Core has been retired. - -EXAMPLES - The following command updates the device registry 'my-registry' in region - 'us-central1'. It enables MQTT and HTTP connections and sets - 'pubsub-topic-name' as the Cloud Pub/Sub topic for state notifications. - - $ gcloud iot registries update my-registry --region=us-central1 \ - --enable-http-config --enable-mqtt-config \ - --state-pubsub-topic=pubsub-topic-name - -POSITIONAL ARGUMENTS - Registry resource - The device registry 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 registry 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. - - REGISTRY - ID of the registry or fully qualified identifier for the registry. - - To set the registry attribute: - ▸ provide the argument registry on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the registry. - - To set the region attribute: - ▸ provide the argument registry on the command line with a fully - specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --enable-http-config - Whether to allow device connections to the HTTP bridge. - - --enable-mqtt-config - Whether to allow MQTT connections to this device registry. - - --event-notification-config=[subfolder=SUBFOLDER],[topic=TOPIC] - The configuration for notification of telemetry events received from - the device. This flag can be specified multiple times to add multiple - configs to the device registry. Configs are added to the registry in - the order the flags are specified. Only one config with an empty - subfolder field is allowed and must be specified last. - - topic - A Google Cloud Pub/Sub topic name for event notifications - - subfolder - If the subfolder name matches this string exactly, this - configuration will be used to publish telemetry events. If empty - all strings are matched. - - --log-level=LOG_LEVEL - The default logging verbosity for activity from devices in this - registry. The verbosity level can be overridden by setting a specific - device's log level. - - LOG_LEVEL must be one of: - - debug - All events will be logged - error - Error events will be logged. - info - Informational events will be logged, such as connections and - disconnections. Also includes error events. - none - Disables logging. - - --state-pubsub-topic=STATE_PUBSUB_TOPIC - A Google Cloud Pub/Sub topic name for state notifications. - -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 iot registries update - - $ gcloud beta iot registries update - diff --git a/gcloud/logging/settings/update b/gcloud/logging/settings/update index 878182c58..ba777ebbd 100644 --- a/gcloud/logging/settings/update +++ b/gcloud/logging/settings/update @@ -12,8 +12,9 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Use this command to update the --kms-key-name, --storage-location and - --disable-default-sink associated with the Cloud Logging Logs Router. + Use this command to update the --kms-key-name, --storage-location, + --disable-default-sink and --analytics-mode associated with the Cloud + Logging Logs Router. The Cloud KMS key must already exist and Cloud Logging must have permission to access it. @@ -56,6 +57,11 @@ EXAMPLES $ gcloud logging settings update --organization=[ORGANIZATION_ID] \ --disable-default-sink=false + To enable analytics for the log buckets under an organization, run: + + $ gcloud logging settings update --organization=[ORGANIZATION_ID] \ + --disable-default-sink=false --analytics-mode=enabled + REQUIRED FLAGS Exactly one of these must be specified: diff --git a/gcloud/looker/instances/describe b/gcloud/looker/instances/describe index 2dd43f20e..f6f315146 100644 --- a/gcloud/looker/instances/describe +++ b/gcloud/looker/instances/describe @@ -1,5 +1,5 @@ NAME - gcloud looker instances describe - show metadata for a Looker + gcloud looker instances describe - show metadata for a Looker instance SYNOPSIS gcloud looker instances describe (INSTANCE : --region=REGION) @@ -8,9 +8,6 @@ SYNOPSIS DESCRIPTION Show metadata for a Looker instance. - Displays all metadata associated with a Looker instance given a valid - instance name. - This command can fail for the following reasons: ▪ The instance specified does not exist. ▪ The active account does not have permission to access the given @@ -22,6 +19,10 @@ EXAMPLES $ gcloud looker instances describe my-looker-instance + To display all fields of the instance metadata, add the --format=json flag: + + $ gcloud looker instances describe my-looker-instance --format=json + POSITIONAL ARGUMENTS Instance resource - Arguments and flags that specify the Looker instance you want to describe. The arguments in this group can be used to specify diff --git a/gcloud/looker/instances/help b/gcloud/looker/instances/help index 5ffcdfc88..3e5e2fec4 100644 --- a/gcloud/looker/instances/help +++ b/gcloud/looker/instances/help @@ -62,7 +62,7 @@ COMMANDS Delete a Looker instance. describe - Show metadata for a Looker. + Show metadata for a Looker instance. export Export a Looker instance. diff --git a/gcloud/monitoring/uptime/create b/gcloud/monitoring/uptime/create index ad3c8cd30..4af307a5a 100644 --- a/gcloud/monitoring/uptime/create +++ b/gcloud/monitoring/uptime/create @@ -12,7 +12,8 @@ SYNOPSIS --custom-content-type=CUSTOM_CONTENT_TYPE --headers=[KEY=VALUE,...] --mask-headers=MASK_HEADERS --password=PASSWORD --path=PATH --pings-count=PINGS_COUNT --port=PORT --protocol=PROTOCOL - --request-method=REQUEST_METHOD --username=USERNAME + --request-method=REQUEST_METHOD + --service-agent-auth=SERVICE_AGENT_AUTH --username=USERNAME --validate-ssl=VALIDATE_SSL --status-classes=[status-class,...] | --status-codes=[status-code,...]] [--matcher-content=MATCHER_CONTENT @@ -175,6 +176,17 @@ OPTIONAL FLAGS post HTTP POST method + Uptime check service agent authorization. + + --service-agent-auth=SERVICE_AGENT_AUTH + The type of authentication to use for the HTTP request. Can only be + set if --protocol is https. + + SERVICE_AGENT_AUTH must be (only one value is supported): + + oidc-token + OIDC Token authentication + --username=USERNAME The username to use when authenticating with the HTTP server. Can only be set if --protocol is http or https. diff --git a/gcloud/monitoring/uptime/update b/gcloud/monitoring/uptime/update index 505804667..9a7d0a51c 100644 --- a/gcloud/monitoring/uptime/update +++ b/gcloud/monitoring/uptime/update @@ -7,7 +7,8 @@ SYNOPSIS [--body=BODY --content-type=CONTENT_TYPE --custom-content-type=CUSTOM_CONTENT_TYPE --mask-headers=MASK_HEADERS --password=PASSWORD --path=PATH --pings-count=PINGS_COUNT --port=PORT - --request-method=REQUEST_METHOD --username=USERNAME + --request-method=REQUEST_METHOD + --service-agent-auth=SERVICE_AGENT_AUTH --username=USERNAME --validate-ssl=VALIDATE_SSL --add-status-classes=[status-class,...] | --clear-status-classes=CLEAR_STATUS_CLASSES | --remove-status-classes=[status-class,...] @@ -119,6 +120,17 @@ FLAGS post HTTP POST method + Uptime check service agent authorization. + + --service-agent-auth=SERVICE_AGENT_AUTH + The type of authentication to use for the HTTP request. Can only be + set if --protocol is https. + + SERVICE_AGENT_AUTH must be (only one value is supported): + + oidc-token + OIDC Token authentication + --username=USERNAME The username to use when authenticating with the HTTP server. Can only be set if --protocol is http or https. diff --git a/gcloud/netapp/storage-pools/create b/gcloud/netapp/storage-pools/create index 301c56ef3..7547a08f6 100644 --- a/gcloud/netapp/storage-pools/create +++ b/gcloud/netapp/storage-pools/create @@ -96,16 +96,16 @@ REQUIRED FLAGS extreme Extreme Service Level for Cloud NetApp Storage Pool. The Extreme - Service Level has a throughput per TiB of allocated volume size of - 128 MiB/s. + Service Level has a throughput per GiB of allocated volume size of + 128 KiB/s. premium Premium Service Level for Cloud NetApp Storage Pool. The Premium - Service Level has a throughput per TiB of allocated volume size of - 64 MiB/s. + Service Level has a throughput per GiB of allocated volume size of + 64 KiB/s. standard Standard Service Level for Cloud NetApp Storage Pool. The Standard - Service Level has a throughput per TiB of allocated volume size of - 128 MiB/s. + Service Level has a throughput per GiB of allocated volume size of + 16 KiB/s. OPTIONAL FLAGS Active directory resource - The Active Directory to attach to the Storage diff --git a/gcloud/network-services/help b/gcloud/network-services/help index 06bdfec42..4d1504321 100644 --- a/gcloud/network-services/help +++ b/gcloud/network-services/help @@ -33,6 +33,9 @@ GROUPS service-bindings Manage Network Services Bindings. + service-lb-policies + Manage Network Services ServiceLbPolicies. + tcp-routes Manage Network Services TcpRoutes. diff --git a/gcloud/network-services/service-lb-policies/create b/gcloud/network-services/service-lb-policies/create new file mode 100644 index 000000000..1f3158617 --- /dev/null +++ b/gcloud/network-services/service-lb-policies/create @@ -0,0 +1,118 @@ +NAME + gcloud network-services service-lb-policies create - create a service LB + policy + +SYNOPSIS + gcloud network-services service-lb-policies create + (SERVICE_LB_POLICY : --location=LOCATION) [--async] + [--auto-capacity-drain] [--description=DESCRIPTION] + [--failover-health-threshold=FAILOVER_HEALTH_THRESHOLD] + [--load-balancing-algorithm=LOAD_BALANCING_ALGORITHM; + default="waterfall-by-region"] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new service LB policy with the given name. + +EXAMPLES + Create a service LB policy with the name 'my-service-lb-policy', load + balancing algorithm 'waterfall-by-region', and location 'global'. + + $ gcloud network-services service-lb-policies create \ + my-service-lb-policy \ + --load-balancing-algorithm=waterfall-by-region \ + --location="global" + +POSITIONAL ARGUMENTS + Service lb policy resource - Name of the service LB policy to be created. + 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 service_lb_policy on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE_LB_POLICY + ID of the service lb policy or fully qualified identifier for the + service lb policy. + + To set the service_lb_policy attribute: + ▸ provide the argument service_lb_policy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service_lb_policy 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. + + --auto-capacity-drain + If specified, an unhealthy MIG/NEG will be removed from Global load + balancing and traffic routing for the service. A MIG/NEG is considered + to be unhealthy if less than 25% of the instance/endpoints in the + MIG/NEG are healthy. autoCapacityDrain will never drain more than 50% + of the configured MIGs/NEGs of a Backend Service. + + --description=DESCRIPTION + The description for the service LB policy. + + --failover-health-threshold=FAILOVER_HEALTH_THRESHOLD + The percentage threshold that a load balancer will begin to send + traffic to failover backends. If the percentage of endpoints in a + MIG/NEG is smaller than this value, traffic would be sent to failover + backends if possible. This field should be set to a value between 1 and + 99. The default value is 50 for Global external HTTP(S) load balancer + (classic) and Proxyless service mesh, and 70 for others. + + --load-balancing-algorithm=LOAD_BALANCING_ALGORITHM; default="waterfall-by-region" + The global load balancing algorithm to be used. + LOAD_BALANCING_ALGORITHM must be one of: + + spray-to-region + Spread the traffic from each client to all the MIGs/NEGs in a + region. + + spray-to-world + Balance traffic across all backends across the world proportionally + based on capacity. + + waterfall-by-region + Direct traffic to the nearest region with endpoints and capacity + before spilling over to other regions. + + waterfall-by-zone + Attempt to keep traffic in a single zone closest to the client, + before spilling over to other zones. + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + These variants are also available: + + $ gcloud alpha network-services service-lb-policies create + + $ gcloud beta network-services service-lb-policies create + diff --git a/gcloud/network-services/service-lb-policies/delete b/gcloud/network-services/service-lb-policies/delete new file mode 100644 index 000000000..16d56818d --- /dev/null +++ b/gcloud/network-services/service-lb-policies/delete @@ -0,0 +1,74 @@ +NAME + gcloud network-services service-lb-policies delete - delete service LB + policy + +SYNOPSIS + gcloud network-services service-lb-policies delete + (SERVICE_LB_POLICY : --location=LOCATION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete the specified service LB policy. + +EXAMPLES + To delete a service LB policy named my-service-lb-policy, run: + + $ gcloud network-services service-lb-policies delete \ + my-service-lb-policy --location=global + +POSITIONAL ARGUMENTS + Service lb policy resource - Name of the service LB policy 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 service_lb_policy on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE_LB_POLICY + ID of the service lb policy or fully qualified identifier for the + service lb policy. + + To set the service_lb_policy attribute: + ▸ provide the argument service_lb_policy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service_lb_policy 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. + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + These variants are also available: + + $ gcloud alpha network-services service-lb-policies delete + + $ gcloud beta network-services service-lb-policies delete + diff --git a/gcloud/network-services/service-lb-policies/describe b/gcloud/network-services/service-lb-policies/describe new file mode 100644 index 000000000..6264e3055 --- /dev/null +++ b/gcloud/network-services/service-lb-policies/describe @@ -0,0 +1,68 @@ +NAME + gcloud network-services service-lb-policies describe - describe a service + LB policy + +SYNOPSIS + gcloud network-services service-lb-policies describe + (SERVICE_LB_POLICY : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Show details of a service LB policy. + +EXAMPLES + Show details about a service LB policy named 'my-service-lb-policy'. + + $ gcloud network-services service-lb-policies describe \ + my-service-lb-policy --location=global + +POSITIONAL ARGUMENTS + Service lb policy resource - Name of the service LB policy to be + described. 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 service_lb_policy on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE_LB_POLICY + ID of the service lb policy or fully qualified identifier for the + service lb policy. + + To set the service_lb_policy attribute: + ▸ provide the argument service_lb_policy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service_lb_policy 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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + These variants are also available: + + $ gcloud alpha network-services service-lb-policies describe + + $ gcloud beta network-services service-lb-policies describe + diff --git a/gcloud/network-services/service-lb-policies/export b/gcloud/network-services/service-lb-policies/export new file mode 100644 index 000000000..b82583103 --- /dev/null +++ b/gcloud/network-services/service-lb-policies/export @@ -0,0 +1,79 @@ +NAME + gcloud network-services service-lb-policies export - export service LB + policy + +SYNOPSIS + gcloud network-services service-lb-policies export + (SERVICE_LB_POLICY : --location=LOCATION) [--destination=DESTINATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Export a service LB policy. + +EXAMPLES + To export a service LB policy named my-service-lb-policy to a YAML file, + run: + + $ gcloud network-services service-lb-policies export \ + my-service-lb-policy --destination=my-service-lb-policy.yaml \ + --location=global + +POSITIONAL ARGUMENTS + Service lb policy resource - Name of the service LB policy 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 service_lb_policy on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE_LB_POLICY + ID of the service lb policy or fully qualified identifier for the + service lb policy. + + To set the service_lb_policy attribute: + ▸ provide the argument service_lb_policy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service_lb_policy on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --destination=DESTINATION + Path to a YAML file where the configuration will be exported. The + exported data will not contain any output-only fields. Alternatively, + you may omit this flag to write to standard output. For a schema + describing the export/import format, see + $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + These variants are also available: + + $ gcloud alpha network-services service-lb-policies export + + $ gcloud beta network-services service-lb-policies export + diff --git a/gcloud/network-services/service-lb-policies/help b/gcloud/network-services/service-lb-policies/help new file mode 100644 index 000000000..b269deff4 --- /dev/null +++ b/gcloud/network-services/service-lb-policies/help @@ -0,0 +1,46 @@ +NAME + gcloud network-services service-lb-policies - manage Network Services + ServiceLbPolicies + +SYNOPSIS + gcloud network-services service-lb-policies COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Network Services ServiceLbPolicies. + +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 service LB policy. + + delete + Delete service LB policy. + + describe + Describe a service LB policy. + + export + Export service LB policy. + + import + Import service LB policy. + + list + List ServiceLbPolicies. + + update + Update a service LB policy. + +NOTES + These variants are also available: + + $ gcloud alpha network-services service-lb-policies + + $ gcloud beta network-services service-lb-policies + diff --git a/gcloud/network-services/service-lb-policies/import b/gcloud/network-services/service-lb-policies/import new file mode 100644 index 000000000..f1b2ee2fd --- /dev/null +++ b/gcloud/network-services/service-lb-policies/import @@ -0,0 +1,86 @@ +NAME + gcloud network-services service-lb-policies import - import service LB + policy + +SYNOPSIS + gcloud network-services service-lb-policies import + (SERVICE_LB_POLICY : --location=LOCATION) [--async] [--source=SOURCE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Import a service LB policy. + +EXAMPLES + To import a service LB policy named my-service-lb-policy from a YAML file, + run: + + $ gcloud network-services service-lb-policies import \ + my-service-lb-policy --source=my-service-lb-policy.yaml \ + --location=global + +POSITIONAL ARGUMENTS + Service lb policy resource - Name of the service LB policy to import. 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 service_lb_policy on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE_LB_POLICY + ID of the service lb policy or fully qualified identifier for the + service lb policy. + + To set the service_lb_policy attribute: + ▸ provide the argument service_lb_policy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service_lb_policy 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. + + --source=SOURCE + Path to a YAML file containing the configuration export data. The YAML + file must not contain any output-only fields. Alternatively, you may + omit this flag to read from standard input. For a schema describing the + export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + + $CLOUDSDKROOT is can be obtained with the following command: + + $ gcloud info --format='value(installation.sdk_root)' + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + These variants are also available: + + $ gcloud alpha network-services service-lb-policies import + + $ gcloud beta network-services service-lb-policies import + diff --git a/gcloud/iot/registries/list b/gcloud/network-services/service-lb-policies/list similarity index 60% rename from gcloud/iot/registries/list rename to gcloud/network-services/service-lb-policies/list index 87b8a94f6..52550740b 100644 --- a/gcloud/iot/registries/list +++ b/gcloud/network-services/service-lb-policies/list @@ -1,42 +1,38 @@ NAME - gcloud iot registries list - list device registries + gcloud network-services service-lb-policies list - list ServiceLbPolicies SYNOPSIS - gcloud iot registries list --region=REGION [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + gcloud network-services service-lb-policies list --location=LOCATION + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (DEPRECATED) This command is deprecated. Google Cloud IoT Core has been - retired. - - (DEPRECATED) List device registries. - - This command is deprecated. Google Cloud IoT Core has been retired. + List all ServiceLbPolicies in the specified location of the current + project. EXAMPLES - To list all device registries in a project and region 'us-central1', run: + To list service lb policies in the current project, run: - $ gcloud iot registries list --region=us-central1 + $ gcloud network-services service-lb-policies list --location=global REQUIRED FLAGS - Region resource - The Cloud region to list registries for. This represents - a Cloud resource. (NOTE) Some attributes are not given arguments in this - group but can be set in other ways. + Location resource - The project of the service LB policies 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 + ◆ 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. + ◆ set the property core/project; + ◆ provide the argument --project on the command line. This must be specified. - --region=REGION - ID of the region or fully qualified identifier for the region. + --location=LOCATION + ID of the location or fully qualified identifier for the location. - To set the region attribute: - ▸ provide the argument --region on the command line. + To set the location attribute: + ▸ provide the argument --location on the command line. LIST COMMAND FLAGS --filter=EXPRESSION @@ -78,10 +74,14 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. +API REFERENCE + This command uses the networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + NOTES These variants are also available: - $ gcloud alpha iot registries list + $ gcloud alpha network-services service-lb-policies list - $ gcloud beta iot registries list + $ gcloud beta network-services service-lb-policies list diff --git a/gcloud/network-services/service-lb-policies/update b/gcloud/network-services/service-lb-policies/update new file mode 100644 index 000000000..1ddd825d7 --- /dev/null +++ b/gcloud/network-services/service-lb-policies/update @@ -0,0 +1,117 @@ +NAME + gcloud network-services service-lb-policies update - update a service LB + policy + +SYNOPSIS + gcloud network-services service-lb-policies update + (SERVICE_LB_POLICY : --location=LOCATION) [--async] + [--auto-capacity-drain] [--description=DESCRIPTION] + [--failover-health-threshold=FAILOVER_HEALTH_THRESHOLD] + [--load-balancing-algorithm=LOAD_BALANCING_ALGORITHM; + default="waterfall-by-region"] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update the detail of a service LB Policy. + +EXAMPLES + Update load-balancing-algorithm of a service LB policy named + my-service-lb-policy: + + $ gcloud network-services service-lb-policies update \ + my-service-lb-policy \ + --load-balancing-algorithm=waterfall-by-zone + +POSITIONAL ARGUMENTS + Service lb policy resource - Name of the service LB policy to be updated. + 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 service_lb_policy on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE_LB_POLICY + ID of the service lb policy or fully qualified identifier for the + service lb policy. + + To set the service_lb_policy attribute: + ▸ provide the argument service_lb_policy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service_lb_policy 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. + + --auto-capacity-drain + If specified, an unhealthy MIG/NEG will be removed from Global load + balancing and traffic routing for the service. A MIG/NEG is considered + to be unhealthy if less than 25% of the instance/endpoints in the + MIG/NEG are healthy. autoCapacityDrain will never drain more than 50% + of the configured MIGs/NEGs of a Backend Service. + + --description=DESCRIPTION + The description for the service LB policy. + + --failover-health-threshold=FAILOVER_HEALTH_THRESHOLD + The percentage threshold that a load balancer will begin to send + traffic to failover backends. If the percentage of endpoints in a + MIG/NEG is smaller than this value, traffic would be sent to failover + backends if possible. This field should be set to a value between 1 and + 99. The default value is 50 for Global external HTTP(S) load balancer + (classic) and Proxyless service mesh, and 70 for others. + + --load-balancing-algorithm=LOAD_BALANCING_ALGORITHM; default="waterfall-by-region" + The global load balancing algorithm to be used. + LOAD_BALANCING_ALGORITHM must be one of: + + spray-to-region + Spread the traffic from each client to all the MIGs/NEGs in a + region. + + spray-to-world + Balance traffic across all backends across the world proportionally + based on capacity. + + waterfall-by-region + Direct traffic to the nearest region with endpoints and capacity + before spilling over to other regions. + + waterfall-by-zone + Attempt to keep traffic in a single zone closest to the client, + before spilling over to other zones. + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + These variants are also available: + + $ gcloud alpha network-services service-lb-policies update + + $ gcloud beta network-services service-lb-policies update + diff --git a/gcloud/run/deploy b/gcloud/run/deploy index 9bdbc985f..fa41c6aed 100644 --- a/gcloud/run/deploy +++ b/gcloud/run/deploy @@ -40,7 +40,9 @@ SYNOPSIS --binary-authorization=POLICY | --clear-binary-authorization --clear-encryption-key-shutdown-hours | --encryption-key-shutdown-hours=ENCRYPTION_KEY_SHUTDOWN_HOURS - --clear-key | --key=KEY --clear-post-key-revocation-action-type + --clear-key | --key=KEY --clear-network + | --network=NETWORK --subnet=SUBNET --clear-network-tags + | --network-tags=[TAG,...] --clear-post-key-revocation-action-type | --post-key-revocation-action-type=POST_KEY_REVOCATION_ACTION_TYPE] [--region=REGION | --cluster=CLUSTER --cluster-location=CLUSTER_LOCATION @@ -532,6 +534,39 @@ FLAGS --key=KEY CMEK key reference to encrypt the container with. + At most one of these can be specified: + + --clear-network + Disconnect this Cloud Run service from the VPC network it is + connected to. + + Direct VPC egress setting flags group. + + --network=NETWORK + The VPC network that the Cloud Run service will be able to send + traffic to. If --subnet is also specified, subnet must be a + subnetwork of the network specified by this --network flag. To + clear existing VPC network settings, use --clear-network. + + --subnet=SUBNET + The VPC subnetwork that the Cloud Run service will get IPs from. + The subnetwork must be /26 or larger. If --network is also + specified, subnet must be a subnetwork of the network specified + by the --network flag. If --network is not specified, network + will be looked up from this subnetwork. To clear existing VPC + network settings, use --clear-network. + + At most one of these can be specified: + + --clear-network-tags + Clears all existing Compute Engine tags from the Cloud Run + service. + + --network-tags=[TAG,...] + Applies the given Compute Engine tags (comma separated) to the + Cloud Run service. To clear existing tags, use + --clear-network-tags. + At most one of these can be specified: --clear-post-key-revocation-action-type diff --git a/gcloud/run/jobs/create b/gcloud/run/jobs/create index 9bdb11648..0f2731a24 100644 --- a/gcloud/run/jobs/create +++ b/gcloud/run/jobs/create @@ -14,6 +14,7 @@ SYNOPSIS [--vpc-connector=VPC_CONNECTOR] [--vpc-egress=VPC_EGRESS] [--async | --execute-now --wait] [--env-vars-file=FILE_PATH | --set-env-vars=[KEY=VALUE,...]] + [--network=NETWORK --network-tags=[TAG,...] --subnet=SUBNET] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -193,6 +194,26 @@ OPTIONAL FLAGS --set-env-vars=[KEY=VALUE,...] List of key-value pairs to set as environment variables. + Direct VPC egress setting flags group. + + --network=NETWORK + The VPC network that the Cloud Run job will be able to send traffic + to. If --subnet is also specified, subnet must be a subnetwork of the + network specified by this --network flag. To clear existing VPC + network settings, use --clear-network. + + --network-tags=[TAG,...] + Applies the given Compute Engine tags (comma separated) to the Cloud + Run job. To clear existing tags, use --clear-network-tags. + + --subnet=SUBNET + The VPC subnetwork that the Cloud Run job will get IPs from. The + subnetwork must be /26 or larger. If --network is also specified, + subnet must be a subnetwork of the network specified by the --network + flag. If --network is not specified, network will be looked up from + this subnetwork. To clear existing VPC network settings, use + --clear-network. + 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/run/jobs/deploy b/gcloud/run/jobs/deploy index 7576b0ea7..c368b7e19 100644 --- a/gcloud/run/jobs/deploy +++ b/gcloud/run/jobs/deploy @@ -16,7 +16,10 @@ SYNOPSIS [--clear-env-vars | --env-vars-file=FILE_PATH | --set-env-vars=[KEY=VALUE,...] | --remove-env-vars=[KEY,...] --update-env-vars=[KEY=VALUE,...]] - [--image=IMAGE | --source=SOURCE] [GCLOUD_WIDE_FLAG ...] + [--clear-network + | --network=NETWORK --subnet=SUBNET --clear-network-tags + | --network-tags=[TAG,...]] [--image=IMAGE | --source=SOURCE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Creates or updates a Cloud Run job. @@ -204,6 +207,37 @@ FLAGS --update-env-vars=[KEY=VALUE,...] List of key-value pairs to set as environment variables. + At most one of these can be specified: + + --clear-network + Disconnect this Cloud Run job from the VPC network it is connected + to. + + Direct VPC egress setting flags group. + + --network=NETWORK + The VPC network that the Cloud Run job will be able to send traffic + to. If --subnet is also specified, subnet must be a subnetwork of + the network specified by this --network flag. To clear existing VPC + network settings, use --clear-network. + + --subnet=SUBNET + The VPC subnetwork that the Cloud Run job will get IPs from. The + subnetwork must be /26 or larger. If --network is also specified, + subnet must be a subnetwork of the network specified by the + --network flag. If --network is not specified, network will be + looked up from this subnetwork. To clear existing VPC network + settings, use --clear-network. + + At most one of these can be specified: + + --clear-network-tags + Clears all existing Compute Engine tags from the Cloud Run job. + + --network-tags=[TAG,...] + Applies the given Compute Engine tags (comma separated) to the + Cloud Run job. To clear existing tags, use --clear-network-tags. + At most one of these can be specified: --image=IMAGE diff --git a/gcloud/run/jobs/update b/gcloud/run/jobs/update index a470acb24..389960a6c 100644 --- a/gcloud/run/jobs/update +++ b/gcloud/run/jobs/update @@ -21,6 +21,9 @@ SYNOPSIS | --remove-env-vars=[KEY,...] --update-env-vars=[KEY=VALUE,...]] [--clear-labels | --remove-labels=[KEY,...] --labels=[KEY=VALUE,...] | --update-labels=[KEY=VALUE,...]] + [--clear-network + | --network=NETWORK --subnet=SUBNET --clear-network-tags + | --network-tags=[TAG,...]] [--clear-secrets | --set-secrets=[KEY=VALUE,...] | --remove-secrets=[KEY,...] --update-secrets=[KEY=VALUE,...]] [GCLOUD_WIDE_FLAG ...] @@ -254,6 +257,37 @@ FLAGS List of label KEY=VALUE pairs to update. If a label exists, its value is modified. Otherwise, a new label is created. + At most one of these can be specified: + + --clear-network + Disconnect this Cloud Run job from the VPC network it is connected + to. + + Direct VPC egress setting flags group. + + --network=NETWORK + The VPC network that the Cloud Run job will be able to send traffic + to. If --subnet is also specified, subnet must be a subnetwork of + the network specified by this --network flag. To clear existing VPC + network settings, use --clear-network. + + --subnet=SUBNET + The VPC subnetwork that the Cloud Run job will get IPs from. The + subnetwork must be /26 or larger. If --network is also specified, + subnet must be a subnetwork of the network specified by the + --network flag. If --network is not specified, network will be + looked up from this subnetwork. To clear existing VPC network + settings, use --clear-network. + + At most one of these can be specified: + + --clear-network-tags + Clears all existing Compute Engine tags from the Cloud Run job. + + --network-tags=[TAG,...] + Applies the given Compute Engine tags (comma separated) to the + Cloud Run job. To clear existing tags, use --clear-network-tags. + Specify secrets to mount or provide as environment variables. Keys starting with a forward slash '/' are mount paths. All other keys correspond to environment variables. Values should be in the form diff --git a/gcloud/run/services/update b/gcloud/run/services/update index 6aee20ba8..57de64c72 100644 --- a/gcloud/run/services/update +++ b/gcloud/run/services/update @@ -34,7 +34,9 @@ SYNOPSIS --binary-authorization=POLICY | --clear-binary-authorization --clear-encryption-key-shutdown-hours | --encryption-key-shutdown-hours=ENCRYPTION_KEY_SHUTDOWN_HOURS - --clear-key | --key=KEY --clear-post-key-revocation-action-type + --clear-key | --key=KEY --clear-network + | --network=NETWORK --subnet=SUBNET --clear-network-tags + | --network-tags=[TAG,...] --clear-post-key-revocation-action-type | --post-key-revocation-action-type=POST_KEY_REVOCATION_ACTION_TYPE] [--clear-labels | --remove-labels=[KEY,...] --labels=[KEY=VALUE,...] | --update-labels=[KEY=VALUE,...]] @@ -414,6 +416,39 @@ FLAGS --key=KEY CMEK key reference to encrypt the container with. + At most one of these can be specified: + + --clear-network + Disconnect this Cloud Run service from the VPC network it is + connected to. + + Direct VPC egress setting flags group. + + --network=NETWORK + The VPC network that the Cloud Run service will be able to send + traffic to. If --subnet is also specified, subnet must be a + subnetwork of the network specified by this --network flag. To + clear existing VPC network settings, use --clear-network. + + --subnet=SUBNET + The VPC subnetwork that the Cloud Run service will get IPs from. + The subnetwork must be /26 or larger. If --network is also + specified, subnet must be a subnetwork of the network specified + by the --network flag. If --network is not specified, network + will be looked up from this subnetwork. To clear existing VPC + network settings, use --clear-network. + + At most one of these can be specified: + + --clear-network-tags + Clears all existing Compute Engine tags from the Cloud Run + service. + + --network-tags=[TAG,...] + Applies the given Compute Engine tags (comma separated) to the + Cloud Run service. To clear existing tags, use + --clear-network-tags. + At most one of these can be specified: --clear-post-key-revocation-action-type diff --git a/gcloud/scc/help b/gcloud/scc/help index 82316eb3e..89b464034 100644 --- a/gcloud/scc/help +++ b/gcloud/scc/help @@ -27,6 +27,9 @@ GROUPS findings Manage Cloud SCC (Security Command Center) findings. + iac-validation-reports + Manage Cloud SCC (Security Command Center) iac-validation-reports. + manage Manage Cloud SCC (Security Command Center) settings. diff --git a/gcloud/scc/iac-validation-reports/create b/gcloud/scc/iac-validation-reports/create new file mode 100644 index 000000000..9a64a9bab --- /dev/null +++ b/gcloud/scc/iac-validation-reports/create @@ -0,0 +1,53 @@ +NAME + gcloud scc iac-validation-reports create - create a Cloud Security Command + Center IaC Validation Report + +SYNOPSIS + gcloud scc iac-validation-reports create PARENT --tf-plan-file=TF_PLAN_FILE + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a Cloud Security Command Center (SCC) IaC Validation Report. First + argument is the parent of the IaC defined in the plan file. It is followed + by path of the terraform plan file in JSON format. + + LRO operation ID is returned as the response of the command. + +EXAMPLES + Create an Iac Validation report on parent + organizations/123/locations/global: + + $ gcloud scc iac-validation-reports create \ + organizations/123/locations/global --tf-plan-file=planFile.json + +POSITIONAL ARGUMENTS + PARENT + Name of the organization where IaC Validation Report is to be created. + Format: organizations//locations/ + +REQUIRED FLAGS + --tf-plan-file=TF_PLAN_FILE + Path to a JSON file containing the IaC plan to be validated. + +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 securityposture/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/security-command-center + +NOTES + This variant is also available: + + $ gcloud alpha scc iac-validation-reports create + diff --git a/gcloud/scc/iac-validation-reports/help b/gcloud/scc/iac-validation-reports/help new file mode 100644 index 000000000..b0e850e39 --- /dev/null +++ b/gcloud/scc/iac-validation-reports/help @@ -0,0 +1,26 @@ +NAME + gcloud scc iac-validation-reports - manage Cloud SCC + (Security Command Center) iac-validation-reports + +SYNOPSIS + gcloud scc iac-validation-reports COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Cloud SCC (Security Command Center) iac-validation-reports. + +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 Cloud Security Command Center (SCC) IaC Validation Report. + +NOTES + This variant is also available: + + $ gcloud alpha scc iac-validation-reports + diff --git a/gcloud/workbench/instances/create b/gcloud/workbench/instances/create index fbe54e97d..2acd29f0c 100644 --- a/gcloud/workbench/instances/create +++ b/gcloud/workbench/instances/create @@ -61,6 +61,14 @@ EXAMPLES base-cpu --container-tag=latest --machine-type=n1-standard-4 \ --location=us-central1-b + To create an instance with shielded-secure-boot, shielded-vtpm and + shielded-integrity-monitoring disabled, run: + + $ gcloud workbench instances create example-instance \ + --shielded-integrity-monitoring=false \ + --shielded-secure-boot=false --shielded-vtpm=false \ + --location=us-central1-b + POSITIONAL ARGUMENTS Instance resource - User-defined unique name of this instance. The instance name must be 1 to 63 characters long and contain only lowercase @@ -376,13 +384,16 @@ FLAGS Shielded VM configurations. --shielded-integrity-monitoring=SHIELDED_INTEGRITY_MONITORING - Enable monitoring of the boot integrity of the instance + Boolean. Enable monitoring of the boot integrity of the instance. + Supported values: true, false. --shielded-secure-boot=SHIELDED_SECURE_BOOT - Boot instance with secure boot enabled + Boolean. Boot instance with secure boot enabled. Supported values: + true, false. --shielded-vtpm=SHIELDED_VTPM - Boot instance with TPM (Trusted Platform Module) enabled + Boolean. Boot instance with TPM (Trusted Platform Module) enabled. + Supported values: true, false. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/workbench/instances/update b/gcloud/workbench/instances/update index d8dcc37ee..70a8a9251 100644 --- a/gcloud/workbench/instances/update +++ b/gcloud/workbench/instances/update @@ -105,13 +105,16 @@ FLAGS Shielded VM configurations. --shielded-integrity-monitoring=SHIELDED_INTEGRITY_MONITORING - Enable monitoring of the boot integrity of the instance + Boolean. Enable monitoring of the boot integrity of the instance. + Supported values: true, false. --shielded-secure-boot=SHIELDED_SECURE_BOOT - Boot instance with secure boot enabled + Boolean. Boot instance with secure boot enabled. Supported values: + true, false. --shielded-vtpm=SHIELDED_VTPM - Boot instance with TPM (Trusted Platform Module) enabled + Boolean. Boot instance with TPM (Trusted Platform Module) enabled. + Supported values: true, false. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account,