oci_zone – Manage a Zone in OCI DNS Service¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

This module allows the user to create, update and delete a Zone in OCI DNS Service.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.7
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_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 containing the zone. Required to create a zone.
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`.
external_masters -				External master servers for the Zone
	address - / required			The server's IP address (IPv4 or IPv6).
	port -			The server's port. Port value must be a value of 53, otherwise omit the port value.
	tsig -			A TSIG key.
		algorithm - / required		TSIG Algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, please see RFC 4635.
		name - / required		A domain name identifying the key for a given pair of hosts.
		secret - / required		A base64 string encoding the binary shared secret.
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.
key_by list				The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
name -				The name of the zone. Required to create a zone. Either name or zone_id must be specified to update or delete a zone. 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.
state -			Choices: present ← absent	Create or update a zone with state=present. 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
wait boolean			Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout integer			Default: 2000	Time, in seconds, to wait when wait=yes.
wait_until string				The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.
zone_id -				The OCID of the target zone. Either name or zone_id must be specified to update or delete a zone. aliases: id
zone_type -			Choices: PRIMARY SECONDARY	The type of the zone. Must be either PRIMARY or SECONDARY. Required to create a zone.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Create a zone
  oci_zone:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    name: test_zone_1.com
    zone_type: PRIMARY

- name: Update a zone using id
  oci_zone:
    id: ocid1.dns-zone.oc1..xxxxxEXAMPLExxxxx
    external_masters: [ { address: "12.123.123.123", tsig: { name: "test_zone_1.com", secret: "XXXX",
                            algorithm: "hmac-sha1" } } ]

- name: Update a zone using name
  oci_zone:
    name: test_zone1.com
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    external_masters: [ { address: "12.123.123.123", tsig: { name: "test_zone_1.com", secret: "XXXX",
                            algorithm: "hmac-sha1" } } ]
- name: Delete a zone
  oci_zone:
    id: ocid1.dns-zone.oc1..xxxxxEXAMPLExxxxx
    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 successful create, delete & update operations on zone	Information about the zone Sample: {'zone_type': 'PRIMARY', 'name': 'test_zone_1.com', 'id': 'ocid1.dns-zone.oc1..xxxxxEXAMPLExxxxx', 'external_masters': [], 'serial': 1, 'version': '1', 'lifecycle_state': 'ACTIVE', 'self_uri': 'https://dns.us-ashburn-1.oraclecloud.com/20180115/zones/test_zone_1.com', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'time_created': '2018-08-23T11:36:26+00:00'}
	compartment_id string	always	The OCID of the compartment containing the Zone. Sample: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
	external_masters list	always	External master servers for the zone. Sample: {'address': '12.123.123.123', 'tsig': {'algorithm': 'hmac-sha1', 'secret': 'XXXX', 'name': 'test_zone_1.com'}}
	id string	always	The OCID of the zone Sample: ocid1.dns-zone.oc1..xxxxxEXAMPLExxxxx
	lifecycle_state string	always	The current state of the zone resource. Sample: ACTIVE
	name string	always	The name of the zone. Sample: test_zone_1.com
	nameservers list	optional	The authoritative nameservers for the zone. Sample: [{'hostname': 'XXX'}]
	self_uri string	always	The canonical absolute URL of the resource. Sample: https://dns.us-ashburn-1.oraclecloud.com/20180115/zones/test_zone_1.com
	serial integer	always	The current serial of the zone. As seen in the zone's SOA record. Sample: 1
	time_created string	always	The date and time the resource was created in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339. Sample: 2018-08-23T11:36:26+00:00
	version string	always	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: 1
	zone_type string	always	The type of the zone. Must be either PRIMARY or SECONDARY. Sample: PRIMARY

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.

oci_zone – Manage a Zone in OCI DNS Service¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶