oracle.oci.oci_oda_instance_facts – Fetches details about one or multiple OdaInstance resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.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_instance_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple OdaInstance resources in Oracle Cloud Infrastructure
Returns a page of Digital Assistant instances that belong to the specified compartment.
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 oda_instance_id is specified, the details of a single OdaInstance will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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
|
List the Digital Assistant instances that belong to this compartment.
Required to list multiple oda_instances.
|
|
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
|
List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change.
Example: `My new resource`
aliases: name |
|
lifecycle_state
string
|
|
List only the Digital Assistant instances that are in this lifecycle state.
|
oda_instance_id
string
|
Unique Digital Assistant instance identifier.
Required to get a specific oda_instance.
aliases: id |
|
realm_specific_endpoint_template_enabled
boolean
|
|
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.
|
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
|
|
Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`.
The default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending.
|
sort_order
string
|
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific oda_instance
oci_oda_instance_facts:
# required
oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"
- name: List oda_instances
oci_oda_instance_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
lifecycle_state: CREATING
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 | ||
---|---|---|---|---|
oda_instances
complex
|
on success |
List of OdaInstance resources
Sample:
[{'attachment_ids': [], 'attachment_types': [], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connector_url': 'connector_url_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'identity_app_console_url': 'identity_app_console_url_example', 'identity_app_guid': 'identity_app_guid_example', 'identity_domain': 'identity_domain_example', 'imported_package_ids': [], 'imported_package_names': [], 'is_role_based_access': True, 'lifecycle_state': 'CREATING', 'lifecycle_sub_state': 'CREATING', 'restricted_operations': [{'operation_name': 'operation_name_example', 'restricting_service': 'restricting_service_example'}], 'shape_name': 'DEVELOPMENT', 'state_message': 'state_message_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'web_app_url': 'web_app_url_example'}]
|
||
attachment_ids
list
/ elements=string
|
on success |
A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
Returned for get operation
|
||
attachment_types
list
/ elements=string
|
on success |
A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.
|
||
compartment_id
string
|
on success |
Identifier of the compartment that the instance belongs to.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
connector_url
string
|
on success |
URL for the connector's endpoint.
Returned for get operation
Sample:
connector_url_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 |
Description of the Digital Assistant instance.
Sample:
description_example
|
||
display_name
string
|
on success |
User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
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 instance was created.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
identity_app_console_url
string
|
on success |
If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain.
Returned for get operation
Sample:
identity_app_console_url_example
|
||
identity_app_guid
string
|
on success |
If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this Digital Assistant instance for users within the identity domain.
Returned for get operation
Sample:
identity_app_guid_example
|
||
identity_domain
string
|
on success |
If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain.
Sample:
identity_domain_example
|
||
imported_package_ids
list
/ elements=string
|
on success |
A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
Returned for get operation
|
||
imported_package_names
list
/ elements=string
|
on success |
A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.
|
||
is_role_based_access
boolean
|
on success |
Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false)
Sample:
True
|
||
lifecycle_state
string
|
on success |
The current state of the Digital Assistant instance.
Sample:
CREATING
|
||
lifecycle_sub_state
string
|
on success |
The current sub-state of the Digital Assistant instance.
Sample:
CREATING
|
||
restricted_operations
complex
|
on success |
A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
Returned for get operation
|
||
operation_name
string
|
on success |
Name of the restricted operation.
Sample:
operation_name_example
|
||
restricting_service
string
|
on success |
Name of the service restricting the operation.
Sample:
restricting_service_example
|
||
shape_name
string
|
on success |
Shape or size of the instance.
Sample:
DEVELOPMENT
|
||
state_message
string
|
on success |
A message that describes the current state in more detail. For example, actionable information about an instance that's in the `FAILED` state.
Sample:
state_message_example
|
||
time_created
string
|
on success |
When the Digital Assistant instance 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 Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
Sample:
2013-10-20T19:20:30+01:00
|
||
web_app_url
string
|
on success |
URL for the Digital Assistant web application that's associated with the instance.
Returned for get operation
Sample:
web_app_url_example
|
Authors¶
Oracle (@oracle)