oracle / oracle.oci / 4.2.0 / module / oci_database_db_server_facts Fetches details about one or multiple DbServer resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_db_server_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 DbServer resources in Oracle Cloud Infrastructure
Lists the Exadata DB servers in the ExadataInfrastructureId and specified compartment.
If I(db_server_id) is specified, the details of a single DbServer will be returned.
- name: Get a specific db_server oci_database_db_server_facts: # required db_server_id: "ocid1.dbserver.oc1..xxxxxxEXAMPLExxxxxx" exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
- name: List db_servers oci_database_db_server_facts: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx" # optional sort_order: ASC sort_by: TIMECREATED lifecycle_state: CREATING display_name: display_name_example
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 description: - Sort by TIMECREATED. Default order for TIMECREATED is descending. 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 sort order to use, either ascending (`ASC`) or descending (`DESC`). 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 db_server_id: aliases: - id description: - The DB server L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). - Required to get a specific db_server. type: str display_name: aliases: - name description: - A filter to return only resources that match the entire display name given. The match is not case sensitive. type: str compartment_id: description: - The compartment L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). - Required to list multiple db_servers. type: str lifecycle_state: choices: - CREATING - AVAILABLE - UNAVAILABLE - DELETING - DELETED - MAINTENANCE_IN_PROGRESS description: - A filter to return only resources that match the given lifecycle state exactly. 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 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 exadata_infrastructure_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the ExadataInfrastructure. required: true type: str
db_servers: contains: compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str cpu_core_count: description: - The number of CPU cores enabled on the Db server. returned: on success sample: 56 type: int db_node_ids: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Db nodes associated with the Db server. returned: on success sample: [] type: list db_node_storage_size_in_gbs: description: - The allocated local node storage in GBs on the Db server. returned: on success sample: 56 type: int db_server_patching_details: contains: estimated_patch_duration: description: - Estimated time, in minutes, to patch one database server. returned: on success sample: 56 type: int patching_status: description: - The status of the patching operation. returned: on success sample: SCHEDULED type: str time_patching_ended: description: - The time when the patching operation ended. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_patching_started: description: - The time when the patching operation started. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - '' returned: on success type: complex 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). returned: on success sample: Operations: CostCenter: US type: dict display_name: description: - The user-friendly name for the Db server. The name does not need to be unique. returned: on success sample: display_name_example type: str exadata_infrastructure_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. returned: on success sample: ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx 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 id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Exacc Db server. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str lifecycle_details: description: - Additional information about the current lifecycle state. returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - The current state of the Db server. returned: on success sample: CREATING type: str max_cpu_count: description: - The total number of CPU cores available. returned: on success sample: 56 type: int max_db_node_storage_in_gbs: description: - The total local node storage available in GBs. returned: on success sample: 56 type: int max_memory_in_gbs: description: - The total memory available in GBs. returned: on success sample: 56 type: int memory_size_in_gbs: description: - The allocated memory in GBs on the Db server. returned: on success sample: 56 type: int time_created: description: - The date and time that the Db Server was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str vm_cluster_ids: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VM Clusters associated with the Db server. returned: on success sample: [] type: list description: - List of DbServer resources returned: on success sample: - compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx cpu_core_count: 56 db_node_ids: [] db_node_storage_size_in_gbs: 56 db_server_patching_details: estimated_patch_duration: 56 patching_status: SCHEDULED time_patching_ended: '2013-10-20T19:20:30+01:00' time_patching_started: '2013-10-20T19:20:30+01:00' defined_tags: Operations: CostCenter: US display_name: display_name_example exadata_infrastructure_id: ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx freeform_tags: Department: Finance id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx lifecycle_details: lifecycle_details_example lifecycle_state: CREATING max_cpu_count: 56 max_db_node_storage_in_gbs: 56 max_memory_in_gbs: 56 memory_size_in_gbs: 56 time_created: '2013-10-20T19:20:30+01:00' vm_cluster_ids: [] type: complex