Try SpotterFetches details about one or multiple ZoneRecords resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about one or multiple ZoneRecords resources in Oracle Cloud Infrastructure
Gets all records in the specified zone.
The results are sorted by `domain` in alphabetical order by default. For more information about records, see L(Resource Record (RR) TYPEs,https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.
- name: List zone_records
oci_dns_zone_records_facts:
# required
zone_name_or_id: "ocid1.zonenameor.oc1..xxxxxxEXAMPLExxxxxx"
# optional
if_modified_since: if_modified_since_example
zone_version: zone_version_example
domain: domain_example
domain_contains: domain_contains_example
rtype: rtype_example
sort_by: domain
sort_order: ASC
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
scope: GLOBAL
view_id: "ocid1.view.oc1..xxxxxxEXAMPLExxxxxx"
rtype:
description:
- Search by record type. Will match any record whose L(type,https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4)
(case-insensitive) 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
domain:
description:
- Search by domain. Will match any record whose domain (case-insensitive) equals the
provided value.
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:
- domain
- rtype
- ttl
description:
- The field by which to sort records.
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
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
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
zone_version:
description:
- The version of the zone for which data is requested.
type: str
compartment_id:
description:
- The OCID of the compartment the zone belongs to.
- This parameter is deprecated and should be omitted.
type: str
domain_contains:
description:
- Search by domain. Will match any record whose domain (case-insensitive) contains
the provided value.
type: str
zone_name_or_id:
aliases:
- zone_id
- name
- zone_name
- id
description:
- The name or OCID of the target zone.
required: true
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
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
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
zone_records:
contains:
domain:
description:
- The fully qualified domain name where the record can be located.
returned: on success
sample: domain_example
type: str
is_protected:
description:
- A Boolean flag indicating whether or not parts of the record are unable to
be explicitly managed.
returned: on success
sample: true
type: bool
rdata:
description:
- The record's data, as whitespace-delimited tokens in type-specific presentation
format. All RDATA is normalized and the returned presentation of your RDATA
may differ from its initial input. For more information about RDATA, see L(Supported
DNS Resource Record Types,https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm)
returned: on success
sample: rdata_example
type: str
record_hash:
description:
- A unique identifier for the record within its zone.
returned: on success
sample: record_hash_example
type: str
rrset_version:
description:
- The latest version of the record's zone in which its RRSet differs from the
preceding version.
returned: on success
sample: rrset_version_example
type: str
rtype:
description:
- The type of DNS record, such as A or CNAME. For more information, see L(Resource
Record (RR) TYPEs,https://www.iana.org/assignments/dns- parameters/dns-parameters.xhtml#dns-parameters-4).
returned: on success
sample: rtype_example
type: str
ttl:
description:
- The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds
is not recommended.
returned: on success
sample: 56
type: int
description:
- List of ZoneRecords resources
returned: on success
sample:
- domain: domain_example
is_protected: true
rdata: rdata_example
record_hash: record_hash_example
rrset_version: rrset_version_example
rtype: rtype_example
ttl: 56
type: complex