NEW - You can now accelerate your migration and modernization with AWS Transform. Read Getting Started in the AWS Transform User Guide.
Inventory Import parameters
The imported file can include multiple parameters, including:
| Parameter | Description |
| mgn:account-id | The ID of the account into which to import. This account must be managed by the calling account. Defaults to the calling account. |
| mgn:app:description | The description of the application being imported. |
| mgn:app:id | The ID of the application being imported. Use this parameter to update an existing application. |
| mgn:app:name | The name of the application being imported. |
| mgn:app:tag:appkey1 | The value of the application tag key (in this example, the tag key is appkey1). |
| mgn:launch:boot-mode | The boot mode of the launch instance. Expected values: LEGACY_BIOS, UEFI, or USE_SOURCE. |
| mgn:launch:copy-private-ip | The option to copy the private IP of the source server to the launch instance (true or false). |
| mgn:launch:iam-instance-profile:name | The name of the instance profile associated with the launch instance. |
| mgn:launch:instance-type | The EC2 instance type of the launch instance (for example, m4.large). |
| mgn:launch:map-tag-key | The key of the map migration tag applied by map auto tagging. Expected values: map-migrated or aws-apn-id. Values are case-sensitive. |
| mgn:launch:map-tag-value | The value of the map migration tag applied by map auto tagging, for example, your MAP program engagement (MPE) ID. |
| mgn:launch:map-tagging | The option to enable map auto tagging, which automatically applies the map migration tag to resources launched by MGN (true or false). |
| mgn:launch:nic:0:network-interface-id | The ID of the network interface that appears first in the launch template ("0" refers to the first network interface, "1" would refer to the second network interface, and so on). |
| mgn:launch:nic:0:private-ip:0 | The private IP that appears first in the network interface that appears first in the launch template. |
| mgn:launch:nic:0:security-group-id:0 | The security group that appears first in the network interface that appears first in the launch template. |
| mgn:launch:nic:0:subnet-id | The subnet ID that appears first in the network interface that appears first in the launch template. |
| mgn:launch:operating-system-licensing | The operating system licensing approach. Expected values: BYOL (bring your own license) or LI (license included). Values are case-sensitive and must be uppercase. |
| mgn:launch:placement:host-id | The host ID of the placement of the launch instance. |
| mgn:launch:placement:tenancy | The tenancy of the launch instance. Expected values: default, dedicated, or host. Values are case-sensitive and must be lowercase. |
| mgn:launch:post-actions:enabled | The option to enable post-launch actions for the server (true or false). |
| mgn:launch:post-actions:<action-name>:ssmDocumentName | The name of the SSM document that the post-launch action runs (in this example, the action name is <action-name>). |
| mgn:launch:post-actions:<action-name>:order | The order in which the post-launch action runs, relative to other post-launch actions. Must be a positive integer. |
| mgn:launch:post-actions:<action-name>:active | The option to activate the post-launch action (true or false). |
| mgn:launch:post-actions:<action-name>:mustSucceedForCutover | The option that determines whether the post-launch action must complete successfully before cutover can proceed (true or false). |
| mgn:launch:post-actions:<action-name>:timeoutSeconds | The timeout of the post-launch action, in seconds. Must be an integer greater than 0. |
| mgn:launch:post-actions:<action-name>:description | The description of the post-launch action. |
| mgn:launch:post-actions:<action-name>:parameters | The parameters passed to the SSM document of the post-launch action, as a JSON object with two optional members, parameters and externalParameters. No other members are allowed. parameters maps each document parameter name to an ordered list of {"value": "<literal>", "type": "String"} entries, where type is String (default) or StringList. externalParameters maps each document parameter name to a dynamic path string. For example: {"parameters":{"Region":[{"value":"us-east-1"}]},"externalParameters":{"InstanceId":"$.instanceId"}} |
| mgn:launch:start-instance | The option to automatically start the test or cutover instance after launch (true or false). If set to false, the instance is launched in a stopped state. |
| mgn:launch:tag:instance:key1 | The value of launch instance tag "key1" (in this example, the tag key is key1). |
| mgn:launch:volume:/dev/sda:type | The EBS volume type of the launch instance's volume whose device name is /dev/sda. The device name must match the name in the EC2 launch template's block device mappings (for example, /dev/sda1 or xvdf). |
| mgn:region | The AWS Region to which you are importing, which must be the Region of your MGN console. If left blank, defaults to the console Region. |
| mgn:replication:associate-default-security-group | The option to associate the default MGN security group with the replication servers (true or false). |
| mgn:replication:bandwidth-throttling | The bandwidth throttling limit for data replication, in Mbps. A value of 0 means no throttling. |
| mgn:replication:create-public-ip | The option to create a public IP address for the replication servers (true or false). |
| mgn:replication:data-replication-routing | Determines whether data is replicated over private connectivity or over the public internet. Expected values: PRIVATE_IP or PUBLIC_IP. |
| mgn:replication:default-large-staging-disk-type | The default EBS volume type to use for large staging area disks. Expected values: GP2, GP3, or ST1. |
| mgn:replication:ebs-encryption | The EBS encryption option for the replicated volumes. Expected values: DEFAULT or CUSTOM. |
| mgn:replication:ebs-encryption-key-arn | The ARN of the KMS key used for EBS encryption, when using a custom encryption key. |
| mgn:replication:fsx-ontap:credentials-secret-arn | The ARN of the AWS Secrets Manager secret that holds the credentials of the Amazon FSx for NetApp ONTAP file system used as the staging area. Required when mgn:replication:storage-type is FSX_ONTAP, and rejected when it is EBS. |
| mgn:replication:fsx-ontap:storage-virtual-machine-id | The ID of the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) used as the staging area. Required when mgn:replication:storage-type is FSX_ONTAP, and rejected when it is EBS. |
| mgn:replication:internet-protocol | The internet protocol used for data replication. Expected values: IPV4 or IPV6. |
| mgn:replication:replication-server-instance-type | The EC2 instance type of the replication servers (for example, t3.small). |
| mgn:replication:security-group-id:0 | The security group that appears first in the replication settings ("0" refers to the first security group, "1" would refer to the second security group, and so on). |
| mgn:replication:staging-area-subnet-id | The ID of the subnet in which the staging area is created. |
| mgn:replication:staging-area-tag:stagingkey1 | The value of the staging area resource tag key (in this example, the tag key is stagingkey1). |
| mgn:replication:storage-type | The staging area storage type. Expected values: EBS or FSX_ONTAP. When set to FSX_ONTAP, you must also provide mgn:replication:fsx-ontap:storage-virtual-machine-id and mgn:replication:fsx-ontap:credentials-secret-arn. |
| mgn:replication:store-snapshot-on-local-zone | The option to store snapshots on the Local Zone (true or false). |
| mgn:replication:use-dedicated-replication-server | The option to use a dedicated replication server for each source server (true or false). |
| mgn:replication:use-fips-endpoint | The option to use FIPS-compliant service endpoints for data replication (true or false). |
| mgn:server:fqdn-for-action-framework | The FQDN that the MGN connector uses to connect to the server. |
| mgn:server:id | The ID of the source server being imported. Use this parameter to update an existing source server. |
| mgn:server:platform | The server's platform (Linux or Windows). |
| mgn:server:tag:serverkey1 | The value of the server tag key (in this example, the tag key is serverkey1). |
| mgn:server:user-provided-id |
The server's user-provided ID. This parameter is used by MGN to consistently recognize the server replication, and avoid duplication when importing inventory from a CSV file. This parameter should be provided during the AWS replication agent installation by the MGN connector or other installation method. This attribute can be edited via the edit server option. After a replication agent is installed on the server, mgn:server:user-provided-id and mgn:server:fqdn-for-action-framework are the only server parameters that import can still change. Any other server parameter in the row causes the row to fail. |
| mgn:wave:description | The description of the imported wave. |
| mgn:wave:id | The ID of the wave being imported. Use this parameter to update an existing wave. |
| mgn:wave:name | The name of the imported wave. |
| mgn:wave:tag:wavekey1 | The value of the wave tag key (in this example, the tag key is wavekey1). |
mgn:launch:transfer-server-tags |
The option to transfer any user-configured custom tags from your source servers onto your test or cutover instance. |
Additional considerations
Note the following considerations regarding the import parameters:
-
Server entries must include either the server IP address, or the FQDN.
-
If a row provides a property of a resource (e.g. mgn:wave:description is a property of a wave), then that row should also provide a parameter that identifies that resource (as explained in the following considerations).
-
If a resource's ID (mgn:server:id, mgn:app:id, or mgn:wave:id) is provided, the service will look for this resource in order to update it. If this resource is not found, the import will fail.
-
If a resource's ID is not provided, the service will look for a resource's alternative identification:
-
For an application: mgn:app:name
-
For a wave: mgn:wave:name
-
For a server: mgn:server:user-provided-id
-
-
If a resource's alternative identification exists in MGN, the service will update this resource with new values (if applicable).
-
If a resource's alternative identification does not exist in MGN, the service will create the resource.
-
Two rows that refer to the same resource need not provide the same parameters for that resource, but they must not conflict. For example, if two rows provide the same mgn:wave:name, it is acceptable for one row to provide mgn:wave:description and for the other row to leave the value blank. However, the two rows must not provide conflicting values of mgn:wave:description.
