oracle.oci.oci_dns_resolver_endpoint – Manage a ResolverEndpoint resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a ResolverEndpoint resource in Oracle Cloud Infrastructure

  • For state=present, creates a new resolver endpoint in the same compartment as the resolver.

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).
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
  • security_token
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.
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.
endpoint_type
string
    Choices:
  • VNIC ←
The type of resolver endpoint. VNIC is currently the only supported type.
This parameter is updatable.
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.
forwarding_address
string
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.
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.
is_forwarding
boolean
    Choices:
  • no
  • yes
A Boolean flag indicating whether or not the resolver endpoint is for forwarding.
Required for create using state=present.
is_listening
boolean
    Choices:
  • no
  • yes
A Boolean flag indicating whether or not the resolver endpoint is for listening.
Required for create using state=present.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
listening_address
string
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.
name
string / required
The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver.
nsg_ids
list / elements=string
An array of network security group OCIDs for the resolver endpoint. These must be part of the VCN that the resolver endpoint is a part of.
This parameter is updatable.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
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 / required
The OCID of the target resolver.
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 ←
  • absent
The state of the ResolverEndpoint.
Use state=present to create or update a ResolverEndpoint.
Use state=absent to delete a ResolverEndpoint.
subnet_id
string
The OCID of a subnet. Must be part of the VCN that the resolver is attached to.
Required for create using state=present.
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: Create resolver_endpoint with endpoint_type = VNIC
  oci_dns_resolver_endpoint:
    # required
    is_forwarding: true
    is_listening: true
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example

    # optional
    forwarding_address: forwarding_address_example
    listening_address: listening_address_example
    endpoint_type: VNIC
    nsg_ids: [ "nsg_ids_example" ]

- name: Update resolver_endpoint with endpoint_type = VNIC
  oci_dns_resolver_endpoint:
    # required
    name: name_example

    # optional
    endpoint_type: VNIC
    nsg_ids: [ "nsg_ids_example" ]

- name: Delete resolver_endpoint
  oci_dns_resolver_endpoint:
    # required
    resolver_id: "ocid1.resolver.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    state: absent

    # optional
    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_endpoint
complex
on success
Details of the ResolverEndpoint resource acted upon by the current operation

Sample:
{'_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', 'nsg_ids': [], 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', '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
 
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
 
nsg_ids
list / elements=string
on success
An array of network security group OCIDs for the resolver endpoint. These must be part of the VCN that the resolver endpoint is a part of.
 
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


Authors

  • Oracle (@oracle)