oci_rrset_facts – Retrieve facts of a RRSet in a specified zone in Oracle Cloud Infrastructure DNS Service

New in version 2.5.

Synopsis

  • This module gets a list of all records in the specified RRSet. The results are sorted by recordHash by default.

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_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
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.
compartment_id
-
The OCID of the compartment the resource belongs to. Use zone_id or zone_name to retrieve a specific zone's information using its OCID.
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.
domain
- / required
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
name
-
A case-sensitive filter for zone names. Will match any zone with a name that equals the provided value.

aliases: zone_name
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.
rtype
- / required
The type of the target RRSet within the target zone.
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
zone_id
-
OCID of the target zone.

aliases: id
zone_version
-
The version of the zone for which data is requested.

Examples

- name: Get a list of all records in the specified RRSet
  oci_rrset_facts:
    zone_id: ocid1.dns-zone.oc1..xxxxxEXAMPLExxxxx
    domain: "test_zone_1.com"
    rtype: "TXT"

Return Values

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

Key Returned Description
rrset
complex
 always
A collection of DNS resource record objects.

Sample:
{'ttl': 86400, 'rrset_version': '1', 'rtype': 'NS', 'domain': 'test_zone_1.com', 'record_hash': '9be3279d81b5e8430fd94c70cfa5f0a8', 'rdata': 'ns2.p68.dns.oraclecloud.net.', 'is_protected': True}
  domain
string
 always
The fully qualified domain name where the record can be located.

Sample:
test_zone_1.com
  is_protected
boolean
 always
A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.

Sample:
True
  rdata
string
 always
The record's data, as whitespace-delimited tokens in type-specific presentation format.

Sample:
ns1.p68.dns.oraclecloud.net. hostmaster.test_zone_1.com. 1 3600 600 604800 1800
  record_hash
string
 always
A unique identifier for the record within its zone.

Sample:
f439fa9a087ff74757485953fe0a8c7d
  rrset_version
string
 always
The latest version of the record's zone in which its RRSet differs from the preceding version.

Sample:
1
  rtype
string
 always
The canonical name for the record's type, such as A or CNAME. For more information, see L(Resource Record (RR) TYPEs, https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4).

Sample:
NS
  ttl
string
 always
The Time To Live for the record, in seconds.

Sample:
86400


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Sivakumar Thyagarajan (@sivakumart)

Hint

If you notice any issues in this documentation you can edit this document to improve it.