Skip to main content
A newer release of this product is available.

Update actions performed during an SVM migration

Contributors
PDFs

PATCH /svm/migrations/{uuid}

Introduced In: 9.10

Actions that can be performed during an SVM migration.

  • vserver migrate pause

  • vserver migrate resume

  • vserver migrate cutover

  • vserver migrate source-cleanup

Parameters

Name Type In Required Description

uuid

string

path

True

SVM migration UUID

action

string

query

False

The pause action pauses the SVM migration. This action stops data transfer and configuration replication. This operation must be performed on the destination cluster. The resume action resumes an SVM migration from a paused or failed state. This operation must be performed on the destination cluster. The cutover action triggers the cutover of an SVM from the source cluster to the destination cluster. The source_clean up action performs a clean up of the SVM on the source cluster.

  • enum: ["pause", "resume", "cutover", "source_cleanup"]

auto_cutover

boolean

query

False

Optional property that when set to true automatically performs cutover when the migration state reaches "ready for cutover".

  • Default value: 1

auto_source_cleanup

boolean

query

False

Optional property that when set to true automatically cleans up the SVM on the source cluster after the migration cutover.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

13172783

Migrate RDB lookup failed
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href
Name Type Description

_links

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.