oracle.oci.oci_application_migration_migration_facts – Fetches details about one or multiple Migration 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_application_migration_migration_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple Migration resources in Oracle Cloud Infrastructure
Retrieves details of all the migrations that are available in the specified compartment.
If migration_id is specified, the details of a single Migration 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
|
The OCID of a compartment. Retrieves details of objects in the specified compartment.
Required to list multiple migrations.
|
|
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
|
|
This field is not supported. Do not use.
|
migration_id
string
|
The OCID of the migration.
Required to get a specific migration.
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. |
|
sort_by
string
|
|
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
|
|
The sort order, 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 migration
oci_application_migration_migration_facts:
# required
migration_id: "ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx"
- name: List migrations
oci_application_migration_migration_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 | |||
---|---|---|---|---|---|
migrations
complex
|
on success |
List of Migration resources
Sample:
[{'application_config': {'description': 'description_example', 'group': 'group_example', 'is_mutable': True, 'is_required': True, 'name': 'name_example', 'resource_list': [{'group': 'group_example', 'name': 'name_example', 'type': 'type_example', 'value': 'value_example'}], 'type': 'type_example', 'value': 'value_example'}, 'application_name': 'application_name_example', 'application_type': 'JCS', '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', 'is_selective_migration': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'migration_state': 'DISCOVERING_APPLICATION', 'pre_created_target_database_type': 'DATABASE_SYSTEM', 'service_config': {'description': 'description_example', 'group': 'group_example', 'is_mutable': True, 'is_required': True, 'name': 'name_example', 'resource_list': [{'group': 'group_example', 'name': 'name_example', 'type': 'type_example', 'value': 'value_example'}], 'type': 'type_example', 'value': 'value_example'}, 'source_id': 'ocid1.source.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00'}]
|
|||
application_config
complex
|
on success |
Configuration required to migrate the application. In addition to the key and value, additional fields are provided to describe type type and purpose of each field. Only the value for each key is required when passing configuration to the CreateMigration operation.
Returned for get operation
|
|||
description
string
|
on success |
Help text to guide the user in setting the configuration value.
Sample:
description_example
|
|||
group
string
|
on success |
The name of the group to which this field belongs, if any.
Sample:
group_example
|
|||
is_mutable
boolean
|
on success |
Indicates whether or not the field may be modified (defaults to `true`).
Sample:
True
|
|||
is_required
boolean
|
on success |
Indicates whether or not the field is required (defaults to `true`).
Sample:
True
|
|||
name
string
|
on success |
The name of the configuration field.
Sample:
name_example
|
|||
resource_list
complex
|
on success |
A list of resources associated with a specific configuration object.
|
|||
group
string
|
on success |
The name of the group to which this field belongs to.
Sample:
group_example
|
|||
name
string
|
on success |
The display name of the resource field.
Sample:
name_example
|
|||
type
string
|
on success |
The type of the resource field.
Sample:
type_example
|
|||
value
string
|
on success |
The value of the field.
Sample:
value_example
|
|||
type
string
|
on success |
The type of the configuration field.
Sample:
type_example
|
|||
value
string
|
on success |
The value of the field.
Sample:
value_example
|
|||
application_name
string
|
on success |
Name of the application which is being migrated. This is the name of the application in the source environment.
Sample:
application_name_example
|
|||
application_type
string
|
on success |
The type of application being migrated.
Sample:
JCS
|
|||
compartment_id
string
|
on success |
The OCID of the compartment that contains the migration.
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 migration.
Sample:
description_example
|
|||
display_name
string
|
on success |
User-friendly name of the migration.
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 migration.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
is_selective_migration
boolean
|
on success |
If set to `true`, Application Migration migrates only the application resources that you specify. If set to `false`, Application Migration migrates the entire application. When you migrate the entire application, all the application resources are migrated to the target environment. You can selectively migrate resources only for the Oracle Integration Cloud and Oracle Integration Cloud Service applications.
Returned for get operation
Sample:
True
|
|||
lifecycle_details
string
|
on success |
Details about the current lifecycle state of the migration.
Sample:
lifecycle_details_example
|
|||
lifecycle_state
string
|
on success |
The current state of the migration.
Sample:
CREATING
|
|||
migration_state
string
|
on success |
The current state of the overall migration process.
Sample:
DISCOVERING_APPLICATION
|
|||
pre_created_target_database_type
string
|
on success |
The pre-existing database type to be used in this migration. Currently, Application migration only supports Oracle Cloud Infrastructure databases and this option is currently available only for `JAVA_CLOUD_SERVICE` and `WEBLOGIC_CLOUD_SERVICE` target instance types.
Returned for get operation
Sample:
DATABASE_SYSTEM
|
|||
service_config
complex
|
on success |
Configuration required to migrate the application. In addition to the key and value, additional fields are provided to describe type type and purpose of each field. Only the value for each key is required when passing configuration to the CreateMigration operation.
Returned for get operation
|
|||
description
string
|
on success |
Help text to guide the user in setting the configuration value.
Sample:
description_example
|
|||
group
string
|
on success |
The name of the group to which this field belongs, if any.
Sample:
group_example
|
|||
is_mutable
boolean
|
on success |
Indicates whether or not the field may be modified (defaults to `true`).
Sample:
True
|
|||
is_required
boolean
|
on success |
Indicates whether or not the field is required (defaults to `true`).
Sample:
True
|
|||
name
string
|
on success |
The name of the configuration field.
Sample:
name_example
|
|||
resource_list
complex
|
on success |
A list of resources associated with a specific configuration object.
|
|||
group
string
|
on success |
The name of the group to which this field belongs to.
Sample:
group_example
|
|||
name
string
|
on success |
The display name of the resource field.
Sample:
name_example
|
|||
type
string
|
on success |
The type of the resource field.
Sample:
type_example
|
|||
value
string
|
on success |
The value of the field.
Sample:
value_example
|
|||
type
string
|
on success |
The type of the configuration field.
Sample:
type_example
|
|||
value
string
|
on success |
The value of the field.
Sample:
value_example
|
|||
source_id
string
|
on success |
The OCID of the source with which this migration is associated.
Sample:
ocid1.source.oc1..xxxxxxEXAMPLExxxxxx
|
|||
time_created
string
|
on success |
The date and time at which the migration was created, in the format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)