Overview

Job schedules determine when migration jobs run. You can manage the job schedules using the command-line interface. The authentication parameters are provided within the configuration file in all examples. See the CLI: Authentication for more information.

List Job Schedulers

List All Job Schedules

Command

skysync-cli schedulers list

Example Results

ID Name            Caption                                  Enabled Status
-1 default         Default Scheduler                        true    running
1  system          System Maintenance                       true    running
2  local-10.0.75.1 Local scheduler for Node local-10.0.75.1 true    running

Example JSON Results

[
  {
    "id": -1,
    "name": "default",
    "caption": "Default Scheduler",
    "disabled": false,
    "status": "running"
  },
  {
    "id": 1,
    "name": "system",
    "caption": "System Maintenance",
    "disabled": false,
    "status": "running"
  },
  {
    "id": 2,
    "name": "local-10.0.75.1",
    "caption": "Local scheduler for Node local-10.0.75.1",
    "disabled": false,
    "status": "running"
  }
]

List Active Job Schedulers

skysync-cli schedulers list --active

List Job Schedules With Specific Text in Name

The following example lists jobs that have “Maint” in the name. 

skysync-cli schedulers list --search Maint

Show a Job Scheduler

This command will show the details of the specified job. In the following examples, the parameters within the two curly braces (including the braces) will need to be replaced with valid values.

It is important to note that any scheduler status returned from the API or any status control functions invoked through the API are specific to the local node that you are executing the request against. If the desire is to control the status of schedulers across an entire cluster, then the requests need to be made against every node in the cluster individually.

Command With Variables

skysync-cli schedulers show {{id}}

Command With Example Values

skysync-cli schedulers show 1

Examples Results

ID      1
Name    system
Caption System Maintenance
Enabled true
Status  running

Example JSON Results

[
  {
    "id": 1,
    "name": "system",
    "caption": "System Maintenance",
    "disabled": false,
    "status": "running"
  }
]

Expected Results for Invalid ID

ID
Name
Caption
Enabled true
Status

Expected JSON Results for Invalid ID

null

Start Job Schedulers

This command will start the specified job scheduler(s). At least one job scheduler specification must be provided to start job schedulers. If the ID is provided, that job scheduler will be started. If any of the other parameters are provided, they will be used to filter the entire job scheduler list and start the job schedulers based on the specified filtering parameters. 

Start a Specific Job Scheduler by ID

Command With Variables

skysync-cli schedulers start {{id}}

Command With Example Values

skysync-cli schedulers start 1

Examples Results

ID      1
Name    system
Caption System Maintenance
Enabled true
Status  running

Example JSON Results

[
  {
    "id": 1,
    "name": "system",
    "caption": "System Maintenance",
    "disabled": false,
    "status": "running"
  }
]

Expected Results for Invalid ID

If the ID does not correspond to an existing job scheduler, the expected output is as follows.

ID
Name
Caption
Enabled true
Status

Expected JSON Results for Invalid ID

null

Start All Job Schedulers

Command With Variables

skysync-cli schedulers start --all

Examples Results

3 job schedulers started

Example JSON Results

[
  {
    "total_count": "3"
  }
]

Start a Filtered List of Job Schedulers

The following example filters the job scheduler list by search text. The parameters within the two curly braces (including the braces) must be replaced with valid values.

Command With Variables

skysync-cli schedulers start --search={{searchText}}

Command With Example Values

This example starts job schedulers with the text "Maint" in the name. 

skysync-cli schedulers start --search=Maint

Examples Results

1 job scheduler started

Example JSON Results

[
  {
    "total_count": "1"
  }
]

Pause Job Schedulers

This command will pause the specified job scheduler. This call will stop the scheduler from picking up any additional jobs, but it will allow currently executing jobs to finish. The difference between pausing a scheduler and stopping a scheduler with the "–wait" option is that the pausing call will return immediately, while stopping with the "–wait" option will not return until all currently executing jobs have finished.

Pause a Specific Job Scheduler by ID

Command With Variables

skysync-cli schedulers pause {{id}}

Command With Example Values

skysync-cli schedulers pause 1

Examples Results

ID      1
Name    system
Caption System Maintenance
Enabled true
Status  paused

Example JSON Results

[
  {
    "id": 1,
    "name": "system",
    "caption": "System Maintenance",
    "disabled": false,
    "status": "paused"
  }
]

Expected Results for Invalid ID

If the ID does not correspond to an existing job scheduler, the expected output is as follows.

ID
Name
Kind
Enabled true
Status

Expected JSON Results for Invalid ID

null

Pausing All Job Schedulers

Command With Variables

skysync-cli schedulers pause --all

Example Results

3 job schedulers paused

Example JSON Results

[
  {
    "total_count": "3"
  }
]

Pause a Filtered List of Job Schedulers

Command With Variables

skysync-cli schedulers pause --search={{searchText}}

Command With Example Values

The following example pauses job schedulers with the text "Maint" in the name.

skysync-cli schedulers pause --search=Maint

Example Results

1 job schedulers paused

Example JSON Results

[
  {
    "total_count": "1"
  }
]

Stop Job Schedulers

This command will stop the specified job scheduler. This call will stop the scheduler from picking up any additional jobs and terminate (or optionally wait for) currently executing jobs. Once this call returns, the currently running jobs on this node will no longer be executing.

Stop a Specific Job Scheduler by ID

Command With Variables

skysync-cli schedulers stop {{id}} --wait

Command With Example Values

skysync-cli schedulers stop 1 --wait

Examples Results

ID      1
Name    system
Caption System Maintenance
Enabled true
Status  stop

Example JSON Results

[
  {
    "id": 1,
    "name": "system",
    "caption": "System Maintenance",
    "disabled": false,
    "status": "stop"
  }
]

Expected Results for Invalid ID

If the ID does not correspond to an existing job scheduler, the expected output is as follows.

ID
Name
Kind
Enabled true
Status

Expected JSON Results for Invalid ID

null

Stop All Job Schedulers

Command With Variables

skysync-cli schedulers stop --all --wait

Examples Results

3 job schedulers stopped

Example JSON Results

[
  {
    "total_count": "3"
  }
]

Stop a Filtered List of Job Schedulers

Command With Variables

skysync-cli schedulers stop --search={{searchText}}

Command With Example Values

The following example stops job schedulers with the text "Maint" in the name.

skysync-cli schedulers stop --search=Maint

Example Results

1 job schedulers stopped

Example JSON Results

[
  {
    "total_count": "1"
  }
]