oracle.oci.oci_cloud_migrations_migration_plan – Manage a MigrationPlan 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_plan.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a migration plan.

  • This resource has the following action operations in the oracle.oci.oci_cloud_migrations_migration_plan_actions module: change_compartment, execute, import_migration_plan, refresh.

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
Compartment identifier
Required for create using state=present.
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
display_name
string
Migration plan identifier
Required for create using state=present.
Required for 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.
freeform_tags
dictionary
Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}`
This parameter is updatable.
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_id
string
The OCID of the associated migration.
Required for create using state=present.
migration_plan_id
string
Unique migration plan 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
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.
source_migration_plan_id
string
Source migraiton plan ID to be cloned.
state
string
    Choices:
  • present ←
  • absent
The state of the MigrationPlan.
Use state=present to create or update a MigrationPlan.
Use state=absent to delete a MigrationPlan.
strategies
list / elements=dictionary
List of strategies for the resources to be migrated.
This parameter is updatable.
adjustment_multiplier
float
The real resource usage is multiplied to this number before making any recommendation.
metric_time_window
string
    Choices:
  • 1d
  • 7d
  • 30d
The current state of the migration plan.
Applicable when strategy_type is one of ['AVERAGE', 'PEAK', 'PERCENTILE']
metric_type
string
    Choices:
  • AUTO
  • HISTORICAL
  • RUNTIME
The current state of the migration plan.
Applicable when strategy_type is one of ['AVERAGE', 'PEAK']
percentile
string
    Choices:
  • P50
  • P90
  • P95
  • P99
Percentile value
Required when strategy_type is 'PERCENTILE'
resource_type
string / required
    Choices:
  • CPU
  • MEMORY
  • ALL
The type of resource.
strategy_type
string / required
    Choices:
  • PEAK
  • PERCENTILE
  • AVERAGE
  • AS_IS
The type of strategy used for migration.
target_environments
list / elements=dictionary
List of target environments.
This parameter is updatable.
availability_domain
string
Availability Domain of the VM configuration.
dedicated_vm_host
string
OCID of the dedicated VM configuration host.
fault_domain
string
Fault domain of the VM configuration.
ms_license
string
Microsoft license for the VM configuration.
preferred_shape_type
string
Preferred VM shape type provided by the customer.
subnet
string / required
OCID of the VM configuration subnet.
target_compartment_id
string
Target compartment identifier
target_environment_type
string / required
    Choices:
  • VM_TARGET_ENV
The type of target environment.
vcn
string / required
OCID of the VM configuration VCN.
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_plan
  oci_cloud_migrations_migration_plan:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    migration_id: "ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    source_migration_plan_id: "ocid1.sourcemigrationplan.oc1..xxxxxxEXAMPLExxxxxx"
    strategies:
    - # required
      resource_type: CPU
      strategy_type: PEAK

      # optional
      metric_type: AUTO
      metric_time_window: 1d
      adjustment_multiplier: 3.4
    target_environments:
    - # required
      target_environment_type: VM_TARGET_ENV
      vcn: vcn_example
      subnet: subnet_example

      # optional
      target_compartment_id: "ocid1.targetcompartment.oc1..xxxxxxEXAMPLExxxxxx"
      availability_domain: Uocm:PHX-AD-1
      fault_domain: FAULT-DOMAIN-1
      dedicated_vm_host: dedicated_vm_host_example
      ms_license: ms_license_example
      preferred_shape_type: preferred_shape_type_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update migration_plan
  oci_cloud_migrations_migration_plan:
    # required
    migration_plan_id: "ocid1.migrationplan.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    strategies:
    - # required
      resource_type: CPU
      strategy_type: PEAK

      # optional
      metric_type: AUTO
      metric_time_window: 1d
      adjustment_multiplier: 3.4
    target_environments:
    - # required
      target_environment_type: VM_TARGET_ENV
      vcn: vcn_example
      subnet: subnet_example

      # optional
      target_compartment_id: "ocid1.targetcompartment.oc1..xxxxxxEXAMPLExxxxxx"
      availability_domain: Uocm:PHX-AD-1
      fault_domain: FAULT-DOMAIN-1
      dedicated_vm_host: dedicated_vm_host_example
      ms_license: ms_license_example
      preferred_shape_type: preferred_shape_type_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

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

    # optional
    strategies:
    - # required
      resource_type: CPU
      strategy_type: PEAK

      # optional
      metric_type: AUTO
      metric_time_window: 1d
      adjustment_multiplier: 3.4
    target_environments:
    - # required
      target_environment_type: VM_TARGET_ENV
      vcn: vcn_example
      subnet: subnet_example

      # optional
      target_compartment_id: "ocid1.targetcompartment.oc1..xxxxxxEXAMPLExxxxxx"
      availability_domain: Uocm:PHX-AD-1
      fault_domain: FAULT-DOMAIN-1
      dedicated_vm_host: dedicated_vm_host_example
      ms_license: ms_license_example
      preferred_shape_type: preferred_shape_type_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete migration_plan
  oci_cloud_migrations_migration_plan:
    # required
    migration_plan_id: "ocid1.migrationplan.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete migration_plan using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_cloud_migrations_migration_plan:
    # 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_plan
complex
on success
Details of the MigrationPlan resource acted upon by the current operation

Sample:
{'calculated_limits': {}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'migration_id': 'ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx', 'migration_plan_stats': {'time_updated': '2013-10-20T19:20:30+01:00', 'total_estimated_cost': {'compute': {'gpu_count': 10, 'gpu_per_hour': 10, 'gpu_per_hour_by_subscription': 10, 'memory_amount_gb': 10, 'memory_gb_per_hour': 10, 'memory_gb_per_hour_by_subscription': 10, 'ocpu_count': 10, 'ocpu_per_hour': 10, 'ocpu_per_hour_by_subscription': 10, 'total_per_hour': 10, 'total_per_hour_by_subscription': 10}, 'currency_code': 'currency_code_example', 'os_image': {'total_per_hour': 10, 'total_per_hour_by_subscription': 10}, 'storage': {'total_gb_per_month': 10, 'total_gb_per_month_by_subscription': 10, 'volumes': [{'capacity_gb': 10, 'description': 'description_example', 'total_gb_per_month': 10, 'total_gb_per_month_by_subscription': 10}]}, 'subscription_id': 'ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx', 'total_estimation_per_month': 10, 'total_estimation_per_month_by_subscription': 10}, 'vm_count': 56}, 'reference_to_rms_stack': 'reference_to_rms_stack_example', 'source_migration_plan_id': 'ocid1.sourcemigrationplan.oc1..xxxxxxEXAMPLExxxxxx', 'strategies': [{'adjustment_multiplier': 3.4, 'metric_time_window': '1d', 'metric_type': 'AUTO', 'percentile': 'P50', 'resource_type': 'CPU', 'strategy_type': 'AS_IS'}], 'system_tags': {}, 'target_environments': [{'availability_domain': 'Uocm:PHX-AD-1', 'dedicated_vm_host': 'dedicated_vm_host_example', 'fault_domain': 'FAULT-DOMAIN-1', 'ms_license': 'ms_license_example', 'preferred_shape_type': 'preferred_shape_type_example', 'subnet': 'subnet_example', 'target_compartment_id': 'ocid1.targetcompartment.oc1..xxxxxxEXAMPLExxxxxx', 'target_environment_type': 'VM_TARGET_ENV', 'vcn': 'vcn_example'}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
calculated_limits
dictionary
on success
Limits of the resources that are needed for migration. Example: {"BlockVolume": 2, "VCN": 1}

 
compartment_id
string
on success
The OCID of the compartment containing the migration plan.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
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
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The unique Oracle ID (OCID) that is immutable on creation.

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 plan.

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

Sample:
ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx
 
migration_plan_stats
complex
on success

   
time_updated
string
on success
The time when the migration plan was calculated. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
   
total_estimated_cost
complex
on success

     
compute
complex
on success

       
gpu_count
float
on success
Total number of GPU

Sample:
10
       
gpu_per_hour
float
on success
GPU per hour

Sample:
10
       
gpu_per_hour_by_subscription
float
on success
GPU per hour by subscription

Sample:
10
       
memory_amount_gb
float
on success
Total usage of memory

Sample:
10
       
memory_gb_per_hour
float
on success
Gigabyte per hour

Sample:
10
       
memory_gb_per_hour_by_subscription
float
on success
Gigabyte per hour by subscription

Sample:
10
       
ocpu_count
float
on success
Total number of OCPUs

Sample:
10
       
ocpu_per_hour
float
on success
OCPU per hour

Sample:
10
       
ocpu_per_hour_by_subscription
float
on success
OCPU per hour by subscription

Sample:
10
       
total_per_hour
float
on success
Total per hour

Sample:
10
       
total_per_hour_by_subscription
float
on success
Total usage per hour by subscription

Sample:
10
     
currency_code
string
on success
Currency code in the ISO format.

Sample:
currency_code_example
     
os_image
complex
on success

       
total_per_hour
float
on success
Total price per hour

Sample:
10
       
total_per_hour_by_subscription
float
on success
Total price per hour by subscription

Sample:
10
     
storage
complex
on success

       
total_gb_per_month
float
on success
Gigabyte storage capacity per month.

Sample:
10
       
total_gb_per_month_by_subscription
float
on success
Gigabyte storage capacity per month by subscription.

Sample:
10
       
volumes
complex
on success
Volume estimation

         
capacity_gb
float
on success
Gigabyte storage capacity

Sample:
10
         
description
string
on success
Volume description

Sample:
description_example
         
total_gb_per_month
float
on success
Gigabyte storage capacity per month.

Sample:
10
         
total_gb_per_month_by_subscription
float
on success
Gigabyte storage capacity per month by subscription

Sample:
10
     
subscription_id
string
on success
Subscription ID

Sample:
ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx
     
total_estimation_per_month
float
on success
Total estimation per month

Sample:
10
     
total_estimation_per_month_by_subscription
float
on success
Total estimation per month by subscription.

Sample:
10
   
vm_count
integer
on success
The total count of VMs in migration

Sample:
56
 
reference_to_rms_stack
string
on success
OCID of the referenced ORM job.

Sample:
reference_to_rms_stack_example
 
source_migration_plan_id
string
on success
Source migraiton plan ID to be cloned.

Sample:
ocid1.sourcemigrationplan.oc1..xxxxxxEXAMPLExxxxxx
 
strategies
complex
on success
List of strategies for the resources to be migrated.

   
adjustment_multiplier
float
on success
The real resource usage is multiplied to this number before making any recommendation.

Sample:
3.4
   
metric_time_window
string
on success
The current state of the migration plan.

Sample:
1d
   
metric_type
string
on success
The current state of the migration plan.

Sample:
AUTO
   
percentile
string
on success
Percentile value

Sample:
P50
   
resource_type
string
on success
The type of resource.

Sample:
CPU
   
strategy_type
string
on success
The type of strategy used for migration.

Sample:
AS_IS
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

 
target_environments
complex
on success
List of target environments.

   
availability_domain
string
on success
Availability Domain of the VM configuration.

Sample:
Uocm:PHX-AD-1
   
dedicated_vm_host
string
on success
OCID of the dedicated VM configuration host.

Sample:
dedicated_vm_host_example
   
fault_domain
string
on success
Fault domain of the VM configuration.

Sample:
FAULT-DOMAIN-1
   
ms_license
string
on success
Microsoft license for the VM configuration.

Sample:
ms_license_example
   
preferred_shape_type
string
on success
Preferred VM shape type provided by the customer.

Sample:
preferred_shape_type_example
   
subnet
string
on success
OCID of the VM configuration subnet.

Sample:
subnet_example
   
target_compartment_id
string
on success
Target compartment identifier

Sample:
ocid1.targetcompartment.oc1..xxxxxxEXAMPLExxxxxx
   
target_environment_type
string
on success
The type of target environment.

Sample:
VM_TARGET_ENV
   
vcn
string
on success
OCID of the VM configuration VCN.

Sample:
vcn_example
 
time_created
string
on success
The time when the migration plan 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 plan was updated. An RFC3339 formatted datetime string.

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


Authors

  • Oracle (@oracle)