oracle / oracle.oci / 2.38.0 / module / oci_identity_domain_facts Fetches details about one or multiple Domain resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_identity_domain_facts (2.38.0) — module
Install with ansible-galaxy collection install oracle.oci:==2.38.0
collections: - name: oracle.oci version: 2.38.0
Fetches details about one or multiple Domain resources in Oracle Cloud Infrastructure
List all domains that are homed or have a replica region in current region. - If any internal error occurs, return 500 INTERNAL SERVER ERROR.
If I(domain_id) is specified, the details of a single Domain will be returned.
- name: Get a specific domain oci_identity_domain_facts: # required domain_id: "ocid1.domain.oc1..xxxxxxEXAMPLExxxxxx"
- name: List domains oci_identity_domain_facts: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" # optional display_name: display_name_example url: url_example home_region_url: home_region_url_example type: type_example license_type: license_type_example is_hidden_on_login: true name: name_example sort_by: TIMECREATED sort_order: ASC lifecycle_state: CREATING
url: description: - The region agnostic domain URL type: str name: description: - A filter to only return resources that match the given name exactly. type: str type: description: - The domain type 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: - TIMECREATED - NAME description: - The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive. - '**Note:** In general, some "List" operations (for example, `ListInstances`) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these "List" operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.' 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 domain_id: aliases: - id description: - The OCID of the domain - Required to get a specific domain. type: str sort_order: choices: - ASC - DESC description: - The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order is case sensitive. type: str display_name: description: - The mutable display name of the domain type: str license_type: description: - The domain license type type: str compartment_id: description: - The OCID of the compartment (remember that the tenancy is simply the root compartment). - Required to list multiple domains. type: str home_region_url: description: - The region specific domain URL type: str lifecycle_state: choices: - CREATING - ACTIVE - DELETING - INACTIVE description: - A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. 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 is_hidden_on_login: description: - Indicate if the domain is visible at login screen or not type: bool 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
domains: contains: compartment_id: description: - The OCID of the compartment containing the domain. returned: on success sample: ocid1.compartment.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 description: description: - The domain descripition returned: on success sample: description_example type: str display_name: description: - The mutable display name of the domain returned: on success sample: display_name_example type: str 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 home_region: description: - The home region for the domain. See L(Regions and Availability Domains,https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm) for the full list of supported region names. - 'Example: `us-phoenix-1`' returned: on success sample: us-phoenix-1 type: str home_region_url: description: - Region specific domain URL. returned: on success sample: home_region_url_example type: str id: description: - The OCID of the domain returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str is_hidden_on_login: description: - Indicates whether domain is hidden on login screen or not. returned: on success sample: true type: bool license_type: description: - The License type of Domain returned: on success sample: license_type_example type: str lifecycle_details: description: - Any additional details about the current state of the Domain. returned: on success sample: DEACTIVATING type: str lifecycle_state: description: - The current state. returned: on success sample: CREATING type: str replica_regions: contains: region: description: - A REPLICATION_ENABLED region, e.g. us-ashburn-1. See L(Regions and Availability Domains,https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm) for the full list of supported region names. returned: on success sample: us-phoenix-1 type: str state: description: - The IDCS replicated region state returned: on success sample: ENABLING_REPLICATION type: str url: description: - Region agnostic domain URL. returned: on success sample: url_example type: str description: - The regions domain is replication to. returned: on success type: complex time_created: description: - Date and time the domain was created, in the format defined by RFC3339. - 'Example: `2016-08-25T21:10:29.600Z`' returned: on success sample: '2013-10-20T19:20:30+01:00' type: str type: description: - The type of the domain. returned: on success sample: DEFAULT type: str url: description: - Region agnostic domain URL. returned: on success sample: url_example type: str description: - List of Domain resources returned: on success sample: - compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx defined_tags: Operations: CostCenter: US description: description_example display_name: display_name_example freeform_tags: Department: Finance home_region: us-phoenix-1 home_region_url: home_region_url_example id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx is_hidden_on_login: true license_type: license_type_example lifecycle_details: DEACTIVATING lifecycle_state: CREATING replica_regions: - region: us-phoenix-1 state: ENABLING_REPLICATION url: url_example time_created: '2013-10-20T19:20:30+01:00' type: DEFAULT url: url_example type: complex