Try SpotterPerform actions on a DatabaseParameter resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Perform actions on a DatabaseParameter resource in Oracle Cloud Infrastructure
For I(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 I(action=reset), resets database parameter values to their default or startup values.
- 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
scope:
choices:
- MEMORY
- SPFILE
- BOTH
description:
- 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.
required: true
type: str
action:
choices:
- change
- reset
description:
- The action to perform on the DatabaseParameter.
required: true
type: str
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
cert_bundle:
description:
- 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.
type: str
credentials:
description:
- ''
required: true
suboptions:
password:
description:
- The password for the database user name.
type: str
role:
choices:
- NORMAL
- SYSDBA
description:
- The role of the database user. Indicates whether the database user is a normal
user or sysdba.
type: str
secret_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the secret containing the user password.
type: str
user_name:
description:
- The database user name used to perform management activity.
type: str
type: dict
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
reset_parameters:
description:
- A list of database parameter names.
- Required for I(action=reset).
elements: str
type: list
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
change_parameters:
description:
- A list of database parameters and their values.
- Required for I(action=change).
elements: dict
suboptions:
name:
description:
- The parameter name.
required: true
type: str
update_comment:
description:
- A comment string to associate with the change in parameter value. It cannot
contain control characters or a line break.
type: str
value:
description:
- The parameter value.
required: true
type: str
type: list
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
managed_database_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Managed Database.
required: true
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
realm_specific_endpoint_template_enabled:
description:
- Enable/Disable realm specific endpoint template for service client. By Default,
realm specific endpoint template is disabled. If not set, then the value of the
OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
type: bool
update_database_parameters_result:
contains:
status:
contains:
error_code:
description:
- An error code that defines the failure or `null` if the parameter was
updated successfully.
returned: on success
sample: error_code_example
type: str
error_message:
description:
- The error message indicating the reason for failure or `null` if the parameter
was updated successfully.
returned: on success
sample: error_message_example
type: str
status:
description:
- The status of the parameter update.
returned: on success
sample: SUCCEEDED
type: str
description:
- A map with the parameter name as key and its update status as value.
returned: on success
type: complex
description:
- Details of the DatabaseParameter resource acted upon by the current operation
returned: on success
sample:
status:
error_code: error_code_example
error_message: error_message_example
status: SUCCEEDED
type: complex