Try SpotterManage a ResolverEndpoint resource 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.0This module allows the user to create, update and delete a ResolverEndpoint resource in Oracle Cloud Infrastructure
For I(state=present), creates a new resolver endpoint in the same compartment as the resolver.
- 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
name:
description:
- The name of the resolver endpoint. Must be unique, case-insensitive, within the
resolver.
required: true
type: str
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
scope:
choices:
- GLOBAL
- PRIVATE
description:
- Specifies to operate only on resources that have a matching DNS scope.
- This parameter is updatable.
type: str
state:
choices:
- present
- absent
default: present
description:
- The state of the ResolverEndpoint.
- Use I(state=present) to create or update a ResolverEndpoint.
- Use I(state=absent) to delete a ResolverEndpoint.
required: false
type: str
key_by:
description: 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.
elements: str
type: list
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
nsg_ids:
description:
- 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.
elements: str
type: list
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
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
subnet_id:
description:
- The OCID of a subnet. Must be part of the VCN that the resolver is attached to.
- Required for create using I(state=present).
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
resolver_id:
description:
- The OCID of the target resolver.
required: true
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
force_create:
default: false
description: 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 I(key_by).
type: bool
is_listening:
description:
- A Boolean flag indicating whether or not the resolver endpoint is for listening.
- Required for create using I(state=present).
type: bool
wait_timeout:
description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most
of the services but some services might have a longer wait timeout.
type: int
endpoint_type:
choices:
- VNIC
default: VNIC
description:
- The type of resolver endpoint. VNIC is currently the only supported type.
- This parameter is updatable.
type: str
is_forwarding:
description:
- A Boolean flag indicating whether or not the resolver endpoint is for forwarding.
- Required for create using I(state=present).
type: bool
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
listening_address:
description:
- 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.
type: str
forwarding_address:
description:
- 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.
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
if_unmodified_since:
description:
- 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.
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
resolver_endpoint:
contains:
_self:
description:
- The canonical absolute URL of the resource.
returned: on success
sample: _self_example
type: str
compartment_id:
description:
- 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.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
endpoint_type:
description:
- The type of resolver endpoint. VNIC is currently the only supported type.
returned: on success
sample: VNIC
type: str
forwarding_address:
description:
- 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.
returned: on success
sample: forwarding_address_example
type: str
is_forwarding:
description:
- A Boolean flag indicating whether or not the resolver endpoint is for forwarding.
returned: on success
sample: true
type: bool
is_listening:
description:
- A Boolean flag indicating whether or not the resolver endpoint is for listening.
returned: on success
sample: true
type: bool
lifecycle_state:
description:
- The current state of the resource.
returned: on success
sample: ACTIVE
type: str
listening_address:
description:
- 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.
returned: on success
sample: listening_address_example
type: str
name:
description:
- The name of the resolver endpoint. Must be unique, case-insensitive, within
the resolver.
returned: on success
sample: name_example
type: str
nsg_ids:
description:
- 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.
returned: on success
sample: []
type: list
subnet_id:
description:
- The OCID of a subnet. Must be part of the VCN that the resolver is attached
to.
returned: on success
sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
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
time_updated:
description:
- 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`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- Details of the ResolverEndpoint resource acted upon by the current operation
returned: on success
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'
type: complex