oracle / oracle.oci / 3.5.0 / module / oci_database_tools_private_endpoint_facts Fetches details about one or multiple DatabaseToolsPrivateEndpoint resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_tools_private_endpoint_facts (3.5.0) — module
Install with ansible-galaxy collection install oracle.oci:==3.5.0
collections: - name: oracle.oci version: 3.5.0
Fetches details about one or multiple DatabaseToolsPrivateEndpoint resources in Oracle Cloud Infrastructure
Returns a list of Database Tools private endpoints.
If I(database_tools_private_endpoint_id) is specified, the details of a single DatabaseToolsPrivateEndpoint will be returned.
- 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
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 sort_by: choices: - timeCreated - displayName description: - 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. 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 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 subnet_id: description: - A filter to return only resources their `subnetId` matches the specified `subnetId`. type: str sort_order: choices: - ASC - DESC description: - The sort order to use, either 'asc' or 'desc'. 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 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 display_name: aliases: - name description: - A filter to return only resources that match the entire specified display name. type: str compartment_id: description: - The ID of the compartment in which to list resources. - Required to list multiple database_tools_private_endpoints. type: str lifecycle_state: choices: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED description: - A filter to return only resources their `lifecycleState` matches the specified `lifecycleState`. 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 endpoint_service_id: description: - A filter to return only resources their `endpointServiceId` matches the specified `endpointServiceId`. 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 database_tools_private_endpoint_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a Database Tools private endpoint. - Required to get a specific database_tools_private_endpoint. type: str
database_tools_private_endpoints: contains: additional_fqdns: description: - A list of additional FQDNs that can be also be used for the private endpoint. returned: on success sample: [] type: list compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools private endpoint. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str defined_tags: description: - 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`' returned: on success sample: Operations: CostCenter: US type: dict description: description: - A description of the Database Tools private endpoint. returned: on success sample: description_example type: str display_name: description: - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. returned: on success sample: display_name_example type: str endpoint_fqdn: description: - Then FQDN to use for the private endpoint. returned: on success sample: endpoint_fqdn_example type: str endpoint_service_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Database Tools Endpoint Service. returned: on success sample: ocid1.endpointservice.oc1..xxxxxxEXAMPLExxxxxx type: str freeform_tags: description: - 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`' returned: on success sample: Department: Finance type: dict id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Database Tools private endpoint. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str lifecycle_details: description: - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - The current state of the Database Tools private endpoint. returned: on success sample: CREATING type: str nsg_ids: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see L(NetworkSecurityGroup,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/NetworkSecurityGroup/). returned: on success sample: [] type: list private_endpoint_ip: description: - The private IP address that represents the access point for the associated endpoint service. returned: on success sample: private_endpoint_ip_example type: str private_endpoint_vnic_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the private endpoint's VNIC. returned: on success sample: ocid1.privateendpointvnic.oc1..xxxxxxEXAMPLExxxxxx type: str reverse_connection_configuration: contains: reverse_connections_source_ips: contains: source_ip: description: - 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. returned: on success sample: source_ip_example type: str description: - 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. returned: on success type: complex description: - '' returned: on success type: complex subnet_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the subnet that the private endpoint belongs to. returned: on success sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx type: str system_tags: description: - 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' returned: on success sample: {} type: dict time_created: description: - The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_updated: description: - The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string returned: on success sample: '2013-10-20T19:20:30+01:00' type: str vcn_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VCN that the private endpoint belongs to. returned: on success sample: ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx type: str description: - List of DatabaseToolsPrivateEndpoint resources returned: on success 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 type: complex