oracle / oracle.oci / 4.2.0 / module / oci_dns_resolver_facts Fetches details about one or multiple Resolver resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_dns_resolver_facts (4.2.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.2.0
collections: - name: oracle.oci version: 4.2.0
Fetches details about one or multiple Resolver resources in Oracle Cloud Infrastructure
Gets a list of all resolvers within a compartment.
The collection can be filtered by display name, id, or lifecycle state. It can be sorted on creation time or displayName both in ASC or DESC order. Note that when no lifecycleState query parameter is provided, the collection does not include resolvers in the DELETED lifecycleState to be consistent with other operations of the API.
If I(resolver_id) is specified, the details of a single Resolver will be returned.
- name: Get a specific resolver oci_dns_resolver_facts: # required resolver_id: "ocid1.resolver.oc1..xxxxxxEXAMPLExxxxxx" # optional if_modified_since: if_modified_since_example scope: GLOBAL
- name: List resolvers oci_dns_resolver_facts: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" # optional display_name: display_name_example sort_order: ASC sort_by: displayName lifecycle_state: ACTIVE scope: GLOBAL
scope: choices: - GLOBAL - PRIVATE description: - Specifies to operate only on resources that have a matching DNS scope. 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 description: - The field by which to sort resolvers. 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 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 resolver_id: aliases: - id description: - The OCID of the target resolver. - Required to get a specific resolver. 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 resolvers. type: str lifecycle_state: choices: - ACTIVE - CREATING - DELETED - DELETING - FAILED - UPDATING 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 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 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
resolvers: contains: _self: description: - The canonical absolute URL of the resource. returned: on success sample: _self_example type: str attached_vcn_id: description: - The OCID of the attached VCN. returned: on success sample: ocid1.attachedvcn.oc1..xxxxxxEXAMPLExxxxxx type: str attached_views: contains: view_id: description: - The OCID of the view. returned: on success sample: ocid1.view.oc1..xxxxxxEXAMPLExxxxxx type: str description: - The attached views. Views are evaluated in order. - Returned for get operation returned: on success type: complex compartment_id: description: - The OCID of the owning compartment. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str default_view_id: description: - The OCID of the default view. returned: on success sample: ocid1.defaultview.oc1..xxxxxxEXAMPLExxxxxx type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - '**Example:** `{"Operations": {"CostCenter": "42"}}`' returned: on success sample: Operations: CostCenter: US type: dict display_name: description: - The display name of the resolver. returned: on success sample: display_name_example type: str endpoints: 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 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: - Read-only array of endpoints for the resolver. - Returned for get operation returned: on success type: complex freeform_tags: description: - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - '**Example:** `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict id: description: - The OCID of the resolver. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str is_protected: description: - A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. returned: on success sample: true type: bool lifecycle_state: description: - The current state of the resource. returned: on success sample: ACTIVE type: str rules: contains: action: description: - The action determines the behavior of the rule. If a query matches a supplied condition, the action will apply. If there are no conditions on the rule, all queries are subject to the specified action. * `FORWARD` - Matching requests will be forwarded from the source interface to the destination address. returned: on success sample: FORWARD type: str client_address_conditions: description: - A list of CIDR blocks. The query must come from a client within one of the blocks in order for the rule action to apply. returned: on success sample: [] type: list destination_addresses: description: - IP addresses to which queries should be forwarded. Currently limited to a single address. returned: on success sample: [] type: list qname_cover_conditions: description: - A list of domain names. The query must be covered by one of the domains in order for the rule action to apply. returned: on success sample: [] type: list source_endpoint_name: description: - Case-insensitive name of an endpoint, that is a sub-resource of the resolver, to use as the forwarding interface. The endpoint must have isForwarding set to true. returned: on success sample: source_endpoint_name_example type: str description: - Rules for the resolver. Rules are evaluated in order. - Returned for get operation returned: on success type: complex 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: - List of Resolver resources returned: on success sample: - _self: _self_example attached_vcn_id: ocid1.attachedvcn.oc1..xxxxxxEXAMPLExxxxxx attached_views: - view_id: ocid1.view.oc1..xxxxxxEXAMPLExxxxxx compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx default_view_id: ocid1.defaultview.oc1..xxxxxxEXAMPLExxxxxx defined_tags: Operations: CostCenter: US display_name: display_name_example endpoints: - _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 subnet_id: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx time_created: '2013-10-20T19:20:30+01:00' time_updated: '2013-10-20T19:20:30+01:00' freeform_tags: Department: Finance id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx is_protected: true lifecycle_state: ACTIVE rules: - action: FORWARD client_address_conditions: [] destination_addresses: [] qname_cover_conditions: [] source_endpoint_name: source_endpoint_name_example time_created: '2013-10-20T19:20:30+01:00' time_updated: '2013-10-20T19:20:30+01:00' type: complex