Retrieve the SVM migration status
GET /svm/migrations
Introduced In: 9.10
Retrieves the SVM migration status.
Related ONTAP commands
-
vserver migrate show
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
source.cluster.name |
string |
query |
False |
Filter by source.cluster.name |
source.cluster.uuid |
string |
query |
False |
Filter by source.cluster.uuid |
source.svm.uuid |
string |
query |
False |
Filter by source.svm.uuid |
source.svm.name |
string |
query |
False |
Filter by source.svm.name |
uuid |
string |
query |
False |
Filter by uuid |
auto_cutover |
boolean |
query |
False |
Filter by auto_cutover |
destination.ipspace.uuid |
string |
query |
False |
Filter by destination.ipspace.uuid |
destination.ipspace.name |
string |
query |
False |
Filter by destination.ipspace.name |
point_of_no_return |
boolean |
query |
False |
Filter by point_of_no_return |
throttle |
integer |
query |
False |
Filter by throttle
|
messages.message |
string |
query |
False |
Filter by messages.message |
messages.code |
string |
query |
False |
Filter by messages.code |
last_failed_state |
string |
query |
False |
Filter by last_failed_state |
auto_source_cleanup |
boolean |
query |
False |
Filter by auto_source_cleanup |
time_metrics.cutover_start_time |
string |
query |
False |
Filter by time_metrics.cutover_start_time |
time_metrics.last_pause_time |
string |
query |
False |
Filter by time_metrics.last_pause_time |
time_metrics.start_time |
string |
query |
False |
Filter by time_metrics.start_time |
time_metrics.last_resume_time |
string |
query |
False |
Filter by time_metrics.last_resume_time |
time_metrics.cutover_trigger_time |
string |
query |
False |
Filter by time_metrics.cutover_trigger_time |
time_metrics.end_time |
string |
query |
False |
Filter by time_metrics.end_time |
time_metrics.cutover_complete_time |
string |
query |
False |
Filter by time_metrics.cutover_complete_time |
current_operation |
string |
query |
False |
Filter by current_operation |
state |
string |
query |
False |
Filter by state |
last_operation |
string |
query |
False |
Filter by last_operation |
restart_count |
integer |
query |
False |
Filter by restart_count |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
num_records |
integer |
Number of records |
records |
array[svm_migration] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"current_operation": "string",
"destination": {
"ipspace": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "Default",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"volume_placement": {
"aggregates": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "aggr1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
],
"volume_aggregate_pairs": [
{
"aggregate": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "aggr1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
}
]
}
},
"ip_interface_placement": {
"ip_interfaces": [
{
"interface": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"ip": {
"address": "10.10.10.7"
},
"name": "lif1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"port": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "e1b",
"node": {
"name": "node1"
},
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
}
]
},
"last_failed_state": "string",
"last_operation": "string",
"messages": [
{
"code": "string",
"message": "string"
}
],
"restart_count": 0,
"source": {
"cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
},
"state": "string",
"throttle": 0,
"time_metrics": {
"cutover_complete_time": "2020-12-02 22:30:19 -0500",
"cutover_start_time": "2020-12-02 21:20:19 -0500",
"cutover_trigger_time": "2020-12-02 22:15:19 -0500",
"end_time": "2020-12-02 22:36:19 -0500",
"last_pause_time": "2020-12-02 21:50:19 -0500",
"last_resume_time": "2020-12-02 21:54:19 -0500",
"start_time": "2020-12-02 21:36:19 -0500"
},
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
]
}
Error
Status: Default
ONTAP Error Response Codes
Error Code | Description |
---|---|
13172783 |
Migrate RDB lookup failed |
Also see the table of common errors in the Response body overview section of this documentation.
Name | Type | Description |
---|---|---|
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 |
---|---|---|
next |
||
self |
_links
Name | Type | Description |
---|---|---|
self |
ipspace
Optional property used to specify which IPspace to use for the SVM. By default, the "default" ipspace is used.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
IPspace name |
uuid |
string |
IPspace UUID |
aggregates
Aggregate
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
uuid |
string |
aggregate
Aggregate to use for volume creation.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
uuid |
string |
volume
Property indicating the source volume.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the volume. This field cannot be specified in a POST or PATCH method. |
uuid |
string |
Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.
|
volume_aggregate_pairs
Volume-aggregate pair information.
Name | Type | Description |
---|---|---|
aggregate |
Aggregate to use for volume creation. |
|
volume |
Property indicating the source volume. |
volume_placement
Optional property to specify the source volume placement in the destination. It is input only and won't be returned by a subsequent GET. Volume placement is ignored if the migration resumes from the cleanup_failed state.
Name | Type | Description |
---|---|---|
aggregates |
array[aggregates] |
Optional property used to specify the list of desired aggregates to use for volume creation in the destination. |
volume_aggregate_pairs |
array[volume_aggregate_pairs] |
Optional property used to specify the list of desired volume-aggregate pairs in the destination. |
destination
Destination cluster details for the SVM migration.
Name | Type | Description |
---|---|---|
ipspace |
Optional property used to specify which IPspace to use for the SVM. By default, the "default" ipspace is used. |
|
volume_placement |
Optional property to specify the source volume placement in the destination. It is input only and won't be returned by a subsequent GET. Volume placement is ignored if the migration resumes from the cleanup_failed state. |
ip
IP information
Name | Type | Description |
---|---|---|
address |
string |
IPv4 or IPv6 address |
interface
Network interface on the source SVM.
Name | Type | Description |
---|---|---|
_links |
||
ip |
IP information |
|
name |
string |
The name of the interface. If only the name is provided, the SVM scope must be provided by the object this object is embedded in. |
uuid |
string |
The UUID that uniquely identifies the interface. |
node
Name | Type | Description |
---|---|---|
name |
string |
Name of node on which the port is located. |
port
Port to use for IP interface placement on the destination SVM.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
node |
||
uuid |
string |
ip_interfaces
IP interface and network port pair information.
Name | Type | Description |
---|---|---|
interface |
Network interface on the source SVM. |
|
port |
Port to use for IP interface placement on the destination SVM. |
svm_migration_ip_interface_placement
Optional property used to specify the list of source SVM's IP interface and network port pairs in the destination for migrating the source SVM IP interfaces. Note that the SVM migration does not perform any reachability checks on the IP interfaces provided.
Name | Type | Description |
---|---|---|
ip_interfaces |
array[ip_interfaces] |
List of source SVM's IP interface and port pairs on the destination for migrating the source SVM's IP interfaces. |
messages
Name | Type | Description |
---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
cluster
Source cluster for the SVM migration.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
uuid |
string |
svm
Source SVM
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
source
Source cluster details for the SVM migration.
Name | Type | Description |
---|---|---|
cluster |
Source cluster for the SVM migration. |
|
svm |
Source SVM |
time_metrics
Various time metrics details
Name | Type | Description |
---|---|---|
cutover_complete_time |
string |
Cutover end time |
cutover_start_time |
string |
Cutover start time |
cutover_trigger_time |
string |
Cutover trigger time |
end_time |
string |
Migration end time |
last_pause_time |
string |
Last migration pause time |
last_resume_time |
string |
Last migration resume time |
start_time |
string |
Migration start time |
svm_migration
Provides information on SVM migration, default and user specified configurations, the state of the migration, and volume transfer metrics.
Name | Type | Description |
---|---|---|
auto_cutover |
boolean |
Optional property that when set to true automatically performs cutover when the migration state reaches "ready for cutover". |
auto_source_cleanup |
boolean |
Optional property that when set to true automatically cleans up the SVM on the source cluster after the migration cutover. |
check_only |
boolean |
Optional property that when set to true performs only migration pre-checks not the actual migration. |
current_operation |
string |
|
destination |
Destination cluster details for the SVM migration. |
|
ip_interface_placement |
Optional property used to specify the list of source SVM's IP interface and network port pairs in the destination for migrating the source SVM IP interfaces. Note that the SVM migration does not perform any reachability checks on the IP interfaces provided. |
|
last_failed_state |
string |