oracle.oci.oci_dns_zone – Manage a Zone resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a Zone resource in Oracle Cloud Infrastructure

  • For state=present, creates a new zone in the specified compartment.

  • Private zones must have a zone type of PRIMARY. Creating a private zone at or under oraclevcn.com within the default protected view of a VCN-dedicated resolver is not permitted.

  • This resource has the following action operations in the oracle.oci.oci_dns_zone_actions module: change_compartment.

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 containing the zone.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable.
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
**Example:** `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
dynect_migration_details
dictionary
Applicable when migration_source is 'DYNECT'
customer_name
string / required
DynECT customer name the zone belongs to.
Required when migration_source is 'DYNECT'
http_redirect_replacements
dictionary
A map of fully-qualified domain names (FQDNs) to an array of `MigrationReplacement` objects.
Applicable when migration_source is 'DYNECT'
password
string / required
DynECT API password for the provided username.
Required when migration_source is 'DYNECT'
username
string / required
DynECT API username to perform the migration with.
Required when migration_source is 'DYNECT'
external_downstreams
list / elements=dictionary
External secondary servers for the zone. This field is currently not supported when `zoneType` is `SECONDARY` or `scope` is `PRIVATE`.
This parameter is updatable.
Applicable when migration_source is 'NONE'
address
string / required
The server's IP address (IPv4 or IPv6).
Required when migration_source is 'NONE'
port
integer
The server's port. Port value must be a value of 53, otherwise omit the port value.
Applicable when migration_source is 'NONE'
tsig_key_id
string
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.
Applicable when migration_source is 'NONE'
external_masters
list / elements=dictionary
External master servers for the zone. `externalMasters` becomes a required parameter when the `zoneType` value is `SECONDARY`.
This parameter is updatable.
Applicable when migration_source is 'NONE'
address
string / required
The server's IP address (IPv4 or IPv6).
Required when migration_source is 'NONE'
port
integer
The server's port. Port value must be a value of 53, otherwise omit the port value.
Applicable when migration_source is 'NONE'
tsig_key_id
string
The OCID of the TSIG key.
Applicable when migration_source is 'NONE'
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
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"}`
This parameter is updatable.
if_unmodified_since
string
The `If-Unmodified-Since` header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
This parameter is updatable.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
migration_source
string
    Choices:
  • NONE ←
  • DYNECT
Discriminator that is used to determine whether to create a new zone (NONE) or to migrate an existing DynECT zone (DYNECT).
name
string
The name of the zone.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.

aliases: zone_name
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
The scope of the zone.
This parameter is updatable.
Applicable when migration_source is 'NONE'
state
string
    Choices:
  • present ←
  • absent
The state of the Zone.
Use state=present to create or update a Zone.
Use state=absent to delete a 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
view_id
string
This value will be null for zones in the global DNS.
This parameter is updatable.
Applicable when migration_source is 'NONE'
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
zone_name_or_id
string
The name or OCID of the target zone.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: zone_id, id
zone_type
string
    Choices:
  • PRIMARY
  • SECONDARY
The type of the zone. Must be either `PRIMARY` or `SECONDARY`. `SECONDARY` is only supported for GLOBAL zones.
Applicable when migration_source is 'NONE'

Examples

- name: Create zone with migration_source = NONE
  oci_dns_zone:
    # required
    name: name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    zone_type: PRIMARY
    migration_source: NONE
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    external_masters:
    - # required
      address: address_example

      # optional
      port: 56
      tsig_key_id: "ocid1.tsigkey.oc1..xxxxxxEXAMPLExxxxxx"
    external_downstreams:
    - # required
      address: address_example

      # optional
      port: 56
      tsig_key_id: "ocid1.tsigkey.oc1..xxxxxxEXAMPLExxxxxx"
    scope: GLOBAL
    view_id: "ocid1.view.oc1..xxxxxxEXAMPLExxxxxx"

- name: Create zone with migration_source = DYNECT
  oci_dns_zone:
    # required
    migration_source: DYNECT
    name: name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    dynect_migration_details:
      # required
      customer_name: customer_name_example
      username: username_example
      password: example-password

      # optional
      http_redirect_replacements: null
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update zone
  oci_dns_zone:
    # required
    zone_name_or_id: "ocid1.zonenameor.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    external_masters:
    - # required
      address: address_example

      # optional
      port: 56
      tsig_key_id: "ocid1.tsigkey.oc1..xxxxxxEXAMPLExxxxxx"
    external_downstreams:
    - # required
      address: address_example

      # optional
      port: 56
      tsig_key_id: "ocid1.tsigkey.oc1..xxxxxxEXAMPLExxxxxx"
    if_unmodified_since: if_unmodified_since_example
    scope: GLOBAL
    view_id: "ocid1.view.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update zone using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_dns_zone:
    # required
    name: name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    external_masters:
    - # required
      address: address_example

      # optional
      port: 56
      tsig_key_id: "ocid1.tsigkey.oc1..xxxxxxEXAMPLExxxxxx"
    external_downstreams:
    - # required
      address: address_example

      # optional
      port: 56
      tsig_key_id: "ocid1.tsigkey.oc1..xxxxxxEXAMPLExxxxxx"
    if_unmodified_since: if_unmodified_since_example
    scope: GLOBAL
    view_id: "ocid1.view.oc1..xxxxxxEXAMPLExxxxxx"

- name: Delete zone
  oci_dns_zone:
    # required
    zone_name_or_id: "ocid1.zonenameor.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

    # optional
    if_unmodified_since: if_unmodified_since_example
    scope: GLOBAL
    view_id: "ocid1.view.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

- name: Delete zone using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_dns_zone:
    # required
    name: name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
zone
complex
on success
Details of the Zone resource acted upon by the current operation

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`.
   
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`.
   
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.
   
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.
   
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)