oracle.oci.oci_bds_metastore_configuration_facts – Fetches details about one or multiple BdsMetastoreConfiguration resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_bds_metastore_configuration_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple BdsMetastoreConfiguration resources in Oracle Cloud Infrastructure

  • Returns a list of metastore configurations ssociated with this Big Data Service cluster.

  • If metastore_config_id is specified, the details of a single BdsMetastoreConfiguration will be returned.

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_ID 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_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_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.
bds_api_key_id
string
The ID of the API key that is associated with the external metastore in the metastore configuration
bds_instance_id
string / required
The OCID of the cluster.
cert_bundle
string
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.
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.
display_name
string
A filter to return only resources that match the entire display name given.

aliases: name
lifecycle_state
string
    Choices:
  • CREATING
  • ACTIVATING
  • ACTIVE
  • INACTIVE
  • UPDATING
  • FAILED
  • DELETING
  • DELETED
The lifecycle state of the metastore in the metastore configuration
metastore_config_id
string
The metastore configuration ID
Required to get a specific bds_metastore_configuration.

aliases: id
metastore_id
string
The OCID of the Data Catalog metastore in the metastore configuration
metastore_type
string
    Choices:
  • LOCAL
  • EXTERNAL
The type of the metastore in the metastore configuration
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.
sort_by
string
    Choices:
  • timeCreated
  • displayName
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
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

Examples

- name: Get a specific bds_metastore_configuration
  oci_bds_metastore_configuration_facts:
    # required
    metastore_config_id: "ocid1.metastoreconfig.oc1..xxxxxxEXAMPLExxxxxx"
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"

- name: List bds_metastore_configurations
  oci_bds_metastore_configuration_facts:
    # required
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    metastore_type: LOCAL
    metastore_id: "ocid1.metastore.oc1..xxxxxxEXAMPLExxxxxx"
    lifecycle_state: CREATING
    bds_api_key_id: "ocid1.bdsapikey.oc1..xxxxxxEXAMPLExxxxxx"
    sort_by: timeCreated
    sort_order: ASC
    display_name: display_name_example

Return Values

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

Key Returned Description
bds_metastore_configurations
complex
on success
List of BdsMetastoreConfiguration resources

Sample:
[{'bds_api_key_id': 'ocid1.bdsapikey.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'metastore_id': 'ocid1.metastore.oc1..xxxxxxEXAMPLExxxxxx', 'metastore_type': 'LOCAL', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
bds_api_key_id
string
on success
The ID of BDS API Key used for metastore configuration. Set only if metastore's type is EXTERNAL.

Sample:
ocid1.bdsapikey.oc1..xxxxxxEXAMPLExxxxxx
 
display_name
string
on success
The display name of metastore configuration

Sample:
display_name_example
 
id
string
on success
The ID of the metastore configuration

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
the lifecycle state of the metastore configuration.

Sample:
CREATING
 
metastore_id
string
on success
The OCID of the Data Catalog metastore. Set only if metastore's type is EXTERNAL.

Sample:
ocid1.metastore.oc1..xxxxxxEXAMPLExxxxxx
 
metastore_type
string
on success
The type of the metastore in the metastore configuration.

Sample:
LOCAL
 
time_created
string
on success
The time when the configuration was created, shown as an RFC 3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)