Overview

The CLI allows you to manage your migration reports. The authentication parameters are provided within the configuration file in all examples. See the CLI: Authentication for more information.

Managing Transfer Reports

Getting the list of transfer reports is the first step in managing your transfer reports.

List All Transfer Reports

Command

skysync-cli reports list

Example Results

ID                               Name
4902735af9c7471c80dab00d7f911eb3 HR Migrations

Example JSON Results

[
  {
    "id": "4902735af9c7471c80dab00d7f911eb3",
    "name": "HR Migrations",
    "parameters": {
      "job_category_id": 34
    }
  }
]

List Reports With Specific Text in the Name

Command

skysync-cli reports list --search HR

List Reports Using an Offset

Command

skysync-cli reports list --offset=5

Show a Transfer Report

This command will show the details of the specified transfer report. The parameters within the two curly braces (including the braces) must be replaced with valid values.

Command With Variables

skysync-cli reports show {{id}}

Command With Example Variables

skysync-cli reports show 4902735af9c7471c80dab00d7f911eb3

Example Results

ID   4902735af9c7471c80dab00d7f911eb3
Name HR Migrations

Example JSON Results

[
  {
    "id": "4902735af9c7471c80dab00d7f911eb3",
    "name": "HR Migrations",
    "parameters": {
      "job_category_id": 34
    }
  }
]

Create a Transfer Report

This command allows you to create a transfer report. The parameters within the two curly braces (including the braces) must be replaced with valid values.

Command With Variables

skysync-cli reports add --name {{reportName}} --category <Job Category ID> --parent <Job Parent ID>

Create a Transfer Report for all Jobs in a Category

Command With Example Variables

skysync-cli reports add --name "HR Migrations" --category 35

Example Results

ID   4902735af9c7471c80dab00d7f911eb3
Name HR Migrations

Create a Transfer Report for Jobs Under a Parent Job

Command With Example Variables

skysync-cli reports add --name "User-Drive Migrations" --parent 1902735af9c7471c80dab00d7f911eb4

Example Results

ID   4902735af9c7471c80dab00d7f911eb3
Name User-Drive Migrations

Create a Transfer Report for all Simulation Jobs in a Category

Command With Example Variables

skysync-cli reports add --name "HR Analysis" --category 35 --simulation

Example Results

ID   4902735af9c7471c80dab00d7f911eb3
Name HR Analysis

Delete a Transfer Report

This command allows you to remove a transfer report. The parameters within the two curly braces (including the braces) must be replaced with valid values.

Example With Variables

skysync-cli reports delete {{reportId}}

Command With Example Variables

skysync-cli reports delete 4902735af9c7471c80dab00d7f911eb3

Expected Results

The report was deleted successfully.

Expected Result for Invalid ID

If the entered ID does not correspond to an existing report (for example, because the report has been deleted), the expected output is as follows. The response is only available in the default format. If JSON output is specified, no output will be provided.

The report could not be deleted.

View Transfer Statistics Report

This command allows you to view transfer statistics for all jobs included in a transfer report. The parameters within the two curly braces (including the braces) must be replaced with valid values.

Command with variables

skysync-cli reports stats {{reportId}}

View Transfer Statistics for a Transfer Report

Command With Example Variables

Timestamp Content                 Files             Folders
May 07    (117.2 MB ↑ 117.2 MB ↓) (6,000 ↑ 6,000 ↓) (12,774 ↑ 12,774 ↓)
May 06    (106.8 MB ↑ 106.8 MB ↓) (5,452 ↑ 5,452 ↓) (11,634 ↑ 11,634 ↓)
May 05    (96.4 MB ↑ 96.4 MB ↓)   (4,920 ↑ 4,920 ↓) (10,500 ↑ 10,500 ↓)
May 04    (85.9 MB ↑ 85.9 MB ↓)   (4,389 ↑ 4,389 ↓) (9,366 ↑ 9,366 ↓)
May 03    (75.5 MB ↑ 75.5 MB ↓)   (3,850 ↑ 3,850 ↓) (8,232 ↑ 8,232 ↓)
May 02    (65.1 MB ↑ 65.1 MB ↓)   (3,321 ↑ 3,321 ↓) (7,092 ↑ 7,092 ↓)
May 01    (54.7 MB ↑ 54.7 MB ↓)   (2,789 ↑ 2,789 ↓) (5,958 ↑ 5,958 ↓)
Apr 30    (44.3 MB ↑ 44.3 MB ↓)   (2,255 ↑ 2,255 ↓) (4,824 ↑ 4,824 ↓)
Apr 29    (33.9 MB ↑ 33.9 MB ↓)   (1,716 ↑ 1,716 ↓) (3,690 ↑ 3,690 ↓)
Apr 28    (23.4 MB ↑ 23.4 MB ↓)   (1,186 ↑ 1,186 ↓) (2,550 ↑ 2,550 ↓)

View Jobs in a Transfer Report

This command allows you to list all the jobs contained within a transfer report. The authentication parameters are provided within the configuration file. The parameters within the two curly braces (including the braces) must be replaced with valid values.

Command With Variables

skysync-cli reports jobs {{reportId}}

Command With Sample Variables

ID                               Name                         Kind     Enabled Status
bf97a389e14244b39a3b877945358ded Department Share 0 Migration transfer true    idle
c841ed0b877f4ec2a3ad7910013d9c98 Department Share 1 Migration transfer true    idle
21821786048045168233084d8af8cf6c Department Share 2 Migration transfer true    idle
23af18adfac1498aaa26caed459f4e9b Department Share 3 Migration transfer true    idle
7266b5e1c4dc497d8490b984f93e8fa7 Department Share 4 Migration transfer true    idle
ae671073e1374e9aae2120e4cbf1764e Department Share 5 Migration transfer true    complete