change-database-parameters-database-secret-credential-details

Description

Changes database parameter values. There are two kinds of database parameters:

  • Dynamic parameters: They can be changed for the current Oracle Database instance. The changes take effect immediately. - Static parameters: They cannot be changed for the current instance. You must change these parameters and then restart the database before changes take effect.

Note: If the instance is started using a text initialization parameter file, the parameter changes are applicable only for the current instance. You must update them manually to be passed to a future instance.

Usage

oci database-management managed-database change-database-parameters-database-secret-credential-details [OPTIONS]

Required Parameters

--database-credential-password-secret-id [text]

The OCID of the Secret where the database password is stored.

--managed-database-id [text]

The OCID of the Managed Database.

--parameters [complex type]

A list of database parameters and their values. 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.

--scope [text]

The clause used to specify when the parameter change takes effect.

Use MEMORY to make the change in memory and affect it immediately. Use SPFILE to make the change in the server parameter file. The change takes effect when the database is next shut down and started up again. Use BOTH to make the change in memory and in the server parameter file. The change takes effect immediately and persists after the database is shut down and started up again.

Accepted values are:

BOTH, MEMORY, SPFILE

Optional Parameters

--credentials [complex type]

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.

--database-credential-role [text]

The role of the database user.

Accepted values are:

NORMAL, SYSDBA, SYSDG
--database-credential-username [text]

The user to connect to the database.

--from-json [text]

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

Example using required parameter

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci database-management managed-database change-database-parameters-database-secret-credential-details --generate-param-json-input parameters > parameters.json

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export database_credential_password_secret_id=<substitute-value-of-database_credential_password_secret_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/managed-database/change-database-parameters-database-secret-credential-details.html#cmdoption-database-credential-password-secret-id
    export managed_database_id=<substitute-value-of-managed_database_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/managed-database/change-database-parameters-database-secret-credential-details.html#cmdoption-managed-database-id
    export scope=<substitute-value-of-scope> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/managed-database/change-database-parameters-database-secret-credential-details.html#cmdoption-scope

    oci database-management managed-database change-database-parameters-database-secret-credential-details --database-credential-password-secret-id $database_credential_password_secret_id --managed-database-id $managed_database_id --parameters file://parameters.json --scope $scope