oci_zone_records_facts - Retrieve facts of records in a specified zone in Oracle Cloud Infrastructure DNS Service¶
New in version 2.5.
Synopsis¶
- This module retrieves information of records in a specified zone. The results are sorted by domain in alphabetical order by default. For more information about records, please see L(Resource Record (RR) TYPEs, https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4).
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.6
- Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_user |
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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 |
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 |
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 |
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 |
|
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 |
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 |
Default: DEFAULT
|
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 |
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
|
|
domain_contains |
Search by domain. Will match any record whose domain (case-insensitive) contains 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 |
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 |
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
|
|
tenancy |
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.
|
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 list of zone records in the specified zone
oci_zone_records_facts:
zone_id: ocid1.dns-zone.oc1..xxxxxEXAMPLExxxxx
- name: Get a list of zone records in a zone for a specific domain
oci_zone_records_facts:
zone_id: ocid1.dns-zone.oc1..xxxxxEXAMPLExxxxx
domain: test_zone_1.com
- name: Gets a list of NS records in a specific zone
oci_zone_records_facts:
name: test_zone_1.com
rtype: NS
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
zone_records
complex
|
always |
A collection of DNS resource record objects.
Sample:
{'domain': 'test_zone_1.com', 'is_protected': True, 'rrset_version': '1', 'rtype': 'NS', 'ttl': 86400, 'record_hash': '9be3279d81b5e8430fd94c70cfa5f0a8', 'rdata': 'ns2.p68.dns.oraclecloud.net.'}
|
|
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
|
|
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
|
|
record_hash
string
|
always |
A unique identifier for the record within its zone.
Sample:
f439fa9a087ff74757485953fe0a8c7d
|
|
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
|
Status¶
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author¶
- Sivakumar Thyagarajan (@sivakumart)
Hint
If you notice any issues in this documentation you can edit this document to improve it.