Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

On This Page

Table of Contents

...

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

Command

...

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

Command

...

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

Command

...

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

Command

...

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

Command

...

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

Command

...

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

...

Panel
bgColor#FFFAE6

To create a job that imports permissions or metadata or performs user-drive mapping, use the below examples in conjunction with the documentation for the the  permissions import, the metadata import or the user -drive job mapping feature.

Example 1: Creating a job using the wizard

In this example, the command run will launch a job creation wizard that will walk you through creating a job.  The authentication parameters are provided within the configuration file.  See the authentication section CLI: Authentication page for more information.  

Command

...

This feature is available only with scripting such as within a PowerShell or Node script.  In this example, the the job will be created by providing the JSON contents as a parameter and the schedule will be set to manual.  The authentication parameters are provided within the configuration file.  See the authentication section CLI: Authentication page for more information.  

Panel
bgColor#FFFAE6

This feature is not supported from a standard terminal such as a command line; however, piping may be utilized to pass in the json option block via Node or PowerShell. See example below.

...

In this example, the the job will be created by providing the location of the JSON options file and the schedule will be set to manual.  The authentication parameters are provided within the configuration file.  See the authentication section CLI: Authentication page for more information.  

Command

...

In this example, the command will clone an existing job with the given ID and assign the cloned job a new name.  The authentication parameters are provided within the configuration file.  See the authentication section CLI: Authentication page for more information.   

Command

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

...

This feature is available only with scripting such as within a PowerShell or Node script.  In this example, the the job will be created by providing the JSON contents as a parameter and the delete_propagation policy is set to ignore_source.  The authentication parameters are provided within the configuration file.  See the authentication section CLI: Authentication page for more information.  

Panel
bgColor#FFFAE6

This feature is not supported from a standard terminal such as a command line; however, piping may be utilized to pass in the json option block via Node or PowerShell. See example below.

...

In this example, the the job will be created by providing the location of the JSON options file with the same outcome as Example 2 above.  The authentication parameters are provided within the configuration file.  See the authentication section CLI: Authentication page for more information.  

Command

...

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

...

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

...

In the following example, we'll filter the jobs list by parent job, search text, kind of job, and active state.  We'll then further filter the list by using an offset and limiting the number of jobs to start.  The authentication parameters are provided within the configuration file.  See the authentication section CLI: Authentication page for more information.  The parameters within the two curly braces (including the braces) will need to be replaced with valid values.

...

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

...

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

...

In the following example, we'll filter the jobs list by parent job, search text, kind of job, and active state.  We'll then further filter the list by using an offset and limiting the number of jobs to pause.  The authentication parameters are provided within the configuration file.  See the authentication section CLI: Authentication page for more information.  The parameters within the two curly braces (including the braces) will need to be replaced with valid values.

...

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

...

In the following examples, authentication parameters are provided within the configuration file. See the authentication section CLI: Authentication page for more information. 

Example 1: List job items for a specific job

...

In the following examples, authentication parameters are provided within the configuration file. See the authentication section CLI: Authentication page for more information. 

Example 1: List all job folders

...

In the following examples, authentication parameters are provided within the configuration file. See the authentication section CLI: Authentication page for more information. 

Example 1: List all job security mappings

...

In the following examples, authentication parameters are provided within the configuration file. See the authentication section CLI: Authentication page for more information. 

Example 1: Produce an audit report for all jobs

...

In the following examples, authentication parameters are provided within the configuration file. See the authentication section CLI: Authentication page for more information. 

Example 1: Produce a history report for all jobs

...

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

...