oracle.oci.oci_psql_configuration – Manage a Configuration resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.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_psql_configuration
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a Configuration resource in Oracle Cloud Infrastructure
For state=present, creates a new configuration.
This resource has the following action operations in the oracle.oci.oci_psql_configuration_actions module: change_compartment.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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.
|
|||
compartment_id
string
|
The OCID of the compartment that contains the configuration.
Required for create using state=present.
|
|||
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 . |
|||
configuration_id
string
|
A unique identifier for the configuration.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
|||
db_configuration_overrides
dictionary
|
Required for create using state=present.
|
|||
items
list
/ elements=dictionary / required
|
List of configuration overridden values.
|
|||
config_key
string
/ required
|
Configuration variable name.
|
|||
overriden_config_value
string
/ required
|
User-selected variable value.
|
|||
db_version
string
|
Version of the PostgreSQL database.
Required for create using state=present.
|
|||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
|||
description
string
|
Details about the configuration set.
This parameter is updatable.
|
|||
display_name
string
|
A user-friendly display name for the configuration. Avoid entering confidential information.
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
|||
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
||
freeform_tags
dictionary
|
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
|
|||
instance_memory_size_in_gbs
integer
|
Memory size in gigabytes with 1GB increment.
Required for create using state=present.
|
|||
instance_ocpu_count
integer
|
CPU core count.
Required for create using state=present.
|
|||
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
|||
realm_specific_endpoint_template_enabled
boolean
|
|
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.
|
||
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. |
|||
shape
string
|
The name of the shape for the configuration. Example: `VM.Standard.E4.Flex`
Required for create using state=present.
|
|||
state
string
|
|
The state of the Configuration.
Use state=present to create or update a Configuration.
Use state=absent to delete a Configuration.
|
||
system_tags
dictionary
|
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
|||
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 |
|||
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
||
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create configuration
oci_psql_configuration:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
shape: shape_example
db_version: db_version_example
instance_ocpu_count: 56
instance_memory_size_in_gbs: 56
db_configuration_overrides:
# required
items:
- # required
config_key: config_key_example
overriden_config_value: overriden_config_value_example
display_name: display_name_example
# optional
system_tags: null
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update configuration
oci_psql_configuration:
# required
configuration_id: "ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update configuration using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_psql_configuration:
# required
display_name: display_name_example
# optional
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete configuration
oci_psql_configuration:
# required
configuration_id: "ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete configuration using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_psql_configuration:
# required
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
configuration
complex
|
on success |
Details of the Configuration resource acted upon by the current operation
Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'configuration_details': {'items': [{'allowed_values': 'allowed_values_example', 'config_key': 'config_key_example', 'data_type': 'data_type_example', 'default_config_value': 'default_config_value_example', 'description': 'description_example', 'is_overridable': True, 'is_restart_required': True, 'overriden_config_value': 'overriden_config_value_example'}]}, 'db_version': 'db_version_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'instance_memory_size_in_gbs': 56, 'instance_ocpu_count': 56, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACTIVE', 'shape': 'shape_example', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00'}
|
|||
compartment_id
string
|
on success |
The OCID of the compartment that contains the configuration.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||
configuration_details
complex
|
on success |
|
|||
items
complex
|
on success |
List of ConfigParms object.
|
|||
allowed_values
string
|
on success |
Range or list of allowed values.
Sample:
allowed_values_example
|
|||
config_key
string
|
on success |
The configuration variable name.
Sample:
config_key_example
|
|||
data_type
string
|
on success |
Data type of the variable.
Sample:
data_type_example
|
|||
default_config_value
string
|
on success |
Default value for the configuration variable.
Sample:
default_config_value_example
|
|||
description
string
|
on success |
Details about the PostgreSQL parameter.
Sample:
description_example
|
|||
is_overridable
boolean
|
on success |
Whether the value can be overridden or not.
Sample:
True
|
|||
is_restart_required
boolean
|
on success |
If true, modifying this configuration value will require a restart of the database.
Sample:
True
|
|||
overriden_config_value
string
|
on success |
User-selected configuration variable value.
Sample:
overriden_config_value_example
|
|||
db_version
string
|
on success |
Version of the PostgreSQL database.
Sample:
db_version_example
|
|||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|||
description
string
|
on success |
A description for the configuration.
Sample:
description_example
|
|||
display_name
string
|
on success |
A user-friendly display name for the configuration. Avoid entering confidential information.
Sample:
display_name_example
|
|||
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
|||
id
string
|
on success |
A unique identifier for the configuration. Immutable on creation.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
instance_memory_size_in_gbs
integer
|
on success |
Memory size in gigabytes with 1GB increment.
Sample:
56
|
|||
instance_ocpu_count
integer
|
on success |
CPU core count.
Sample:
56
|
|||
lifecycle_details
string
|
on success |
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Sample:
lifecycle_details_example
|
|||
lifecycle_state
string
|
on success |
The current state of the configuration.
Sample:
ACTIVE
|
|||
shape
string
|
on success |
The name of the shape for the configuration. Example: `VM.Standard.E4.Flex`
Sample:
shape_example
|
|||
system_tags
dictionary
|
on success |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
|||
time_created
string
|
on success |
The date and time that the configuration was created, expressed in RFC 3339 timestamp format.
Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)