oracle.oci.oci_cloud_migrations_migration_asset – Manage a MigrationAsset resource 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.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a MigrationAsset resource in Oracle Cloud Infrastructure

  • For state=present, creates a migration asset.

  • This resource has the following action operations in the oracle.oci.oci_cloud_migrations_migration_asset_actions module: refresh, start_asset_replication.

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.
availability_domain
string
Availability domain
Required for create using state=present.
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.
depends_on
list / elements=string
List of migration assets that depends on this asset.
This parameter is updatable.
display_name
string
A user-friendly name. If empty, then source asset name will be used. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
inventory_asset_id
string
OCID of an asset for an inventory.
Required for create using state=present.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
migration_asset_id
string
Unique migration asset identifier
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
migration_id
string
OCID of the associated migration.
Required for create using state=present.
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.
replication_compartment_id
string
Replication compartment identifier
Required for create using state=present.
replication_schedule_id
string
Replication schedule identifier
This parameter is updatable.
snap_shot_bucket_name
string
Name of snapshot bucket
Required for create using state=present.
state
string
    Choices:
  • present ←
  • absent
The state of the MigrationAsset.
Use state=present to create or update a MigrationAsset.
Use state=absent to delete a MigrationAsset.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create migration_asset
  oci_cloud_migrations_migration_asset:
    # required
    inventory_asset_id: "ocid1.inventoryasset.oc1..xxxxxxEXAMPLExxxxxx"
    migration_id: "ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx"
    availability_domain: Uocm:PHX-AD-1
    replication_compartment_id: "ocid1.replicationcompartment.oc1..xxxxxxEXAMPLExxxxxx"
    snap_shot_bucket_name: snap_shot_bucket_name_example

    # optional
    display_name: display_name_example
    replication_schedule_id: "ocid1.replicationschedule.oc1..xxxxxxEXAMPLExxxxxx"
    depends_on: [ "depends_on_example" ]

- name: Update migration_asset
  oci_cloud_migrations_migration_asset:
    # required
    migration_asset_id: "ocid1.migrationasset.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    replication_schedule_id: "ocid1.replicationschedule.oc1..xxxxxxEXAMPLExxxxxx"
    depends_on: [ "depends_on_example" ]

- name: Update migration_asset using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_cloud_migrations_migration_asset:
    # required
    display_name: display_name_example

    # optional
    replication_schedule_id: "ocid1.replicationschedule.oc1..xxxxxxEXAMPLExxxxxx"
    depends_on: [ "depends_on_example" ]

- name: Delete migration_asset
  oci_cloud_migrations_migration_asset:
    # required
    migration_asset_id: "ocid1.migrationasset.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete migration_asset using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_cloud_migrations_migration_asset:
    # required
    display_name: display_name_example
    state: absent

Return Values

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

Key Returned Description
migration_asset
complex
on success
Details of the MigrationAsset resource acted upon by the current operation

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', '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

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

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

Sample:
snap_shot_bucket_name_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)