Try SpotterManage an ExternalExadataInfrastructure resource 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.0This module allows the user to create, update and delete an ExternalExadataInfrastructure resource in Oracle Cloud Infrastructure
For I(state=present), creates an OCI resource for the Exadata infrastructure and enable monitoring service on the exadata infrastructure. The following resource/subresources are created: Infrastructure Storage server connectors Storage servers Storage grids
This resource has the following action operations in the M(oracle.oci.oci_database_management_external_exadata_infrastructure_actions) module: change_compartment, disable_external_exadata_infrastructure_management, discover, enable_external_exadata_infrastructure_management.
- name: Create external_exadata_infrastructure
oci_database_management_external_exadata_infrastructure:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
db_system_ids: [ "db_system_ids_example" ]
# optional
discovery_key: discovery_key_example
license_model: LICENSE_INCLUDED
storage_server_names: [ "storage_server_names_example" ]
- name: Update external_exadata_infrastructure
oci_database_management_external_exadata_infrastructure:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
external_exadata_infrastructure_id: "ocid1.externalexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
# optional
discovery_key: discovery_key_example
license_model: LICENSE_INCLUDED
display_name: display_name_example
db_system_ids: [ "db_system_ids_example" ]
storage_server_names: [ "storage_server_names_example" ]
- name: Update external_exadata_infrastructure using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_database_management_external_exadata_infrastructure:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
discovery_key: discovery_key_example
license_model: LICENSE_INCLUDED
db_system_ids: [ "db_system_ids_example" ]
storage_server_names: [ "storage_server_names_example" ]
- name: Delete external_exadata_infrastructure
oci_database_management_external_exadata_infrastructure:
# required
external_exadata_infrastructure_id: "ocid1.externalexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete external_exadata_infrastructure using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_database_management_external_exadata_infrastructure:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
state:
choices:
- present
- absent
default: present
description:
- The state of the ExternalExadataInfrastructure.
- Use I(state=present) to create or update an ExternalExadataInfrastructure.
- Use I(state=absent) to delete an ExternalExadataInfrastructure.
required: false
type: str
key_by:
description: The list of attributes of this resource which should be used to uniquely
identify an instance of the resource. By default, all the attributes of a resource
are used to uniquely identify a resource.
elements: str
type: list
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
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
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:
- The name of the Exadata infrastructure.
- Required for create using I(state=present).
- Required for update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is set.
- This parameter is updatable when C(OCI_USE_NAME_AS_IDENTIFIER) is not set.
type: str
force_create:
default: false
description: Whether to attempt non-idempotent creation of a resource. By default,
create resource is an idempotent operation, and doesn't create the resource if it
already exists. Setting this option to true, forcefully creates a copy of the resource,
even if it already exists.This option is mutually exclusive with I(key_by).
type: bool
wait_timeout:
description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most
of the services but some services might have a longer wait timeout.
type: int
db_system_ids:
description:
- The list of all the rac database system OCIDs.
- Required for create using I(state=present).
- This parameter is updatable.
elements: str
type: list
discovery_key:
description:
- The unique key of the discovery request.
- This parameter is updatable.
type: str
license_model:
choices:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
description:
- The Oracle license model that applies to the database management resources.
- This parameter is updatable.
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of compartment.
- Required for create using I(state=present), update using I(state=present) with external_exadata_infrastructure_id
present.
- Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
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
storage_server_names:
description:
- The list of all the storage server names to be included for monitoering purpose.
If not specified, all the storage servers associated with the database systems are
included.
- This parameter is updatable.
elements: str
type: list
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
external_exadata_infrastructure_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Exadata infrastructure.
- Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
- Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
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
external_exadata_infrastructure:
contains:
additional_details:
description:
- 'The additional details of the resource defined in `{"key": "value"}` format.
Example: `{"bar-key": "value"}`'
returned: on success
sample: {}
type: dict
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of compartment.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
database_compartments:
description:
- The list of L(OCIDs],https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartments
returned: on success
sample: []
type: list
database_systems:
contains:
additional_details:
description:
- 'The additional details of the resource defined in `{"key": "value"}`
format. Example: `{"bar-key": "value"}`'
returned: on success
sample: {}
type: dict
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of compartment.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
display_name:
description:
- The name of the resource. English letters, numbers, "-", "_" and "." only.
returned: on success
sample: display_name_example
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Exadata resource.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
internal_id:
description:
- The internal ID.
returned: on success
sample: ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx
type: str
license_model:
description:
- The Oracle license model that applies to the database management resources.
returned: on success
sample: LICENSE_INCLUDED
type: str
lifecycle_details:
description:
- The details of the lifecycle state.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current lifecycle state of the database resource.
returned: on success
sample: CREATING
type: str
resource_type:
description:
- The type of resource.
returned: on success
sample: INFRASTRUCTURE_SUMMARY
type: str
status:
description:
- The status of the entity.
returned: on success
sample: status_example
type: str
time_created:
description:
- The timestamp of the creation.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_updated:
description:
- The timestamp of the last update.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
version:
description:
- The version of the resource.
returned: on success
sample: version_example
type: str
description:
- A list of database systems.
returned: on success
type: complex
display_name:
description:
- The name of the resource. English letters, numbers, "-", "_" and "." only.
returned: on success
sample: display_name_example
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Exadata resource.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
internal_id:
description:
- The internal ID.
returned: on success
sample: ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx
type: str
license_model:
description:
- The Oracle license model that applies to the database management resources.
returned: on success
sample: LICENSE_INCLUDED
type: str
lifecycle_details:
description:
- The details of the lifecycle state.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current lifecycle state of the database resource.
returned: on success
sample: CREATING
type: str
rack_size:
description:
- The rack size of the Exadata infrastructure.
returned: on success
sample: FULL
type: str
resource_type:
description:
- The type of resource.
returned: on success
sample: INFRASTRUCTURE_SUMMARY
type: str
status:
description:
- The status of the entity.
returned: on success
sample: status_example
type: str
storage_grid:
contains:
additional_details:
description:
- 'The additional details of the resource defined in `{"key": "value"}`
format. Example: `{"bar-key": "value"}`'
returned: on success
sample: {}
type: dict
display_name:
description:
- The name of the resource. English letters, numbers, "-", "_" and "." only.
returned: on success
sample: display_name_example
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Exadata resource.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
internal_id:
description:
- The internal ID.
returned: on success
sample: ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx
type: str
lifecycle_details:
description:
- The details of the lifecycle state.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current lifecycle state of the database resource.
returned: on success
sample: CREATING
type: str
resource_type:
description:
- The type of resource.
returned: on success
sample: INFRASTRUCTURE_SUMMARY
type: str
server_count:
description:
- The number of the storage servers in the Exadata infrastructure.
returned: on success
sample: 10
type: float
status:
description:
- The status of the entity.
returned: on success
sample: status_example
type: str
time_created:
description:
- The timestamp of the creation.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_updated:
description:
- The timestamp of the last update.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
version:
description:
- The version of the resource.
returned: on success
sample: version_example
type: str
description:
- ''
returned: on success
type: complex
time_created:
description:
- The timestamp of the creation.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_updated:
description:
- The timestamp of the last update.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
version:
description:
- The version of the resource.
returned: on success
sample: version_example
type: str
description:
- Details of the ExternalExadataInfrastructure resource acted upon by the current
operation
returned: on success
sample:
additional_details: {}
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
database_compartments: []
database_systems:
- additional_details: {}
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
display_name: display_name_example
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
internal_id: ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx
license_model: LICENSE_INCLUDED
lifecycle_details: lifecycle_details_example
lifecycle_state: CREATING
resource_type: INFRASTRUCTURE_SUMMARY
status: status_example
time_created: '2013-10-20T19:20:30+01:00'
time_updated: '2013-10-20T19:20:30+01:00'
version: version_example
display_name: display_name_example
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
internal_id: ocid1.internal.oc1..xxxxxxEXAMPLExxxxxx
license_model: LICENSE_INCLUDED
lifecycle_details: lifecycle_details_example
lifecycle_state: CREATING
rack_size: FULL
resource_type: INFRASTRUCTURE_SUMMARY
status: status_example
storage_grid:
additional_details: {}
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
server_count: 10
status: status_example
time_created: '2013-10-20T19:20:30+01:00'
time_updated: '2013-10-20T19:20:30+01:00'
version: version_example
time_created: '2013-10-20T19:20:30+01:00'
time_updated: '2013-10-20T19:20:30+01:00'
version: version_example
type: complex