oracle.oci.oci_cloud_migrations_migration_asset_facts – Fetches details about one or multiple MigrationAsset 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_cloud_migrations_migration_asset_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns a list of migration assets.

  • If migration_asset_id is specified, the details of a single MigrationAsset 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.
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
A filter to return only resources that match the entire given display name.

aliases: name
lifecycle_state
string
    Choices:
  • CREATING
  • UPDATING
  • NEEDS_ATTENTION
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
The current state of the migration asset.
migration_asset_id
string
Unique migration asset identifier
Required to get a specific migration_asset.

aliases: id
migration_id
string
Unique migration 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
  • displayName
The field to sort by. Only one sort order can be provided. The default order for 'timeCreated' is descending. The default order for 'displayName' is ascending.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'ASC' or 'DESC'.
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 migration_asset
  oci_cloud_migrations_migration_asset_facts:
    # required
    migration_asset_id: "ocid1.migrationasset.oc1..xxxxxxEXAMPLExxxxxx"

- name: List migration_assets
  oci_cloud_migrations_migration_asset_facts:

    # optional
    migration_id: "ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    migration_asset_id: "ocid1.migrationasset.oc1..xxxxxxEXAMPLExxxxxx"
    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
migration_assets
complex
on success
List of MigrationAsset resources

Sample:
[{'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'depended_on_by': [], 'depends_on': [], 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'migration_id': 'ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx', 'notifications': [], 'parent_snapshot': 'parent_snapshot_example', 'replication_compartment_id': 'ocid1.replicationcompartment.oc1..xxxxxxEXAMPLExxxxxx', 'replication_schedule_id': 'ocid1.replicationschedule.oc1..xxxxxxEXAMPLExxxxxx', 'snap_shot_bucket_name': 'snap_shot_bucket_name_example', 'snapshot_info': 'snapshot_info_example', 'snapshots': {'unmodified_volume_id': 'ocid1.unmodifiedvolume.oc1..xxxxxxEXAMPLExxxxxx', 'uuid': 'uuid_example', 'volume_id': 'ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx', 'volume_type': 'BOOT'}, 'source_asset_data': {}, 'source_asset_id': 'ocid1.sourceasset.oc1..xxxxxxEXAMPLExxxxxx', 'tenancy_id': 'ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'type_example'}]
 
availability_domain
string
on success
Availability domain
Returned for get operation

Sample:
Uocm:PHX-AD-1
 
compartment_id
string
on success
Compartment Identifier

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
depended_on_by
list / elements=string
on success
List of migration assets that depend on the asset.

 
depends_on
list / elements=string
on success
List of migration assets that depends on the asset.

 
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
id
string
on success
Asset ID generated by mirgration service. It is used in the mirgration service pipeline.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

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

Sample:
CREATING
 
migration_id
string
on success
OCID of the associated migration.

Sample:
ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx
 
notifications
list / elements=string
on success
List of notifications

 
parent_snapshot
string
on success
The parent snapshot of the migration asset to be used by the replication task.

Sample:
parent_snapshot_example
 
replication_compartment_id
string
on success
Replication compartment identifier
Returned for get operation

Sample:
ocid1.replicationcompartment.oc1..xxxxxxEXAMPLExxxxxx
 
replication_schedule_id
string
on success
Replication schedule identifier

Sample:
ocid1.replicationschedule.oc1..xxxxxxEXAMPLExxxxxx
 
snap_shot_bucket_name
string
on success
Name of snapshot bucket
Returned for get operation

Sample:
snap_shot_bucket_name_example
 
snapshot_info
string
on success
The snapshot information.
Returned for list operation

Sample:
snapshot_info_example
 
snapshots
complex
on success
Key-value pair representing disks ID mapped to the OCIDs of replicated or hydration server volume snapshots. Example: `{"bar-key": "value"}`

   
unmodified_volume_id
string
on success
ID of the unmodified volume

Sample:
ocid1.unmodifiedvolume.oc1..xxxxxxEXAMPLExxxxxx
   
uuid
string
on success
ID of the vCenter disk obtained from Inventory.

Sample:
uuid_example
   
volume_id
string
on success
ID of the hydration server volume

Sample:
ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx
   
volume_type
string
on success
The hydration server volume type

Sample:
BOOT
 
source_asset_data
dictionary
on success
Key-value pair representing asset metadata keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

 
source_asset_id
string
on success
OCID that is referenced to an asset for an inventory.

Sample:
ocid1.sourceasset.oc1..xxxxxxEXAMPLExxxxxx
 
tenancy_id
string
on success
Tenancy identifier

Sample:
ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The time when the migration asset was created. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time when the migration asset was updated. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
type
string
on success
The type of asset referenced for inventory.

Sample:
type_example


Authors

  • Oracle (@oracle)