oci_autonomous_exadata_infrastructure – Manage an AutonomousExadataInfrastructure resource in Oracle Cloud Infrastructure

New in version 2.5.

Synopsis

  • This module allows the user to create, update and delete an AutonomousExadataInfrastructure resource in Oracle Cloud Infrastructure
  • For state=present, launches a new Autonomous Exadata Infrastructure in the specified compartment and availability domain.

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_OCID 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_type
string
    Choices:
  • api_key ←
  • instance_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.
autonomous_exadata_infrastructure_id
-
The Autonomous Exadata Infrastructure OCID.
Required for update using state=present, state=absent.

aliases: id
availability_domain
-
The availability domain where the Autonomous Exadata Infrastructure is located.
Required for create using state=present.
compartment_id
-
The OCID of the compartment the Autonomous Exadata Infrastructure belongs in.
Required for create using state=present.
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
display_name
-
The user-friendly name for the Autonomous Exadata Infrastructure. It does not have to be unique.

aliases: name
domain
-
A domain name used for the Autonomous Exadata Infrastructure. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (don't provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.
force_create
boolean
    Choices:
  • no ←
  • yes
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 key_by.
freeform_tags
dictionary
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"}`
hostname
-
The host name for the Autonomous Exadata Infrastructure. The host name must begin with an alphabetic character and can contain a maximum of 30 alphanumeric characters, including hyphens (-).
The maximum length of the combined hostname and domain is 63 characters.
**Note:** The hostname must be unique within the subnet. If it is not unique, the Autonomous Exadata Infrastructure will fail to provision.
key_by
list
The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
license_model
-
    Choices:
  • LICENSE_INCLUDED
  • BRING_YOUR_OWN_LICENSE
The Oracle license model that applies to all the databases in the Autonomous Exadata Infrastructure. The default is BRING_YOUR_OWN_LICENSE.
maintenance_window_details
dictionary
Required for create using state=present.
day_of_week
- / required
    Choices:
  • ANY
  • SUNDAY
  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
Day of the week that the patch should be applied to the Autonomous Exadata Infrastructure. Patches are applied during the first week of the quarter.
hour_of_day
integer
Hour of the day that the patch should be applied.
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.
shape
-
The shape of the Autonomous Exadata Infrastructure. The shape determines resources allocated to the Autonomous Exadata Infrastructure (CPU cores, memory and storage). To get a list of shapes, use the ListDbSystemShapes operation.
Required for create using state=present.
state
-
    Choices:
  • present ←
  • absent
The state of the AutonomousExadataInfrastructure.
Use state=present to create or update an AutonomousExadataInfrastructure.
Use state=absent to delete an AutonomousExadataInfrastructure.
subnet_id
-
The OCID of the subnet the Autonomous Exadata Infrastructure is associated with.
**Subnet Restrictions:** - For Autonomous Exadata Infrastructures, do not use a subnet that overlaps with 192.168.128.0/20
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.
Required for create using state=present.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Default:
1200
Time, in seconds, to wait when wait=yes.
wait_until
string
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Examples

- name: Create autonomous_exadata_infrastructure
  oci_autonomous_exadata_infrastructure:
      compartment_id: ocid1.tenancy.oc1.<var>&lt;unique_ID&gt;</var>
      display_name: tst3dbsys
      availability_domain: Uocm:PHX-AD-1
      subnet_id: ocid1.subnet.oc1.<var>&lt;unique_ID&gt;</var>
      shape: Exadata.Half1.168
      hostname: athena
      domain: my.company.com

- name: Update autonomous_exadata_infrastructure
  oci_autonomous_exadata_infrastructure:
      display_name: new displayname
      autonomous_exadata_infrastructure_id: ocid1.autonomousexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx

- name: Delete autonomous_exadata_infrastructure
  oci_autonomous_exadata_infrastructure:
      autonomous_exadata_infrastructure_id: ocid1.autonomousexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
      state: absent

Return Values

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

Key Returned Description
autonomous_exadata_infrastructure
complex
on success
Details of the AutonomousExadataInfrastructure resource acted upon by the current operation

Sample:
{'domain': 'domain_example', 'time_created': '2013-10-20T19:20:30+01:00', 'next_maintenance_run': {'maintenance_type': 'PLANNED', 'lifecycle_state': 'SCHEDULED', 'display_name': 'display_name_example', 'description': 'description_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'target_resource_type': 'AUTONOMOUS_DBSYSTEM', 'maintenance_subtype': 'QUARTERLY', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'time_ended': '2013-10-20T19:20:30+01:00', 'target_resource_id': 'ocid1.targetresource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'time_scheduled': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}, 'shape': 'shape_example', 'license_model': 'LICENSE_INCLUDED', 'last_maintenance_run': {'maintenance_type': 'PLANNED', 'lifecycle_state': 'SCHEDULED', 'display_name': 'display_name_example', 'description': 'description_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'target_resource_type': 'AUTONOMOUS_DBSYSTEM', 'maintenance_subtype': 'QUARTERLY', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'time_ended': '2013-10-20T19:20:30+01:00', 'target_resource_id': 'ocid1.targetresource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'time_scheduled': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'maintenance_window': {'day_of_week': 'ANY', 'hour_of_day': 56}, 'lifecycle_state': 'PROVISIONING', 'availability_domain': 'Uocm:PHX-AD-1', 'display_name': 'display_name_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'hostname': 'hostname_example', 'freeform_tags': {'Department': 'Finance'}, 'lifecycle_details': 'lifecycle_details_example'}
  availability_domain
string
on success
The name of the availability domain that the Autonomous Exadata Infrastructure is located in.

Sample:
Uocm:PHX-AD-1
  compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
  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.
Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
  display_name
string
on success
The user-friendly name for the Autonomous Exadata Infrastructure.

Sample:
display_name_example
  domain
string
on success
The domain name for the Autonomous Exadata Infrastructure.

Sample:
domain_example
  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'}
  hostname
string
on success
The host name for the Autonomous Exadata Infrastructure node.

Sample:
hostname_example
  id
string
on success
The OCID of the Autonomous Exadata Infrastructure.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
  last_maintenance_run
complex
on success

    compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
    description
string
on success
The text describing this Maintenance Run.

Sample:
description_example
    display_name
string
on success
The user-friendly name for the Maintenance Run.

Sample:
display_name_example
    id
string
on success
The OCID of the Maintenance Run.

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

Sample:
lifecycle_details_example
    lifecycle_state
string
on success
The current state of the Maintenance Run.

Sample:
SCHEDULED
    maintenance_subtype
string
on success
Maintenance sub-type.

Sample:
QUARTERLY
    maintenance_type
string
on success
Maintenance type.

Sample:
PLANNED
    target_resource_id
string
on success
The ID of the target resource on which the Maintenance Run occurs.

Sample:
ocid1.targetresource.oc1..xxxxxxEXAMPLExxxxxx
    target_resource_type
string
on success
The type of the target resource on which the Maintenance Run occurs.

Sample:
AUTONOMOUS_DBSYSTEM
    time_ended
string
on success
The date and time the Maintenance Run was completed.

Sample:
2013-10-20 18:20:30
    time_scheduled
string
on success
The date and time the Maintenance Run is scheduled for.

Sample:
2013-10-20 18:20:30
    time_started
string
on success
The date and time the Maintenance Run starts.

Sample:
2013-10-20 18:20:30
  license_model
string
on success
The Oracle license model that applies to all databases in the Autonomous Exadata Infrastructure. The default is BRING_YOUR_OWN_LICENSE.

Sample:
LICENSE_INCLUDED
  lifecycle_details
string
on success
Additional information about the current lifecycle state of the Autonomous Exadata Infrastructure.

Sample:
lifecycle_details_example
  lifecycle_state
string
on success
The current lifecycle state of the Autonomous Exadata Infrastructure.

Sample:
PROVISIONING
  maintenance_window
complex
on success

    day_of_week
string
on success
Day of the week that the patch should be applied to the Autonomous Exadata Infrastructure. Patches are applied during the first week of the quarter.

Sample:
ANY
    hour_of_day
integer
on success
Hour of the day that the patch should be applied.

Sample:
56
  next_maintenance_run
complex
on success

    compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
    description
string
on success
The text describing this Maintenance Run.

Sample:
description_example
    display_name
string
on success
The user-friendly name for the Maintenance Run.

Sample:
display_name_example
    id
string
on success
The OCID of the Maintenance Run.

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

Sample:
lifecycle_details_example
    lifecycle_state
string
on success
The current state of the Maintenance Run.

Sample:
SCHEDULED
    maintenance_subtype
string
on success
Maintenance sub-type.

Sample:
QUARTERLY
    maintenance_type
string
on success
Maintenance type.

Sample:
PLANNED
    target_resource_id
string
on success
The ID of the target resource on which the Maintenance Run occurs.

Sample:
ocid1.targetresource.oc1..xxxxxxEXAMPLExxxxxx
    target_resource_type
string
on success
The type of the target resource on which the Maintenance Run occurs.

Sample:
AUTONOMOUS_DBSYSTEM
    time_ended
string
on success
The date and time the Maintenance Run was completed.

Sample:
2013-10-20 18:20:30
    time_scheduled
string
on success
The date and time the Maintenance Run is scheduled for.

Sample:
2013-10-20 18:20:30
    time_started
string
on success
The date and time the Maintenance Run starts.

Sample:
2013-10-20 18:20:30
  shape
string
on success
The shape of the Autonomous Exadata Infrastructure. The shape determines resources to allocate to the Autonomous Exadata Infrastructure (CPU cores, memory and storage).

Sample:
shape_example
  subnet_id
string
on success
The OCID of the subnet the Autonomous Exadata Infrastructure is associated with.
**Subnet Restrictions:** - For Autonomous Databases with Autonomous Exadata Infrastructure, do not use a subnet that overlaps with 192.168.128.0/20
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
  time_created
string
on success
The date and time the Autonomous Exadata Infrastructure was created.

Sample:
2013-10-20 18:20:30


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Manoj Meda (@manojmeda)
  • Mike Ross (@mross22)
  • Nabeel Al-Saber (@nalsaber)

Hint

If you notice any issues in this documentation you can edit this document to improve it.