oracle.oci.oci_dns_resolver – Manage a Resolver resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to update a Resolver resource in Oracle Cloud Infrastructure

  • This resource has the following action operations in the oracle.oci.oci_dns_resolver_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).
attached_views
list / elements=dictionary
The attached views. Views are evaluated in order.
This parameter is updatable.
view_id
string / required
The OCID of the view.
This parameter is updatable.
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
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 the resource belongs to.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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.
display_name
string
The display name of the resolver.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
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.
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.
resolver_id
string
The OCID of the target resolver.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
rules
list / elements=dictionary
Rules for the resolver. Rules are evaluated in order.
This parameter is updatable.
action
string / required
    Choices:
  • FORWARD
The action determines the behavior of the rule. If a query matches a supplied condition, the action will apply. If there are no conditions on the rule, all queries are subject to the specified action. * `FORWARD` - Matching requests will be forwarded from the source interface to the destination address.
This parameter is updatable.
client_address_conditions
list / elements=string
A list of CIDR blocks. The query must come from a client within one of the blocks in order for the rule action to apply.
This parameter is updatable.
destination_addresses
list / elements=string / required
IP addresses to which queries should be forwarded. Currently limited to a single address.
This parameter is updatable.
qname_cover_conditions
list / elements=string
A list of domain names. The query must be covered by one of the domains in order for the rule action to apply.
This parameter is updatable.
source_endpoint_name
string / required
Case-insensitive name of an endpoint, that is a sub-resource of the resolver, to use as the forwarding interface. The endpoint must have isForwarding set to true.
This parameter is updatable.
scope
string
    Choices:
  • GLOBAL
  • PRIVATE
Specifies to operate only on resources that have a matching DNS scope.
This parameter is updatable.
state
string
    Choices:
  • present ←
The state of the Resolver.
Use state=present to update an existing a Resolver.
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
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.

Examples

- name: Update resolver
  oci_dns_resolver:
    # required
    resolver_id: "ocid1.resolver.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    attached_views:
    - # required
      view_id: "ocid1.view.oc1..xxxxxxEXAMPLExxxxxx"
    rules:
    - # required
      action: FORWARD
      destination_addresses: [ "destination_addresses_example" ]
      source_endpoint_name: source_endpoint_name_example

      # optional
      client_address_conditions: [ "client_address_conditions_example" ]
      qname_cover_conditions: [ "qname_cover_conditions_example" ]
    if_unmodified_since: if_unmodified_since_example
    scope: GLOBAL

- name: Update resolver using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_dns_resolver:
    # required
    display_name: display_name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    attached_views:
    - # required
      view_id: "ocid1.view.oc1..xxxxxxEXAMPLExxxxxx"
    rules:
    - # required
      action: FORWARD
      destination_addresses: [ "destination_addresses_example" ]
      source_endpoint_name: source_endpoint_name_example

      # optional
      client_address_conditions: [ "client_address_conditions_example" ]
      qname_cover_conditions: [ "qname_cover_conditions_example" ]
    if_unmodified_since: if_unmodified_since_example
    scope: GLOBAL

Return Values

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

Key Returned Description
resolver
complex
on success
Details of the Resolver resource acted upon by the current operation

Sample:
{'_self': '_self_example', 'attached_vcn_id': 'ocid1.attachedvcn.oc1..xxxxxxEXAMPLExxxxxx', 'attached_views': [{'view_id': 'ocid1.view.oc1..xxxxxxEXAMPLExxxxxx'}], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'default_view_id': 'ocid1.defaultview.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'endpoints': [{'_self': '_self_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'endpoint_type': 'VNIC', 'forwarding_address': 'forwarding_address_example', 'is_forwarding': True, 'is_listening': True, 'lifecycle_state': 'ACTIVE', 'listening_address': 'listening_address_example', 'name': 'name_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}], 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_protected': True, 'lifecycle_state': 'ACTIVE', 'rules': [{'action': 'FORWARD', 'client_address_conditions': [], 'destination_addresses': [], 'qname_cover_conditions': [], 'source_endpoint_name': 'source_endpoint_name_example'}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
_self
string
on success
The canonical absolute URL of the resource.

Sample:
_self_example
 
attached_vcn_id
string
on success
The OCID of the attached VCN.

Sample:
ocid1.attachedvcn.oc1..xxxxxxEXAMPLExxxxxx
 
attached_views
complex
on success
The attached views. Views are evaluated in order.

   
view_id
string
on success
The OCID of the view.

Sample:
ocid1.view.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
The OCID of the owning compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
default_view_id
string
on success
The OCID of the default view.

Sample:
ocid1.defaultview.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'}}
 
display_name
string
on success
The display name of the resolver.

Sample:
display_name_example
 
endpoints
complex
on success
Read-only array of endpoints for the resolver.

   
_self
string
on success
The canonical absolute URL of the resource.

Sample:
_self_example
   
compartment_id
string
on success
The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver's compartment is changed.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
   
endpoint_type
string
on success
The type of resolver endpoint. VNIC is currently the only supported type.

Sample:
VNIC
   
forwarding_address
string
on success
An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true.

Sample:
forwarding_address_example
   
is_forwarding
boolean
on success
A Boolean flag indicating whether or not the resolver endpoint is for forwarding.

Sample:
True
   
is_listening
boolean
on success
A Boolean flag indicating whether or not the resolver endpoint is for listening.

Sample:
True
   
lifecycle_state
string
on success
The current state of the resource.

Sample:
ACTIVE
   
listening_address
string
on success
An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true.

Sample:
listening_address_example
   
name
string
on success
The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver.

Sample:
name_example
   
subnet_id
string
on success
The OCID of a subnet. Must be part of the VCN that the resolver is attached to.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
   
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
   
time_updated
string
on success
The date and time the resource was last updated 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
 
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 resolver.

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 resource.

Sample:
ACTIVE
 
rules
complex
on success
Rules for the resolver. Rules are evaluated in order.

   
action
string
on success
The action determines the behavior of the rule. If a query matches a supplied condition, the action will apply. If there are no conditions on the rule, all queries are subject to the specified action. * `FORWARD` - Matching requests will be forwarded from the source interface to the destination address.

Sample:
FORWARD
   
client_address_conditions
list / elements=string
on success
A list of CIDR blocks. The query must come from a client within one of the blocks in order for the rule action to apply.

   
destination_addresses
list / elements=string
on success
IP addresses to which queries should be forwarded. Currently limited to a single address.

   
qname_cover_conditions
list / elements=string
on success
A list of domain names. The query must be covered by one of the domains in order for the rule action to apply.

   
source_endpoint_name
string
on success
Case-insensitive name of an endpoint, that is a sub-resource of the resolver, to use as the forwarding interface. The endpoint must have isForwarding set to true.

Sample:
source_endpoint_name_example
 
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
 
time_updated
string
on success
The date and time the resource was last updated 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


Authors

  • Oracle (@oracle)