Try SpotterManage a ManagedDatabaseGroup 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.0This module allows the user to create, update and delete a ManagedDatabaseGroup resource in Oracle Cloud Infrastructure
For I(state=present), creates a Managed Database Group. The group does not contain any Managed Databases when it is created, and they must be added later.
This resource has the following action operations in the M(oracle.oci.oci_database_management_managed_database_group_actions) module: add_managed_database, change_compartment, remove_managed_database.
- name: Create managed_database_group
oci_database_management_managed_database_group:
# required
name: name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
description: description_example
- name: Update managed_database_group
oci_database_management_managed_database_group:
# required
managed_database_group_id: "ocid1.manageddatabasegroup.oc1..xxxxxxEXAMPLExxxxxx"
# optional
description: description_example
- name: Update managed_database_group using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_database_management_managed_database_group:
# required
name: name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
description: description_example
- name: Delete managed_database_group
oci_database_management_managed_database_group:
# required
managed_database_group_id: "ocid1.manageddatabasegroup.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete managed_database_group using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_database_management_managed_database_group:
# required
name: name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
name:
description:
- The name of the Managed Database Group. Valid characters are uppercase or lowercase
letters, numbers, and "_". The name of the Managed Database Group cannot be modified.
It must be unique in the compartment and must begin with an alphabetic character.
- Required for create using I(state=present).
- Required for update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is set.
type: str
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
state:
choices:
- present
- absent
default: present
description:
- The state of the ManagedDatabaseGroup.
- Use I(state=present) to create or update a ManagedDatabaseGroup.
- Use I(state=absent) to delete a ManagedDatabaseGroup.
required: false
type: str
key_by:
description: 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.
elements: str
type: list
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
description:
description:
- The information specified by the user about the Managed Database Group.
- This parameter is updatable.
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
force_create:
default: false
description: 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 I(key_by).
type: bool
wait_timeout:
description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most
of the services but some services might have a longer wait timeout.
type: int
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment in which the Managed Database Group resides.
- Required for create using I(state=present).
- Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
- Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
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
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
managed_database_group_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Managed Database Group.
- Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
- Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
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
managed_database_group:
contains:
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
description:
- The information specified by the user about the Managed Database Group.
returned: on success
sample: description_example
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Managed Database Group.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
lifecycle_state:
description:
- The current lifecycle state of the Managed Database Group.
returned: on success
sample: CREATING
type: str
managed_databases:
contains:
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment in which the Managed Database resides.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
database_sub_type:
description:
- The subtype of the Oracle Database. Indicates whether the database is
a Container Database, Pluggable Database, Non-container Database, Autonomous
Database, or Autonomous Container Database.
returned: on success
sample: CDB
type: str
database_type:
description:
- The type of Oracle Database installation.
returned: on success
sample: EXTERNAL_SIDB
type: str
deployment_type:
description:
- The infrastructure used to deploy the Oracle Database.
returned: on success
sample: ONPREMISE
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Managed Database.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
name:
description:
- The name of the Managed Database.
returned: on success
sample: name_example
type: str
time_added:
description:
- The date and time the Managed Database was added to the group.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
workload_type:
description:
- The workload type of the Autonomous Database.
returned: on success
sample: OLTP
type: str
description:
- A list of Managed Databases in the Managed Database Group.
returned: on success
type: complex
name:
description:
- The name of the Managed Database Group.
returned: on success
sample: name_example
type: str
time_created:
description:
- The date and time the Managed Database Group was created.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_updated:
description:
- The date and time the Managed Database Group was last updated.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- Details of the ManagedDatabaseGroup resource acted upon by the current operation
returned: on success
sample:
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
description: description_example
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
lifecycle_state: CREATING
managed_databases:
- compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
database_sub_type: CDB
database_type: EXTERNAL_SIDB
deployment_type: ONPREMISE
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
name: name_example
time_added: '2013-10-20T19:20:30+01:00'
workload_type: OLTP
name: name_example
time_created: '2013-10-20T19:20:30+01:00'
time_updated: '2013-10-20T19:20:30+01:00'
type: complex