migrationIntent

migrationIntent
migrationIntent
JSON Example
{
    "desiredMigrationId": "string",
    "desiredMigrationGroupId": "string",
    "migrationId": "string",
    "migrationGroupId": "string",
    "migrationType": "string",
    "state": "string",
    "entity": {
        "entityId": "string",
        "entityType": "string",
        "entityName": "string",
        "summary": {
            "guestFullName": "string",
            "guestId": "string",
            "guestHostName": "string",
            "memorySizeMB": "number",
            "numCpu": 0,
            "diskSize": "number",
            "memorySize": "number"
        }
    },
    "source": {
        "endpointId": "string",
        "computeResourceId": "string",
        "endpointType": "string",
        "endpointName": "string",
        "resourceType": "string",
        "resourceId": "string",
        "resourceName": "string"
    },
    "destination": {
        "endpointId": "string",
        "computeResourceId": "string",
        "endpointType": "string",
        "endpointName": "string",
        "resourceType": "string",
        "resourceId": "string",
        "resourceName": "string"
    },
    "transferParams": {
        "transferId": "string",
        "transferGroupId": "string",
        "transferType": "string",
        "schedule": {
            "startTime": 0,
            "expiryTime": 0
        },
        "longRecovery": false,
        "continuousSync": false,
        "syncInterval": 0,
        "transferProfile": [
            {
                "option": "string",
                "value": "string"
            }
        ]
    },
    "switchoverParams": {
        "switchoverType": "string",
        "schedule": {
            "startTime": 0,
            "expiryTime": 0,
            "clearSchedule": false
        },
        "options": {
            "vcpus": 0,
            "memory": 0,
            "removeISOs": false,
            "retainMac": false,
            "forcePowerOffVm": false,
            "upgradeHardware": false,
            "upgradeVMTools": false,
            "removeCbrc": false,
            "removeCbt": false,
            "removeSnapshots": false,
            "isEvcDisabled": false,
            "retainTags": false,
            "upgradeHardwareVersion": "string",
            "replicateSecurityTags": false,
            "updateCustomAttributes": false
        },
        "switchoverProfile": [
            {
                "option": "string",
                "value": false
            }
        ]
    },
    "placement": [
        {
            "id": "string",
            "name": "string",
            "type": "string"
        }
    ],
    "storage": {
        "defaultStorage": {
            "id": "string",
            "type": "string",
            "name": "string",
            "diskProvisionType": "string",
            "storageParams": [
                {
                    "option": "string",
                    "value": "string"
                }
            ]
        },
        "diskMappings": [
            {
                "diskId": "string",
                "storage": {
                    "id": "string",
                    "diskProvisionType": "string"
                },
                "storageParams": [
                    {
                        "option": "string",
                        "value": "string"
                    }
                ]
            }
        ]
    },
    "guestCustomization": {
        "changeSID": false,
        "personalizationScript": "string",
        "identity": {
            "name": "string",
            "domain": "string",
            "domainName": "string"
        },
        "dnsCustomizations": {
            "dns": [
                "string"
            ],
            "dnsSuffixes": [
                "string"
            ]
        },
        "networkCustomizations": [
            {
                "macAddress": "string",
                "ipAddress": "string",
                "netmask": "string",
                "gateways": [
                    "string"
                ],
                "dns": [
                    "string"
                ],
                "dnsSuffix": "string"
            }
        ]
    },
    "networkParams": {
        "defaultMappings": [
            {
                "srcNetworkId": "string",
                "srcNetworkType": "string",
                "srcNetworkName": "string",
                "destNetworkId": "string",
                "destNetworkType": "string",
                "destNetworkName": "string",
                "bindingType": "string"
            }
        ],
        "networkMappings": [
            {
                "srcNetworkName": "string",
                "srcNetworkDisplayName": "string",
                "srcNetworkValue": "string",
                "srcNetworkHref": "string",
                "destNetworkName": "string",
                "destNetworkDisplayName": "string",
                "destNetworkValue": "string",
                "destNetworkHref": "string",
                "macAddress": "string",
                "isPrimaryNic": false,
                "srcNetworkId": "string",
                "srcNetworkType": "string",
                "destNetworkId": "string",
                "destNetworkType": "string",
                "bindingType": "string",
                "connected": false
            }
        ]
    },
    "servicemeshId": "string",
    "tags": [
        "string"
    ]
}
string
desiredMigrationId
Optional

This parameter is optional. If set it will apply to a migrationId.

string
desiredMigrationGroupId
Optional

This parameter is optional. If set it will apply to a migrationGroupId.

string
migrationId
Optional

This parameter is optional and would be generated by the system if not present. It uniquely identifies the migration intent

string
migrationGroupId
Optional

This parameter is optional and would be generated by the system if not present. It uniquely identifies the group thats migration intent is member of

string
migrationType
Optional

migrationType

string
state
Optional

State of the migration is persisted in this attribute.

entity
Optional

entity

source
Required

source

destination
Required

destination

transferParams
Optional

transferParams

switchoverParams
Optional

switchoverParams

array of placements
placement
Required

placement

storage
Required

storage

guestCustomization
Optional

guestCustomization

networkParams
Optional

networkParams

string
servicemeshId
Optional

This parameter is optional. IX applainces corresponding to this servicemesh will be used for migration.

array of string
tags
Optional

tags