oracle.oci.oci_golden_gate_database_registration – Manage a DatabaseRegistration resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a DatabaseRegistration resource in Oracle Cloud Infrastructure

  • For state=present, note: Deprecated. Use the new resource model APIs instead. Creates a new DatabaseRegistration.

  • This resource has the following action operations in the oracle.oci.oci_golden_gate_database_registration_actions module: change_compartment.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
alias_name
string
Credential store alias.
Required for create using state=present.
This parameter is updatable.
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.
compartment_id
string
The OCID of the compartment being referenced.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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.
connection_string
string
Connect descriptor or Easy Connect Naming method that Oracle GoldenGate uses to connect to a database.
This parameter is updatable.
database_id
string
The OCID of the database being referenced.
database_registration_id
string
A unique DatabaseRegistration identifier.
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
defined_tags
dictionary
Tags defined for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
description
string
Metadata about this specific object.
This parameter is updatable.
display_name
string
An object's Display Name.
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
    Choices:
  • no ←
  • yes
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.
fqdn
string
A three-label Fully Qualified Domain Name (FQDN) for a resource.
Required for create using state=present.
This parameter is updatable.
freeform_tags
dictionary
A 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.
ip_address
string
The private IP address in the customer's VCN of the customer's endpoint, typically a database.
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.
key_id
string
The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
password
string
The password Oracle GoldenGate uses to connect the associated RDBMS. It must conform to the specific security requirements implemented by the database including length, case sensitivity, and so on.
Required for create using state=present.
This parameter is updatable.
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.
secret_compartment_id
string
The OCID of the compartment where the the GGS Secret will be created. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Compartment in which to create a Secret.
session_mode
string
    Choices:
  • DIRECT
  • REDIRECT
The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
This parameter is updatable.
state
string
    Choices:
  • present ←
  • absent
The state of the DatabaseRegistration.
Use state=present to create or update a DatabaseRegistration.
Use state=absent to delete a DatabaseRegistration.
subnet_id
string
The OCID of the subnet being referenced.
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
username
string
The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
Required for create using state=present.
This parameter is updatable.
vault_id
string
The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
wait
boolean
    Choices:
  • no
  • yes ←
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.
wallet
string
The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.
This parameter is updatable.

Examples

- name: Create database_registration
  oci_golden_gate_database_registration:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    fqdn: fqdn_example
    username: username_example
    password: example-password
    alias_name: alias_name_example

    # optional
    ip_address: ip_address_example
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
    database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    secret_compartment_id: "ocid1.secretcompartment.oc1..xxxxxxEXAMPLExxxxxx"
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    connection_string: connection_string_example
    session_mode: DIRECT
    wallet: wallet_example

- name: Update database_registration
  oci_golden_gate_database_registration:
    # required
    database_registration_id: "ocid1.databaseregistration.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    fqdn: fqdn_example
    username: username_example
    password: example-password
    connection_string: connection_string_example
    session_mode: DIRECT
    wallet: wallet_example
    alias_name: alias_name_example

- name: Update database_registration using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_golden_gate_database_registration:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    fqdn: fqdn_example
    username: username_example
    password: example-password
    connection_string: connection_string_example
    session_mode: DIRECT
    wallet: wallet_example
    alias_name: alias_name_example

- name: Delete database_registration
  oci_golden_gate_database_registration:
    # required
    database_registration_id: "ocid1.databaseregistration.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete database_registration using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_golden_gate_database_registration:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    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
database_registration
complex
on success
Details of the DatabaseRegistration resource acted upon by the current operation

Sample:
{'alias_name': 'alias_name_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connection_string': 'connection_string_example', 'database_id': 'ocid1.database.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'fqdn': 'fqdn_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ip_address': 'ip_address_example', 'key_id': 'ocid1.key.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'rce_private_ip': 'rce_private_ip_example', 'secret_compartment_id': 'ocid1.secretcompartment.oc1..xxxxxxEXAMPLExxxxxx', 'secret_id': 'ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx', 'session_mode': 'DIRECT', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'username': 'username_example', 'vault_id': 'ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx'}
 
alias_name
string
on success
Credential store alias.

Sample:
alias_name_example
 
compartment_id
string
on success
The OCID of the compartment being referenced.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
connection_string
string
on success
Connect descriptor or Easy Connect Naming method that Oracle GoldenGate uses to connect to a database.

Sample:
connection_string_example
 
database_id
string
on success
The OCID of the database being referenced.

Sample:
ocid1.database.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Tags defined 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
Metadata about this specific object.

Sample:
description_example
 
display_name
string
on success
An object's Display Name.

Sample:
display_name_example
 
fqdn
string
on success
A three-label Fully Qualified Domain Name (FQDN) for a resource.

Sample:
fqdn_example
 
freeform_tags
dictionary
on success
A 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
The OCID of the databaseRegistration being referenced.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
ip_address
string
on success
The private IP address in the customer's VCN of the customer's endpoint, typically a database.

Sample:
ip_address_example
 
key_id
string
on success
The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.

Sample:
ocid1.key.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
Possible lifecycle states.

Sample:
CREATING
 
rce_private_ip
string
on success
A Private Endpoint IP Address created in the customer's subnet. A customer database can expect network traffic initiated by GGS from this IP address and send network traffic to this IP address, typically in response to requests from GGS (OGG). The customer may utilize this IP address in Security Lists or Network Security Groups (NSG) as needed.

Sample:
rce_private_ip_example
 
secret_compartment_id
string
on success
The OCID of the compartment where the the GGS Secret will be created. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Compartment in which to create a Secret.

Sample:
ocid1.secretcompartment.oc1..xxxxxxEXAMPLExxxxxx
 
secret_id
string
on success
The OCID of the customer GGS Secret being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Secret

Sample:
ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx
 
session_mode
string
on success
The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

Sample:
DIRECT
 
subnet_id
string
on success
The OCID of the subnet being referenced.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
system_tags
dictionary
on success
The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.
Example: `{orcl-cloud: {free-tier-retain: true}}`

 
time_created
string
on success
The time the resource was created. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the resource was last updated. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.

Sample:
2013-10-20T19:20:30+01:00
 
username
string
on success
The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.

Sample:
username_example
 
vault_id
string
on success
The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.

Sample:
ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)