oracle / oracle.oci / 4.21.0 / module / oci_database_management_database_parameter_facts Fetches details about one or multiple DatabaseParameter resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_management_database_parameter_facts (4.21.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.21.0
collections: - name: oracle.oci version: 4.21.0
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.
- 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
name: description: - A filter to return all parameters that have the text given in their names. 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 source: choices: - CURRENT - SPFILE description: - 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`. type: str sort_by: choices: - NAME description: - 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. 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 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 sort_order: choices: - ASC - DESC description: - The option to sort information in ascending ('ASC') or descending ('DESC') order. Ascending order is the default order. 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 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 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 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: 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 is_allowed_values_included: description: - When true, results include a list of valid values for parameters (if applicable). type: bool 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
database_parameters: contains: allowed_values: contains: is_default: description: - Indicates whether the given ordinal value is the default value for the parameter. returned: on success sample: true type: bool ordinal: description: - The ordinal number in the list (1-based). returned: on success sample: 10 type: float value: description: - The parameter value at ordinal. returned: on success sample: value_example type: str description: - A list of allowed values for this parameter. returned: on success type: complex category: description: - The parameter category. returned: on success sample: category_example type: str constraint: description: - 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. returned: on success sample: UNIQUE type: str container_id: description: - '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.' returned: on success sample: 10 type: float description: description: - The description of the parameter. returned: on success sample: description_example type: str display_value: description: - 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. returned: on success sample: display_value_example type: str is_adjusted: description: - Indicates whether Oracle adjusted the input value to a more suitable value. returned: on success sample: true type: bool is_basic: description: - Indicates whether the parameter is a basic parameter (`TRUE`) or not (`FALSE`). returned: on success sample: true type: bool is_default: description: - Indicates whether the parameter is set to the default value (`TRUE`) or the parameter value was specified in the parameter file (`FALSE`). returned: on success sample: true type: bool is_deprecated: description: - Indicates whether the parameter has been deprecated (`TRUE`) or not (`FALSE`). returned: on success sample: true type: bool is_instance_modifiable: description: - 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`. returned: on success sample: true type: bool is_modified: description: - Indicates how the parameter was modified. If an `ALTER SYSTEM` was performed, the value will be `MODIFIED`. returned: on success sample: MODIFIED type: str is_pdb_modifiable: description: - 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`. returned: on success sample: true type: bool is_session_modifiable: description: - Indicates whether the parameter can be changed with `ALTER SESSION` (`TRUE`) or not (`FALSE`) returned: on success sample: true type: bool is_specified: description: - Indicates whether the parameter was specified in the server parameter file (`TRUE`) or not (`FALSE`). Applicable only when the parameter source is `SPFILE`. returned: on success sample: true type: bool is_system_modifiable: description: - '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.' returned: on success sample: IMMEDIATE type: str name: description: - The parameter name. returned: on success sample: name_example type: str number: description: - The parameter number. returned: on success sample: 10 type: float ordinal: description: - The position (ordinal number) of the parameter value. Useful only for parameters whose values are lists of strings. returned: on success sample: 10 type: float sid: description: - The database instance SID for which the parameter is defined. returned: on success sample: sid_example type: str type: description: - The parameter type. returned: on success sample: BOOLEAN type: str update_comment: description: - The comments associated with the most recent update. returned: on success sample: update_comment_example type: str value: description: - The parameter value. returned: on success sample: value_example type: str description: - List of DatabaseParameter resources returned: on success 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 type: complex