oracle.oci.oci_database_external_container_database_facts (5.0.0) — module

Fetches details about one or multiple ExternalContainerDatabase 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 ExternalContainerDatabase resources in Oracle Cloud Infrastructure

Gets a list of the external container databases in the specified compartment.

If I(external_container_database_id) is specified, the details of a single ExternalContainerDatabase will be returned.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get a specific external_container_database
  oci_database_external_container_database_facts:
    # required
    external_container_database_id: "ocid1.externalcontainerdatabase.oc1..xxxxxxEXAMPLExxxxxx"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: List external_container_databases
  oci_database_external_container_database_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    sort_by: DISPLAYNAME
    sort_order: ASC
    lifecycle_state: PROVISIONING
    display_name: display_name_example

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:
    - DISPLAYNAME
    - TIMECREATED
    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 external_container_databases.
    type: str

lifecycle_state:
    choices:
    - PROVISIONING
    - NOT_CONNECTED
    - AVAILABLE
    - UPDATING
    - TERMINATING
    - TERMINATED
    - FAILED
    description:
    - A filter to return only resources that match the specified lifecycle state.
    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

external_container_database_id:
    aliases:
    - id
    description:
    - The ExternalContainerDatabase L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
    - Required to get a specific external_container_database.
    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

external_container_databases:
  contains:
    character_set:
      description:
      - The character set of the external database.
      returned: on success
      sample: character_set_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
    database_configuration:
      description:
      - The Oracle Database configuration
      returned: on success
      sample: RAC
      type: str
    database_edition:
      description:
      - The Oracle Database edition.
      returned: on success
      sample: STANDARD_EDITION
      type: str
    database_management_config:
      contains:
        database_management_connection_id:
          description:
          - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
            of the L(external database connector,https://docs.cloud.oracle.com/en-
            us/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails).
          returned: on success
          sample: ocid1.databasemanagementconnection.oc1..xxxxxxEXAMPLExxxxxx
          type: str
        database_management_status:
          description:
          - The status of the Database Management service.
          returned: on success
          sample: ENABLING
          type: str
        license_model:
          description:
          - The Oracle license model that applies to the external database.
          returned: on success
          sample: LICENSE_INCLUDED
          type: str
      description:
      - ''
      returned: on success
      type: complex
    database_version:
      description:
      - The Oracle Database version.
      returned: on success
      sample: database_version_example
      type: str
    db_id:
      description:
      - The Oracle Database ID, which identifies an Oracle Database located outside
        of Oracle Cloud.
      returned: on success
      sample: ocid1.db.oc1..xxxxxxEXAMPLExxxxxx
      type: str
    db_packs:
      description:
      - The database packs licensed for the external Oracle Database.
      returned: on success
      sample: db_packs_example
      type: str
    db_unique_name:
      description:
      - The `DB_UNIQUE_NAME` of the external database.
      returned: on success
      sample: db_unique_name_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 external database. The name does not have to
        be unique.
      returned: on success
      sample: display_name_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
    id:
      description:
      - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
        of the Oracle Cloud Infrastructure external database resource.
      returned: on success
      sample: ocid1.resource.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 state of the Oracle Cloud Infrastructure external database resource.
      returned: on success
      sample: PROVISIONING
      type: str
    ncharacter_set:
      description:
      - The national character of the external database.
      returned: on success
      sample: ncharacter_set_example
      type: str
    stack_monitoring_config:
      contains:
        stack_monitoring_connector_id:
          description:
          - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
            of the L(external database connector,https://docs.cloud.oracle.com/en-
            us/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails).
          returned: on success
          sample: ocid1.stackmonitoringconnector.oc1..xxxxxxEXAMPLExxxxxx
          type: str
        stack_monitoring_status:
          description:
          - The status of Stack Monitoring.
          returned: on success
          sample: ENABLING
          type: str
      description:
      - ''
      returned: on success
      type: complex
    time_created:
      description:
      - The date and time the database was created.
      returned: on success
      sample: '2013-10-20T19:20:30+01:00'
      type: str
    time_zone:
      description:
      - The time zone of the external database. It is a time zone offset (a character
        type in the format '[+|-]TZH:TZM') or a time zone region name, depending on
        how the time zone value was specified when the database was created / last
        altered.
      returned: on success
      sample: time_zone_example
      type: str
  description:
  - List of ExternalContainerDatabase resources
  returned: on success
  sample:
  - character_set: character_set_example
    compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
    database_configuration: RAC
    database_edition: STANDARD_EDITION
    database_management_config:
      database_management_connection_id: ocid1.databasemanagementconnection.oc1..xxxxxxEXAMPLExxxxxx
      database_management_status: ENABLING
      license_model: LICENSE_INCLUDED
    database_version: database_version_example
    db_id: ocid1.db.oc1..xxxxxxEXAMPLExxxxxx
    db_packs: db_packs_example
    db_unique_name: db_unique_name_example
    defined_tags:
      Operations:
        CostCenter: US
    display_name: display_name_example
    freeform_tags:
      Department: Finance
    id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
    lifecycle_details: lifecycle_details_example
    lifecycle_state: PROVISIONING
    ncharacter_set: ncharacter_set_example
    stack_monitoring_config:
      stack_monitoring_connector_id: ocid1.stackmonitoringconnector.oc1..xxxxxxEXAMPLExxxxxx
      stack_monitoring_status: ENABLING
    time_created: '2013-10-20T19:20:30+01:00'
    time_zone: time_zone_example
  type: complex