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

skysync-cli reports list

Example results

ID Name 4902735af9c7471c80dab00d7f911eb3 HR Migrations

Example results (JSON)

[ { "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

 

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

 

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

 

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

Example results

Example results (JSON)

 

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

 

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

Example results

 

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

Example results

 

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

Example results

 

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

 

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

Expected results

 

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

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

 

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

 

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

 

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

 

DryvIQ Migrate Version: 5.6.1.4136
Release Date: February 9, 2024