oracle.oci.oci_data_catalog_catalog_actions – Perform actions on a Catalog resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.13.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_data_catalog_catalog_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a Catalog resource in Oracle Cloud Infrastructure

  • For action=attach_catalog_private_endpoint, attaches a private reverse connection endpoint resource to a data catalog resource. When provided, ‘If- Match’ is checked against ‘ETag’ values of the resource.

  • For action=change_compartment, moves a resource into a different compartment. When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.

  • For action=detach_catalog_private_endpoint, detaches a private reverse connection endpoint resource to a data catalog resource. When provided, ‘If- Match’ is checked against ‘ETag’ values of the resource.

  • For action=object_stats, returns stats on objects by type in the repository.

  • For action=users, returns active users in the system.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • attach_catalog_private_endpoint
  • change_compartment
  • detach_catalog_private_endpoint
  • object_stats
  • users
The action to perform on the Catalog.
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.
catalog_id
string / required
Unique catalog identifier.

aliases: id
catalog_private_endpoint_id
string
The identifier of the private endpoint to be attached to the catalog resource.
Required for action=attach_catalog_private_endpoint, action=detach_catalog_private_endpoint.
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.
compartment_id
string
The identifier of the compartment where the resource should be moved.
Required for action=change_compartment.
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.
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.
Applicable only for action=object_statsaction=users.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
Applicable only for action=object_statsaction=users.
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
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Perform action attach_catalog_private_endpoint on catalog
  oci_data_catalog_catalog_actions:
    # required
    catalog_private_endpoint_id: "ocid1.catalogprivateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    action: attach_catalog_private_endpoint

- name: Perform action change_compartment on catalog
  oci_data_catalog_catalog_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

- name: Perform action detach_catalog_private_endpoint on catalog
  oci_data_catalog_catalog_actions:
    # required
    catalog_private_endpoint_id: "ocid1.catalogprivateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    action: detach_catalog_private_endpoint

- name: Perform action object_stats on catalog
  oci_data_catalog_catalog_actions:
    # required
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    action: object_stats

    # optional
    sort_by: TIMECREATED
    sort_order: ASC

- name: Perform action users on catalog
  oci_data_catalog_catalog_actions:
    # required
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    action: users

    # optional
    sort_by: TIMECREATED
    sort_order: ASC

Return Values

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

Key Returned Description
catalog
complex
on success
Details of the Catalog resource acted upon by the current operation

Sample:
{'attached_catalog_private_endpoints': [], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', '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': 'CREATING', 'number_of_objects': 56, 'service_api_url': 'service_api_url_example', 'service_console_url': 'service_console_url_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
attached_catalog_private_endpoints
list / elements=string
on success
The list of private reverse connection endpoints attached to the catalog
 
compartment_id
string
on success
Compartment identifier.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
Data catalog identifier, which can be renamed.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
OCID of the data catalog instance.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the data catalog resource.

Sample:
CREATING
 
number_of_objects
integer
on success
The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.

Sample:
56
 
service_api_url
string
on success
The REST front endpoint URL to the data catalog instance.

Sample:
service_api_url_example
 
service_console_url
string
on success
The console front endpoint URL to the data catalog instance.

Sample:
service_console_url_example
 
time_created
string
on success
The time the data catalog was created. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the data catalog was updated. An RFC3339 formatted datetime string.

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


Authors

  • Oracle (@oracle)