Retrieve all ongoing file move operations in the cluster
Retrieves details about all ongoing file move operations within the cluster to monitor and manage active data migrations effectively.
HTTP method and endpoint
GET /storage/file/moves
Introduced in
ONTAP 9.11
Usage notes
Retrieves all ongoing file move operations in the cluster.
Related ONTAP commands
-
volume file move show -
volume rebalance file-move show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
source.path |
string |
query |
False |
Filter by source.path |
source.volume.name |
string |
query |
False |
Filter by source.volume.name |
source.volume.uuid |
string |
query |
False |
Filter by source.volume.uuid |
source.svm.uuid |
string |
query |
False |
Filter by source.svm.uuid |
source.svm.name |
string |
query |
False |
Filter by source.svm.name |
max_throughput |
integer |
query |
False |
Filter by max_throughput |
index |
integer |
query |
False |
Filter by index |
uuid |
string |
query |
False |
Filter by uuid |
is_snapshot_fenced |
boolean |
query |
False |
Filter by is_snapshot_fenced |
failure.code |
string |
query |
False |
Filter by failure.code |
failure.arguments.message |
string |
query |
False |
Filter by failure.arguments.message |
failure.arguments.code |
string |
query |
False |
Filter by failure.arguments.code |
failure.message |
string |
query |
False |
Filter by failure.message |
destination.path |
string |
query |
False |
Filter by destination.path |
destination.volume.name |
string |
query |
False |
Filter by destination.volume.name |
destination.volume.uuid |
string |
query |
False |
Filter by destination.volume.uuid |
destination.svm.uuid |
string |
query |
False |
Filter by destination.svm.uuid |
destination.svm.name |
string |
query |
False |
Filter by destination.svm.name |
scanner.total |
integer |
query |
False |
Filter by scanner.total |
scanner.state |
string |
query |
False |
Filter by scanner.state |
scanner.percent |
integer |
query |
False |
Filter by scanner.percent |
scanner.progress |
integer |
query |
False |
Filter by scanner.progress |
elapsed_time |
integer |
query |
False |
Filter by elapsed_time |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
svm.name |
string |
query |
False |
Filter by svm.name |
is_destination_ready |
boolean |
query |
False |
Filter by is_destination_ready |
is_flexgroup |
boolean |
query |
False |
Filter by is_flexgroup |
volume.name |
string |
query |
False |
Filter by volume.name |
volume.uuid |
string |
query |
False |
Filter by volume.uuid |
node.name |
string |
query |
False |
Filter by node.name |
node.uuid |
string |
query |
False |
Filter by node.uuid |
max_cutover_time |
integer |
query |
False |
Filter by max_cutover_time |
cutover_time |
integer |
query |
False |
Filter by cutover_time |
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[file_move] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"cutover_time": 8,
"destination": {
"path": "d1/d2/file1",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
},
"elapsed_time": 100,
"failure": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist"
},
"index": 0,
"max_cutover_time": 10,
"max_throughput": 250000,
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"scanner": {
"percent": 80,
"progress": 80000,
"state": "string",
"total": 100000
},
"source": {
"path": "d1/d2/file1",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
},
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"uuid": "4fcb3159-a4ee-42b5-bb16-f752f2c430fc",
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
}
]
}
Error
Status: Default, Error
| 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 |
collection_links
| Name | Type | Description |
|---|---|---|
next |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
svm
SVM, applies only to SVM-scoped objects.
| 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. |
volume
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the volume. This field cannot be specified in a 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.
|
destination
Destination file information.
| Name | Type | Description |
|---|---|---|
path |
string |
|
svm |
SVM, applies only to SVM-scoped objects. |
|
volume |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
Contains the most recent failure reason for move operation.
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
destinations
Path for file move operation.
| Name | Type | Description |
|---|---|---|
path |
string |
|
svm |
SVM, applies only to SVM-scoped objects. |
|
volume |
sources
Path for file move operation.
| Name | Type | Description |
|---|---|---|
path |
string |
|
svm |
SVM, applies only to SVM-scoped objects. |
|
volume |
files_to_move
A list of source files along with the destination file they are moved to. If the terminal path component of the destination is a directory, then the source file's basename is replicated in that directory. This is only used for FlexVol volume file move operations.
| Name | Type | Description |
|---|---|---|
destinations |
array[destinations] |
The destination file information. |
sources |
array[sources] |
The source file information. |
node
Node hosting the destination of this move operation.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
svm
SVM of the source reference file.
| 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. |
volume
Volume of the source reference file.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the volume. This field cannot be specified in a 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.
|
reference
Reference file information.
scanner
| Name | Type | Description |
|---|---|---|
percent |
integer |
Scanner progress, as a percentage. |
progress |
integer |
Scanner progress, in bytes scanned. |
state |
string |
Status of the file move scanner. |
total |
integer |
Total bytes to be scanned. |
source
Source file information.
| Name | Type | Description |
|---|---|---|
path |
string |
|
svm |
SVM, applies only to SVM-scoped objects. |
|
volume |
svm
SVM of the FlexGroup volume in file move operation. Only used in a FlexGroup volume file move operation.
| 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. |
volume
FlexGroup volume in file move operation. Only used in a FlexGroup volume file move operation.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the volume. This field cannot be specified in a 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.
|
file_move
Details of a file move operation.
| Name | Type | Description |
|---|---|---|
cutover_time |
integer |
Time that the file move operation takes before cutover completes, in seconds. |
destination |
Destination file information. |
|
elapsed_time |
integer |
Time elapsed since the start of the file move operation, in seconds. |
failure |
Contains the most recent failure reason for move operation. |
|
index |
integer |
An additional unique element identifying one file among many that could possibly be moved as part of a job. File index is an identifier ordered by the file path arrays provided during create. For file move operations that involve only one file, the file-index value of zero is always correct. |
is_destination_ready |
boolean |
Indicates whether the destination file is ready for use. |
is_flexgroup |
boolean |
Indicates whether this is a FlexGroup file move operation. |
is_snapshot_fenced |
boolean |
Indicates whether snapshots are fenced. |
max_cutover_time |
integer |
The maximum amount of time, in seconds that the source can be quiesced before a destination file must be made available for read-write traffic. Not supported in FlexGroup volume file move operations. |
max_throughput |
integer |
Maximum amount of data, in bytes that can be transferred per second in support of this operation. A non-zero value less than 1 MB/s is set to 1 MB/s. A non-zero value greater than 1 MB/s is truncated to the nearest integral megabyte value. If unspecified, the default value is "0" which means no range is set for the data transfer. |
node |
Node hosting the destination of this move operation. |
|
scanner |
||
source |
Source file information. |
|
svm |
SVM of the FlexGroup volume in file move operation. Only used in a FlexGroup volume file move operation. |
|
uuid |
string |
The UUID which uniquely identifies the job that started this move operation. |
volume |
FlexGroup volume in file move operation. Only used in a FlexGroup volume file move operation. |
returned_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. |