oracle.oci.oci_database_management_database_parameter_actions – Perform actions on a DatabaseParameter resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.13.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_database_management_database_parameter_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a DatabaseParameter resource in Oracle Cloud Infrastructure

  • For action=change, 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.

  • For action=reset, resets database parameter values to their default or startup values.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • change
  • reset
The action to perform on the DatabaseParameter.
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
change_parameters
list / elements=dictionary
A list of database parameters and their values.
Required for action=change.
name
string / required
The parameter name.
update_comment
string
A comment string to associate with the change in parameter value. It cannot contain control characters or a line break.
value
string / required
The parameter value.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
credentials
dictionary / required
password
string
The password for the database user name.
role
string
    Choices:
  • NORMAL
  • SYSDBA
The role of the database user. Indicates whether the database user is a normal user or sysdba.
secret_id
string
The OCID of the secret containing the user password.
user_name
string
The database user name used to perform management activity.
managed_database_id
string / required
The OCID of the Managed Database.

aliases: id
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
reset_parameters
list / elements=string
A list of database parameter names.
Required for action=reset.
scope
string / required
    Choices:
  • MEMORY
  • SPFILE
  • BOTH
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.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

- name: Perform action change on database_parameter
  oci_database_management_database_parameter_actions:
    # required
    change_parameters:
    - # required
      name: name_example
      value: value_example

      # optional
      update_comment: update_comment_example
    managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
    credentials:
      # optional
      user_name: user_name_example
      password: example-password
      secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
      role: NORMAL
    scope: MEMORY
    action: change

- name: Perform action reset on database_parameter
  oci_database_management_database_parameter_actions:
    # required
    managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
    credentials:
      # optional
      user_name: user_name_example
      password: example-password
      secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
      role: NORMAL
    scope: MEMORY
    reset_parameters: [ "reset_parameters_example" ]
    action: reset

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
update_database_parameters_result
complex
on success
Details of the DatabaseParameter resource acted upon by the current operation

Sample:
{'status': {'error_code': 'error_code_example', 'error_message': 'error_message_example', 'status': 'SUCCEEDED'}}
 
status
complex
on success
A map with the parameter name as key and its update status as value.
   
error_code
string
on success
An error code that defines the failure or `null` if the parameter was updated successfully.

Sample:
error_code_example
   
error_message
string
on success
The error message indicating the reason for failure or `null` if the parameter was updated successfully.

Sample:
error_message_example
   
status
string
on success
The status of the parameter update.

Sample:
SUCCEEDED


Authors

  • Oracle (@oracle)