NAME

DESCRIPTION

USAGE

oci db autonomous-database update [OPTIONS]

REQUIRED PARAMETERS

The database OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>.

OPTIONAL PARAMETERS

The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (“) or the username “admin”, regardless of casing. It must be different from the last four passwords and it must not be a password used within the last 24 hours.

This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. TRUE if the Autonomous Database has Data Guard and Access Control enabled, and the Autonomous Database uses the primary’s IP access control list (ACL) for standby. FALSE if the Autonomous Database has Data Guard and Access Control enabled, and the Autonomous Database uses a different IP access control list (ACL) for standby compared to primary.

The number of OCPU cores to be made available to the Autonomous Database.

Note: This parameter cannot be used with the ocpuCount parameter.

Customer Contacts. Setting this to an empty list removes all customer contacts of an Oracle Autonomous Database.

This option is a JSON list with items of type CustomerContact. For documentation on CustomerContact please see our API reference: https://docs.cloud.oracle.com/api/#/en/database/20160918/datatypes/CustomerContact. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

Applies to dedicated Exadata infrastructure only.

The size, in gigabytes, of the data volume that will be created and attached to the database. The maximum storage value depends on the system shape. See Characteristics of Infrastructure Shapes <https://www.oracle.com/pls/topic/lookup?ctx&#x3D;en/cloud/paas/autonomous-database&amp;id&#x3D;ATPFG-GUID-B0F033C1-CC5A-42F0-B2E7-3CECFEDA1FD1> for shape details.

Note: This parameter cannot be used with the dataStorageSizeInTBs parameter.

The size, in terabytes, of the data volume that will be created and attached to the database. For Autonomous Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes <https://www.oracle.com/pls/topic/lookup?ctx&#x3D;en/cloud/paas/autonomous-database&amp;id&#x3D;ATPFG-GUID-B0F033C1-CC5A-42F0-B2E7-3CECFEDA1FD1> for shape details.

Note: This parameter cannot be used with the dataStorageSizeInGBs parameter.

The Oracle Database Edition that applies to the Autonomous databases.

New name for this Autonomous Database. For databases using dedicated Exadata infrastructure, the name must begin with an alphabetic character, and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. For databases using shared Exadata infrastructure, the name must begin with an alphabetic character, and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy.

A valid Oracle Database version for Autonomous Database.

The Autonomous Database workload type. The following values are valid:

Accepted values are:

AJD, APEX, DW, OLTP

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags <https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm>. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

The user-friendly name for the Autonomous Database. The name does not have to be unique. The display name can only be updated for Autonomous Databases using dedicated Exadata infrastructure.

Perform update without prompting for confirmation.

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags <https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm>.

Example:

{"Department": "Finance"}

This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.

Indicates if the database-level access control is enabled. If disabled, database access is defined by the network security rules. If enabled, database access is restricted to the IP addresses defined by the rules specified with the whitelistedIps property. While specifying whitelistedIps rules is optional, if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using the UpdateAutonomousDatabase API operation or edit option in console. When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.

This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer <Cloud@Customer> platform.

Indicates whether auto scaling is enabled for the Autonomous Database OCPU core count. Setting to TRUE enables auto scaling. Setting to FALSE disables auto scaling. The default value is true. Auto scaling is available for databases on shared Exadata infrastructure <https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html> only.

Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is FALSE.

** Deprecated. ** Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer <Cloud@Customer> infrastructure.

To create a local standby, set to TRUE. To delete a local standby, set to FALSE. For more information on using Autonomous Data Guard on shared Exadata infrastructure (local and cross-region) , see About Standby Databases <https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-about.html#GUID-045AD017-8120-4BDC-AF58-7430FFE28D2B>

To enable cross-region Autonomous Data Guard on shared Exadata infrastructure, see CreateCrossRegionAutonomousDatabaseDataGuardDetails <https://docs.cloud.oracle.com/api/#/en/database/20160918/datatypes/CreateCrossRegionAutonomousDatabaseDataGuardDetails>.

To delete a cross-region standby database, provide the peerDbId for the standby database in a remote region, and set isDataGuardEnabled to FALSE.

Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled.

Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer <Cloud@Customer> infrastructure.

To create a local standby, set to TRUE. To delete a local standby, set to FALSE. For more information on using Autonomous Data Guard on shared Exadata infrastructure (local and cross-region) , see About Standby Databases <https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-about.html#GUID-045AD017-8120-4BDC-AF58-7430FFE28D2B>

To enable cross-region Autonomous Data Guard on shared Exadata infrastructure, see CreateCrossRegionAutonomousDatabaseDataGuardDetails <https://docs.cloud.oracle.com/api/#/en/database/20160918/datatypes/CreateCrossRegionAutonomousDatabaseDataGuardDetails>.

Indicates whether the Autonomous Database requires mTLS connections.

Indicates whether the Autonomous Database is a refreshable clone.

The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure <https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html>, this attribute must be null because the attribute is already set at the Autonomous Exadata Infrastructure level. When using shared Exadata infrastructure <https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html>, if a value is not specified, the system will supply the value of BRING_YOUR_OWN_LICENSE.

Accepted values are:

BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED

The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.

The maximum time to wait for the resource to reach the lifecycle state defined by --wait-for-state. Defaults to 1200 seconds.

The list of OCIDs <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules <https://docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm>. NsgIds restrictions: - Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds list cannot be empty. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

The number of OCPU cores to be made available to the Autonomous Database.

For databases on dedicated Exadata infrastructure, you can specify a fractional value for this parameter. Fractional values are not supported for Autonomous Database on shared Exadata infrastructure.

To provision less than 1 core, enter a fractional value in an increment of 0.1. To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available to the infrastructure shape. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. Likewise, you can provision 2 cores or 3 cores, but not 2.5 cores. The maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes <https://www.oracle.com/pls/topic/lookup?ctx&#x3D;en/cloud/paas/autonomous-database&amp;id&#x3D;ATPFG-GUID-B0F033C1-CC5A-42F0-B2E7-3CECFEDA1FD1> for shape details.

Note: This parameter cannot be used with the cpuCoreCount parameter.

The DATABASE OPEN mode. You can open the database in READ_ONLY or READ_WRITE mode.

Accepted values are:

READ_ONLY, READ_WRITE

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Autonomous Data Guard standby database located in a different (remote) region from the source primary Autonomous Database.

To create or delete a local (in-region) standby, see the isDataGuardEnabled parameter.

The Autonomous Database permission level. Restricted mode allows access only to admin users.

Accepted values are:

RESTRICTED, UNRESTRICTED

The private endpoint label for the resource. Setting this to an empty string, after the private endpoint database gets created, will change the same private endpoint database to the public endpoint database.

The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.

Accepted values are:

AUTOMATIC, MANUAL

list of scheduled operations

This option is a JSON list with items of type ScheduledOperationDetails. For documentation on ScheduledOperationDetails please see our API reference: https://docs.cloud.oracle.com/api/#/en/database/20160918/datatypes/ScheduledOperationDetails. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

The client IP access control list (ACL). This feature is available for autonomous databases on shared Exadata infrastructure <https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html> and on Exadata Cloud@Customer <Cloud@Customer>. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance.

For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: [“1.1.1.1”,”1.1.1.0/24”,”ocid1.vcn.oc1.sea.<unique_id>”,”ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1”,”ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16”] For Exadata Cloud@Customer <Cloud@Customer>, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example: [“1.1.1.1”,”1.1.1.0/24”,”1.1.2.25”]

For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the subnet the resource is associated with.

Subnet Restrictions: - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. - For Autonomous Database, setting this will disable public secure access to the database.

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.

This operation creates, modifies or deletes a resource that has a defined lifecycle state. Specify this option to perform the action and then wait until the resource reaches a given lifecycle state. Multiple states can be specified, returning on the first state. For example, --wait-for-state SUCCEEDED --wait-for-state FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

AVAILABLE, AVAILABLE_NEEDS_ATTENTION, BACKUP_IN_PROGRESS, INACCESSIBLE, MAINTENANCE_IN_PROGRESS, PROVISIONING, RECREATING, RESTARTING, RESTORE_FAILED, RESTORE_IN_PROGRESS, ROLE_CHANGE_IN_PROGRESS, SCALE_IN_PROGRESS, STANDBY, STARTING, STOPPED, STOPPING, TERMINATED, TERMINATING, UNAVAILABLE, UPDATING, UPGRADING

Check every --wait-interval-seconds to see whether the resource to see if it has reached the lifecycle state defined by --wait-for-state. Defaults to 30 seconds.

The client IP access control list (ACL). This feature is available for autonomous databases on shared Exadata infrastructure <https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html> and on Exadata Cloud@Customer <Cloud@Customer>. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance.

For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example: [“1.1.1.1”,”1.1.1.0/24”,”ocid1.vcn.oc1.sea.<unique_id>”,”ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1”,”ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16”] For Exadata Cloud@Customer <Cloud@Customer>, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example: [“1.1.1.1”,”1.1.1.0/24”,”1.1.2.25”]

For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

GLOBAL PARAMETERS

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

EXAMPLES

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/autonomous-database/create.html#cmdoption-compartment-id
    autonomous_database_id=$(oci db autonomous-database create --compartment-id $compartment_id --query data.id --raw-output)
    oci db autonomous-database update --autonomous-database-id $autonomous_database_id

AUTHOR

COPYRIGHT