Migrate Services

Migrate Services
Migrate external appliance data into this appliance.

Migrate external appliance data into this appliance.

Request
URI
POST
https://{api_host}/appliance/migration-manager/actions/migrate
COPY
Request Body

Spec to describe vCenter services for migration.

MigrateServicesSpec of type(s) application/json
Required

Show optional properties

{
    "vcenter_connection_spec": {
        "credentials": {
            "admin_user": "string",
            "admin_password": "string"
        },
        "connection_spec": {
            "psc_uri": "psc01.acme.com, psc01.acme.com:80, psc01.acme.com:443, https://psc01.acme.com, https://psc01.acme.com:443"
        }
    },
    "migration_service_specs": [
        {
            "appliance_uri": "https://my-appliance.acme.com:443",
            "appliance_credentials": {
                "admin_user": "string",
                "admin_password": "string"
            },
            "services": [
                {}
            ]
        }
    ]
}
{
    "vcenter_connection_spec": {
        "credentials": {
            "admin_user": "string",
            "admin_password": "string"
        },
        "connection_spec": {
            "psc_uri": "psc01.acme.com, psc01.acme.com:80, psc01.acme.com:443, https://psc01.acme.com, https://psc01.acme.com:443",
            "psc_thumbprint": "string"
        }
    },
    "migration_service_specs": [
        {
            "appliance_uri": "https://my-appliance.acme.com:443",
            "appliance_credentials": {
                "admin_user": "string",
                "admin_password": "string"
            },
            "appliance_thumbprint": "string",
            "appliance_certificate": "string",
            "services": [
                "string"
            ]
        }
    ]
}
object
vcenter_connection_spec
Required

Data to be used to connect to vSphere infrastructure.

array of object
migration_service_specs
Required

List of services to migrate.

Authentication
This operation uses the following authentication methods.
Responses
202

Task to monitor the operation.

Returns TaskDrResponseEntity of type(s) application/json
This response body class contains all of the following: Task , InlineTaskDrResponseEntity1 
{
    "id": "string",
    "description": "string",
    "type": "string",
    "status": "string",
    "error": {
        "message": "string",
        "details": "string"
    },
    "result": {},
    "progress": 0,
    "start_time": 0,
    "complete_time": 0,
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}

400

Bad request - the server cannot understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json 
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"migration_service_specs":["object"],"vcenter_connection_spec":"object"}' https://{api_host}/appliance/migration-manager/actions/migrate
On This Page
Migration Operations
POST
List Services To Migrate
POST
Migrate Services
POST
Validate Migrate Connection Spec