Skip to content
This repository has been archived by the owner on May 1, 2021. It is now read-only.

Latest commit

 

History

History
519 lines (468 loc) · 32.9 KB

oci_zone_facts_module.rst

File metadata and controls

519 lines (468 loc) · 32.9 KB
Raw
source:cloud/oracle/oci_zone_facts.py
orphan:

oci_zone_facts -- Retrieve facts of zones in Oracle Cloud Infrastructure DNS Service

.. versionadded:: 2.5

Synopsis

  • This module retrieves information of the specified zone or all zones in the specified 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_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
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
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 to retrieve a specific zone's information using its OCID.
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.
lifecycle_state
-
The state of a resource. Allowed values are "ACTIVE", "CREATING", "DELETED", "DELETING", "FAILED"
name
-
A case-sensitive filter for zone names. Will match any zone with a name that equals the provided value.

aliases: zone_name
name_contains
-
Search by zone name. Will match any zone whose name (case-insensitive) contains the provided value.
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.
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
-
An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.
time_created_less_than
-
An RFC 3339 timestamp that states all returned resources were before the indicated time.
zone_id
-
OCID of the target zone.

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

Notes

Examples

- name: Get a list of zones in the specified compartment
  oci_zone_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx

- name: Get a zone with the specified name
  oci_zone_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    name: test_zone_1.com

- name: Get a list of primary zones in the specified compartment
  oci_zone_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    zone_type: "PRIMARY"

- name: Gets details of a specific zone using the OCID of the zone
  oci_zone_facts:
    zone_id: ocid1.dns-zone.oc1..xxxxxEXAMPLExxxxx

Return Values

Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

Key Returned Description
zones
complex
 always
List of Zone details

Sample:
[{'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', 'external_masters': [], 'version': '1', 'zone_type': 'PRIMARY', 'serial': 1, 'id': 'ocid1.dns-zone.oc1..xxxxxEXAMPLExxxxx', 'name': 'test_zone_1.com'}]
  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:
['...']
  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:
  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

Authors

  • Sivakumar Thyagarajan (@sivakumart)

Hint

If you notice any issues in this documentation you can edit this document to improve it.