oracle.oci.oci_database_management_external_exadata_storage_server_facts – Fetches details about one or multiple ExternalExadataStorageServer resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_management_external_exadata_storage_server_facts.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple ExternalExadataStorageServer resources in Oracle Cloud Infrastructure
Lists all the storage servers for the exadata infrastructure or storage grid.
If external_exadata_storage_server_id is specified, the details of a single ExternalExadataStorageServer will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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 OCID of the compartment.
Required to list multiple external_exadata_storage_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. |
|
|
display_name
string
|
The optional single value query filter parameter on the entity display name.
aliases: name |
|
|
external_exadata_infrastructure_id
string
|
The OCID of the Exadata infrastructure.
Required to list multiple external_exadata_storage_servers.
|
|
|
external_exadata_storage_server_id
string
|
The OCID of the Exadata storage server.
Required to get a specific external_exadata_storage_server.
aliases: id |
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
|
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
|
|
The field to sort information by. Only one sortOrder can be used. The default sort order for 'TIMECREATED' is descending and the default sort order for 'NAME' is ascending. The 'NAME' sort order is case-sensitive.
|
|
sort_order
string
|
|
The option to sort information in ascending ('ASC') or descending ('DESC') order. Ascending order is the default order.
|
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific external_exadata_storage_server
oci_database_management_external_exadata_storage_server_facts:
# required
external_exadata_storage_server_id: "ocid1.externalexadatastorageserver.oc1..xxxxxxEXAMPLExxxxxx"
- name: List external_exadata_storage_servers
oci_database_management_external_exadata_storage_server_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
external_exadata_infrastructure_id: "ocid1.externalexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
sort_by: TIMECREATED
sort_order: ASC
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | ||
|---|---|---|---|---|
|
external_exadata_storage_servers
complex
|
on success |
List of ExternalExadataStorageServer resources
Sample:
[{'additional_details': {}, 'connector': {'additional_details': {}, 'agent_id': 'ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx', 'connection_uri': 'connection_uri_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'internal_id': 'ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'resource_type': 'INFRASTRUCTURE_SUMMARY', 'status': 'status_example', 'storage_server_id': 'ocid1.storageserver.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}, 'connector_id': 'ocid1.connector.oc1..xxxxxxEXAMPLExxxxxx', 'cpu_count': 10, 'display_name': 'display_name_example', 'exadata_infrastructure_id': 'ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'internal_id': 'ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx', 'ip_address': 'ip_address_example', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'make_model': 'make_model_example', 'max_flash_disk_iops': 56, 'max_flash_disk_throughput': 56, 'max_hard_disk_iops': 56, 'max_hard_disk_throughput': 56, 'memory_gb': 1.2, 'resource_type': 'INFRASTRUCTURE_SUMMARY', 'status': 'status_example', 'storage_grid_id': 'ocid1.storagegrid.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}]
|
||
|
additional_details
dictionary
|
on success |
The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}`
|
||
|
connector
complex
|
on success |
Returned for get operation
|
||
|
additional_details
dictionary
|
on success |
The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}`
|
||
|
agent_id
string
|
on success |
The OCID of the agent for the Exadata storage server.
Sample:
ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
connection_uri
string
|
on success |
The unique connection string of the connection. For example, "https://slcm21celadm02.us.oracle.com:443/MS/RESTService/".
Sample:
connection_uri_example
|
||
|
display_name
string
|
on success |
The name of the resource. English letters, numbers, "-", "_" and "." only.
Sample:
display_name_example
|
||
|
id
string
|
on success |
The OCID of the Exadata resource.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
internal_id
string
|
on success |
The internal ID.
Sample:
ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
lifecycle_details
string
|
on success |
The details of the lifecycle state.
Sample:
lifecycle_details_example
|
||
|
lifecycle_state
string
|
on success |
The current lifecycle state of the database resource.
Sample:
CREATING
|
||
|
resource_type
string
|
on success |
The type of resource.
Sample:
INFRASTRUCTURE_SUMMARY
|
||
|
status
string
|
on success |
The status of the entity.
Sample:
status_example
|
||
|
storage_server_id
string
|
on success |
The OCID of the Exadata storage server.
Sample:
ocid1.storageserver.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
time_created
string
|
on success |
The timestamp of the creation.
Sample:
2013-10-20T19:20:30+01:00
|
||
|
time_updated
string
|
on success |
The timestamp of the last update.
Sample:
2013-10-20T19:20:30+01:00
|
||
|
version
string
|
on success |
The version of the resource.
Sample:
version_example
|
||
|
connector_id
string
|
on success |
The OCID of connector.
Returned for list operation
Sample:
ocid1.connector.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
cpu_count
float
|
on success |
CPU count of the storage server
Sample:
10
|
||
|
display_name
string
|
on success |
The name of the resource. English letters, numbers, "-", "_" and "." only.
Sample:
display_name_example
|
||
|
exadata_infrastructure_id
string
|
on success |
The OCID of Exadata infrastructure system.
Returned for get operation
Sample:
ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
id
string
|
on success |
The OCID of the Exadata resource.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
internal_id
string
|
on success |
The internal ID.
Sample:
ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
ip_address
string
|
on success |
The IP address of the storage server.
Sample:
ip_address_example
|
||
|
lifecycle_details
string
|
on success |
The details of the lifecycle state.
Sample:
lifecycle_details_example
|
||
|
lifecycle_state
string
|
on success |
The current lifecycle state of the database resource.
Sample:
CREATING
|
||
|
make_model
string
|
on success |
The make model of the storage server.
Sample:
make_model_example
|
||
|
max_flash_disk_iops
integer
|
on success |
Maximum flash disk IO operations per second of the storage server
Sample:
56
|
||
|
max_flash_disk_throughput
integer
|
on success |
Maximum flash disk IO throughput in MB/s of the storage server
Sample:
56
|
||
|
max_hard_disk_iops
integer
|
on success |
Maximum hard disk IO operations per second of the storage server
Sample:
56
|
||
|
max_hard_disk_throughput
integer
|
on success |
Maximum hard disk IO throughput in MB/s of the storage server
Sample:
56
|
||
|
memory_gb
float
|
on success |
Storage server memory size in GB
Sample:
1.2
|
||
|
resource_type
string
|
on success |
The type of resource.
Sample:
INFRASTRUCTURE_SUMMARY
|
||
|
status
string
|
on success |
The status of the entity.
Sample:
status_example
|
||
|
storage_grid_id
string
|
on success |
The OCID of Exadata storage grid.
Returned for get operation
Sample:
ocid1.storagegrid.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
time_created
string
|
on success |
The timestamp of the creation.
Sample:
2013-10-20T19:20:30+01:00
|
||
|
time_updated
string
|
on success |
The timestamp of the last update.
Sample:
2013-10-20T19:20:30+01:00
|
||
|
version
string
|
on success |
The version of the resource.
Sample:
version_example
|
||
Authors¶
Oracle (@oracle)