oracle.oci.oci_dns_steering_policy_attachment_facts – Fetches details about one or multiple SteeringPolicyAttachment resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple SteeringPolicyAttachment resources in Oracle Cloud Infrastructure

  • Lists the steering policy attachments in the specified compartment.

  • If steering_policy_attachment_id is specified, the details of a single SteeringPolicyAttachment will be returned.

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
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 to list multiple steering_policy_attachments.
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.
display_name
string
The displayName of a resource.

aliases: name
domain
string
Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
domain_contains
string
Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
if_modified_since
string
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.
lifecycle_state
string
    Choices:
  • CREATING
  • ACTIVE
  • DELETING
The state of a resource.
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.
scope
string
    Choices:
  • GLOBAL
  • PRIVATE
Specifies to operate only on resources that have a matching DNS scope.
sort_by
string
    Choices:
  • displayName
  • timeCreated
  • domainName
The field by which to sort steering policy attachments. If unspecified, defaults to `timeCreated`.
sort_order
string
    Choices:
  • ASC
  • DESC
The order to sort the resources.
steering_policy_attachment_id
string
The OCID of the target steering policy attachment.
Required to get a specific steering_policy_attachment.

aliases: id
steering_policy_id
string
Search by steering policy OCID. Will match any resource whose steering policy ID matches the provided value.
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
time_created_greater_than_or_equal_to
string
An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.
time_created_less_than
string
An RFC 3339 timestamp that states all returned resources were created before the indicated time.
zone_id
string
Search by zone OCID. Will match any resource whose zone ID matches the provided value.

Examples

- name: Get a specific steering_policy_attachment
  oci_dns_steering_policy_attachment_facts:
    # required
    steering_policy_attachment_id: "ocid1.steeringpolicyattachment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    if_modified_since: if_modified_since_example
    scope: GLOBAL

- name: List steering_policy_attachments
  oci_dns_steering_policy_attachment_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    steering_policy_id: "ocid1.steeringpolicy.oc1..xxxxxxEXAMPLExxxxxx"
    zone_id: "ocid1.zone.oc1..xxxxxxEXAMPLExxxxxx"
    domain: domain_example
    domain_contains: domain_contains_example
    time_created_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
    time_created_less_than: 2013-10-20T19:20:30+01:00
    lifecycle_state: CREATING
    sort_by: displayName
    sort_order: ASC
    scope: GLOBAL

Return Values

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

Key Returned Description
steering_policy_attachments
complex
on success
List of SteeringPolicyAttachment resources

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'}]
 
_self
string
on success
The canonical absolute URL of the resource.

Sample:
_self_example
 
compartment_id
string
on success
The OCID of the compartment containing the steering policy attachment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
display_name
string
on success
A user-friendly name for the steering policy attachment. Does not have to be unique and can be changed. Avoid entering confidential information.

Sample:
display_name_example
 
domain_name
string
on success
The attached domain within the attached zone.

Sample:
domain_name_example
 
id
string
on success
The OCID of the resource.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the resource.

Sample:
CREATING
 
rtypes
list / elements=string
on success
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.

 
steering_policy_id
string
on success
The OCID of the attached steering policy.

Sample:
ocid1.steeringpolicy.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The date and time the resource was created, expressed in RFC 3339 timestamp format.
**Example:** `2016-07-22T17:23:59:60Z`

Sample:
2013-10-20T19:20:30+01:00
 
zone_id
string
on success
The OCID of the attached zone.

Sample:
ocid1.zone.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)