oracle.oci.oci_oda_digital_assistant_facts – Fetches details about one or multiple DigitalAssistant resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns a page of Digital Assistants that belong to the specified Digital Assistant instance.

  • If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header’s value as the page query parameter.

  • If digital_assistant_id is specified, the details of a single DigitalAssistant 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.
category
string
List only Bot resources with this category.
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.
digital_assistant_id
string
Unique Digital Assistant identifier.
Required to get a specific digital_assistant.

aliases: id
display_name
string
Use display_name along with the other options to return only resources that match the given display name exactly.
lifecycle_details
string
List only Bot resources with this lifecycle details.
lifecycle_state
string
    Choices:
  • CREATING
  • UPDATING
  • ACTIVE
  • INACTIVE
  • DELETING
  • DELETED
  • FAILED
List only the resources that are in this lifecycle state.
name
string
List only Bot resources with this name. Names are unique and may not change.
Example: `MySkill`
namespace
string
List only Bot resources with this namespace. Namespaces may not change.
Example: `MyNamespace`
oda_instance_id
string / required
Unique Digital Assistant instance identifier.
platform_version
string
List only Bot resources with this platform version.
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
  • timeUpdated
  • name
Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`.
The default sort order for `timeCreated` and `timeUpdated` is descending. For all other sort fields the default sort order is ascending.
sort_order
string
    Choices:
  • ASC
  • DESC
Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
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
version
string
List only Bot resources with this version. Versions are unique and may not change.
Example: `1.0`

Examples

- name: Get a specific digital_assistant
  oci_oda_digital_assistant_facts:
    # required
    oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"
    digital_assistant_id: "ocid1.digitalassistant.oc1..xxxxxxEXAMPLExxxxxx"

- name: List digital_assistants
  oci_oda_digital_assistant_facts:
    # required
    oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    digital_assistant_id: "ocid1.digitalassistant.oc1..xxxxxxEXAMPLExxxxxx"
    category: category_example
    name: name_example
    version: version_example
    namespace: namespace_example
    platform_version: platform_version_example
    lifecycle_state: CREATING
    lifecycle_details: lifecycle_details_example
    sort_order: ASC
    sort_by: timeCreated

Return Values

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

Key Returned Description
digital_assistants
complex
on success
List of DigitalAssistant resources

Sample:
[{'base_id': 'ocid1.base.oc1..xxxxxxEXAMPLExxxxxx', 'category': 'category_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'PUBLISHED', 'lifecycle_state': 'CREATING', 'multilingual_mode': 'NATIVE', 'name': 'name_example', 'namespace': 'namespace_example', 'native_language_tags': [], 'platform_version': 'platform_version_example', 'primary_language_tag': 'primary_language_tag_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}]
 
base_id
string
on success
The unique identifier for the base reource (when this resource extends another).
Returned for get operation

Sample:
ocid1.base.oc1..xxxxxxEXAMPLExxxxxx
 
category
string
on success
The resource's category. This is used to group resource's together.

Sample:
category_example
 
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'}}
 
description
string
on success
A short description of the resource.
Returned for get operation

Sample:
description_example
 
display_name
string
on success
The resource's display name.

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

Sample:
{'Department': 'Finance'}
 
id
string
on success
Unique immutable identifier that was assigned when the resource was created.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
The resource's publish state.

Sample:
PUBLISHED
 
lifecycle_state
string
on success
The resource's current state.

Sample:
CREATING
 
multilingual_mode
string
on success
The multilingual mode for the resource.
Returned for get operation

Sample:
NATIVE
 
name
string
on success
The reource's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter.

Sample:
name_example
 
namespace
string
on success
The resource's namespace.

Sample:
namespace_example
 
native_language_tags
list / elements=string
on success
A list of native languages supported by this resource.
Returned for get operation

 
platform_version
string
on success
The ODA Platform Version for this resource.

Sample:
platform_version_example
 
primary_language_tag
string
on success
The primary language for the resource.
Returned for get operation

Sample:
primary_language_tag_example
 
time_created
string
on success
When the resource was created. A date-time string as described in RFC 3339, section 14.29.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.

Sample:
2013-10-20T19:20:30+01:00
 
version
string
on success
The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number.

Sample:
version_example


Authors

  • Oracle (@oracle)