GridGain Documentation

The GridGain Developer Hub

Welcome to the GridGain developer hub. You'll find comprehensive guides and documentation to help you start working with GridGain as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Snapshots Management Tool

GridGain Ultimate Edition includes a command line tool that simplifies snapshots creation, recovery and management related tasks.

The script that starts the tool is called snapshot-utility and is located under {gridgain-ultimate-farbric}/bin/ folder. There is a version of the script for Unix-based systems (snapshot-utility.sh) as well as for Windows machines (snapshot-utility.bat).

Currently, the tool supports commands listed below:

To call a specific command, follow this format:

{gridgain}/bin/snapshot-utility.sh <command> <args>
{gridgain}/bin/snapshot-utility.bat <command> <args>

Exit codes

The snapshot utility returns a code as a result of an operation performed on the cluster. These codes are listed below:

Exit code
Description

0

Successful execution.

1

Unexpected error.

2

Unknown command.

3

Invalid arguments.

4

Connection failed.

5

Command failed with known error code.

6

Command executed successfully, but snapshot utility failed to write result to output file.

7

Command failed and snapshot utility failed to write error code to output file.

HELP

The command prints out the list of all the commands supported by the tool.

{gridgain}/bin/snapshot-utility.sh help
{gridgain}/bin/snapshot-utility.bat help

To get more details about specific command pass the command name as an argument to help command.

{gridgain}/bin/snapshot-utility.sh help snapshot
{gridgain}/bin/snapshot-utility.bat help snapshot

Common arguments

All commands supports following arguments

Argument
Description
Default

-output=file

File to output command result or error code in machine-readable format.

snapshot-utility.out

-format=text|json

Format of command output: text or JSON.

text

-host={IP or host name}

The command accepts an IP address or a host name of one of the nodes of the cluster.

The tool connects to this node in order to issue snapshot related requests.

127.0.0.1

-port={number}

The port number on the cluster's node that will listen to snapshot tool's requests.

The port number is defined by org.apache.ignite.configuration.ConnectorConfiguration and equal to 11211 by default.

11211

-ping_interval={time in millis}

Defines an interval for the heartbeats that are sent from the tool to the cluster's node.

5000 ms

-ping_timeout={time in millis}

Defines a timeout for responses and acknowledgements coming from the cluster's node to the tool.

30 000 ms

LIST

The command enumerates all the snapshots that have been created so far.

{gridgain}/bin/snapshot-utility.sh list
{gridgain}/bin/snapshot-utility.bat list

The full command format is the following:
list [-src=path1[,path2,...,pathN]] [-verbose] [-output=snapshot-utility.out] [-format=text|json] [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Command Arguments

The command supports common arguments as well as additional ones.

Argument
Description
Default

-src=path1[,patn2,...,pathN]

List of folders to search for snapshot files.

Empty

-verbose

Enable verbose mode: show all caches in snapshot.

Empty

Error Codes

Code
Description
Solution

2000

Failed to execute list command.

Check cluster logs for errors. This error means, that some unexpected happened.

2110

Unknown or unsupported arguments specified for list command.

Check that the arguments are correct.

2120

An invalid argument is passed to list command.

Check that the arguments values are correct.

2130

Snapshot utility incompatible with cluster.

Check that snapshot utility is the same version as cluster.

2200

Snapshots utility failed to authenticate in the cluster at list command execution time.

Check that username and password are correct.

2300

Snapshots utility failed to connect to the cluster at list command execution time.

Check the following:

  • the node defined by -host and -port arguments is reachable.

  • the port number defined by -port is not blocked by firewalls.

  • check GridGain cluster logs to troubleshoot the issue further.

2400

The persistent store is not configured. The command can't be executed.

Refer to this documentation section for more details.

2410

Cluster is not active, command cannot be executed.

Activate cluster.

2800

Command executed successfully, but snapshot utility failed to write result to output file.

Check output file name and permissions.

2810

Command failed and snapshot utility failed to write error code to output file.

Check output file name and permissions.

INFO

This command will print detailed information about specified snapshot.

{gridgain}/bin/snapshot-utility.sh info -id=123456

The full command format is the following:
info -id=snapshot_id [-output=snapshot-utility.out] [-format=text|json] [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Command Arguments

The command supports common arguments as well as additional ones.

Argument
Description
Default

-id={snapshot_id}

An ID of the snapshot to show detailed info. Use list command to obtain snapshot IDs and other snapshots related details.

This is a mandatory argument that has to be set explicitly.

-src=path1[,patn2,...,pathN]

List of folders to search for snapshot files.

Empty

Error Codes

Code
Description
Solution

3000

Failed to execute info command.

Check cluster logs for errors. This error means, that some unexpected happened.

3110

Unknown or unsupported arguments specified for info command.

Check that the arguments are correct.

3120

An invalid argument is passed to info command.

Check that the arguments values are correct.

3130

Snapshot utility incompatible with cluster.

Check that snapshot utility is the same version as cluster.

3200

Snapshots utility failed to authenticate in the cluster at info command execution time.

Check that username and password are correct.

3300

Snapshots utility failed to connect to the cluster at info command execution time.

Check the following:

  • the node defined by -host and -port arguments is reachable.

  • the port number defined by -port is not blocked by firewalls.

  • check GridGain cluster logs to troubleshoot the issue further.

3400

The persistent store is not configured. The command can't be executed.

Refer to this documentation section for more details.

3410

Cluster is not active, command cannot be executed.

Activate cluster.

3500

Snapshot with a specific ID doesn't exist.

Check that the snapshot ID is correct. Use list command to get an ID of required snapshot.

3800

Command executed successfully, but snapshot utility failed to write result to output file.

Check output file name and permissions.

3810

Command failed and snapshot utility failed to write error code to output file.

Check output file name and permissions.

SNAPSHOT

The command creates a new cluster's data snapshot.

{gridgain}/bin/snapshot-utility.sh snapshot -type=full
{gridgain}/bin/snapshot-utility.bat snapshot -type=full

The full command format is the following:
snapshot [-type=full | inc] [-caches=cache1,cache2…] [-dest=EXTERNAL_FOLDER] [-verbose] [-output=snapshot-utility.out] [-format=text|json] [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Output

After successful execution this command will write SNAPSHOT_ID to file specified by -output argument.

Command Arguments

The command supports common arguments as well as additional ones.

Argument
Description
Default

-type=full | inc

Creates snapshot of specified type (full or incremental).

An incremental snapshot will be created.

-caches={cache1,…,cacheN}

Names of the caches which data has to be included in a snapshot.

Data of all the caches will be included in a snapshot.

-dest=EXTERNAL_FOLDER

Folder name where snapshot will be created

This argument has to be set explicitly.

-verbose

Enable verbose mode: show all caches in snapshot.

Empty.

Error Codes

Code
Description
Solution

4000

Failed to execute snapshot command.

Check cluster logs for errors. This error means, that some unexpected happened.

4110

Unknown or unsupported arguments specified for snapshot command.

Check that the arguments are correct.

4120

An invalid argument is passed to snapshot command.

Check that the arguments values are correct.

4130

Snapshot utility incompatible with cluster.

Check that snapshot utility is the same version as cluster.

4200

Snapshots utility failed to authenticate in the cluster at snapshot command execution time.

Check that username and password are correct.

4300

Snapshots utility failed to connect to the cluster at snapshot command execution time.

Check the following:

  • the node defined by -host and -port arguments is reachable.

  • the port number defined by -port is not blocked by firewalls.

  • check GridGain cluster logs to troubleshoot the issue further.

4400

The persistent store is not configured. The command can't be executed.

Refer to this documentation section for more details.

4410

Cluster is not active, command cannot be executed.

Activate cluster.

4520

Attempt to start snapshot while previous snapshot is not finished yet.

Wait for previous snapshot completion. STATUS command could be used for current snapshot progress monitoring.

4530

Can not create incremental snapshot, last full snapshot was not found.

Create full snapshot first.

4600

Snapshot utility failed to find cache with specified name.

Check that -caches argument specified correctly.

4710

Snapshot utility failed to create snapshot in destination folder.

Check destination folder permissions.

4800

Command executed successfully, but snapshot utility failed to write result to output file.

Check output file name and permissions.

4810

Command failed and snapshot utility failed to write error code to output file.

Check output file name and permissions.

RESTORE

The command restores cluster data to the state preserved in a specific snapshot.

{gridgain}/bin/snapshot-utility.sh restore -id=123456
{gridgain}/bin/snapshot-utility.bat restore -id=123456

The full command format is the following:
restore -id=snapshot_id [-caches=cache1,cache2…] [-nocheck] [-src=path1[,path2,...,pathN]] [-config=config.xml] [-output=snapshot-utility.out] [-format=text|json] [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Command Arguments

The command supports common arguments as well as additional ones.

Argument
Description
Default

-id={snapshot_id}

An ID of the snapshot to restore to. Use list command to obtain ID and other snapshots related details.

This is a mandatory argument that has to be set explicitly.

-caches={cache1,…,cacheN}

The list of caches' names which content has to be replaced with the content stored in a snapshot.

Content of all the caches will be replaced with the data stored in a snapshot.

-nocheck

Snapshot utility will skip snapshot check before restore.

Snapshot will be checked for consistency before restore.

-src=path1[,patn2,...,pathN]

List of folders to search for snapshot files.

Empty.

-config=config.xml

File name with new caches configurations that should be used on restore instead of saved in snapshot metadata.

This argument has to be set explicitly.

Error Codes

Code
Description
Solution

5000

Failed to execute restore command.

Check cluster logs for errors. This error means, that some unexpected happened.

5110

Unknown or unsupported arguments specified for restore command.

Check that the arguments are correct.

5120

An invalid argument is passed to restore command.

Check that the arguments values are correct.

5130

Snapshot utility incompatible with cluster.

Check that snapshot utility is the same version as cluster.

5200

Snapshots utility failed to authenticate in the cluster at restore command execution time.

Check that username and password are correct.

5300

Snapshots utility failed to connect to the cluster at restore command execution time.

Check the following:

  • the node defined by -host and -port arguments is reachable.

  • the port number defined by -port is not blocked by firewalls.

  • check GridGain cluster logs to troubleshoot the issue further.

5400

The persistent store is not configured. The command can't be executed.

Refer to this documentation section for more details.

5410

Cluster is not active, command cannot be executed.

Activate cluster.

5500

Snapshot with a specific ID doesn't exist.

Check that the snapshot ID is correct. Use list command to get an ID of required snapshot.

5510

Snapshot is broken.

Replace broken snapshot files with correct ones.

5600

Snapshot utility failed to find cache with specified name.

Check that -caches argument specified correctly.

5610

Snapshot utility failed to read file with caches configs.

Check file permissions.

5800

Command executed successfully, but snapshot utility failed to write result to output file.

Check output file name and permissions.

5810

Command failed and snapshot utility failed to write error code to output file.

Check output file name and permissions.

CHECK

This command will check that the specified snapshot is not broken and is logically consistent.

{gridgain}/bin/snapshot-utility.sh check -id=123456

The full command format is the following:
check -id=123456 [-src=path1[,path2,...,pathN]] [-output=snapshot-utility.out] [-format=text|json] [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Command Arguments

The command supports common arguments as well as additional ones.

Argument
Description
Default

-id={snapshot_id}

An ID of the snapshot to check. Use list command to obtain ID and other snapshots related details.

This is a mandatory argument that has to be set explicitly.

-src=path1[,patn2,...,pathN]

List of folders to search for snapshot files.

Empty.

Error Codes

Code
Description
Solution

6000

Failed to execute check command.

Check cluster logs for errors. This error means, that some unexpected happened.

6110

Unknown or unsupported arguments specified for check command.

Check that the arguments are correct.

6120

An invalid argument is passed to check command.

Check that the arguments values are correct.

6130

Snapshot utility incompatible with cluster.

Check that snapshot utility is the same version as cluster.

6200

Snapshots utility failed to authenticate in the cluster at delete command execution time.

Check that username and password are correct.

6300

Snapshots utility failed to connect to the cluster at delete command execution time.

Check the following:

  • the node defined by -host and -port arguments is reachable.

  • the port number defined by -port is not blocked by firewalls.

  • check GridGain cluster logs to troubleshoot the issue further.

6400

The persistent store is not configured. The command can't be executed.

Refer to this documentation section for more details.

6410

Cluster is not active, command cannot be executed.

Activate cluster.

6500

Snapshot with a specific ID doesn't exist.

Check that the snapshot ID is correct. Use list command to get an ID of required snapshot.

6510

Snapshot is broken.

Examine list of found errors. Check your hardware. Restore broken or missing files from backup copy.

6800

Command executed successfully, but snapshot utility failed to write result to output file.

Check output file name and permissions.

6810

Command failed and snapshot utility failed to write error code to output file.

Check output file name and permissions.

DELETE

The command removes data for specific caches stored in a snapshot, or the whole snapshot completely.

{gridgain}/bin/snapshot-utility.sh delete -id=123456
{gridgain}/bin/snapshot-utility.bat delete -id=123456

The full command format is the following:
delete -id=snapshot_id [-force] [-output=snapshot-utility.out] [-format=text|json] [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Command Arguments

The command supports common arguments as well as additional ones.

Argument
Description
Default

-id={snapshot_id}

An ID of the snapshot to delete. Use list command to obtain ID and other snapshots related details.

This is a mandatory argument that has to be set explicitly.

-force

Delete this snapshot and all dependent snapshots.

By default, if specified snapshot has dependent snapshots, command will return error code.

Error Codes

Code
Description
Solution

7000

Failed to execute delete command.

Check cluster logs for errors. This error means, that some unexpected happened.

7110

Unknown or unsupported arguments specified for delete command.

Check that the arguments are correct.

7120

An invalid argument is passed to delete command.

Check that the arguments values are correct.

7130

Snapshot utility incompatible with cluster.

Check that snapshot utility is the same version as cluster.

7200

Snapshots utility failed to authenticate in the cluster at delete command execution time.

Check that username and password are correct.

7300

Snapshots utility failed to connect to the cluster at delete command execution time.

Check the following:

  • the node defined by -host and -port arguments is reachable.

  • the port number defined by -port is not blocked by firewalls.

  • check GridGain cluster logs to troubleshoot the issue further.

7400

The persistent store is not configured. The command can't be executed.

Refer to this documentation section for more details.

7410

Cluster is not active, command cannot be executed.

Activate cluster.

7500

Snapshot with a specific ID doesn't exist.

Check that the snapshot ID is correct. Use list command to get an ID of required snapshot.

7700

Snapshot utility failed to delete specified snapshot because there some dependent snapshots.

Remove snapshot with -force argument.

7800

Command executed successfully, but snapshot utility failed to write result to output file.

Check output file name and permissions.

7810

Command failed and snapshot utility failed to write error code to output file.

Check output file name and permissions.

MOVE

This command will move files of specified snapshot to specified folder in external disk storage.

{gridgain}/bin/snapshot-utility.sh move -id=123456 -dest=/snapshots/2017/01

The full command format is the following:
move -id=snapshot_id -dest=EXTERNAL_FOLDER [-force] [-output=snapshot-utility.out] [-format=text|json] [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Command Arguments

The command supports common arguments as well as additional ones.

Code
Description
Solution

-id={snapshot_id}

An ID of the snapshot to move. Use list command to obtain ID and other snapshots related details

This is a mandatory argument that has to be set explicitly.

-dest=EXTERNAL_FOLDER

Folder name where to move snapshot.

This is a mandatory argument that has to be set explicitly.

-force

Move this snapshot and all dependent snapshots.

By default, if specified snapshot has dependent snapshots, command will return error code.

Error Codes

Code
Description
Solution

8000

Failed to execute move command.

Check cluster logs for errors. This error means, that some unexpected happened.

8110

Unknown or unsupported arguments specified for move command.

Check that the arguments are correct.

8120

An invalid argument is passed to move command.

Check that the arguments values are correct.

8130

Snapshot utility incompatible with cluster.

Check that snapshot utility is the same version as cluster.

8200

Snapshots utility failed to authenticate in the cluster at move command execution time.

Check that username and password are correct.

8300

Snapshots utility failed to connect to the cluster at move command execution time.

Check the following:

  • the node defined by -host and -port arguments is reachable.

  • the port number defined by -port is not blocked by firewalls.

  • check GridGain cluster logs to troubleshoot the issue further.

8400

The persistent store is not configured. The command can't be executed.

Refer to this documentation section for more details.

8410

Cluster is not active, command cannot be executed.

Activate cluster.

8500

Snapshot with a specific ID doesn't exist.

Check that the snapshot ID is correct. Use list command to get an ID of required snapshot

8700

Snapshot utility failed to move specified snapshot because there some dependent snapshots.

Move snapshot with -force argument.

8710

Snapshot utility failed to move snapshot to destination folder.

Check destination folder permissions.

8800

Command executed successfully, but snapshot utility failed to write result to output file.

Check output file name and permissions.

8810

Command failed and snapshot utility failed to write error code to output file.

Check output file name and permissions.

STATUS

This command will print a list of the current running snapshot, restore, delete, and move processes if any.

{gridgain}/bin/snapshot-utility.sh status

The full command format is the following:
status [-output=snapshot-utility.out] [-format=text|json] [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Command Arguments

The command supports common arguments.

Error Codes

Code
Description
Solution

9000

Failed to execute status command.

Check cluster logs for errors. This error means, that some unexpected happened.

9110

Unknown or unsupported arguments specified for status command.

Check that the arguments are correct.

9120

An invalid argument is passed to status command.

Check that the arguments values are correct.

9130

Snapshot utility incompatible with cluster.

Check that snapshot utility is the same version as cluster.

9200

Snapshots utility failed to authenticate in the cluster at status command execution time.

Check that username and password are correct.

9300

Snapshots utility failed to connect to the cluster at status command execution time.

Check the following:

  • the node defined by -host and -port arguments is reachable.

  • the port number defined by -port is not blocked by firewalls.

  • check GridGain cluster logs to troubleshoot the issue further

9400

The persistent store is not configured. The command can't be executed.

Refer to this documentation section for more details.

9410

Cluster is not active, command cannot be executed.

Activate cluster.

9800

Command executed successfully, but snapshot utility failed to write result to output file.

Check output file name and permissions.

9810

Command failed and snapshot utility failed to write error code to output file.

Check output file name and permissions.

CATALOG

This command will print information about snapshots from the so called snapshots catalog (central place where all clusters store information about snapshot operations).

{gridgain}/bin/snapshot-utility.sh catalog

List snapshots in catalog:
catalog [-cluster[=CLUSTER_NAME]] [-from=yyyy-MM-dd-HH:mm:ss.SSS] [-to=yyyy-MM-dd-HH:mm:ss.SSS] [-last=PERIOD] [-verbose] [-host=http://localhost] [-port=80]

List snapshot operations history registered in catalog:
catalog [-cluster[=CLUSTER_NAME]] -history [-from=yyyy-MM-dd-HH:mm:ss.SSS] [-to=yyyy-MM-dd-HH:mm:ss.SSS] [-last=PERIOD] [-verbose] [-host=http://localhost] [-port=80]

Where PERIOD could be one of the following:
Nd - N days, for example: 3d
Nh - N hours, for example: 12h
Nm - N minutes, for example: 90m
N - N milliseconds, for example: 100000

Argument
Description
Default

-cluster

Cluster name to list snapshots.

Empty. Will show all clusters in catalog.

-history

If specified then history of snapshot operations will be printed

This is a mandatory argument that has to be set explicitly.

-from

Period to filter data from

Date in format yyyy-MM-dd-HH:mm:ss.SSS

-to

Period to filter data to

Date in format yyyy-MM-dd-HH:mm:ss.SSS

-last

Show latest history for specified period

1 hour

-verbose

Enable verbose mode: show all caches in snapshot.

Empty.

-host

Snapshots catalog URI

-port

Snapshots catalog connection port.

80

Error Codes

Code
Description
Solution

10000

Command failed.

Check cluster logs for errors. This error means, that some unexpected happened.

10900

Snapshot utility failed to receive data from snapshots catalog.

Check that utility can connect to snapshots catalog via REST HTTP.

CANCEL

This command will cancel specified snapshot operation.

{gridgain}/bin/snapshot-utility.sh cancel -id=1df9ace9b51-537536a4-e47d-4446-b0e4

The full command format is the following:
cancel -id=operationId [-output=snapshot-utility.out] [-format=text|json] [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Command Arguments

The command supports common arguments as well as additional ones.

Argument
Description
Default

-id

Snapshot operation ID.

This is a mandatory argument that has to be set explicitly.

Error Codes

Code
Description
Solution

11000

Failed to execute cancel command.

Check cluster logs for errors. This error means, that some unexpected happened.

11110

Unknown or unsupported arguments specified for cancel command.

Check that the arguments are correct.

11120

An invalid argument is passed to cancel command.

Check that the arguments values are correct.

11130

Snapshot utility incompatible with cluster.

Check that snapshot utility is the same version as cluster.

11200

Snapshots utility failed to authenticate in the cluster at cancel command execution time.

Check that username and password are correct.

11300

Snapshots utility failed to connect to the cluster at cancel command execution time.

Check the following:

  • the node defined by -host and -port arguments is reachable.

  • the port number defined by -port is not blocked by firewalls.

  • check GridGain cluster logs to troubleshoot the issue further.

11400

The persistent store is not configured. The command can't be executed.

Refer to this documentation section for more details.

11410

Cluster is not active, command cannot be executed.

Activate cluster.

11800

Command executed successfully, but snapshot utility failed to write result to output file.

Check output file name and permissions.

11810

Command failed and snapshot utility failed to write error code to output file.

Check output file name and permissions.

SCHEDULE

This command will schedule snapshot operation in cluster.

{gridgain}/bin/snapshot-utility.sh schedule -list

List all registered schedules:
schedule -list [-verbose] [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Schedule snapshots creation:
schedule -name=SCHEDULE_NAME -command=create [-caches=cache1,cache2,...,cacheN] -full_frequency=FREQUENCY [-incremental_frequency=FREQUENCY] [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Schedule snapshots deletion:
schedule -name=SCHEDULE_NAME -command=delete [-ttl=TTL] [-frequency=hourly] [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Schedule snapshots moving:
schedule -name=SCHEDULE_NAME -command=move -dest=EXTERNAL_FOLDER [-ttl=TTL] [-frequency=hourly] [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Enabled specified schedule:
schedule -name=SCHEDULE_NAME -enable [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Disable specified schedule:
schedule -name=SCHEDULE_NAME -disable [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Delete specified schedule:
schedule -name=SCHEDULE_NAME -delete [-host=127.0.0.1] [-port=11211] [-ping_interval=5000] [-ping_timeout=30000]

Command Arguments

The command supports common arguments as well as additional ones.

Argument
Description
Default

-list

Show list of all registered schedules.

This is a mandatory argument that has to be set explicitly

-verbose

Enable verbose mode.

Empty.

-name

Schedule name.

This is a mandatory argument that has to be set explicitly.

-command

Command name: create, delete or move.

This is a mandatory argument that has to be set explicitly.

-caches

Names of the caches which data has to be included in a snapshot.

Data of all the caches will be included in a snapshot.

-full_frequency

Full snapshot frequency.

This is a mandatory argument that has to be set explicitly.

-incremental_frequency

Incremental snapshot frequency.

This is a mandatory argument that has to be set explicitly.

-frequency

Move and delete check frequency.

Every hour.

-ttl

Period after which snapshots will be considered as obsolete.

3d (three days).

-dest

Folder name where to move snapshot.

This is a mandatory argument that has to be set explicitly.

-enable

Enable specified snapshot schedule.

This is a mandatory argument that has to be set explicitly.

-disable

Disable specified snapshot schedule.

This is a mandatory argument that has to be set explicitly.

-delete

Delete specified snapshot schedule.

This is a mandatory argument that has to be set explicitly.

Where FREQUENCY could be one of the following:

  • 15mins - execute every 15 minutes
  • 30mins - execute every 30 minutes
  • hourly - execute every hour
  • daily - execute every day at 00:00
  • weekly - execute every sunday at 00:00
  • any valid CRON expression, for example: 0 0 * * *

Where TTL could be one of the following:

  • NNd - NN days, for example: 3d
  • NNh - NN hours, for example: 12h
  • NNm - NN minutes, for example: 90m
  • NN - NN milliseconds, for example: 100000

Error Codes

Code
Description
Solution

12000

Failed to execute schedule command.

Check cluster logs for errors. This error means, that some unexpected happened.

12110

Unknown or unsupported arguments specified for schedule command.

Check that the arguments are correct.

12120

An invalid argument is passed to schedule command.

Check that the arguments values are correct.

12130

Snapshot utility incompatible with cluster.

Check that snapshot utility is the same version as cluster.

12200

Snapshots utility failed to authenticate in the cluster at schedule command execution time.

Check that username and password are correct.

12300

Snapshots utility failed to connect to the cluster at schedule command execution time.

Check the following:

  • the node defined by -host and -port arguments is reachable.

  • the port number defined by -port is not blocked by firewalls.

  • check GridGain cluster logs to troubleshoot the issue further.

12400

The persistent store is not configured. The command can't be executed.

Refer to this documentation section for more details.

12410

Cluster is not active, command cannot be executed.

Activate cluster.

12420

"ignite-schedule" module not found in cluster nodes classpath.

Check cluster class path.

12430

Schedule with specified name not found.

Check that schedule name is correct.

12440

Schedule with specified name already exists.

Enter another name.

12800

Command executed successfully, but snapshot utility failed to write result to output file.

Check output file name and permissions.

12810

Command failed and snapshot utility failed to write error code to output file.

Check output file name and permissions.

Snapshots Management Tool