oracle.oci.oci_dns_zone_records_facts – Fetches details about one or multiple ZoneRecords 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_dns_zone_records_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple ZoneRecords resources in Oracle Cloud Infrastructure
Gets all records in the specified zone.
The results are sorted by domain in alphabetical order by default. For more information about records, see L(Resource Record (RR) TYPEs,https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.
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 OCID of the compartment the zone belongs to.
This parameter is deprecated and should be omitted.
|
|
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
string
|
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
|
|
domain_contains
string
|
Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
|
|
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.
|
|
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. |
|
rtype
string
|
Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
|
|
scope
string
|
|
Specifies to operate only on resources that have a matching DNS scope.
|
sort_by
string
|
|
The field by which to sort records.
|
sort_order
string
|
|
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 |
|
view_id
string
|
The OCID of the view the resource is associated with.
|
|
zone_name_or_id
string
/ required
|
The name or OCID of the target zone.
aliases: zone_id, name, zone_name, id |
|
zone_version
string
|
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: List zone_records
oci_dns_zone_records_facts:
# required
zone_name_or_id: "ocid1.zonenameor.oc1..xxxxxxEXAMPLExxxxxx"
# optional
if_modified_since: if_modified_since_example
zone_version: zone_version_example
domain: domain_example
domain_contains: domain_contains_example
rtype: rtype_example
sort_by: domain
sort_order: ASC
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
scope: GLOBAL
view_id: "ocid1.view.oc1..xxxxxxEXAMPLExxxxxx"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
zone_records
complex
|
on success |
List of ZoneRecords resources
Sample:
[{'domain': 'domain_example', 'is_protected': True, 'rdata': 'rdata_example', 'record_hash': 'record_hash_example', 'rrset_version': 'rrset_version_example', 'rtype': 'rtype_example', 'ttl': 56}]
|
|
domain
string
|
on success |
The fully qualified domain name where the record can be located.
Sample:
domain_example
|
|
is_protected
boolean
|
on success |
A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
Sample:
True
|
|
rdata
string
|
on success |
The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types
Sample:
rdata_example
|
|
record_hash
string
|
on success |
A unique identifier for the record within its zone.
Sample:
record_hash_example
|
|
rrset_version
string
|
on success |
The latest version of the record's zone in which its RRSet differs from the preceding version.
Sample:
rrset_version_example
|
|
rtype
string
|
on success |
The type of DNS record, 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:
rtype_example
|
|
ttl
integer
|
on success |
The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended.
Sample:
56
|
Authors¶
Oracle (@oracle)