oracle.oci.oci_dns_resolver_endpoint_facts – Fetches details about one or multiple ResolverEndpoint resources 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_dns_resolver_endpoint_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple ResolverEndpoint resources in Oracle Cloud Infrastructure

  • Gets a list of all endpoints within a resolver. The collection can be filtered by name or lifecycle state. It can be sorted on creation time or name both in ASC or DESC order. Note that when no lifecycleState query parameter is provided, the collection does not include resolver endpoints in the DELETED lifecycle state to be consistent with other operations of the API.

  • If resolver_endpoint_name is specified, the details of a single ResolverEndpoint will be returned.

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.
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.
if_modified_since
string
The `If-Modified-Since` header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
lifecycle_state
string
    Choices:
  • ACTIVE
  • CREATING
  • DELETED
  • DELETING
  • FAILED
  • UPDATING
The state of a resource.
name
string
The name of a resource.
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.
resolver_endpoint_name
string
The name of the target resolver endpoint.
Required to get a specific resolver_endpoint.
resolver_id
string / required
The OCID of the target resolver.
scope
string
    Choices:
  • GLOBAL
  • PRIVATE
Specifies to operate only on resources that have a matching DNS scope.
sort_by
string
    Choices:
  • name
  • timeCreated
The field by which to sort resolver endpoints.
sort_order
string
    Choices:
  • ASC
  • DESC
The order to sort the resources.
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

Examples

- name: Get a specific resolver_endpoint
  oci_dns_resolver_endpoint_facts:
    # required
    resolver_endpoint_name: resolver_endpoint_name_example
    resolver_id: "ocid1.resolver.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    if_modified_since: if_modified_since_example
    scope: GLOBAL

- name: List resolver_endpoints
  oci_dns_resolver_endpoint_facts:
    # required
    resolver_id: "ocid1.resolver.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: name_example
    sort_order: ASC
    sort_by: name
    lifecycle_state: ACTIVE
    scope: GLOBAL

Return Values

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

Key Returned Description
resolver_endpoints
complex
on success
List of ResolverEndpoint resources

Sample:
[{'_self': '_self_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'endpoint_type': 'VNIC', 'forwarding_address': 'forwarding_address_example', 'is_forwarding': True, 'is_listening': True, 'lifecycle_state': 'ACTIVE', 'listening_address': 'listening_address_example', 'name': 'name_example', 'nsg_ids': [], 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
_self
string
on success
The canonical absolute URL of the resource.

Sample:
_self_example
 
compartment_id
string
on success
The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver's compartment is changed.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
endpoint_type
string
on success
The type of resolver endpoint. VNIC is currently the only supported type.

Sample:
VNIC
 
forwarding_address
string
on success
An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true.

Sample:
forwarding_address_example
 
is_forwarding
boolean
on success
A Boolean flag indicating whether or not the resolver endpoint is for forwarding.

Sample:
True
 
is_listening
boolean
on success
A Boolean flag indicating whether or not the resolver endpoint is for listening.

Sample:
True
 
lifecycle_state
string
on success
The current state of the resource.

Sample:
ACTIVE
 
listening_address
string
on success
An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true.

Sample:
listening_address_example
 
name
string
on success
The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver.

Sample:
name_example
 
nsg_ids
list / elements=string
on success
An array of network security group OCIDs for the resolver endpoint. These must be part of the VCN that the resolver endpoint is a part of.
Returned for get operation

 
subnet_id
string
on success
The OCID of a subnet. Must be part of the VCN that the resolver is attached to.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.
**Example:** `2016-07-22T17:23:59:60Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.
**Example:** `2016-07-22T17:23:59:60Z`

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)