CLI: Reports



On This Page

 


The CLI references “skysync.” This is expected.

Managing Transfer Reports

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

List the Transfer Reports

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

parameter

description

required

default

parameter

description

required

default

search, q

Search text

optional

 

offset

Search offset

optional

0

limit

Search page size

optional

20

 

Example 1: List all the transfer reports

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command

1 skysync-cli reports list

Example results

1 2 ID Name 4902735af9c7471c80dab00d7f911eb3 HR Migrations

Example results (JSON)

1 2 3 4 5 6 7 8 9 [ { "id": "4902735af9c7471c80dab00d7f911eb3", "name": "HR Migrations", "parameters": { "job_category_id": 34 } } ]

 

Example 2: List reports with "HR" in their name

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command

1 skysync-cli reports list --search HR

 

Example 3: List the reports skipping the first 5

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command

1 skysync-cli reports list --offset=5

 

Show a Transfer Report

This command will show the details of the specified transfer report.

parameter

description

required

default

parameter

description

required

default

id

The ID of the transfer report for which details will be shown

required

 

 

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  The parameters within the two curly braces (including the braces) will need to be replaced with valid values.

Command with variables

1 skysync-cli reports show {{id}}

 

Example 1: Show a transfer report

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

command with example values

1 skysync-cli reports show 4902735af9c7471c80dab00d7f911eb3

Example results

1 2 ID 4902735af9c7471c80dab00d7f911eb3 Name HR Migrations

Example results (JSON)

1 2 3 4 5 6 7 8 9 [ { "id": "4902735af9c7471c80dab00d7f911eb3", "name": "HR Migrations", "parameters": { "job_category_id": 34 } } ]

 

Create a Transfer Report

This command provides the ability to create a transfer report.  The authentication parameters are provided within the configuration file.  See the authentication section for more information.  The parameters within the two curly braces (including the braces) will need to be replaced with valid values.

Command with variables

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

 

Example 1: Create a transfer report for all jobs in a specified category

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command with sample values

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

Example results

1 2 ID 4902735af9c7471c80dab00d7f911eb3 Name HR Migrations

 

Example 2: Create a transfer report for all jobs under a specified parent

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command with sample values

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

Example results

1 2 ID 4902735af9c7471c80dab00d7f911eb3 Name User-Drive Migrations

 

Example 3: Create a transfer report for all simulation jobs in a specified category

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command with sample values

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

Example results

1 2 ID 4902735af9c7471c80dab00d7f911eb3 Name HR Analysis

 

Delete a Transfer Report

This command provides the ability to remove a transfer report.  The authentication parameters are provided within the configuration file.  See the authentication section for more information.  The parameters within the two curly braces (including the braces) will need to be replaced with valid values.

Example with variables

1 skysync-cli reports delete {{reportId}}

 

Example 1: Delete a transfer report

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Example with sample values

1 skysync-cli reports delete 4902735af9c7471c80dab00d7f911eb3

Expected results

1 The report was deleted successfully.

 

If the ID entered does not correspond to an existing report, for example, if the report was already deleted, the expected output is the following.

Expected results

1 The report could not be deleted.

The response is only available in the default format.  If JSON output is specified, no output will be provided.

 

View a Transfer Statistics for Report

This command provides the ability to view transfer statistics for all jobs contained within a transfer report. The authentication parameters are provided within the configuration file.  See the authentication section for more information.  The parameters within the two curly braces (including the braces) will need to be replaced with valid values.

Command with variables

1 skysync-cli reports stats {{reportId}}

 

Example 1: View transfer statistics for a transfer report

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command with sample values

1 2 3 4 5 6 7 8 9 10 11 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 Contained in Transfer Report

This command provides the ability to list all of the jobs contained within a transfer report. The authentication parameters are provided within the configuration file.  See the authentication section for more information.  The parameters within the two curly braces (including the braces) will need to be replaced with valid values.

Command with variables

1 skysync-cli reports jobs {{reportId}}

 

Example 1: View jobs for a transfer report

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command with sample values

1 2 3 4 5 6 7 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