oracle.oci.oci_application_migration_source_facts – Fetches details about one or multiple Source 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_application_migration_source_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Retrieves details of all the sources that are available in the specified compartment and match the specified query criteria. If you don’t specify any query criteria, then details of all the sources are displayed. To filter the retrieved results, you can pass one or more of the following query parameters, by appending them to the URI as shown in the following example.

  • If source_id is specified, the details of a single Source 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 OCID of a compartment. Retrieves details of objects in the specified compartment.
Required to list multiple sources.
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
Display name on which to query.

aliases: name
lifecycle_state
string
    Choices:
  • CREATING
  • DELETING
  • UPDATING
  • ACTIVE
  • INACTIVE
  • DELETED
Retrieves details of sources in the specified lifecycle state.
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
Specifies the field on which to sort. By default, `TIMECREATED` is ordered descending. By default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order, either `ASC` (ascending) or `DESC` (descending).
source_id
string
The OCID of the source.
Required to get a specific source.

aliases: id
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 source
  oci_application_migration_source_facts:
    # required
    source_id: "ocid1.source.oc1..xxxxxxEXAMPLExxxxxx"

- name: List sources
  oci_application_migration_source_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    sort_order: ASC
    sort_by: TIMECREATED
    display_name: display_name_example
    lifecycle_state: CREATING

Return Values

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

Key Returned Description
sources
complex
on success
List of Source resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'source_details': {'account_name': 'account_name_example', 'bucket': 'bucket_example', 'compute_account': 'compute_account_example', 'manifest': {'export_details': {}, 'export_type': 'export_type_example', 'md5': 'md5_example', 'signature': 'signature_example', 'timestamp': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}, 'namespace': 'namespace_example', 'object_name': 'object_name_example', 'region': 'us-phoenix-1', 'type': 'OCIC'}, 'time_created': '2013-10-20T19:20:30+01:00', 'type': 'OCIC'}]
 
compartment_id
string
on success
The OCID of the compartment that contains the source.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
Description of the source. This helps you to identify the appropriate source environment when you have multiple sources defined.

Sample:
description_example
 
display_name
string
on success
Name of the source. This helps you to identify the appropriate source environment when you have multiple sources defined.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the source.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
Details about the current lifecycle state of the source.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the source.

Sample:
CREATING
 
source_details
complex
on success
Returned for get operation

   
account_name
string
on success
The identity domain ID of your traditional Oracle Cloud Infrastructure - Classic account.

Sample:
account_name_example
   
bucket
string
on success
the bucket wherein the export archive exists in object storage

Sample:
bucket_example
   
compute_account
string
on success
If you are using an Oracle Cloud@Customer account with Identity Cloud Service (IDCS), enter the service instance ID. For example, if Compute-567890123 is the account name of your Oracle Cloud@Customer Compute service entitlement, then enter 567890123.

Sample:
compute_account_example
   
manifest
complex
on success

     
export_details
dictionary
on success
application specific details as parsed from various sources of the application that was exported

     
export_type
string
on success
the type of application that the export tool was executed against to generate this manifest

Sample:
export_type_example
     
md5
string
on success
the MD5 hash of the export artifact archive that was produced by the export tool and should be used with this manifest

Sample:
md5_example
     
signature
string
on success
a sha1 hash of all the fields of this manifest (excluding the signature)

Sample:
signature_example
     
timestamp
string
on success
when this manifest was generated

Sample:
2013-10-20T19:20:30+01:00
     
version
string
on success
the version of the export tool that was used to generate the manifest

Sample:
version_example
   
namespace
string
on success
the object storage namespace where the bucket and uploaded object resides

Sample:
namespace_example
   
object_name
string
on success
the name of the archive as it exists in object storage

Sample:
object_name_example
   
region
string
on success
The Oracle Cloud Infrastructure - Classic region from which you want to migrate your applications. For example, uscom-east-1 or uscom-central-1.

Sample:
us-phoenix-1
   
type
string
on success
The type of source environment.

Sample:
OCIC
 
time_created
string
on success
The date and time at which the source was created, in the format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
type
string
on success
The type of source environment.
Returned for list operation

Sample:
OCIC


Authors

  • Oracle (@oracle)