oracle.oci.oci_oda_instance_attachment_facts – Fetches details about one or multiple OdaInstanceAttachment resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns a list of ODA instance attachments

  • If attachment_id is specified, the details of a single OdaInstanceAttachment 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).
attachment_id
string
Unique Digital Assistant instance attachment identifier.
Required to get a specific oda_instance_attachment.

aliases: id
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.
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.
include_owner_metadata
boolean
    Choices:
  • no
  • yes
Whether to send attachment owner info during get/list call.
lifecycle_state
string
    Choices:
  • ATTACHING
  • ACTIVE
  • DETACHING
  • INACTIVE
  • FAILED
List only the ODA instance attachments that are in this lifecycle state.
oda_instance_id
string / required
Unique Digital Assistant instance identifier.
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
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.
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

Examples

- name: Get a specific oda_instance_attachment
  oci_oda_instance_attachment_facts:
    # required
    attachment_id: "ocid1.attachment.oc1..xxxxxxEXAMPLExxxxxx"
    oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    include_owner_metadata: true

- name: List oda_instance_attachments
  oci_oda_instance_attachment_facts:
    # required
    oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    include_owner_metadata: true
    lifecycle_state: ATTACHING
    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_instance_attachments
complex
on success
List of OdaInstanceAttachment resources

Sample:
[{'attach_to_id': 'ocid1.attachto.oc1..xxxxxxEXAMPLExxxxxx', 'attachment_metadata': 'attachment_metadata_example', 'attachment_type': 'FUSION', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'instance_id': 'ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ATTACHING', 'owner': {'owner_service_name': 'owner_service_name_example', 'owner_service_tenancy': 'owner_service_tenancy_example'}, 'restricted_operations': [], 'time_created': '2013-10-20T19:20:30+01:00', 'time_last_update': '2013-10-20T19:20:30+01:00'}]
 
attach_to_id
string
on success
The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which the ODA instance is or is being attached.

Sample:
ocid1.attachto.oc1..xxxxxxEXAMPLExxxxxx
 
attachment_metadata
string
on success
Attachment-specific metadata, defined by the target service.

Sample:
attachment_metadata_example
 
attachment_type
string
on success
The type of attachment defined as an enum.

Sample:
FUSION
 
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'}}
 
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 ODA instance attachment was created.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
instance_id
string
on success
The OCID of the ODA instance to which the attachment applies.

Sample:
ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the attachment.

Sample:
ATTACHING
 
owner
complex
on success

   
owner_service_name
string
on success
Name of the owner service principal

Sample:
owner_service_name_example
   
owner_service_tenancy
string
on success
Tenancy OCID of the owner service principal

Sample:
owner_service_tenancy_example
 
restricted_operations
list / elements=string
on success
List of operation names that are restricted while this ODA instance is attached.

 
time_created
string
on success
The time the attachment was created. An RFC3339 formatted datetime string

Sample:
2013-10-20T19:20:30+01:00
 
time_last_update
string
on success
The time the attachment was last modified. An RFC3339 formatted datetime string

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


Authors

  • Oracle (@oracle)