oracle.oci.oci_usage_custom_table_facts – Fetches details about one or multiple CustomTable 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_usage_custom_table_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns the saved custom table list.

  • If custom_table_id is specified, the details of a single CustomTable 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.
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 compartment ID in which to list resources.
Required to list multiple custom_tables.
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.
custom_table_id
string
The custom table unique OCID.
Required to get a specific custom_table.

aliases: id
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.
saved_report_id
string
The saved report ID in which to list resources.
Required to list multiple custom_tables.
sort_by
string
    Choices:
  • displayName
The field to sort by. If not specified, the default is displayName.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, whether '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 custom_table
  oci_usage_custom_table_facts:
    # required
    custom_table_id: "ocid1.customtable.oc1..xxxxxxEXAMPLExxxxxx"

- name: List custom_tables
  oci_usage_custom_table_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    saved_report_id: "ocid1.savedreport.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    sort_by: displayName
    sort_order: ASC

Return Values

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

Key Returned Description
custom_tables
complex
on success
List of CustomTable resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'saved_custom_table': {'column_group_by': [], 'compartment_depth': 10, 'display_name': 'display_name_example', 'group_by_tag': [{'key': 'key_example', 'namespace': 'namespace_example', 'value': 'value_example'}], 'row_group_by': [], 'version': 10}, 'saved_report_id': 'ocid1.savedreport.oc1..xxxxxxEXAMPLExxxxxx'}]
 
compartment_id
string
on success
The custom table compartment OCID.
Returned for get operation

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
id
string
on success
The custom table OCID.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
saved_custom_table
complex
on success

   
column_group_by
list / elements=string
on success
The column groupBy key list. example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]`

   
compartment_depth
float
on success
The compartment depth level.

Sample:
10
   
display_name
string
on success
The name of the custom table.

Sample:
display_name_example
   
group_by_tag
complex
on success
GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only one tag in the list is supported. For example: `[{"namespace":"oracle", "key":"createdBy"]`

     
key
string
on success
The tag key.

Sample:
key_example
     
namespace
string
on success
The tag namespace.

Sample:
namespace_example
     
value
string
on success
The tag value.

Sample:
value_example
   
row_group_by
list / elements=string
on success
The row groupBy key list. example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]`

   
version
float
on success
The version of the custom table.

Sample:
10
 
saved_report_id
string
on success
The custom table associated saved report OCID.
Returned for get operation

Sample:
ocid1.savedreport.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)