Try SpotterPerform actions on an AutonomousExadataInfrastructure 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.0Perform actions on an AutonomousExadataInfrastructure resource in Oracle Cloud Infrastructure
For I(action=change_compartment), **Deprecated.** Use the L(ChangeCloudExadataInfrastructureCompartment,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/CloudExadataInfrastructure/ChangeCloudExadataInfrastructureCompartment) operation to move an Exadata infrastructure resource to a different compartment and L(ChangeCloudAutonomousVmClusterCompartment,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/CloudAutonomousVmCluster/ChangeCloudAutonomousVmClusterCompartment) operation to move an Autonomous Exadata VM cluster to a different compartment. For more information, see L(Moving Database Resources to a Different Compartment,https://docs.cloud.oracle.com/Content/Database/Concepts/databaseoverview.htm#moveRes).
For I(action=rotate_ords_certs), **Deprecated.** Use the L(RotateCloudAutonomousVmClusterOrdsCerts,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/CloudAutonomousVmCluster/RotateCloudAutonomousVmClusterOrdsCerts) to rotate Oracle REST Data Services (ORDS) certs for an Autonomous Exadata VM cluster instead.
For I(action=rotate_ssl_certs), **Deprecated.** Use the L(RotateCloudAutonomousVmClusterSslCerts,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/CloudAutonomousVmCluster/RotateCloudAutonomousVmClusterSslCerts) to rotate SSL certs for an Autonomous Exadata VM cluster instead.
- name: Perform action change_compartment on autonomous_exadata_infrastructure
oci_database_autonomous_exadata_infrastructure_actions:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
autonomous_exadata_infrastructure_id: "ocid1.autonomousexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
action: change_compartment
- name: Perform action rotate_ords_certs on autonomous_exadata_infrastructure
oci_database_autonomous_exadata_infrastructure_actions:
# required
autonomous_exadata_infrastructure_id: "ocid1.autonomousexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
action: rotate_ords_certs
- name: Perform action rotate_ssl_certs on autonomous_exadata_infrastructure
oci_database_autonomous_exadata_infrastructure_actions:
# required
autonomous_exadata_infrastructure_id: "ocid1.autonomousexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
action: rotate_ssl_certs
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
action:
choices:
- change_compartment
- rotate_ords_certs
- rotate_ssl_certs
description:
- The action to perform on the AutonomousExadataInfrastructure.
required: true
type: str
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
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
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment to move the resource to.
- Required for I(action=change_compartment).
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
autonomous_exadata_infrastructure_id:
aliases:
- id
description:
- The Autonomous Exadata Infrastructure L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
required: true
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
autonomous_exadata_infrastructure:
contains:
availability_domain:
description:
- The name of the availability domain that the Autonomous Exadata Infrastructure
is located in.
returned: on success
sample: Uocm:PHX-AD-1
type: str
compartment_id:
description:
- The OCID of the compartment.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
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 Autonomous Exadata Infrastructure.
returned: on success
sample: display_name_example
type: str
domain:
description:
- The domain name for the Autonomous Exadata Infrastructure.
returned: on success
sample: domain_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
hostname:
description:
- The host name for the Autonomous Exadata Infrastructure node.
returned: on success
sample: hostname_example
type: str
id:
description:
- The OCID of the Autonomous Exadata Infrastructure.
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
license_model:
description:
- The Oracle license model that applies to all databases in the Autonomous Exadata
Infrastructure. The default is BRING_YOUR_OWN_LICENSE.
returned: on success
sample: LICENSE_INCLUDED
type: str
lifecycle_details:
description:
- Additional information about the current lifecycle state of the Autonomous
Exadata Infrastructure.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current lifecycle state of the Autonomous Exadata Infrastructure.
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
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
nsg_ids:
description:
- The list of L(OCIDs,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
for the network security groups (NSGs) to which this resource belongs. Setting
this to an empty list removes all resources from all NSGs. For more information
about NSGs, see L(Security Rules,https://docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm).
**NsgIds restrictions:** - A network security group (NSG) is optional for
Autonomous Databases with private access. The nsgIds list can be empty.
returned: on success
sample: []
type: list
scan_dns_name:
description:
- The FQDN of the DNS record for the SCAN IP addresses that are associated with
the Autonomous Exadata Infrastructure.
returned: on success
sample: scan_dns_name_example
type: str
shape:
description:
- The shape of the Autonomous Exadata Infrastructure. The shape determines resources
to allocate to the Autonomous Exadata Infrastructure (CPU cores, memory and
storage).
returned: on success
sample: shape_example
type: str
subnet_id:
description:
- 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.
returned: on success
sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
time_created:
description:
- The date and time the Autonomous Exadata Infrastructure was created.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
zone_id:
description:
- The OCID of the zone the Autonomous Exadata Infrastructure is associated with.
returned: on success
sample: ocid1.zone.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- Details of the AutonomousExadataInfrastructure resource acted upon by the current
operation
returned: on success
sample:
availability_domain: Uocm:PHX-AD-1
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
domain: domain_example
freeform_tags:
Department: Finance
hostname: hostname_example
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
last_maintenance_run_id: ocid1.lastmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
license_model: LICENSE_INCLUDED
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: []
next_maintenance_run_id: ocid1.nextmaintenancerun.oc1..xxxxxxEXAMPLExxxxxx
nsg_ids: []
scan_dns_name: scan_dns_name_example
shape: shape_example
subnet_id: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
time_created: '2013-10-20T19:20:30+01:00'
zone_id: ocid1.zone.oc1..xxxxxxEXAMPLExxxxxx
type: complex