oracle.oci.oci_dns_zone_facts – Fetches details about one or multiple Zone resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.5.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_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Gets a list of all zones in the specified compartment.

  • The collection can be filtered by name, time created, scope, associated view, and zone type. Filtering by view is only supported for private zones.

  • If zone_name_or_id is specified, the details of a single Zone 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
  • security_token
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.
Required to list multiple zones.
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
A case-sensitive filter for zone names. Will match any zone with a name that equals the provided value.

aliases: zone_name
name_contains
string
Search by zone name. Will match any zone whose name (case-insensitive) contains the provided value.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
scope
string
    Choices:
  • GLOBAL
  • PRIVATE
Specifies to operate only on resources that have a matching DNS scope.
sort_by
string
    Choices:
  • name
  • zoneType
  • timeCreated
The field by which to sort zones.
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
time_created_greater_than_or_equal_to
string
An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.
time_created_less_than
string
An RFC 3339 timestamp that states all returned resources were created before the indicated time.
tsig_key_id
string
Search for zones that are associated with a TSIG key.
view_id
string
The OCID of the view the resource is associated with.
zone_name_or_id
string
The name or OCID of the target zone.
Required to get a specific zone.

aliases: zone_id, id
zone_type
string
    Choices:
  • PRIMARY
  • SECONDARY
Search by zone type, `PRIMARY` or `SECONDARY`. Will match any zone whose type equals the provided value.

Examples

- name: Get a specific zone
  oci_dns_zone_facts:
    # required
    zone_name_or_id: "ocid1.zonenameor.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    if_modified_since: if_modified_since_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    scope: GLOBAL
    view_id: "ocid1.view.oc1..xxxxxxEXAMPLExxxxxx"

- name: List zones
  oci_dns_zone_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: name_example
    name_contains: name_contains_example
    zone_type: PRIMARY
    time_created_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
    time_created_less_than: 2013-10-20T19:20:30+01:00
    lifecycle_state: ACTIVE
    sort_by: name
    sort_order: ASC
    scope: GLOBAL
    view_id: "ocid1.view.oc1..xxxxxxEXAMPLExxxxxx"
    tsig_key_id: "ocid1.tsigkey.oc1..xxxxxxEXAMPLExxxxxx"

Return Values

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

Key Returned Description
zones
complex
on success
List of Zone resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'external_downstreams': [{'address': 'address_example', 'port': 56, 'tsig_key_id': 'ocid1.tsigkey.oc1..xxxxxxEXAMPLExxxxxx'}], 'external_masters': [{'address': 'address_example', 'port': 56, 'tsig_key_id': 'ocid1.tsigkey.oc1..xxxxxxEXAMPLExxxxxx'}], 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_protected': True, 'lifecycle_state': 'ACTIVE', 'name': 'name_example', 'nameservers': [{'hostname': 'hostname_example'}], 'scope': 'GLOBAL', 'self_uri': '_self_example', 'serial': 56, 'time_created': '2013-10-20T19:20:30+01:00', 'version': 'version_example', 'view_id': 'ocid1.view.oc1..xxxxxxEXAMPLExxxxxx', 'zone_transfer_servers': [{'address': 'address_example', 'is_transfer_destination': True, 'is_transfer_source': True, 'port': 56}], 'zone_type': 'PRIMARY'}]
 
compartment_id
string
on success
The OCID of the compartment containing the zone.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
**Example:** `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
external_downstreams
complex
on success
External secondary servers for the zone. This field is currently not supported when `zoneType` is `SECONDARY` or `scope` is `PRIVATE`.
Returned for get operation
   
address
string
on success
The server's IP address (IPv4 or IPv6).

Sample:
address_example
   
port
integer
on success
The server's port. Port value must be a value of 53, otherwise omit the port value.

Sample:
56
   
tsig_key_id
string
on success
The OCID of the TSIG key. A TSIG key is used to secure DNS messages (in this case, zone transfers) between two systems that both have the (shared) secret.

Sample:
ocid1.tsigkey.oc1..xxxxxxEXAMPLExxxxxx
 
external_masters
complex
on success
External master servers for the zone. `externalMasters` becomes a required parameter when the `zoneType` value is `SECONDARY`.
Returned for get operation
   
address
string
on success
The server's IP address (IPv4 or IPv6).

Sample:
address_example
   
port
integer
on success
The server's port. Port value must be a value of 53, otherwise omit the port value.

Sample:
56
   
tsig_key_id
string
on success
The OCID of the TSIG key.

Sample:
ocid1.tsigkey.oc1..xxxxxxEXAMPLExxxxxx
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
**Example:** `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the zone.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_protected
boolean
on success
A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.

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

Sample:
ACTIVE
 
name
string
on success
The name of the zone.

Sample:
name_example
 
nameservers
complex
on success
The authoritative nameservers for the zone.
Returned for get operation
   
hostname
string
on success
The hostname of the nameserver.

Sample:
hostname_example
 
scope
string
on success
The scope of the zone.

Sample:
GLOBAL
 
self_uri
string
on success
The canonical absolute URL of the resource.

Sample:
_self_example
 
serial
integer
on success
The current serial of the zone. As seen in the zone's SOA record.

Sample:
56
 
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
 
version
string
on success
Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.

Sample:
version_example
 
view_id
string
on success
The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.

Sample:
ocid1.view.oc1..xxxxxxEXAMPLExxxxxx
 
zone_transfer_servers
complex
on success
The OCI nameservers that transfer the zone data with external nameservers.
Returned for get operation
   
address
string
on success
The server's IP address (IPv4 or IPv6).

Sample:
address_example
   
is_transfer_destination
boolean
on success
A Boolean flag indicating whether or not the server is a zone data transfer destination.

Sample:
True
   
is_transfer_source
boolean
on success
A Boolean flag indicating whether or not the server is a zone data transfer source.

Sample:
True
   
port
integer
on success
The server's port.

Sample:
56
 
zone_type
string
on success
The type of the zone. Must be either `PRIMARY` or `SECONDARY`. `SECONDARY` is only supported for GLOBAL zones.

Sample:
PRIMARY


Authors

  • Oracle (@oracle)