Try SpotterFetches details about one or multiple CloudExadataInfrastructure resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about one or multiple CloudExadataInfrastructure resources in Oracle Cloud Infrastructure
Gets a list of the cloud Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.
If I(cloud_exadata_infrastructure_id) is specified, the details of a single CloudExadataInfrastructure will be returned.
- name: Get a specific cloud_exadata_infrastructure
oci_database_cloud_exadata_infrastructure_facts:
# required
cloud_exadata_infrastructure_id: "ocid1.cloudexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
- name: List cloud_exadata_infrastructures
oci_database_cloud_exadata_infrastructure_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
sort_by: TIMECREATED
sort_order: ASC
lifecycle_state: PROVISIONING
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
- DISPLAYNAME
description:
- The field to sort by. You can provide one sort order (`sortOrder`). Default order
for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The
DISPLAYNAME sort order is case sensitive.
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
- security_token
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
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 cloud_exadata_infrastructures.
type: str
lifecycle_state:
choices:
- PROVISIONING
- AVAILABLE
- UPDATING
- TERMINATING
- TERMINATED
- FAILED
- 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
cloud_exadata_infrastructure_id:
aliases:
- id
description:
- The cloud Exadata infrastructure L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
- Required to get a specific cloud_exadata_infrastructure.
type: str
realm_specific_endpoint_template_enabled:
description:
- 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.
type: bool
cloud_exadata_infrastructures:
contains:
activated_storage_count:
description:
- The requested number of additional storage servers activated for the Exadata
infrastructure.
returned: on success
sample: 56
type: int
additional_storage_count:
description:
- The requested number of additional storage servers for the Exadata infrastructure.
returned: on success
sample: 56
type: int
availability_domain:
description:
- The name of the availability domain that the cloud Exadata infrastructure
resource is located in.
returned: on success
sample: Uocm:PHX-AD-1
type: str
available_storage_size_in_gbs:
description:
- The available storage can be allocated to the cloud Exadata infrastructure
resource, in gigabytes (GB).
returned: on success
sample: 56
type: int
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
compute_count:
description:
- The number of compute servers for the cloud Exadata infrastructure.
returned: on success
sample: 56
type: int
cpu_count:
description:
- The total number of CPU cores allocated.
returned: on success
sample: 56
type: int
customer_contacts:
contains:
email:
description:
- The email address used by Oracle to send notifications regarding databases
and infrastructure.
returned: on success
sample: email_example
type: str
description:
- The list of customer email addresses that receive information from Oracle
about the specified OCI Database service resource. Oracle uses these email
addresses to send notifications about planned and unplanned software maintenance
updates, information about system hardware, and other information needed by
administrators. Up to 10 email addresses can be added to the customer contacts
for a cloud Exadata infrastructure instance.
returned: on success
type: complex
data_storage_size_in_tbs:
description:
- Size, in terabytes, of the DATA disk group.
returned: on success
sample: 1.2
type: float
db_node_storage_size_in_gbs:
description:
- The local node storage allocated in GBs.
returned: on success
sample: 56
type: int
db_server_version:
description:
- 'The software version of the database servers (dom0) in the cloud Exadata
infrastructure. Example: 20.1.15'
returned: on success
sample: db_server_version_example
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).
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- The user-friendly name for the cloud Exadata infrastructure resource. The
name does not need to be unique.
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
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the cloud Exadata infrastructure resource.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
last_maintenance_run_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the last maintenance run.
returned: on success
sample: ocid1.lastmaintenancerun.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 lifecycle state of the cloud Exadata infrastructure resource.
returned: on success
sample: PROVISIONING
type: str
maintenance_window:
contains:
custom_action_timeout_in_mins:
description:
- Determines the amount of time the system will wait before the start of
each database server patching operation. Custom action timeout is in minutes
and valid value is between 15 to 120 (inclusive).
returned: on success
sample: 56
type: int
days_of_week:
contains:
name:
description:
- Name of the day of the week.
returned: on success
sample: MONDAY
type: str
description:
- Days during the week when maintenance should be performed.
returned: on success
type: complex
hours_of_day:
description:
- The window of hours during the day when maintenance should be performed.
The window is a 4 hour slot. Valid values are - 0 - represents time slot
0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents
time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC
- 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot
20:00 - 23:59 UTC
returned: on success
sample: []
type: list
is_custom_action_timeout_enabled:
description:
- If true, enables the configuration of a custom action timeout (waiting
period) between database server patching operations.
returned: on success
sample: true
type: bool
is_monthly_patching_enabled:
description:
- If true, enables the monthly patching option.
returned: on success
sample: true
type: bool
lead_time_in_weeks:
description:
- Lead time window allows user to set a lead time to prepare for a down
time. The lead time is in weeks and valid value is between 1 to 4.
returned: on success
sample: 56
type: int
months:
contains:
name:
description:
- Name of the month of the year.
returned: on success
sample: JANUARY
type: str
description:
- Months during the year when maintenance should be performed.
returned: on success
type: complex
patching_mode:
description:
- Cloud Exadata infrastructure node patching method, either "ROLLING" or
"NONROLLING". Default value is ROLLING.
- '*IMPORTANT*: Non-rolling infrastructure patching involves system down
time. See L(Oracle-Managed Infrastructure Maintenance Updates,https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle)
for more information.'
returned: on success
sample: ROLLING
type: str
preference:
description:
- The maintenance window scheduling preference.
returned: on success
sample: NO_PREFERENCE
type: str
weeks_of_month:
description:
- Weeks during the month when maintenance should be performed. Weeks start
on the 1st, 8th, 15th, and 22nd days of the month, and have a duration
of 7 days. Weeks start and end based on calendar dates, not days of the
week. For example, to allow maintenance during the 2nd week of the month
(from the 8th day to the 14th day of the month), use the value 2. Maintenance
cannot be scheduled for the fifth week of months that contain more than
28 days. Note that this parameter works in conjunction with the daysOfWeek
and hoursOfDay parameters to allow you to specify specific days of the
week and hours that maintenance will be performed.
returned: on success
sample: []
type: list
description:
- ''
returned: on success
type: complex
max_cpu_count:
description:
- The total number of CPU cores available.
returned: on success
sample: 56
type: int
max_data_storage_in_tbs:
description:
- The total available DATA disk group size.
returned: on success
sample: 1.2
type: float
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 memory allocated in GBs.
returned: on success
sample: 56
type: int
monthly_db_server_version:
description:
- 'The monthly software version of the database servers (dom0) in the cloud
Exadata infrastructure. Example: 20.1.15'
returned: on success
sample: monthly_db_server_version_example
type: str
monthly_storage_server_version:
description:
- 'The monthly software version of the storage servers (cells) in the cloud
Exadata infrastructure. Example: 20.1.15'
returned: on success
sample: monthly_storage_server_version_example
type: str
next_maintenance_run_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the next maintenance run.
returned: on success
sample: ocid1.nextmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
type: str
shape:
description:
- The model name of the cloud Exadata infrastructure resource.
returned: on success
sample: shape_example
type: str
storage_count:
description:
- The number of storage servers for the cloud Exadata infrastructure.
returned: on success
sample: 56
type: int
storage_server_version:
description:
- 'The software version of the storage servers (cells) in the cloud Exadata
infrastructure. Example: 20.1.15'
returned: on success
sample: storage_server_version_example
type: str
time_created:
description:
- The date and time the cloud Exadata infrastructure resource was created.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
total_storage_size_in_gbs:
description:
- The total storage allocated to the cloud Exadata infrastructure resource,
in gigabytes (GB).
returned: on success
sample: 56
type: int
description:
- List of CloudExadataInfrastructure resources
returned: on success
sample:
- activated_storage_count: 56
additional_storage_count: 56
availability_domain: Uocm:PHX-AD-1
available_storage_size_in_gbs: 56
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
compute_count: 56
cpu_count: 56
customer_contacts:
- email: email_example
data_storage_size_in_tbs: 1.2
db_node_storage_size_in_gbs: 56
db_server_version: db_server_version_example
defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
freeform_tags:
Department: Finance
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
last_maintenance_run_id: ocid1.lastmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
lifecycle_details: lifecycle_details_example
lifecycle_state: PROVISIONING
maintenance_window:
custom_action_timeout_in_mins: 56
days_of_week:
- name: MONDAY
hours_of_day: []
is_custom_action_timeout_enabled: true
is_monthly_patching_enabled: true
lead_time_in_weeks: 56
months:
- name: JANUARY
patching_mode: ROLLING
preference: NO_PREFERENCE
weeks_of_month: []
max_cpu_count: 56
max_data_storage_in_tbs: 1.2
max_db_node_storage_in_gbs: 56
max_memory_in_gbs: 56
memory_size_in_gbs: 56
monthly_db_server_version: monthly_db_server_version_example
monthly_storage_server_version: monthly_storage_server_version_example
next_maintenance_run_id: ocid1.nextmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
shape: shape_example
storage_count: 56
storage_server_version: storage_server_version_example
time_created: '2013-10-20T19:20:30+01:00'
total_storage_size_in_gbs: 56
type: complex