imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-10 19:31:55 +00:00
Code Activity
gcloud-help/gcloud/oracle-database/autonomous-databases/update
Automated 154ebc873d gcloud: Wed Oct 15 10:52:53 UTC 2025
2025-10-15 10:52:53 +00:00

563 lines
22 KiB
Text
Raw Blame History

NAME
gcloud oracle-database autonomous-databases update - update an
AutonomousDatabase
SYNOPSIS
gcloud oracle-database autonomous-databases update AUTONOMOUS_DATABASE
[--admin-password=ADMIN_PASSWORD] [--async] [--cidr=CIDR]
[--clear-odb-network] [--database=DATABASE]
[--display-name=DISPLAY_NAME] [--location=LOCATION]
[--odb-network=ODB_NETWORK] [--request-id=REQUEST_ID]
[--clear-network | --network=NETWORK]
[--clear-odb-subnet | --odb-subnet=ODB_SUBNET]
[--clear-properties
--properties-backup-retention-period-days=PROPERTIES_BACKUP_RETENTION_PERIOD_DAYS --properties-character-set=PROPERTIES_CHARACTER_SET --properties-compute-count=PROPERTIES_COMPUTE_COUNT --properties-cpu-core-count=PROPERTIES_CPU_CORE_COUNT --properties-data-storage-size-gb=PROPERTIES_DATA_STORAGE_SIZE_GB --properties-data-storage-size-tb=PROPERTIES_DATA_STORAGE_SIZE_TB --properties-db-edition=PROPERTIES_DB_EDITION --properties-db-version=PROPERTIES_DB_VERSION --properties-db-workload=PROPERTIES_DB_WORKLOAD --[no-]properties-is-auto-scaling-enabled --[no-]properties-is-storage-auto-scaling-enabled --properties-license-type=PROPERTIES_LICENSE_TYPE --properties-maintenance-schedule-type=PROPERTIES_MAINTENANCE_SCHEDULE_TYPE --[no-]properties-mtls-connection-required --properties-n-character-set=PROPERTIES_N_CHARACTER_SET --properties-private-endpoint-ip=PROPERTIES_PRIVATE_ENDPOINT_IP --properties-private-endpoint-label=PROPERTIES_PRIVATE_ENDPOINT_LABEL --properties-secret-id=PROPERTIES_SECRET_ID --properties-vault-id=PROPERTIES_VAULT_ID --encryption-key-provider=ENCRYPTION_KEY_PROVIDER --key-ring=KEY_RING --clear-encryption-key-kms | --encryption-key-kms=ENCRYPTION_KEY_KMS --properties-allowlisted-ips=[PROPERTIES_ALLOWLISTED_IPS,
...]
| --add-properties-allowlisted-ips=[ADD_PROPERTIES_ALLOWLISTED_IPS,
...] --clear-properties-allowlisted-ips
| --remove-properties-allowlisted-ips=[REMOVE_PROPERTIES_ALLOWLISTED_IPS,
...] --properties-customer-contacts=[email=EMAIL]
| --add-properties-customer-contacts=[email=EMAIL]
--clear-properties-customer-contacts
| --remove-properties-customer-contacts=[email=EMAIL]]
[--clear-source-config
--[no-]source-config-automatic-backups-replication-enabled
--clear-source-config-autonomous-database
| --source-config-autonomous-database=SOURCE_CONFIG_AUTONOMOUS_DATABASE]
[--labels=[LABELS,...]
| --update-labels=[UPDATE_LABELS,...] --clear-labels
| --remove-labels=REMOVE_LABELS] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Update an AutonomousDatabase.
EXAMPLES
To Update the encryption for a given AutonomousDatabase with id
my-autonomous-database with custom KMS encryption key
projects/project-id/locations/us-east4/keyRings/keyring/cryptoKeys/key,
run:
$ gcloud oracle-database autonomous-databases update \
my-autonomous-database --location=us-east4 \
--properties-encryption-key-provider=GOOGLE_MANAGED \
--properties-encryption-key-kms-key=projects/project-id/\
locations/us-east4/keyRings/keyring/cryptoKeys/key
POSITIONAL ARGUMENTS
AutonomousDatabase resource - Identifier. The name of the Autonomous
Database resource in the following format:
projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}
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 autonomous_database on the command line with a
fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
To set the location attribute:
◆ provide the argument autonomous_database on the command line with a
fully specified name;
◆ provide the argument --location on the command line.
This must be specified.
AUTONOMOUS_DATABASE
ID of the autonomousDatabase or fully qualified identifier for the
autonomousDatabase.
To set the autonomous_database attribute:
▸ provide the argument autonomous_database on the command line.
FLAGS
--admin-password=ADMIN_PASSWORD
The password for the default ADMIN user.
--async
Return immediately, without waiting for the operation in progress to
complete.
--cidr=CIDR
The subnet CIDR range for the Autonomous Database.
Update odb_network.
--clear-odb-network
Clear odb_network value and set to null.
--database=DATABASE
The name of the Autonomous Database. The database name must be unique
in the project. The name must begin with a letter and can contain a
maximum of 30 alphanumeric characters.
--display-name=DISPLAY_NAME
The display name for the Autonomous Database. The name does not have to
be unique within your project.
--location=LOCATION
For resources [autonomous_database, encryption-key-kms, odb-network,
odb-subnet, source-config-autonomous-database], provides fallback value
for resource location attribute. When the resource's full URI path is
not provided, location will fallback to this flag value.
--odb-network=ODB_NETWORK
For resources [odb-network, odb-subnet], provides fallback value for
resource odb-network attribute. When the resource's full URI path is
not provided, odb-network will fallback to this flag value.
--request-id=REQUEST_ID
An optional ID to identify the request. This value is used to identify
duplicate requests. If you make a request with the same request ID and
the original request is still in progress or completed, the server
ignores the second request. This prevents clients from accidentally
creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID
is not supported (00000000-0000-0000-0000-000000000000).
Update network.
At most one of these can be specified:
--clear-network
Clear network value and set to null.
Network resource - Set network to new value.
The name of the VPC network used by the Autonomous Database in the
following format: projects/{project}/global/networks/{network} 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 --network on the command line with a fully
specified name;
▸ provide the argument --project on the command line;
▸ set the property core/project.
--network=NETWORK
ID of the network or fully qualified identifier for the network.
To set the network attribute:
▫ provide the argument --network on the command line.
Update odb_subnet.
At most one of these can be specified:
--clear-odb-subnet
Clear odb_subnet value and set to null.
OdbSubnet resource - Set odb_subnet to new value.
The name of the OdbSubnet associated with the Autonomous Database.
Format:
projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
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 --odb-subnet on the command line with a fully
specified name;
▸ provide the argument --project on the command line;
▸ set the property core/project.
To set the location attribute:
▸ provide the argument --odb-subnet on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
To set the odb-network attribute:
▸ provide the argument --odb-subnet on the command line with a fully
specified name;
▸ provide the argument --odb-network on the command line.
--odb-subnet=ODB_SUBNET
ID of the odbSubnet or fully qualified identifier for the
odbSubnet.
To set the odb-subnet attribute:
▫ provide the argument --odb-subnet on the command line.
The properties of an Autonomous Database.
--clear-properties
Set autonomousDatabase.properties back to default value.
--properties-backup-retention-period-days=PROPERTIES_BACKUP_RETENTION_PERIOD_DAYS
The retention period for the Autonomous Database. This field is
specified in days, can range from 1 day to 60 days, and has a default
value of 60 days.
--properties-character-set=PROPERTIES_CHARACTER_SET
The character set for the Autonomous Database. The default is
AL32UTF8.
--properties-compute-count=PROPERTIES_COMPUTE_COUNT
The number of compute servers for the Autonomous Database.
--properties-cpu-core-count=PROPERTIES_CPU_CORE_COUNT
The number of CPU cores to be made available to the database.
--properties-data-storage-size-gb=PROPERTIES_DATA_STORAGE_SIZE_GB
The size of the data stored in the database, in gigabytes.
--properties-data-storage-size-tb=PROPERTIES_DATA_STORAGE_SIZE_TB
The size of the data stored in the database, in terabytes.
--properties-db-edition=PROPERTIES_DB_EDITION
The edition of the Autonomous Databases. PROPERTIES_DB_EDITION must
be one of:
enterprise-edition
Enterprise Database Edition
standard-edition
Standard Database Edition
--properties-db-version=PROPERTIES_DB_VERSION
The Oracle Database version for the Autonomous Database.
--properties-db-workload=PROPERTIES_DB_WORKLOAD
The workload type of the Autonomous Database. PROPERTIES_DB_WORKLOAD
must be one of:
ajd
Autonomous JSON Database.
apex
Autonomous Database with the Oracle APEX Application Development
workload type.
dw
Autonomous Data Warehouse database.
oltp
Autonomous Transaction Processing database.
--[no-]properties-is-auto-scaling-enabled
This field indicates if auto scaling is enabled for the Autonomous
Database CPU core count. Use --properties-is-auto-scaling-enabled to
enable and --no-properties-is-auto-scaling-enabled to disable.
--[no-]properties-is-storage-auto-scaling-enabled
This field indicates if auto scaling is enabled for the Autonomous
Database storage. Use --properties-is-storage-auto-scaling-enabled to
enable and --no-properties-is-storage-auto-scaling-enabled to
disable.
--properties-license-type=PROPERTIES_LICENSE_TYPE
The license type used for the Autonomous Database.
PROPERTIES_LICENSE_TYPE must be one of:
bring-your-own-license
Bring your own license
license-included
License included part of offer
--properties-maintenance-schedule-type=PROPERTIES_MAINTENANCE_SCHEDULE_TYPE
The maintenance schedule of the Autonomous Database.
PROPERTIES_MAINTENANCE_SCHEDULE_TYPE must be one of:
early
An EARLY maintenance schedule patches the database before the
regular scheduled maintenance.
regular
A REGULAR maintenance schedule follows the normal maintenance
cycle.
--[no-]properties-mtls-connection-required
This field specifies if the Autonomous Database requires mTLS
connections. Use --properties-mtls-connection-required to enable and
--no-properties-mtls-connection-required to disable.
--properties-n-character-set=PROPERTIES_N_CHARACTER_SET
The national character set for the Autonomous Database. The default
is AL16UTF16.
--properties-private-endpoint-ip=PROPERTIES_PRIVATE_ENDPOINT_IP
The private endpoint IP address for the Autonomous Database.
--properties-private-endpoint-label=PROPERTIES_PRIVATE_ENDPOINT_LABEL
The private endpoint label for the Autonomous Database.
--properties-secret-id=PROPERTIES_SECRET_ID
The ID of the Oracle Cloud Infrastructure vault secret.
--properties-vault-id=PROPERTIES_VAULT_ID
The ID of the Oracle Cloud Infrastructure vault.
The encryption key used to encrypt the Autonomous Database.
--encryption-key-provider=ENCRYPTION_KEY_PROVIDER
The provider of the encryption key. ENCRYPTION_KEY_PROVIDER must be
one of:
google-managed
Google Managed KMS key, if selected, please provide the KMS key
name.
oracle-managed
Oracle Managed.
All arguments needed to update encryption_key_kms.
--key-ring=KEY_RING
The keyRing id of the cryptoKey resource.
To set the key-ring attribute:
◇ provide the argument --current on the command line with a
fully specified name;
◇ provide the argument --key-ring on the command line.
Update encryption_key_kms.
At most one of these can be specified:
--clear-encryption-key-kms
Clear encryption_key_kms value and set to null.
CryptoKey resource - Set encryption_key_kms to new value.
The KMS key used to encrypt the Autonomous Database. This field is
required if the provider is GOOGLE_MANAGED. The name of the KMS
key resource in the following format:
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
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 --encryption-key-kms on the command line
with a fully specified name;
▹ provide the argument --project on the command line;
▹ set the property core/project.
To set the location attribute:
▹ provide the argument --encryption-key-kms on the command line
with a fully specified name;
▹ provide the argument --location on the command line.
To set the key-ring attribute:
▹ provide the argument --encryption-key-kms on the command line
with a fully specified name;
▹ provide the argument --key-ring on the command line.
--encryption-key-kms=ENCRYPTION_KEY_KMS
ID of the cryptoKey or fully qualified identifier for the
cryptoKey.
To set the crypto-key attribute:
▪ provide the argument --encryption-key-kms on the command
line.
Update properties_allowlisted_ips.
At most one of these can be specified:
--properties-allowlisted-ips=[PROPERTIES_ALLOWLISTED_IPS,...]
Set properties_allowlisted_ips to new value.
--add-properties-allowlisted-ips=[ADD_PROPERTIES_ALLOWLISTED_IPS,...]
Add new value to properties_allowlisted_ips list.
At most one of these can be specified:
--clear-properties-allowlisted-ips
Clear properties_allowlisted_ips value and set to empty list.
--remove-properties-allowlisted-ips=[REMOVE_PROPERTIES_ALLOWLISTED_IPS,...]
Remove existing value from properties_allowlisted_ips list.
Update properties_customer_contacts.
At most one of these can be specified:
--properties-customer-contacts=[email=EMAIL]
Set properties_customer_contacts to new value. The list of customer
contacts.
email
The email address used by Oracle to send notifications
regarding databases and infrastructure.
Shorthand Example:
--properties-customer-contacts=email=string --properties-customer-contacts=email=string
JSON Example:
--properties-customer-contacts='[{"email": "string"}]'
File Example:
--properties-customer-contacts=path_to_file.(yaml|json)
--add-properties-customer-contacts=[email=EMAIL]
Add new value to properties_customer_contacts list. The list of
customer contacts.
email
The email address used by Oracle to send notifications
regarding databases and infrastructure.
Shorthand Example:
--add-properties-customer-contacts=email=string --add-properties-customer-contacts=email=string
JSON Example:
--add-properties-customer-contacts='[{"email": "string"}]'
File Example:
--add-properties-customer-contacts=path_to_file.(yaml|json)
At most one of these can be specified:
--clear-properties-customer-contacts
Clear properties_customer_contacts value and set to empty list.
--remove-properties-customer-contacts=[email=EMAIL]
Remove existing value from properties_customer_contacts list. The
list of customer contacts.
email
The email address used by Oracle to send notifications
regarding databases and infrastructure.
Shorthand Example:
--remove-properties-customer-contacts=email=string --remove-properties-customer-contacts=email=string
JSON Example:
--remove-properties-customer-contacts='[{"email": "string"}]'
File Example:
--remove-properties-customer-contacts=path_to_file.(yaml|json)
The source configuration for the standby Autonomous Database.
--clear-source-config
Set autonomousDatabase.sourceConfig back to default value.
--[no-]source-config-automatic-backups-replication-enabled
This field specifies if the replication of automatic backups is
enabled when creating a Data Guard. Use
--source-config-automatic-backups-replication-enabled to enable and
--no-source-config-automatic-backups-replication-enabled to disable.
Update source_config_autonomous_database.
At most one of these can be specified:
--clear-source-config-autonomous-database
Clear source_config_autonomous_database value and set to null.
AutonomousDatabase resource - Set source_config_autonomous_database to
new value.
The name of the primary Autonomous Database that is used to create a
Peer Autonomous Database from a source. 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 --source-config-autonomous-database on the
command line with a fully specified name;
▫ provide the argument --project on the command line;
▫ set the property core/project.
To set the location attribute:
▫ provide the argument --source-config-autonomous-database on the
command line with a fully specified name;
▫ provide the argument --location on the command line.
--source-config-autonomous-database=SOURCE_CONFIG_AUTONOMOUS_DATABASE
ID of the autonomousDatabase or fully qualified identifier for
the autonomousDatabase.
To set the autonomous-database attribute:
◇ provide the argument --source-config-autonomous-database on
the command line.
Update labels.
At most one of these can be specified:
--labels=[LABELS,...]
Set labels to new value. The labels or tags associated with the
Autonomous Database.
KEY
Keys must start with a lowercase character and contain only
hyphens (-), underscores (_), lowercase characters, and numbers.
VALUE
Values must contain only hyphens (-), underscores (_), lowercase
characters, and numbers.
Shorthand Example:
--labels=string=string
JSON Example:
--labels='{"string": "string"}'
File Example:
--labels=path_to_file.(yaml|json)
--update-labels=[UPDATE_LABELS,...]
Update labels value or add key value pair. The labels or tags
associated with the Autonomous Database.
KEY
Keys must start with a lowercase character and contain only
hyphens (-), underscores (_), lowercase characters, and numbers.
VALUE
Values must contain only hyphens (-), underscores (_), lowercase
characters, and numbers.
Shorthand Example:
--update-labels=string=string
JSON Example:
--update-labels='{"string": "string"}'
File Example:
--update-labels=path_to_file.(yaml|json)
At most one of these can be specified:
--clear-labels
Clear labels value and set to empty map.
--remove-labels=REMOVE_LABELS
Remove existing value from map labels. Sets remove_labels value.
Shorthand Example:
--remove-labels=string,string
JSON Example:
--remove-labels=["string"]
File Example:
--remove-labels=path_to_file.(yaml|json)
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --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 oracledatabase/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/oracle/database/docs
View git blame Copy permalink