oracle.oci.oci_database_management_database_parameter_facts – Fetches details about one or multiple DatabaseParameter resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.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_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple DatabaseParameter resources in Oracle Cloud Infrastructure

  • Gets the list of database parameters for the specified Managed Database. The parameters are listed in alphabetical order, along with their current values.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
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.
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.
is_allowed_values_included
boolean
    Choices:
  • no
  • yes
When true, results include a list of valid values for parameters (if applicable).
managed_database_id
string / required
The OCID of the Managed Database.
name
string
A filter to return all parameters that have the text given in their names.
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.
sort_by
string
    Choices:
  • NAME
The field to sort information by. Only one sortOrder can be used. The default sort order for `NAME` is ascending and it is case-sensitive.
sort_order
string
    Choices:
  • ASC
  • DESC
The option to sort information in ascending ('ASC') or descending ('DESC') order. Ascending order is the default order.
source
string
    Choices:
  • CURRENT
  • SPFILE
The source used to list database parameters. `CURRENT` is used to get the database parameters that are currently in effect for the database instance. `SPFILE` is used to list parameters from the server parameter file. Default is `CURRENT`.
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: List database_parameters
  oci_database_management_database_parameter_facts:
    # required
    managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    source: CURRENT
    name: name_example
    is_allowed_values_included: true
    sort_by: NAME
    sort_order: ASC

Return Values

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

Key Returned Description
database_parameters
complex
on success
List of DatabaseParameter resources

Sample:
[{'allowed_values': [{'is_default': True, 'ordinal': 10, 'value': 'value_example'}], 'category': 'category_example', 'constraint': 'UNIQUE', 'container_id': 10, 'description': 'description_example', 'display_value': 'display_value_example', 'is_adjusted': True, 'is_basic': True, 'is_default': True, 'is_deprecated': True, 'is_instance_modifiable': True, 'is_modified': 'MODIFIED', 'is_pdb_modifiable': True, 'is_session_modifiable': True, 'is_specified': True, 'is_system_modifiable': 'IMMEDIATE', 'name': 'name_example', 'number': 10, 'ordinal': 10, 'sid': 'sid_example', 'type': 'BOOLEAN', 'update_comment': 'update_comment_example', 'value': 'value_example'}]
 
allowed_values
complex
on success
A list of allowed values for this parameter.

   
is_default
boolean
on success
Indicates whether the given ordinal value is the default value for the parameter.

Sample:
True
   
ordinal
float
on success
The ordinal number in the list (1-based).

Sample:
10
   
value
string
on success
The parameter value at ordinal.

Sample:
value_example
 
category
string
on success
The parameter category.

Sample:
category_example
 
constraint
string
on success
Applicable in case of Oracle Real Application Clusters (Oracle RAC) databases. A `UNIQUE` parameter is one which is unique to each Oracle Real Application Clusters (Oracle RAC) instance. For example, the parameter `INSTANCE_NUMBER` must have different values in each instance. An `IDENTICAL` parameter must have the same value for every instance. For example, the parameter `DB_BLOCK_SIZE` must have the same value in all instances.

Sample:
UNIQUE
 
container_id
float
on success
The ID of the database container to which the data pertains. Possible values include: - `0`: This value is used for data that pertain to the entire CDB. This value is also used for data in non-CDBs. - `1`: This value is used for data that pertain to only the root container. - `n`: Where n is the applicable container ID for the data.

Sample:
10
 
description
string
on success
The description of the parameter.

Sample:
description_example
 
display_value
string
on success
The parameter value in a user-friendly format. For example, if the `value` property shows the value 262144 for a big integer parameter, then the `displayValue` property will show the value 256K.

Sample:
display_value_example
 
is_adjusted
boolean
on success
Indicates whether Oracle adjusted the input value to a more suitable value.

Sample:
True
 
is_basic
boolean
on success
Indicates whether the parameter is a basic parameter (`TRUE`) or not (`FALSE`).

Sample:
True
 
is_default
boolean
on success
Indicates whether the parameter is set to the default value (`TRUE`) or the parameter value was specified in the parameter file (`FALSE`).

Sample:
True
 
is_deprecated
boolean
on success
Indicates whether the parameter has been deprecated (`TRUE`) or not (`FALSE`).

Sample:
True
 
is_instance_modifiable
boolean
on success
For parameters that can be changed with `ALTER SYSTEM`, indicates whether the value of the parameter can be different for every instance (`TRUE`) or whether the parameter must have the same value for all Real Application Clusters instances (`FALSE`). For other parameters, this is always `FALSE`.

Sample:
True
 
is_modified
string
on success
Indicates how the parameter was modified. If an `ALTER SYSTEM` was performed, the value will be `MODIFIED`.

Sample:
MODIFIED
 
is_pdb_modifiable
boolean
on success
Indicates whether the parameter can be modified on a per-PDB basis (`TRUE`) or not (`FALSE`). In a non-CDB, the value of this property is `null`.

Sample:
True
 
is_session_modifiable
boolean
on success
Indicates whether the parameter can be changed with `ALTER SESSION` (`TRUE`) or not (`FALSE`)

Sample:
True
 
is_specified
boolean
on success
Indicates whether the parameter was specified in the server parameter file (`TRUE`) or not (`FALSE`). Applicable only when the parameter source is `SPFILE`.

Sample:
True
 
is_system_modifiable
string
on success
Indicates whether the parameter can be changed with `ALTER SYSTEM` and when the change takes effect: - IMMEDIATE: Parameter can be changed with `ALTER SYSTEM` regardless of the type of parameter file used to start the instance. The change takes effect immediately. - DEFERRED: Parameter can be changed with `ALTER SYSTEM` regardless of the type of parameter file used to start the instance. The change takes effect in subsequent sessions. - FALSE: Parameter cannot be changed with `ALTER SYSTEM` unless a server parameter file was used to start the instance. The change takes effect in subsequent instances.

Sample:
IMMEDIATE
 
name
string
on success
The parameter name.

Sample:
name_example
 
number
float
on success
The parameter number.

Sample:
10
 
ordinal
float
on success
The position (ordinal number) of the parameter value. Useful only for parameters whose values are lists of strings.

Sample:
10
 
sid
string
on success
The database instance SID for which the parameter is defined.

Sample:
sid_example
 
type
string
on success
The parameter type.

Sample:
BOOLEAN
 
update_comment
string
on success
The comments associated with the most recent update.

Sample:
update_comment_example
 
value
string
on success
The parameter value.

Sample:
value_example


Authors

  • Oracle (@oracle)