oracle / oracle.oci / 3.5.0 / module / oci_dns_steering_policy_attachment_facts Fetches details about one or multiple SteeringPolicyAttachment resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_dns_steering_policy_attachment_facts (3.5.0) — module
Install with ansible-galaxy collection install oracle.oci:==3.5.0
collections: - name: oracle.oci version: 3.5.0
Fetches details about one or multiple SteeringPolicyAttachment resources in Oracle Cloud Infrastructure
Lists the steering policy attachments in the specified compartment.
If I(steering_policy_attachment_id) is specified, the details of a single SteeringPolicyAttachment will be returned.
- 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
scope: choices: - GLOBAL - PRIVATE description: - Specifies to operate only on resources that have a matching DNS scope. type: str domain: description: - Search by domain. Will match any record whose domain (case-insensitive) equals the provided value. type: str 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 sort_by: choices: - displayName - timeCreated - domainName description: - The field by which to sort steering policy attachments. If unspecified, defaults to `timeCreated`. 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: - Search by zone OCID. Will match any resource whose zone ID matches the provided value. 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 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 sort_order: choices: - ASC - DESC description: - The order to sort the resources. 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 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: - The displayName of a resource. type: str compartment_id: description: - The OCID of the compartment the resource belongs to. - Required to list multiple steering_policy_attachments. type: str domain_contains: description: - Search by domain. Will match any record whose domain (case-insensitive) contains the provided value. type: str lifecycle_state: choices: - CREATING - ACTIVE - DELETING description: - The state of a resource. 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 if_modified_since: description: - 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. type: str steering_policy_id: description: - Search by steering policy OCID. Will match any resource whose steering policy ID matches the provided value. 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 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 time_created_less_than: description: - An L(RFC 3339,https://www.ietf.org/rfc/rfc3339.txt) timestamp that states all returned resources were created before the indicated time. 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 to get a specific steering_policy_attachment. type: str time_created_greater_than_or_equal_to: description: - An L(RFC 3339,https://www.ietf.org/rfc/rfc3339.txt) timestamp that states all returned resources were created on or after the indicated time. type: str
steering_policy_attachments: 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: - List of SteeringPolicyAttachment resources 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