oracle.oci.oci_database_management_db_management_private_endpoint – Manage a DbManagementPrivateEndpoint resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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.
compartment_id
string
The OCID of the compartment.
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.
db_management_private_endpoint_id
string
The OCID of the Database Management private endpoint.
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
description
string
The description of the private endpoint.
This parameter is updatable.
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.
is_cluster
boolean
    Choices:
  • no
  • yes
Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.
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.
name
string
The display name of the Database Management private endpoint.
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.
nsg_ids
list / elements=string
The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
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.
state
string
    Choices:
  • present ←
  • absent
The state of the DbManagementPrivateEndpoint.
Use state=present to create or update a DbManagementPrivateEndpoint.
Use state=absent to delete a DbManagementPrivateEndpoint.
subnet_id
string
The OCID of the subnet.
Required for create using state=present.
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
    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.

Examples

- name: Create db_management_private_endpoint
  oci_database_management_db_management_private_endpoint:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example

    # optional
    is_cluster: true
    description: description_example
    nsg_ids: [ "nsg_ids_example" ]

- name: Update db_management_private_endpoint
  oci_database_management_db_management_private_endpoint:
    # required
    db_management_private_endpoint_id: "ocid1.dbmanagementprivateendpoint.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: name_example
    description: description_example
    nsg_ids: [ "nsg_ids_example" ]

- name: Update db_management_private_endpoint using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_database_management_db_management_private_endpoint:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example

    # optional
    description: description_example
    nsg_ids: [ "nsg_ids_example" ]

- name: Delete db_management_private_endpoint
  oci_database_management_db_management_private_endpoint:
    # required
    db_management_private_endpoint_id: "ocid1.dbmanagementprivateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete db_management_private_endpoint using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_database_management_db_management_private_endpoint:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    state: absent

Return Values

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

Key Returned Description
db_management_private_endpoint
complex
on success
Details of the DbManagementPrivateEndpoint resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'description': 'description_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_cluster': True, 'lifecycle_state': 'CREATING', 'name': 'name_example', 'nsg_ids': [], 'private_ip': 'private_ip_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'vcn_id': 'ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx'}
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
description
string
on success
The description of the Database Management private endpoint.

Sample:
description_example
 
id
string
on success
The OCID of the Database Management private endpoint.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_cluster
boolean
on success
Specifies whether the Database Management private endpoint can be used for Oracle Databases in a cluster.

Sample:
True
 
lifecycle_state
string
on success
The current lifecycle state of the Database Management private endpoint.

Sample:
CREATING
 
name
string
on success
The display name of the Database Management private endpoint.

Sample:
name_example
 
nsg_ids
list / elements=string
on success
The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.

 
private_ip
string
on success
The IP addresses assigned to the Database Management private endpoint.

Sample:
private_ip_example
 
subnet_id
string
on success
The OCID of the subnet.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
vcn_id
string
on success
The OCID of the VCN.

Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)