Try SpotterFetches details about one or multiple ExadataInfrastructure 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 ExadataInfrastructure resources in Oracle Cloud Infrastructure
Lists the Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud@Customer instances only. To list the Exadata Cloud Service infrastructure resources in a compartment, use the L(ListCloudExadataInfrastructures,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/CloudExadataInfrastructure/ListCloudExadataInfrastructures) operation.
If I(exadata_infrastructure_id) is specified, the details of a single ExadataInfrastructure will be returned.
- name: Get a specific exadata_infrastructure
oci_database_exadata_infrastructure_facts:
# required
exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
# optional
excluded_fields: [ "multiRackConfigurationFile" ]
- name: List exadata_infrastructures
oci_database_exadata_infrastructure_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
sort_by: TIMECREATED
sort_order: ASC
lifecycle_state: CREATING
display_name: display_name_example
excluded_fields: [ "multiRackConfigurationFile" ]
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 exadata_infrastructures.
type: str
excluded_fields:
choices:
- multiRackConfigurationFile
description:
- If provided, the specified fields will be excluded in the response.
elements: str
type: list
lifecycle_state:
choices:
- CREATING
- REQUIRES_ACTIVATION
- ACTIVATING
- ACTIVE
- ACTIVATION_FAILED
- FAILED
- UPDATING
- DELETING
- DELETED
- DISCONNECTED
- MAINTENANCE_IN_PROGRESS
- WAITING_FOR_CONNECTIVITY
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:
aliases:
- id
description:
- The Exadata infrastructure L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
- Required to get a specific 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
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_compute_count:
description:
- The requested number of additional compute servers for the Exadata infrastructure.
returned: on success
sample: 56
type: int
additional_compute_system_model:
description:
- Oracle Exadata System Model specification. The system model determines the
amount of compute or storage server resources available for use. For more
information, please see L(System and Shape Configuration Options],https://docs.oracle.com/en/engineered-systems/exadata-cloud-at-customer/ecccm/ecc-system-config-
options.html#GUID-9E090174-5C57-4EB1-9243-B470F9F10D6B)
returned: on success
sample: X7
type: str
additional_storage_count:
description:
- The requested number of additional storage servers for the Exadata infrastructure.
returned: on success
sample: 56
type: int
admin_network_cidr:
description:
- The CIDR block for the Exadata administration network.
returned: on success
sample: admin_network_cidr_example
type: str
availability_domain:
description:
- The name of the availability domain that the Exadata infrastructure is located
in.
returned: on success
sample: Uocm:PHX-AD-1
type: str
cloud_control_plane_server1:
description:
- The IP address for the first control plane server.
returned: on success
sample: cloud_control_plane_server1_example
type: str
cloud_control_plane_server2:
description:
- The IP address for the second control plane server.
returned: on success
sample: cloud_control_plane_server2_example
type: str
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 Exadata infrastructure.
returned: on success
sample: 56
type: int
contacts:
contains:
email:
description:
- The email for the Exadata Infrastructure contact.
returned: on success
sample: email_example
type: str
is_contact_mos_validated:
description:
- If `true`, this Exadata Infrastructure contact is a valid My Oracle Support
(MOS) contact. If `false`, this Exadata Infrastructure contact is not
a valid MOS contact.
returned: on success
sample: true
type: bool
is_primary:
description:
- If `true`, this Exadata Infrastructure contact is a primary contact. If
`false`, this Exadata Infrastructure is a secondary contact.
returned: on success
sample: true
type: bool
name:
description:
- The name of the Exadata Infrastructure contact.
returned: on success
sample: name_example
type: str
phone_number:
description:
- The phone number for the Exadata Infrastructure contact.
returned: on success
sample: phone_number_example
type: str
description:
- The list of contacts for the Exadata infrastructure.
returned: on success
type: complex
corporate_proxy:
description:
- The corporate network proxy for access to the control plane network.
returned: on success
sample: corporate_proxy_example
type: str
cpus_enabled:
description:
- The number of enabled CPU cores.
returned: on success
sample: 56
type: int
csi_number:
description:
- The CSI Number of the Exadata infrastructure.
returned: on success
sample: csi_number_example
type: str
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 Exadata infrastructure.
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 Exadata Cloud@Customer infrastructure. The
name does not need to be unique.
returned: on success
sample: display_name_example
type: str
dns_server:
description:
- The list of DNS server IP addresses. Maximum of 3 allowed.
returned: on success
sample: []
type: list
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
gateway:
description:
- The gateway for the control plane network.
returned: on success
sample: gateway_example
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Exadata infrastructure.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
infini_band_network_cidr:
description:
- The CIDR block for the Exadata InfiniBand interconnect.
returned: on success
sample: infini_band_network_cidr_example
type: str
is_cps_offline_report_enabled:
description:
- Indicates whether cps offline diagnostic report is enabled for this Exadata
infrastructure. This will allow a customer to quickly check status themselves
and fix problems on their end, saving time and frustration for both Oracle
and the customer when they find the CPS in a disconnected state.You can enable
offline diagnostic report during Exadata infrastructure provisioning. You
can also disable or enable it at any time using the UpdateExadatainfrastructure
API.
returned: on success
sample: true
type: bool
is_multi_rack_deployment:
description:
- Indicates if deployment is Multi-Rack or not.
returned: on success
sample: true
type: bool
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 Exadata infrastructure.
returned: on success
sample: CREATING
type: str
maintenance_slo_status:
description:
- A field to capture 'Maintenance SLO Status' for the Exadata infrastructure
with values 'OK', 'DEGRADED'. Default is 'OK' when the infrastructure is provisioned.
returned: on success
sample: OK
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_t_bs:
description:
- The total available DATA disk group size.
returned: on success
sample: 1.2
type: float
max_db_node_storage_in_g_bs:
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 Exadata
infrastructure.
returned: on success
sample: monthly_db_server_version_example
type: str
multi_rack_configuration_file:
description:
- The base64 encoded Multi-Rack configuration json file.
returned: on success
sample: 'null'
type: str
netmask:
description:
- The netmask for the control plane network.
returned: on success
sample: netmask_example
type: str
network_bonding_mode_details:
contains:
backup_network_bonding_mode:
description:
- The network bonding mode for the Exadata infrastructure.
returned: on success
sample: ACTIVE_BACKUP
type: str
client_network_bonding_mode:
description:
- The network bonding mode for the Exadata infrastructure.
returned: on success
sample: ACTIVE_BACKUP
type: str
dr_network_bonding_mode:
description:
- The network bonding mode for the Exadata infrastructure.
returned: on success
sample: ACTIVE_BACKUP
type: str
description:
- ''
returned: on success
type: complex
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
ntp_server:
description:
- The list of NTP server IP addresses. Maximum of 3 allowed.
returned: on success
sample: []
type: list
rack_serial_number:
description:
- The serial number for the Exadata infrastructure.
returned: on success
sample: rack_serial_number_example
type: str
shape:
description:
- The shape of the Exadata infrastructure. The shape determines the amount of
CPU, storage, and memory resources allocated to the instance.
returned: on success
sample: shape_example
type: str
storage_count:
description:
- The number of Exadata storage servers for the Exadata infrastructure.
returned: on success
sample: 56
type: int
storage_server_version:
description:
- The software version of the storage servers (cells) in the Exadata infrastructure.
returned: on success
sample: storage_server_version_example
type: str
time_created:
description:
- The date and time the Exadata infrastructure was created.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_zone:
description:
- The time zone of the Exadata infrastructure. For details, see L(Exadata Infrastructure
Time Zones,https://docs.cloud.oracle.com/Content/Database/References/timezones.htm).
returned: on success
sample: time_zone_example
type: str
description:
- List of ExadataInfrastructure resources
returned: on success
sample:
- activated_storage_count: 56
additional_compute_count: 56
additional_compute_system_model: X7
additional_storage_count: 56
admin_network_cidr: admin_network_cidr_example
availability_domain: Uocm:PHX-AD-1
cloud_control_plane_server1: cloud_control_plane_server1_example
cloud_control_plane_server2: cloud_control_plane_server2_example
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
compute_count: 56
contacts:
- email: email_example
is_contact_mos_validated: true
is_primary: true
name: name_example
phone_number: phone_number_example
corporate_proxy: corporate_proxy_example
cpus_enabled: 56
csi_number: csi_number_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
dns_server: []
freeform_tags:
Department: Finance
gateway: gateway_example
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
infini_band_network_cidr: infini_band_network_cidr_example
is_cps_offline_report_enabled: true
is_multi_rack_deployment: true
last_maintenance_run_id: ocid1.lastmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
lifecycle_details: lifecycle_details_example
lifecycle_state: CREATING
maintenance_slo_status: OK
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_t_bs: 1.2
max_db_node_storage_in_g_bs: 56
max_memory_in_gbs: 56
memory_size_in_gbs: 56
monthly_db_server_version: monthly_db_server_version_example
multi_rack_configuration_file: null
netmask: netmask_example
network_bonding_mode_details:
backup_network_bonding_mode: ACTIVE_BACKUP
client_network_bonding_mode: ACTIVE_BACKUP
dr_network_bonding_mode: ACTIVE_BACKUP
next_maintenance_run_id: ocid1.nextmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
ntp_server: []
rack_serial_number: rack_serial_number_example
shape: shape_example
storage_count: 56
storage_server_version: storage_server_version_example
time_created: '2013-10-20T19:20:30+01:00'
time_zone: time_zone_example
type: complex