oracle.oci.oci_database_tools_private_endpoint_facts – Fetches details about one or multiple DatabaseToolsPrivateEndpoint resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_tools_private_endpoint_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple DatabaseToolsPrivateEndpoint resources in Oracle Cloud Infrastructure
Returns a list of Database Tools private endpoints.
If database_tools_private_endpoint_id is specified, the details of a single DatabaseToolsPrivateEndpoint will be returned.
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 ID of the compartment in which to list resources.
Required to list multiple database_tools_private_endpoints.
|
|
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 . |
|
database_tools_private_endpoint_id
string
|
The OCID of a Database Tools private endpoint.
Required to get a specific database_tools_private_endpoint.
aliases: id |
|
display_name
string
|
A filter to return only resources that match the entire specified display name.
aliases: name |
|
endpoint_service_id
string
|
A filter to return only resources their `endpointServiceId` matches the specified `endpointServiceId`.
|
|
lifecycle_state
string
|
|
A filter to return only resources their `lifecycleState` matches the specified `lifecycleState`.
|
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. |
|
sort_by
string
|
|
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
|
sort_order
string
|
|
The sort order to use, either 'asc' or 'desc'.
|
subnet_id
string
|
A filter to return only resources their `subnetId` matches the specified `subnetId`.
|
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific database_tools_private_endpoint
oci_database_tools_private_endpoint_facts:
# required
database_tools_private_endpoint_id: "ocid1.databasetoolsprivateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
- name: List database_tools_private_endpoints
oci_database_tools_private_endpoint_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
sort_order: ASC
sort_by: timeCreated
endpoint_service_id: "ocid1.endpointservice.oc1..xxxxxxEXAMPLExxxxxx"
lifecycle_state: CREATING
display_name: display_name_example
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
database_tools_private_endpoints
complex
|
on success |
List of DatabaseToolsPrivateEndpoint resources
Sample:
[{'additional_fqdns': [], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'endpoint_fqdn': 'endpoint_fqdn_example', 'endpoint_service_id': 'ocid1.endpointservice.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'nsg_ids': [], 'private_endpoint_ip': 'private_endpoint_ip_example', 'private_endpoint_vnic_id': 'ocid1.privateendpointvnic.oc1..xxxxxxEXAMPLExxxxxx', 'reverse_connection_configuration': {'reverse_connections_source_ips': [{'source_ip': 'source_ip_example'}]}, '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', 'vcn_id': 'ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx'}]
|
|||
additional_fqdns
list
/ elements=string
|
on success |
A list of additional FQDNs that can be also be used for the private endpoint.
|
|||
compartment_id
string
|
on success |
The OCID of the compartment containing the Database Tools private endpoint.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||
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 of the Database Tools private endpoint.
Sample:
description_example
|
|||
display_name
string
|
on success |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
display_name_example
|
|||
endpoint_fqdn
string
|
on success |
Then FQDN to use for the private endpoint.
Sample:
endpoint_fqdn_example
|
|||
endpoint_service_id
string
|
on success |
The OCID of the Database Tools Endpoint Service.
Sample:
ocid1.endpointservice.oc1..xxxxxxEXAMPLExxxxxx
|
|||
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 |
The OCID of the Database Tools private endpoint.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
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 Database Tools private endpoint.
Sample:
CREATING
|
|||
nsg_ids
list
/ elements=string
|
on success |
The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
|
|||
private_endpoint_ip
string
|
on success |
The private IP address that represents the access point for the associated endpoint service.
Sample:
private_endpoint_ip_example
|
|||
private_endpoint_vnic_id
string
|
on success |
The OCID of the private endpoint's VNIC.
Sample:
ocid1.privateendpointvnic.oc1..xxxxxxEXAMPLExxxxxx
|
|||
reverse_connection_configuration
complex
|
on success |
|
|||
reverse_connections_source_ips
complex
|
on success |
A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN.
|
|||
source_ip
string
|
on success |
The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN.
Sample:
source_ip_example
|
|||
subnet_id
string
|
on success |
The OCID of the subnet that the private endpoint belongs to.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
|||
system_tags
dictionary
|
on success |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
|||
time_created
string
|
on success |
The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string
Sample:
2013-10-20T19:20:30+01:00
|
|||
time_updated
string
|
on success |
The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
Sample:
2013-10-20T19:20:30+01:00
|
|||
vcn_id
string
|
on success |
The OCID of the VCN that the private endpoint belongs to.
Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)