Try SpotterManage a SteeringPolicyAttachment 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 SteeringPolicyAttachment resource in Oracle Cloud Infrastructure
For I(state=present), creates a new attachment between a steering policy and a domain, giving the policy permission to answer queries for the specified domain. A steering policy must be attached to a domain for the policy to answer DNS queries for that domain.
For the purposes of access control, the attachment is automatically placed into the same compartment as the domain's zone.
- name: Create steering_policy_attachment
oci_dns_steering_policy_attachment:
# required
steering_policy_id: "ocid1.steeringpolicy.oc1..xxxxxxEXAMPLExxxxxx"
zone_id: "ocid1.zone.oc1..xxxxxxEXAMPLExxxxxx"
domain_name: domain_name_example
# optional
display_name: display_name_example
scope: GLOBAL
- name: Update steering_policy_attachment
oci_dns_steering_policy_attachment:
# required
steering_policy_attachment_id: "ocid1.steeringpolicyattachment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
if_unmodified_since: if_unmodified_since_example
scope: GLOBAL
- name: Update steering_policy_attachment using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_dns_steering_policy_attachment:
# required
display_name: display_name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
if_unmodified_since: if_unmodified_since_example
scope: GLOBAL
- name: Delete steering_policy_attachment
oci_dns_steering_policy_attachment:
# required
steering_policy_attachment_id: "ocid1.steeringpolicyattachment.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
# optional
if_unmodified_since: if_unmodified_since_example
scope: GLOBAL
- name: Delete steering_policy_attachment using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_dns_steering_policy_attachment:
# required
display_name: display_name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
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 SteeringPolicyAttachment.
- Use I(state=present) to create or update a SteeringPolicyAttachment.
- Use I(state=absent) to delete a SteeringPolicyAttachment.
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
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
zone_id:
description:
- The OCID of the attached zone.
- Required for create using I(state=present).
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
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
domain_name:
description:
- The attached domain within the attached zone.
- Required for create using I(state=present).
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
display_name:
aliases:
- name
description:
- A user-friendly name for the steering policy attachment. Does not have to be unique
and can be changed. Avoid entering confidential information.
- Required for create, update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is set.
- This parameter is updatable when C(OCI_USE_NAME_AS_IDENTIFIER) is not set.
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
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
compartment_id:
description:
- The OCID of the compartment the resource belongs to.
- Required for create using I(state=present).
- Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
- Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
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
steering_policy_id:
description:
- The OCID of the attached steering policy.
- Required for create using I(state=present).
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
steering_policy_attachment_id:
aliases:
- id
description:
- The OCID of the target steering policy attachment.
- Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
- Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
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
steering_policy_attachment:
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 compartment containing the steering policy attachment.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
display_name:
description:
- A user-friendly name for the steering policy attachment. Does not have to
be unique and can be changed. Avoid entering confidential information.
returned: on success
sample: display_name_example
type: str
domain_name:
description:
- The attached domain within the attached zone.
returned: on success
sample: domain_name_example
type: str
id:
description:
- The OCID of the resource.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
lifecycle_state:
description:
- The current state of the resource.
returned: on success
sample: CREATING
type: str
rtypes:
description:
- The record types covered by the attachment at the domain. The set of record
types is determined by aggregating the record types from the answers defined
in the steering policy.
returned: on success
sample: []
type: list
steering_policy_id:
description:
- The OCID of the attached steering policy.
returned: on success
sample: ocid1.steeringpolicy.oc1..xxxxxxEXAMPLExxxxxx
type: str
time_created:
description:
- The date and time the resource was created, expressed in RFC 3339 timestamp
format.
- '**Example:** `2016-07-22T17:23:59:60Z`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
zone_id:
description:
- The OCID of the attached zone.
returned: on success
sample: ocid1.zone.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- Details of the SteeringPolicyAttachment resource acted upon by the current operation
returned: on success
sample:
_self: _self_example
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
display_name: display_name_example
domain_name: domain_name_example
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
lifecycle_state: CREATING
rtypes: []
steering_policy_id: ocid1.steeringpolicy.oc1..xxxxxxEXAMPLExxxxxx
time_created: '2013-10-20T19:20:30+01:00'
zone_id: ocid1.zone.oc1..xxxxxxEXAMPLExxxxxx
type: complex