oracle.oci.oci_database_autonomous_db_preview_version_facts (5.0.0) — module

Fetches details about one or multiple AutonomousDbPreviewVersion resources in Oracle Cloud Infrastructure

| "added in version" 2.9.0 of oracle.oci"

Authors: Oracle (@oracle)

preview | supported by community

Install collection

Install with ansible-galaxy collection install oracle.oci:==5.0.0


Add to requirements.yml

  collections:
    - name: oracle.oci
      version: 5.0.0

Description

Fetches details about one or multiple AutonomousDbPreviewVersion resources in Oracle Cloud Infrastructure

Gets a list of supported Autonomous Database versions. Note that preview version software is only available for Autonomous Database Serverless (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) databases.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: List autonomous_db_preview_versions
  oci_database_autonomous_db_preview_version_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    sort_by: DBWORKLOAD
    sort_order: ASC

Inputs

    
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:
    - DBWORKLOAD
    description:
    - The field to sort by.  You can provide one sort order (`sortOrder`).  Default order
      for DBWORKLOAD is ascending.
    - '**Note:** If you do not include the availability domain filter, the resources are
      grouped by availability domain, then sorted.'
    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

compartment_id:
    description:
    - The compartment L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
    required: true
    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

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

Outputs

autonomous_db_preview_versions:
  contains:
    db_workload:
      description:
      - 'The Autonomous Database workload type. The following values are valid:'
      - '- OLTP - indicates an Autonomous Transaction Processing database - DW - indicates
        an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON
        Database - APEX - indicates an Autonomous Database with the Oracle APEX Application
        Development workload type.'
      - 'This cannot be updated in parallel with any of the following: licenseModel,
        dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps,
        isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable,
        dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.'
      returned: on success
      sample: OLTP
      type: str
    details:
      description:
      - A URL that points to a detailed description of the preview version.
      returned: on success
      sample: details_example
      type: str
    time_preview_begin:
      description:
      - The date and time when the preview version availability begins.
      returned: on success
      sample: '2013-10-20T19:20:30+01:00'
      type: str
    time_preview_end:
      description:
      - The date and time when the preview version availability ends.
      returned: on success
      sample: '2013-10-20T19:20:30+01:00'
      type: str
    version:
      description:
      - A valid Autonomous Database preview version.
      returned: on success
      sample: version_example
      type: str
  description:
  - List of AutonomousDbPreviewVersion resources
  returned: on success
  sample:
  - db_workload: OLTP
    details: details_example
    time_preview_begin: '2013-10-20T19:20:30+01:00'
    time_preview_end: '2013-10-20T19:20:30+01:00'
    version: version_example
  type: complex