oracle / oracle.oci / 4.32.0 / module / oci_dns_zone_facts Fetches details about one or multiple Zone resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_dns_zone_facts (4.32.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.32.0
collections: - name: oracle.oci version: 4.32.0
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 I(zone_name_or_id) is specified, the details of a single Zone will be returned.
- 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"
name: aliases: - zone_name description: - A case-sensitive filter for zone names. Will match any zone with a name that equals the provided value. type: str scope: choices: - GLOBAL - PRIVATE description: - Specifies to operate only on resources that have a matching DNS scope. type: str region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str sort_by: choices: - name - zoneType - timeCreated description: - The field by which to sort zones. type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str view_id: description: - The OCID of the view the resource is associated with. type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str zone_type: choices: - PRIMARY - SECONDARY description: - Search by zone type, `PRIMARY` or `SECONDARY`. Will match any zone whose type equals the provided value. type: str sort_order: choices: - ASC - DESC description: - The order to sort the resources. type: str cert_bundle: description: - 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. type: str tsig_key_id: description: - Search for zones that are associated with a TSIG key. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str name_contains: description: - Search by zone name. Will match any zone whose name (case-insensitive) contains the provided value. type: str compartment_id: description: - The OCID of the compartment the zone belongs to. - This parameter is deprecated and should be omitted. - Required to list multiple zones. type: str lifecycle_state: choices: - ACTIVE - CREATING - DELETED - DELETING - FAILED - UPDATING description: - The state of a resource. type: str zone_name_or_id: aliases: - zone_id - id description: - The name or OCID of the target zone. - Required to get a specific zone. type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str if_modified_since: description: - 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. type: str config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str time_created_less_than: description: - An L(RFC 3339,https://www.ietf.org/rfc/rfc3339.txt) timestamp that states all returned resources were created before the indicated time. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str time_created_greater_than_or_equal_to: description: - An L(RFC 3339,https://www.ietf.org/rfc/rfc3339.txt) timestamp that states all returned resources were created on or after the indicated time. type: str realm_specific_endpoint_template_enabled: description: - 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. type: bool
zones: contains: compartment_id: description: - The OCID of the compartment containing the zone. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - '**Example:** `{"Operations": {"CostCenter": "42"}}`' returned: on success sample: Operations: CostCenter: US type: dict external_downstreams: contains: address: description: - The server's IP address (IPv4 or IPv6). returned: on success sample: address_example type: str port: description: - The server's port. Port value must be a value of 53, otherwise omit the port value. returned: on success sample: 56 type: int tsig_key_id: description: - 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. returned: on success sample: ocid1.tsigkey.oc1..xxxxxxEXAMPLExxxxxx type: str description: - External secondary servers for the zone. This field is currently not supported when `zoneType` is `SECONDARY` or `scope` is `PRIVATE`. - Returned for get operation returned: on success type: complex external_masters: contains: address: description: - The server's IP address (IPv4 or IPv6). returned: on success sample: address_example type: str port: description: - The server's port. Port value must be a value of 53, otherwise omit the port value. returned: on success sample: 56 type: int tsig_key_id: description: - The OCID of the TSIG key. returned: on success sample: ocid1.tsigkey.oc1..xxxxxxEXAMPLExxxxxx type: str description: - External master servers for the zone. `externalMasters` becomes a required parameter when the `zoneType` value is `SECONDARY`. - Returned for get operation returned: on success type: complex freeform_tags: description: - 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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - '**Example:** `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict id: description: - The OCID of the zone. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str is_protected: description: - A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. returned: on success sample: true type: bool lifecycle_state: description: - The current state of the zone resource. returned: on success sample: ACTIVE type: str name: description: - The name of the zone. returned: on success sample: name_example type: str nameservers: contains: hostname: description: - The hostname of the nameserver. returned: on success sample: hostname_example type: str description: - The authoritative nameservers for the zone. - Returned for get operation returned: on success type: complex scope: description: - The scope of the zone. returned: on success sample: GLOBAL type: str self_uri: description: - The canonical absolute URL of the resource. returned: on success sample: _self_example type: str serial: description: - The current serial of the zone. As seen in the zone's SOA record. returned: on success sample: 56 type: int time_created: description: - 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`' returned: on success sample: '2013-10-20T19:20:30+01:00' type: str version: description: - Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived. returned: on success sample: version_example type: str view_id: description: - 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. returned: on success sample: ocid1.view.oc1..xxxxxxEXAMPLExxxxxx type: str zone_transfer_servers: contains: address: description: - The server's IP address (IPv4 or IPv6). returned: on success sample: address_example type: str is_transfer_destination: description: - A Boolean flag indicating whether or not the server is a zone data transfer destination. returned: on success sample: true type: bool is_transfer_source: description: - A Boolean flag indicating whether or not the server is a zone data transfer source. returned: on success sample: true type: bool port: description: - The server's port. returned: on success sample: 56 type: int description: - The OCI nameservers that transfer the zone data with external nameservers. - Returned for get operation returned: on success type: complex zone_type: description: - The type of the zone. Must be either `PRIMARY` or `SECONDARY`. `SECONDARY` is only supported for GLOBAL zones. returned: on success sample: PRIMARY type: str description: - List of Zone resources returned: on success 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 type: complex