oracle.oci.oci_database_db_server_facts – Fetches details about one or multiple DbServer resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists the Exadata DB servers in the ExadataInfrastructureId and specified compartment.

  • If db_server_id is specified, the details of a single DbServer 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 compartment OCID.
Required to list multiple db_servers.
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.
db_server_id
string
The DB server OCID.
Required to get a specific db_server.

aliases: id
display_name
string
A filter to return only resources that match the entire display name given. The match is not case sensitive.

aliases: name
exadata_infrastructure_id
string / required
The OCID of the ExadataInfrastructure.
lifecycle_state
string
    Choices:
  • CREATING
  • AVAILABLE
  • UNAVAILABLE
  • DELETING
  • DELETED
  • MAINTENANCE_IN_PROGRESS
A filter to return only resources that match the given lifecycle state exactly.
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.
sort_by
string
    Choices:
  • TIMECREATED
Sort by TIMECREATED. Default order for TIMECREATED is descending.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`DESC`).
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

Examples

- 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

Return Values

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

Key Returned Description
db_servers
complex
on success
List of DbServer resources

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, 'shape': 'shape_example', 'time_created': '2013-10-20T19:20:30+01:00', 'vm_cluster_ids': []}]
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
cpu_core_count
integer
on success
The number of CPU cores enabled on the Db server.

Sample:
56
 
db_node_ids
list / elements=string
on success
The OCID of the Db nodes associated with the Db server.

 
db_node_storage_size_in_gbs
integer
on success
The allocated local node storage in GBs on the Db server.

Sample:
56
 
db_server_patching_details
complex
on success

   
estimated_patch_duration
integer
on success
Estimated time, in minutes, to patch one database server.

Sample:
56
   
patching_status
string
on success
The status of the patching operation.

Sample:
SCHEDULED
   
time_patching_ended
string
on success
The time when the patching operation ended.

Sample:
2013-10-20T19:20:30+01:00
   
time_patching_started
string
on success
The time when the patching operation started.

Sample:
2013-10-20T19:20:30+01:00
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
The user-friendly name for the Db server. The name does not need to be unique.

Sample:
display_name_example
 
exadata_infrastructure_id
string
on success
The OCID of the Exadata infrastructure.

Sample:
ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
 
freeform_tags
dictionary
on success
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 Resource Tags.
Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the Exacc Db server.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
Additional information about the current lifecycle state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the Db server.

Sample:
CREATING
 
max_cpu_count
integer
on success
The total number of CPU cores available.

Sample:
56
 
max_db_node_storage_in_gbs
integer
on success
The total local node storage available in GBs.

Sample:
56
 
max_memory_in_gbs
integer
on success
The total memory available in GBs.

Sample:
56
 
memory_size_in_gbs
integer
on success
The allocated memory in GBs on the Db server.

Sample:
56
 
shape
string
on success
The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.

Sample:
shape_example
 
time_created
string
on success
The date and time that the Db Server was created.

Sample:
2013-10-20T19:20:30+01:00
 
vm_cluster_ids
list / elements=string
on success
The OCID of the VM Clusters associated with the Db server.



Authors

  • Oracle (@oracle)