Overview

The CLI allows you to manage migration jobs in your DryvIQ Platform. In all examples, the authentication parameters are provided within the configuration file. For more information, see CLI: Authentication.

List Jobs

List all the jobs

Command

skysync-cli jobs list

Example Results

ID                               Name                          Discriminator     Kind            Enabled Status
delete_jobs                      Delete Pending Jobs                             system          true    idle
job_retention_policy             Apply Job Retention Policies                    system          true    idle
4ef88eeda7904b8e9d542439a24c232d My Job 1                                        folder_mapping  true    idle
887622dea68c4189aa69d83c376c5b50 My Job 1                      folder1           transfer        true    idle

Example JSON Results

[
  {
    "id": "delete_jobs",
    "name": "Delete Pending Jobs",
    "discriminator": "",
    "kind": "system",
    "disabled": false,
    "status": "idle"
  },
  {
    "id": "job_retention_policy",
    "name": "Apply Job Retention Policies",
    "discriminator": "",
    "kind": "system",
    "disabled": false,
    "status": "idle"
  },
  {
    "id": "4ef88eeda7904b8e9d542439a24c232d",
    "name": "My Job 1",
    "discriminator": "",
    "kind": "folder_mapping",
    "disabled": false,
    "status: "idle"
  },
  {
    "id": "887622dea68c4189aa69d83c376c5b50",
    "name": "My Job 1",
    "discriminator": "folder1",
    "kind": "transfer",
    "disabled": false,
    "status: "idle"
  }
]

List Transfer Jobs

Command

skysync-cli jobs list --kind transfer

List Active Jobs

Command

skysync-cli jobs list --active

List Jobs With Specific Text in the Name

The following examples list jobs that include the text “test” in the name. 

Command

skysync-cli jobs list --search test

or

skysync-cli jobs list -q "test"

List Jobs Using Offset

An offset allows you to skip jobs and start listing at a certain number. The following example skips the first five jobs. 

Command

skysync-cli jobs list --offset=5

List Running Jobs

Command

skysync-cli jobs list "--status=start,running"

Show a Job

This command displays the details of the specified job. The parameters within the two curly braces (including the braces) must be replaced with valid values.

Command

skysync-cli jobs show {{id}}

Example Results

ID      bb7d0ba7015d4c9eab58a28ef46109f5
Name    Transfer Job 1
Kind    transfer
Enabled true
Status  idle

Example JSON Results

[
  {
    "id": "bb7d0ba7015d4c9eab58a28ef46109f5",
    "name": "Transfer Job 1",
    "kind": "transfer",
    "disabled": false,
    "status": "idle"
  }
]

Expected Results for Invalid ID

If the entered ID does not correspond to an existing job (for example, because the job has been deleted), the expected output is as follows.

ID
Name
Kind
Enabled true
Status

Expected JSON Results for Invalid ID

null

Create a Job

This command will create a job. If both auto and manual are set to true, the job will be created to run manually.

Create a Job Using the Wizard

Command

skysync-cli jobs add

The wizard will prompt for a job name, schedule details, source platform, source connection, source path, destination platform, destination connection, and destination path.

Example Wizard

This wizard will walk you through creating a new job
Do you want to continue? (Y) y
Enter the job name: [default] Wizard Created Job 1
Do you want to customize the schedule? (N)
What platform do you want for the source of the job?
(1) Box
(2) My Computer
(3) Network File System
(4) Microsoft OneDrive for Business
: 3
What connection do you want for the source of the job?
(1) Network File System (\\server1\folder1)
(2) Network File System (\\server2\folder2)
(3) Add a new Network File System connection
: 1
What is the source path? /source
What platform do you want for the destination of the job?
(1) Box
(2) My Computer
(3) Network File System
(4) Microsoft OneDrive for Business
: 3
What connection do you want for the destination of the job?
(1) Network File System (\\server1\folder1)
(2) Network File System (\\server2\folder2)
(3) Add a new Network File System connection
: 2
What is the destination path? /wizardjob1
ID      16e5f218ab4142c8b0c05158aa573d85
Name    Wizard Created Job 1
Kind    transfer
Enabled true
Status

Create a Job Providing Options From STDIN

This feature is only available with scripting, such as in a PowerShell or Node script. This feature is not supported from a standard terminal, such as a command line. However, piping can be used to pass in the JSON option block via Node or PowerShell. See the example below.

PowerShell Command With Variables

'{"transfer": {"source": {"connection": {"id": "{{sourceConnectionId"}, "target": {"path": "{{sourcePath}}"}}, "destination": {"connection": {"id": "{{destinationConnectionId"}, "target": {"path": "{{destinationPath}}"}}}}' | skysync-cli jobs add --manual --in 

Example Results

The expected output is the same as requesting job details.

ID      8b9ea3d812e24d7892d88d63acb40402
Name    :  to
Kind    transfer
Enabled true
Status

Create a Job Providing Options From a File

In this example, the job will be created by providing the location of the JSON options file, and the schedule will be set to manual.  

Command

skysync-cli jobs add --manual --job-file=job1Options.JSON

Contents of jobOptions.json With Variables

{
	"transfer":
	{
		"source": 
		{
			"connection": 
			{
				"id": "{{sourceConnectionId}}"
			}, 
			"target": 
			{
				"path": "{{sourcePath}}"
			}
		},
		"destination": 
		{
			"connection": 
			{
				"id": "{{destinationConnectionId}}"
			}, 
			"target": 
			{
				"path": "{{destinationPath}}"
			}
		}
	}
}

Contents of jobOptions.json With Sample Values

{
	"transfer":
	{
		"source": 
		{
			"connection": 
			{
				"id": "490d8c2eba054392bde988a548d88354"
			}, 
			"target": 
			{
				"path": "/source"
			}
		},
		"destination": 
		{
			"connection": 
			{
				"id": "fbc78a0fa9074d20b778e6e6fc1bd898"
			}, 
			"target": 
			{
				"path": "/destination"
			}
		}
	}
}

Example Results

The expected output is the same as requesting job details.

ID      8b9ea3d812e24d7892d88d63acb40402
Name    :  to
Kind    transfer
Enabled true
Status

Clone a Job

This command will clone a job and optionally change the cloned job's configuration.

Clone a Job With a New Name

In this example, the command will clone an existing job with the given ID and assign the cloned job a new name.  

Command

skysync-cli jobs clone 713291003ecf44749166db782df4c4e5 --name "Cloned Job"

Clone a Job Providing Changes From the STDIN

This feature is only available with scripting, such as in a PowerShell or Node script. In this example, the job will be created by providing the JSON contents as a parameter, and the delete_propagation policy is set to ignore_source.  

PowerShell Command With Variables

'{"transfer": {"delete_propagation": "ignore_source"},"name": "Cloned Job"}' | skysync-cli jobs clone 713291003ecf44749166db782df4c4e5 --in 

Example Results

The expected output is the same as requesting job details.

ID      8b9ea3d812e24d7892d88d63acb40402
Name    Cloned Job
Kind    transfer
Enabled true
Status

Clone a Job Providing Changes From a File

In this example, the job will be created by providing the location of the JSON options file with the same outcome as the example above. 

Command

skysync-cli jobs clone 713291003ecf44749166db782df4c4e5 --job-file=jobOptions.json

Contents of jobOptions.json With Sample Values

{
	"name": "Cloned Job",
	"transfer": {
		"delete_propagation": "ignore_source"
	}
}

Example Results

The expected output is the same as requesting job details.

ID      3b238054a02144c2bbd32b5c650ee7ae
Name    Cloned Job
Kind    transfer
Enabled true
Status

Start Job(s)

This command will start the specified job(s). At least one job specification must be provided to start jobs. If the ID is provided, that job will be started. If any other parameters are provided, they will be used to filter the entire job list and start the jobs based on the specified filtering parameters. For more information on this feature, reference: Start/Pause multiple jobs.

Start All Jobs

Command

skysync-cli jobs start --all

Example Results

8 jobs started

Example JSON Results

[
  {
    "total_count": "8"
  }
]

Start a Specific Job

The parameters within the two curly braces (including the braces) must be replaced with valid values.

Command With Variables

skysync-cli jobs start {{id}}

Command With Example Variables

skysync-cli jobs start 5dc531df34554edd96c31272262ad950

Example Results

ID      5dc531df34554edd96c31272262ad950
Name    Test Transfer Job 1
Kind    transfer
Enabled true
Status  start

Example JSON Results

[
  {
    "id": "5dc531df34554edd96c31272262ad950",
    "name": "Test Transfer Job 1",
    "kind": "transfer",
    "disabled": false,
    "status": "start"
  }
]

Expected Results for Invalid ID

If the entered ID does not correspond to an existing job (for example, because the job has been deleted), the expected output is as follows.

ID
Name
Kind
Enabled true
Status

Expected JSON Results for Invalid ID

null

Start a Filtered List of Jobs

In the following example, the jobs list is filtered by parent job, search text, job type, and active state. An offset further filters the list, and a limit starts only a specific number of jobs.    

Command With Variables

skysync-cli jobs start --parent={{parentJobID}} --offset={{offset}} --limit={{limit}} --search={{searchText}} --kind={{jobKind}} --active

Command With Sample Variables

In this example, only active jobs with the specified parent and containing the text "testjob" in the name will start. In addition, the offset skips the first two jobs, and the limit starts only the next five jobs.

skysync-cli jobs start --parent=5dc531df34554edd96c31272262ad950 --offset=2 --limit=5 --search=testjob --kind=transfer --active

Example Results

5 jobs started

Example JSON Results

[
  {
    "total_count": "5"
  }
]

Pause Job(s)

This command will pause the specified job. The parameters within the two curly braces (including the braces) must be replaced with valid values.

Pause All Jobs

Command With Variables

skysync-cli jobs pause --all

Example Results

8 jobs paused

Example JSON Results

[
  {
    "total_count": "8"
  }
]

Pause a Specific Job

Command With Variables

skysync-cli jobs pause {{id}}

Command With Example Variables

skysync-cli jobs pause 5dc531df34554edd96c31272262ad950

Example Results

ID      5dc531df34554edd96c31272262ad950
Name    Test Transfer Job 1
Kind    transfer
Enabled true
Status  paused

Example JSON Results

[
  {
    "id": "5dc531df34554edd96c31272262ad950",
    "name": "Test Transfer Job 1",
    "kind": "transfer",
    "disabled": false,
    "status": "paused"
  }
]

Expected Results for Invalid ID

If the entered ID does not correspond to an existing job (for example, because the job has been deleted), the expected output is as follows.

ID
Name
Kind
Enabled true
Status

Expected JSON Results for Invalid ID

null

Pause a Filtered List of Jobs

In the following example, the jobs list is filtered by parent job, search text, job type, and active state. An offset further filters the list, and a limit pauses only a specific number of jobs.    

Command With Variables

skysync-cli jobs pause --parent={{parentJobID}} --offset={{offset}} --limit={{limit}} --search={{searchText}} --kind={{jobKind}} --active

Command With Sample Variables

In this example, only active jobs with the specified parent and containing the text "testjob" in the name will start. In addition, the offset skips the first two jobs, and the limit pauses only the next five jobs.

skysync-cli jobs pause --parent=5dc531df34554edd96c31272262ad950 --offset=2 --limit=5 --search=testjob --kind=transfer --active

Example Results

5 jobs paused

Example JSON Results

[
  {
    "total_count": "5"
  }
]

Delete a Job

This command will delete the specified job. The parameters within the two curly braces (including the braces) must be replaced with valid values.

Command With Variables

skysync-cli jobs delete {{id}}

Command With Sample Variables

skysync-cli jobs delete 5dc531df34554edd96c31272262ad950

Example Results

The job was deleted successfully.

Expected Results for Invalid ID

If the entered ID does not correspond to an existing job (for example, because the job 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 job could not be deleted.

Job Items

This command produces a list of items identified in relation to a job. A parameter is required when generating a job items list. If you do not use a parameter, you will receive an error: "Not enough non-option arguments: got 0, need at least 1."

List Job Items for a Job

Command With No Parameters

skysync-cli jobs items {{jobID}}

Example Results

ID Source                                             Destination                                      Size Status
1  /                                                → /                                                     success

Example JSON Results

[
  {
    "id": 1,
    "source": {
      "name": "do-not-delete-many-files",
      "path": "/",
      "bytes": 0,
      "created_on": 1509145659,
      "modified_on": 1515528174
    },
    "source_to_destination": true,
    "destination": {
      "name": "destination",
      "path": "/",
      "bytes": 0,
      "created_on": 1515528271,
      "modified_on": 1515528271
    },
    "status": "success",
    "retried": 0,
    "processing": [
      "none"
    ],
    "transferred_on": 1515528270
  }
]

Job Folders

This command produces a list of folders identified in relation to a job.

List All Job Folders

This command only returns the first page of 20 records and not all the folders. You can add --limit and --offset to handle pagination if needed. 

Command With no Parameters

skysync-cli jobs folders

Example Results

ID  Source     Destination Size  Status
178 /        → /           161 B success
185 /folder2 → /folder2    112 B success
193 /folder1 → /folder1    16 B  success

Example JSON Results

[
  {
    "id": 178,
    "source": {
      "name": "do-not-delete-many-files",
      "path": "/",
      "bytes": 161,
      "created_on": 1509145659,
      "modified_on": 1523541561
    },
    "source_to_destination": true,
    "destination": {
      "name": "destination3",
      "path": "/",
      "bytes": 0,
      "created_on": 1530816748,
      "modified_on": 1530816748
    },
    "status": "success",
    "retried": 0,
    "processing": [
      "none"
    ],
    "transferred_on": 1530816748
  },
  {
    "id": 185,
    "source": {
      "name": "folder2",
      "path": "/folder2",
      "bytes": 112,
      "created_on": 1523541559,
      "modified_on": 1523541574
    },
    "source_to_destination": true,
    "destination": {
      "name": "folder2",
      "path": "/folder2",
      "bytes": 0,
      "created_on": 1523541559,
      "modified_on": 1523541574
    },
    "status": "success",
    "retried": 0,
    "processing": [
      "none"
    ],
    "transferred_on": 1530816748
  },
  {
    "id": 193,
    "source": {
      "name": "folder1",
      "path": "/folder1",
      "bytes": 16,
      "created_on": 1523541553,
      "modified_on": 1523541565
    },
    "source_to_destination": true,
    "destination": {
      "name": "folder1",
      "path": "/folder1",
      "bytes": 0,
      "created_on": 1523541553,
      "modified_on": 1523541565
    },
    "status": "success",
    "retried": 0,
    "processing": [
      "none"
    ],
    "transferred_on": 1530816748
  }
]

List Folders for a Job

Command With no Parameters

skysync-cli jobs folders {{jobID}}

Example Results

The expected results are similar to the previous example.

Job Security Mappings

This command produces a list of folders identified in relation to a job.

List All Job Security Mappings

Command With no Parameters

skysync-cli jobs security-mappings

Example Results

Source                   Destination              Resolution Message
Test User 00001          Test User 00001          email
Test User 00002          Test User 00002          email
Test User 00003          Test User 00003          email
TestBoxGroup1            TestBoxGroup1            id
TestBoxGroup2            TestBoxGroup2            id

Example JSON Results

[
  {
    "source": {
      "name": "Test User 00001",
      "email": "testuser00001@portalarchitects.com",
      "id": "265899621",
      "type": "account"
    },
    "destination": {
      "name": "Test User 00001",
      "email": "testuser00001@portalarchitects.com",
      "id": "265899621",
      "type": "account"
    },
    "resolution": "email",
    "id": "97f691056e824de9948f740f21fb808f"
  },
  {
    "source": {
      "name": "Test User 00002",
      "email": "testuser00002@portalarchitects.com",
      "id": "265899629",
      "type": "account"
    },
    "destination": {
      "name": "Test User 00002",
      "email": "testuser00002@portalarchitects.com",
      "id": "265899629",
      "type": "account"
    },
    "resolution": "email",
    "id": "9a37b7ef2b7a4404997d1502d5aee153"
  },
  {
    "source": {
      "name": "Test User 00003",
      "email": "testuser00003@portalarchitects.com",
      "id": "265899633",
      "type": "account"
    },
    "destination": {
      "name": "Test User 00003",
      "email": "testuser00003@portalarchitects.com",
      "id": "265899633",
      "type": "account"
    },
    "resolution": "email",
    "id": "44a6400858aa4fc9aac4dc67f60aa615"
  },
  {
    "source": {
      "name": "TestBoxGroup1",
      "id": "1485266",
      "type": "group"
    },
    "destination": {
      "name": "TestBoxGroup1",
      "id": "1485266",
      "type": "group"
    },
    "resolution": "id",
    "id": "b3e9f753979a4b13be6e1cccead26f0e"
  },
  {
    "source": {
      "name": "TestBoxGroup2",
      "id": "1485270",
      "type": "group"
    },
    "destination": {
      "name": "TestBoxGroup2",
      "id": "1485270",
      "type": "group"
    },
    "resolution": "id",
    "id": "afc2772bd44c4b3595216b4e762f1505"
  }  
]

List Security Mappings For a Specific Job

Command With no Parameters

skysync-cli jobs security-mappings {{jobID}}

Example Results

The expected results are similar to the previous example.

Audit Job(s)

This command will produce an audit report of job executions.

Produce an Audit Report for All Jobs

Without parameters, the following will output an audit for all jobs. If a job did not transfer items and the resulting items block is empty, the audit command will return empty brackets ([]).

Command With no Parameters

skysync-cli jobs audit

Example Results

Level Event      RecordedOn            Reason
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM

Produce an Audit Report for a Job

Command With no Parameters

skysync-cli jobs audit 5dc531df34554edd96c31272262ad950

Example Results

Level Event      RecordedOn            Reason
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM
debug audit_item 1/18/1970, 8:37:45 AM

Produce an Audit Report for a Job in CSV format

Adding the --csv option produces an audit report in comma-delimited value (CSV) format. Without it, output is formatted as JSON.

Command With Sample Variables

skysync-cli jobs audit 5dc531df34554edd96c31272262ad950 --csv

Example Results

execution_id,recorded_on,level,type,direction,reason,source_path,destination_path,bytes,version,hash,item_type
136,2018-02-05T21:17:26+00:00,debug,audit_item,->,"","/UserDrive/items-2/ADKSpring.jpg","/UserDrive/items-2/ADKSpring.jpg",5844151,288078761880,32342c62bc4f0139df792718757087155c53247a,""
136,2018-02-05T21:17:26+00:00,debug,audit_item,->,"","/UserDrive/items/ADKSpring.jpg","/UserDrive/items/ADKSpring.jpg",5844151,288079555273,32342c62bc4f0139df792718757087155c53247a,""
136,2018-02-05T21:17:27+00:00,debug,audit_item,->,"","/UserDrive/items-2/1/ADKSpring.jpg","/UserDrive/items-2/1/ADKSpring.jpg",5844151,288079706440,32342c62bc4f0139df792718757087155c53247a,""
136,2018-02-05T21:17:27+00:00,debug,audit_item,->,"","/UserDrive/items/1/ADKSpring.jpg","/UserDrive/items/1/ADKSpring.jpg",5844151,288079555451,32342c62bc4f0139df792718757087155c53247a,""
136,2018-02-05T21:17:28+00:00,debug,audit_item,->,"","/UserDrive/msaelens/2003-Aug-25-Santanonis.txt","/UserDrive/msaelens/2003-Aug-25-Santanonis.txt",185982,288078767712,3a724f4dc61d7d11ab10d389992ea934e208551d,""
136,2018-02-05T21:17:28+00:00,debug,audit_item,->,"","/UserDrive/mikes-2/ADKSpring.jpg","/UserDrive/mikes-2/ADKSpring.jpg",5844151,288079543378,32342c62bc4f0139df792718757087155c53247a,""
136,2018-02-05T21:17:28+00:00,debug,audit_item,->,"","/UserDrive/mikes/ADKSpring.jpg","/UserDrive/mikes/ADKSpring.jpg",5844151,288078641430,32342c62bc4f0139df792718757087155c53247a,""
136,2018-02-05T21:17:28+00:00,debug,audit_item,->,"","/UserDrive/mikes-2/1/ADKSpring - Copy.jpg","/UserDrive/mikes-2/1/ADKSpring - Copy.jpg",5844151,288079386224,32342c62bc4f0139df792718757087155c53247a,""
136,2018-02-05T21:17:29+00:00,debug,audit_item,->,"","/UserDrive/mikes/1/ADKSpring - Copy.jpg","/UserDrive/mikes/1/ADKSpring - Copy.jpg",5844151,288079659664,32342c62bc4f0139df792718757087155c53247a,""
 

Produce an Audit Report for a Specific Job Execution

Adding an --execution option produces an audit report for a specific execution of the specified job. The execution_id  may not be sequential for a specific job and can be found within the response from the command: skysync-cli jobs audit.

Execution Option

skysync-cli jobs audit 5dc531df34554edd96c31272262ad950 --execution 13

Report Job History

This command will produce a report of job execution history.

Produce a History Report for All Jobs

Without parameters, the following will output a history report for all jobs.

Command With no Parameters

skysync-cli jobs history

Produce a History Report for a Job

By specifying an ID parameter, the following command will output a history report for a specific job.

Command With Example Values

skysync-cli jobs history 5dc531df34554edd96c31272262ad950

Produce a History Report for a Job in CSV format

Adding the --csv option produces a history report in comma-delimited value (CSV) format. Without it, output is formatted as JSON.

Command With Example Values

skysync-cli jobs history 5dc531df34554edd96c31272262ad950 --csv

Produce a History Report for a Specific Job Execution

Adding an --execution option produces an audit report for a specific execution of the specified job. The execution_id  may not be sequential for a specific job and can be found within the response from the command: skysync-cli jobs audit.

Execution Option

skysync-cli jobs history 5dc531df34554edd96c31272262ad950 --execution 13

Produce a History Report for the Last Execution of a Job

Adding an --execution option with a last parameter produces a history report for the last execution of the specified job.

Execution Option

skysync-cli jobs history 5dc531df34554edd96c31272262ad950 --execution last

Produce a History Report for the Current Execution of a Job

Adding an --execution option with a current parameter produces a history report for the current execution of the specified job. If the specified job is between executions, this will return null.

Execution Option

skysync-cli jobs history 5dc531df34554edd96c31272262ad950 --execution current