GridGain Developers Hub

GridGain CLI Tool

Overview

The GridGain CLI communicates with the cluster via the REST API, allowing you to configure the entire cluster or apply node-specific settings. You can run the CLI either in the interactive mode or execute commands without entering it.

Interactive CLI Mode

To use the CLI in the interactive mode, first run it, then configure the cluster or node using the update command.

For example, to add a new user to the cluster:

cluster config update ignite.security.authentication.providers.default.users=[{username=newuser,displayName=newuser,password="newpassword",passwordEncoding=PLAIN,roles=[system]}]

Non-Interactive CLI Mode

Non-interactive mode is useful for quick updates or when running commands in scripts.

When running commands non-interactively, enclose arguments in quotation marks to ensure that special POSIX characters (such as { and }) are interpreted correctly:

bin/gridgain9 cluster config update "ignite.schemaSync={delayDurationMillis=500,maxClockSkewMillis=500}"
bin/gridgain9.bat cluster config update "ignite.schemaSync={delayDurationMillis=500,maxClockSkewMillis=500}"

Alternatively, you can use the backslash (\) to escape all special characters in your command. For example:

bin/gridgain9 cluster config update ignite.security.authentication.providers.default.users=\[\{username\=newuser,displayName\=newuser,password\=\"newpassword\",passwordEncoding\=PLAIN,roles\=\[system\]\}\]
bin/gridgain9.bat cluster config update ignite.security.authentication.providers.default.users=\[\{username\=newuser,displayName\=newuser,password\=\"newpassword\",passwordEncoding\=PLAIN,roles\=\[system\]\}\]

Non-interactive mode is also useful in automation scripts. For example, you can set configuration items in a Bash script as follows:

#!/bin/bash

...

bin/gridgain9 cluster config update "ignite.schemaSync={delayDurationMillis=500,maxClockSkewMillis=500}"

bin/gridgain9 cluster config update "ignite.security.authentication.providers.default.users=[{username=newuser,displayName=newuser,password=\"newpassword\",passwordEncoding=PLAIN,roles=[system]}]"

Verbose Output

All CLI commands can provide additional output that can be helpful in debugging. You can specify the -v option multiple times to increase output verbosity. Single option shows REST request and response, second option (-vv) shows request headers, third one (-vvv) shows request body.

CLI Tool Logs

CLI tool stores extended logs for your operations. These logs contain additional information not displayed during normal operation. You can configure the directory in the following ways:

  • By setting the IGNITE_CLI_LOGS_DIR environment variable to the directory logs will be stored it.

  • By setting the $XDG_STATE_HOME environment variable to set the CLI home folder. This configuration variable follows the XDG Base Directory Specification and does not override the IGNITE_CLI_LOGS_DIR. If $XDG_STATE_HOME is set and IGNITE_CLI_LOGS_DIR is not, logs will be stored in $XDG_STATE_HOME/ignitecli/logs directory.

If neither of the above properties are set, the logs are stored in the following locations:

  • On Unix systems and MacOS, in the ~/.local/state/ignitecli/logs directory;

  • On Windows, in the %USERPROFILE%\.local\state\ignitecli\logs folder.

SQL Commands

These commands help you execute SQL queries against the cluster.

sql

Executes SQL query or enters the interactive SQL editor mode if no SQL query is specified.

Syntax

sql [--jdbc-url=<jdbc>] [--plain] [--file=<file>] [--profile=<profileName>] [--verbose] <command>

Parameters

Parameter Type Required Description

‑‑jdbc‑url

Option

No

JDBC url to ignite cluster (e.g., 'jdbc:ignite:thin://127.0.0.1:10800').

‑‑plain

Flag

No

Display output with plain formatting.

‑‑file

Option

No

Path to file with SQL commands to execute.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<command>

Argument

Yes

SQL query to execute.

Example

sql "SELECT * FROM PUBLIC.PERSON"

sql planner invalidate-cache

Invalidates SQL planner cache.

Syntax

sql planner invalidate-cache [--tables=<tables>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑tables

Option

No

Comma-separated list of tables.

‑‑url

Option

No

URL of cluster endpoint. It can be any node URL. If not set, the default URL from the profile settings will be used.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

sql planner invalidate-cache --tables=PUBLIC.PERSON,PUBLIC.ORDERS

CLI Configuration Commands

These commands help you configure GridGain CLI tool profiles and settings.

cli config profile create

Creates a profile with the given name.

Syntax

cli config profile create [--activate] [--copy-from=<copyFrom>] [--verbose] <profileName>

Parameters

Parameter Type Required Description

‑‑activate

Flag

No

Activate new profile as current.

‑‑copy-from

Option

No

Profile whose content will be copied to new one.

‑‑verbose

Flag

No

Show additional information: logs, REST calls..

<profileName>

Argument

Yes

Name of new profile.

Example

cli config profile create --activate --copy-from=default myprofile

cli config profile activate

Activates the profile identified by name.

Syntax

cli config profile activate [--verbose] <profileName>

Parameters

Parameter Type Required Description

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<profileName>

Argument

Yes

Name of profile to activate.

Example

cli config profile activate myprofile

cli config profile list

Lists configuration profiles.

Syntax

cli config profile list [--verbose]

Parameters

Parameter Type Required Description

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cli config profile list

cli config profile show

Gets the current profile details.

Syntax

cli config profile show [--verbose]

Parameters

Parameter Type Required Description

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cli config profile show

cli config get

Gets the value for the specified configuration key.

Syntax

cli config get [--profile=<profileName>] [--verbose] <key>

Parameters

Parameter Type Required Description

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<key>

Argument

Yes

Property name.

Example

cli config get ignite.jdbc-url

cli config set

Sets configuration parameters using comma-separated input key-value pairs.

Syntax

cli config set [--profile=<profileName>] [--verbose] <String=String>...

Parameters

Parameter Type Required Description

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<String=String>…​

Arguments

Yes

CLI configuration parameters.

Example

cli config set ignite.jdbc-url=http://localhost:10300

cli config show

Shows the currently active configuration.

Syntax

cli config show [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cli config show

cli config remove

Removes the specified configuration key.

Syntax

cli config remove [--profile=<profileName>] [--verbose] <key>

Parameters

Parameter Type Required Description

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<key>

Argument

Yes

Property name.

Example

cli config remove ignite.jdbc-url

Cluster Commands

These commands help you manage your cluster.

cluster config show

Shows configuration of the cluster indicated by the endpoint URL and, optionally, by a configuration path selector.

Syntax

cluster config show [--url=<clusterUrl>] [--format=<format>] [--profile=<profileName>] [--verbose] [<selector>]

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of cluster endpoint.

‑‑format

Option

No

Output format. Valid values: JSON, HOCON (Default: HOCON).

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<selector>

Argument

No

Configuration path selector.

Example

cluster config show

cluster config update

Updates configuration of the cluster indicated by the endpoint URL with the provided argument values.

Syntax

cluster config update [--url=<clusterUrl>] [--file=<configFile>] [--profile=<profileName>] [--verbose] [<args>...]

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of cluster endpoint.

‑‑file

Option

No

Path to file with config update commands to execute.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<args>…​

Arguments

No

Configuration arguments and values to update.

Example

cluster config update ignite.system.idleSafeTimeSyncIntervalMillis=250

cluster init

Initializes an Ignite cluster.

Syntax

cluster init --name=<clusterName> --license=<license> [--metastorage-group=<nodeNames>] [--cluster-management-group=<nodeNames>] [--config=<config>] [--config-files=<filePaths>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Human-readable name of the cluster.

‑‑license

Option

Yes

License file.

‑‑metastorage-group

Option

No

Metastorage group nodes (comma-separated list).

‑‑cluster-management-group

Option

No

Names of nodes that will host the Cluster Management Group (comma-separated list).

‑‑config

Option

No

Cluster configuration that will be applied during initialization.

‑‑config-files

Option

No

Path to cluster configuration files (comma-separated list).

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cluster init --name=myCluster --license=/path/to/license

cluster status

Prints status of the cluster.

Syntax

cluster status [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cluster status --url http://localhost:10300

cluster topology physical

Shows physical topology of the specified cluster.

Syntax

cluster topology physical [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cluster topology physical --url http://localhost:10300

cluster topology logical

Shows logical topology of the specified cluster.

Syntax

cluster topology logical [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cluster topology logical --url http://localhost:10300

cluster unit deploy

Deploys a unit from a file or a directory (non-recursively).

Syntax

cluster unit deploy --version=<version> --path=<path> [--nodes=<nodes>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <id>

Parameters

Parameter Type Required Description

‑‑version

Option

Yes

Unit version (x.y.z).

‑‑path

Option

Yes

Path to deployment unit file or directory.

‑‑nodes

Option

No

Initial set of nodes where the unit will be deployed (comma-separated).

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<id>

Argument

Yes

Deployment unit identifier.

Example

cluster unit deploy --version=1.0.0 --path=/path/to/unit.jar

cluster unit undeploy

Undeploys a unit.

Syntax

cluster unit undeploy --version=<version> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <id>

Parameters

Parameter Type Required Description

‑‑version

Option

Yes

Unit version (x.y.z).

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<id>

Argument

Yes

Unit id.

Example

cluster unit undeploy --version=1.0.0 --url http://localhost:10300 myunit

cluster unit list

Shows a list of deployed units for specified deployment unit.

Syntax

cluster unit list [--version=<version>] [--status=<statuses>] [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <unitId>

Parameters

Parameter Type Required Description

‑‑version

Option

No

Filters out deployment unit by version (exact match assumed).

‑‑status

Option

No

Filters out deployment unit by status (comma-separated).

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<unitId>

Argument

Yes

Deployment unit id.

Example

cluster unit list --status=DEPLOYED,STARTING myunit

cluster metric source enable

Enables cluster metric source.

Syntax

cluster metric source enable [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <srcName>

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<srcName>

Argument

Yes

Metric source name.

Example

cluster metric source enable jvm

cluster metric source disable

Disables cluster metric source.

Syntax

cluster metric source disable [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <srcName>

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<srcName>

Argument

Yes

Metric source name.

Example

cluster metric source disable jvm

cluster metric source list

Lists cluster metric sources.

Syntax

cluster metric source list [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cluster metric source list

Snapshot Commands

These commands help you manage GridGain snapshots.

cluster snapshot create

Creates a new snapshot.

Syntax

cluster snapshot create --type=<snapshotType> (--all | --tables=<tableNames>) [--timestamp=<timestampValue>] [--destination=<destination>] [--encryption-provider=<encryptionProvider>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑type

Option

Yes

Type of the snapshot to create. Possible values: 'full', 'incremental'.

‑‑all

Flag

No

Create snapshot of all tables. Incompatible with --tables.

‑‑tables

Option

No

Comma-separated fully-qualified table names that will be parts of the snapshot. Incompatible with --all.

‑‑timestamp

Option

No

Timestamp to create snapshot at in the ISO-8601 format (e.g., 1970-01-01T00:00:00Z).

‑‑destination

Option

No

Name of the snapshot URI in configuration.

‑‑encryption‑provider

Option

No

Name of the encryption provider.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cluster snapshot create --type=full --all

cluster snapshot delete

Deletes a snapshot.

Syntax

cluster snapshot delete --id=<snapshotId> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑id

Option

Yes

ID of the snapshot.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cluster snapshot delete --id=15225e58-a045-4d7b-8ebe-b965f99d560c

cluster snapshot restore

Restores a snapshot.

Syntax

cluster snapshot restore --id=<snapshotId> [--tables=<tableNames>] [--source=<source>] [--decryption-provider=<decryptionProvider>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑id

Option

Yes

ID of the snapshot.

‑‑tables

Option

No

Comma-separated fully-qualified table names to restore from the snapshot.

‑‑source

Option

No

Name of the snapshot URI in configuration.

‑‑decryption‑provider

Option

No

Name of the decryption provider.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cluster snapshot restore --id=15225e58-a045-4d7b-8ebe-b965f99d560c --tables=PUBLIC.PERSON,PUBLIC.ORDERS

cluster snapshot status

Returns snapshot operations.

Syntax

cluster snapshot status [--plain] [--id=<operationId>] [--all-nodes] [--show-tables] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑plain

Flag

No

Display output with plain formatting.

‑‑id

Option

No

ID of the operation.

‑‑all-nodes

Flag

No

Optional flag that modifies the output to contain every status of all nodes that participate in the snapshot operation.

‑‑show-tables

Flag

No

Optional flag that modifies the output to contain table names that participate in snapshot creation or restoration.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cluster snapshot status --id=15225e58-a045-4d7b-8ebe-b965f99d560c --all-nodes --show-tables

Node Commands

These commands help you manage individual nodes.

node config show

Shows node configuration.

Syntax

node config show [--url=<nodeUrl>] [--format=<format>] [--profile=<profileName>] [--verbose] [<selector>]

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of a node that will be used as a communication endpoint.

‑‑format

Option

No

Output format. Valid values: JSON, HOCON (Default: HOCON).

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<selector>

Argument

No

Configuration path selector.

Example

node config show ignite.clientConnector

node config update

Updates node configuration.

Syntax

node config update [--url=<nodeUrl>] [--file=<configFile>] [--profile=<profileName>] [--verbose] [<args>...]

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of a node that will be used as a communication endpoint.

‑‑file

Option

No

Path to file with config update commands to execute.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<args>…​

Arguments

No

Configuration arguments and values to update.

Example

node config update --url http://localhost:10300 ignite.clientConnector.connectTimeoutMillis=5000

node status

Prints status of the node.

Syntax

node status [--url=<nodeUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of a node that will be used as a communication endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

node status

node version

Prints the node build version.

Syntax

node version [--url=<nodeUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of a node that will be used as a communication endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

node version

node metric list

Lists node metrics.

Syntax

node metric list [--url=<nodeUrl>] [--plain] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of a node that will be used as a communication endpoint.

‑‑plain

Flag

No

Display output with plain formatting.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

node metric list

node metric source enable

Enables node metric source.

Syntax

node metric source enable [--url=<nodeUrl>] [--profile=<profileName>] [--verbose] <srcName>

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of a node that will be used as a communication endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<srcName>

Argument

Yes

Metric source name.

Example

node metric source enable jvm

node metric source disable

Disables node metric source.

Syntax

node metric source disable [--url=<nodeUrl>] [--profile=<profileName>] [--verbose] <srcName>

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of a node that will be used as a communication endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<srcName>

Argument

Yes

Metric source name.

Example

node metric source disable jvm

node metric source list

Lists node metric sources.

Syntax

node metric source list [--url=<nodeUrl>] [--plain] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of a node that will be used as a communication endpoint.

‑‑plain

Flag

No

Display output with plain formatting.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

node metric source list --plain

node unit list

Shows a list of deployed units.

Syntax

node unit list [--version=<version>] [--status=<statuses>] [--url=<nodeUrl>] [--plain] [--profile=<profileName>] [--verbose] <unitId>

Parameters

Parameter Type Required Description

‑‑version

Option

No

Filters out deployment unit by version (exact match assumed).

‑‑status

Option

No

Filters out deployment unit by status (comma-separated).

‑‑url

Option

No

URL of a node that will be used as a communication endpoint.

‑‑plain

Flag

No

Display output with plain formatting.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<unitId>

Argument

Yes

Deployment unit id.

Example

node unit list --status=DEPLOYED myunit

Disaster Recovery Commands

These commands let you recover data partitions in disaster scenarios and recover system RAFT groups.

recovery partitions restart

Restarts partitions.

Syntax

recovery partitions restart --zone=<zoneName> --table=<tableName> [--partitions=<partitionIds>] [--nodes=<nodeNames>] [--with-cleanup] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑zone

Option

Yes

Name of the zone to reset partitions of. Case-sensitive, without quotes.

‑‑table

Option

Yes

Fully-qualified name of the table to reset partitions of. Case-sensitive, without quotes.

‑‑partitions

Option

No

IDs of partitions to get states. All partitions if not set (comma-separated).

‑‑nodes

Option

No

Names specifying nodes to get partition states from. Case-sensitive, without quotes, all nodes if not set (comma-separated).

‑‑with-cleanup

Flag

No

Restarts partitions, preceded by a storage cleanup. This will remove all data from the partition storages before restart.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

recovery partitions restart --zone=default --table=PUBLIC.PERSON --with-cleanup

recovery partitions reset

Resets partitions.

Syntax

recovery partitions reset --zone=<zoneName> [--table=<tableName>] [--partitions=<partitionIds>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑zone

Option

Yes

Name of the zone to reset partitions of. Case-sensitive, without quotes.

‑‑table

Option

No

Fully-qualified name of the table to reset partitions of. Case-sensitive, without quotes.

‑‑partitions

Option

No

IDs of partitions to get states. All partitions if not set (comma-separated).

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

recovery partitions reset --zone=default --table=PUBLIC.PERSON

recovery partitions states

Returns partition states.

Syntax

recovery partitions states (--global | --local) [--nodes=<nodeNames>] [--partitions=<partitionIds>] [--zones=<zoneNames>] [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑global

Flag

Yes

Gets global partition states. One of global or local is required.

‑‑local

Flag

Yes

Gets local partition states. One of global or local is required.

‑‑nodes

Option

No

Names specifying nodes to get partition states from. Case-sensitive, without quotes, all nodes if not set (comma-separated).

‑‑partitions

Option

No

IDs of partitions to get states. All partitions if not set (comma-separated).

‑‑zones

Option

No

Names specifying zones to get partition states from. Case-sensitive, without quotes, all zones if not set (comma-separated).

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

recovery partitions states --local --zones=default

recovery cluster reset

Resets cluster.

Syntax

recovery cluster reset [--cluster-management-group=<cmgNodeNames>] [--metastorage-replication-factor=<metastorageReplicationFactor>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑cluster-management-group

Option

No

Names of nodes that will host the Cluster Management Group (comma-separated)

‑‑metastorage‑replication‑factor

Option

No

Number of nodes in the voting member set of the Metastorage RAFT group.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

recovery cluster reset

recovery cluster migrate

Migrates nodes missed during repair to repaired cluster.

Syntax

recovery cluster migrate --old-cluster-url=<oldClusterUrl> --new-cluster-url=<newClusterUrl> [--verbose]

Parameters

Parameter Type Required Description

‑‑old‑cluster‑url

Option

Yes

URL of old cluster endpoint (nodes of this cluster will be migrated to a new cluster).

‑‑new‑cluster‑url

Option

Yes

URL of new cluster endpoint (nodes of old cluster will be migrated to this cluster).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

recovery cluster migrate --old-cluster-url=http://old-cluster:10300 --new-cluster-url=http://new-cluster:10300

recovery tables start

Starts a table point-in-time recovery.

Syntax

recovery tables start --tables=<tableNames> --timestamp=<timestamp> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑tables

Option

Yes

Comma-separated fully-qualified table names that will be recovered.

‑‑timestamp

Option

Yes

Timestamp to create snapshot at in the ISO-8601 format (e.g., 1970-01-01T00:00:00Z).

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

recovery tables start --tables=PUBLIC.PERSON,PUBLIC.ORDERS --timestamp=2024-01-01T00:00:00Z

recovery tables state

View state of a table point-in-time recovery.

Syntax

recovery tables state --id=<operationId> [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑id

Option

Yes

ID of the recovery operation.

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

recovery tables state --id=15225e58-a045-4d7b-8ebe-b965f99d560c --plain

User and Role Commands

These commands help you manage access to the system by defining users and roles.

role create

Creates a new role if it does not exist.

Syntax

role create [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <roleName>

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<roleName>

Argument

Yes

Role name.

Example

role create myrole

role delete

Deletes a role if it exists.

Syntax

role delete [--with-revoke] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <roleName>

Parameters

Parameter Type Required Description

‑‑with‑revoke

Flag

No

Revoke connected roles and users.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<roleName>

Argument

Yes

Role name.

Example

role delete --with-revoke myrole

role list

Lists roles.

Syntax

role list [--user=<user>] [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑user

Option

No

Filter by user name.

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

role list --user=admin

role show

Shows role information.

Syntax

role show [--with-users] [--with-privileges] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <roleName>

Parameters

Parameter Type Required Description

‑‑with‑users

Flag

No

Show role with assigned users.

‑‑with‑privileges

Flag

No

Show role with granted privileges.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<roleName>

Argument

Yes

Role name.

Example

role show --with-users --with-privileges myrole

role privilege grant

Grants a privilege to a role.

Syntax

role privilege grant --to=<roleName> --action=<action> [--on=<object>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑to

Option

Yes

To role name (comma-separated).

‑‑action

Option

Yes

Action (comma-separated).

‑‑on

Option

No

Object.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

role privilege grant --to=myrole --action=CREATE_TABLE

role privilege revoke

Revokes a privilege from a role.

Syntax

role privilege revoke --from=<roleName> --action=<action> [--on=<object>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑from

Option

Yes

From role (comma-separated).

‑‑action

Option

Yes

Action (comma-separated).

‑‑on

Option

No

Object.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

role privilege revoke --from=myrole --action=CREATE_TABLE

user create

Creates a new user if it does not exist.

Syntax

user create [--password=<password>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <username>

Parameters

Parameter Type Required Description

‑‑password

Option

No

Password.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<username>

Argument

Yes

Username.

Example

user create myuser

user delete

Deletes a user if it exists.

Syntax

user delete [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <username>

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<username>

Argument

Yes

Username.

Example

user delete myuser

user edit

Edits a user if it exists.

Syntax

user edit [--password=<password>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <username>

Parameters

Parameter Type Required Description

‑‑password

Option

No

Password.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<username>

Argument

Yes

Username.

Example

user edit --password=newpassword myuser

user list

Lists users.

Syntax

user list [--role=<role>] [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑role

Option

No

Filter by role name.

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

user list

user show

Shows user information.

Syntax

user show [--with-roles] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <username>

Parameters

Parameter Type Required Description

‑‑with‑roles

Flag

No

Show user with assigned roles.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<username>

Argument

Yes

Username.

Example

user show myuser

user role assign

Assigns a role to a user.

Syntax

user role assign --to=<username> --role=<roleName> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑to

Option

Yes

To username (comma-separated).

‑‑role

Option

Yes

Role name (comma-separated).

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

user role assign --to=myuser --role=myrole

user role revoke

Revokes a role from a user.

Syntax

user role revoke --from=<username> --role=<roleName> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑from

Option

Yes

From username (comma-separated).

‑‑role

Option

Yes

Role name (comma-separated).

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

user role revoke --from=myuser --role=myrole

Data Center Replication Commands

These commands help you manage data center replication.

dcr create

Creates data center replication.

Syntax

dcr create [--plain] --name=<name> --source-cluster-address=<sourceClusterAddresses> [--replication-nodes=<replicationNodes>] --username=<username> --password=<password> [--keyStorePath=<keyStorePath>] [--keyStorePassword=<keyStorePassword>] [--trustStorePath=<trustStorePath>] [--trustStorePassword=<trustStorePassword>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑plain

Flag

No

Display output with plain formatting.

‑‑name

Option

Yes

The unique name of the replication. Should be without whitespaces.

‑‑source‑cluster‑address

Option

Yes

Comma-separated list of client addresses of the cluster that is a source cluster for the replication.

‑‑replication‑nodes

Option

No

Comma-separated replication nodes names, worker node will be chosen from the list of replication nodes.

‑‑username

Option

Yes

Username.

‑‑password

Option

Yes

Password

‑‑keyStorePath

Option

No

Key store path for SSL/TLS.

‑‑keyStorePassword

Option

No

Key store password for SSL/TLS.

‑‑trustStorePath

Option

No

Trust store path for SSL/TLS.

‑‑trustStorePassword

Option

No

Trust store password for SSL/TLS.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

dcr create --name=myreplication --source-cluster-address=localhost:10300 --username=admin --password=password

dcr delete

Deletes data center replication.

Syntax

dcr delete --name=<nameOption> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Replication name.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

dcr delete --name=myreplication

dcr flush

Sets replication flush point with provided timestamp.

Syntax

dcr flush --name=<nameOption> --flush-point=<flushPoint> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Replication name.

‑‑flush‑point

Option

Yes

The flush point is a timestamp in the ISO-8601 format (e.g., 1970-01-01T00:00:00Z).

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

dcr flush --name=myreplication --flush-point=2024-01-01T00:00:00Z

dcr list

Lists all replications in the cluster.

Syntax

dcr list [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

dcr list

dcr start

Starts data center replication.

Syntax

dcr start --name=<nameOption> [--schema=<schema>] (--all | --tables=<tableNames>) [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Replication name.

‑‑schema

Option

No

Schema name (e.g., PUBLIC).

‑‑all

Flag

No

Replicate all tables. Incompatible with --tables. One of --tables or --all is required.

‑‑tables

Option

No

Comma-separated table names that should be replicated. Incompatible with --all. One of --tables or --all is required.

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

dcr start --name=myreplication --all

dcr stop

Stops data center replication.

Syntax

dcr stop --name=<nameOption> [--schema=<schema>] (--all | --tables=<tableNames>) [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Replication name.

‑‑schema

Option

No

Schema name (e.g., PUBLIC).

‑‑all

Flag

No

Replicate all tables. Incompatible with --tables. One of --tables or --all is required.

‑‑tables

Option

No

Comma-separated table names that should be replicated. Incompatible with --all. One of --tables or --all is required.

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

dcr stop --name=myreplication --all

dcr status

Shows data center replication status.

Syntax

dcr status --name=<nameOption> [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Replication name.

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

dcr status --name=myreplication

Distribution Commands

These commands help you manage table partition distribution.

distribution reset

Resets distribution of partitions.

Syntax

distribution reset --zones=<zoneNames> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑zones

Option

Yes

Names specifying zones to reset the distribution state in (comma-separated).

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

distribution reset --zones=default

License Commands

These commands help you manage the license on a running cluster.

license update

Updates license.

Syntax

license update [--url=<clusterUrl>] [--profile=<profileName>] [--verbose] <licenseFile>

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<licenseFile>

Argument

Yes

License file.

Example

license update /path/to/license

license show

Shows license.

Syntax

license show [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

license show

Rolling Update Commands

These commands help you manage rolling updates for cluster upgrades.

upgrade start

Starts rolling upgrade process.

Syntax

upgrade start --version=<version> [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑version

Option

Yes

New version. For example, 9.1.1.

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

upgrade start --version=9.1.8

upgrade commit

Commits rolling upgrade process.

Syntax

upgrade commit [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

upgrade commit

upgrade cancel

Cancels rolling upgrade process.

Syntax

upgrade cancel [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

upgrade cancel

upgrade state

Shows rolling upgrade state.

Syntax

upgrade state [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

upgrade state

Change Data Capture Commands

These commands help you manage Change Data Capture (CDC) sources, sinks, and replications.

cdc source create

Creates a CDC source.

Syntax

cdc source create --name=<name> --type=<type> --tables=<tables> [--parameters=<String=Object>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Name of the CDC source.

‑‑type

Option

Yes

Type of the CDC source.

‑‑tables

Option

Yes

Comma-separated fully-qualified table names that will be parts of the source.

‑‑parameters

Option

No

Comma-separated key-value pairs of parameters for the source. For example: 'param1=value1, param2=value2'. If not set, then default parameters will be used.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cdc source create --name=mysource --type=jdbc --tables=PUBLIC.PERSON,PUBLIC.ORDERS

cdc source update

Updates a CDC source.

Syntax

cdc source update --name=<name> --type=<type> --tables=<tables> [--parameters=<String=Object>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Name of the CDC source.

‑‑type

Option

Yes

Type of the CDC source.

‑‑tables

Option

Yes

Comma-separated fully-qualified table names that will be parts of the source.

‑‑parameters

Option

No

Comma-separated key-value pairs of parameters for the source. For example: 'param1=value1, param2=value2'. If not set, then default parameters will be used.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cdc source update --name=mysource --type=jdbc --tables=PUBLIC.USERS,PUBLIC.ORDERS --url http://localhost:10300

cdc source delete

Deletes a CDC source.

Syntax

cdc source delete --name=<name> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Name of the CDC source.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cdc source delete --name=mysource

cdc source status

Shows CDC source status.

Syntax

cdc source status --name=<name> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Name of the CDC source.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cdc source status --name=mysource

cdc source list

Lists CDC sources.

Syntax

cdc source list [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cdc source list

cdc sink create

Creates a CDC sink.

Syntax

cdc sink create --name=<name> --type=<type> [--parameters=<String=Object>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Name of the CDC sink.

‑‑type

Option

Yes

Type of the CDC sink.

‑‑parameters

Option

No

Comma-separated key-value pairs of parameters for the sink. For example: 'param1=value1, param2=value2'. If not set, then default parameters will be used.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cdc sink create --name=mysink --type=Iceberg

cdc sink update

Updates a CDC sink.

Syntax

cdc sink update --name=<name> --type=<type> [--parameters=<String=Object>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Name of the CDC sink.

‑‑type

Option

Yes

Type of the CDC sink.

‑‑parameters

Option

No

Comma-separated key-value pairs of parameters for the sink. For example: 'param1=value1, param2=value2'. If not set, then default parameters will be used.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cdc sink update --name=mysink --type=Iceberg

cdc sink delete

Deletes a CDC sink.

Syntax

cdc sink delete --name=<name> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Name of the CDC sink.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cdc sink delete --name=mysink

cdc sink status

Shows CDC sink status.

Syntax

cdc sink status --name=<name> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Name of the CDC sink.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cdc sink status --name=mysink

cdc replication create

Creates a CDC replication.

Syntax

cdc replication create --name=<name> --sink=<sinkName> --source=<sourceName> [--mode=<mode>] [--execution-nodes=<executionNodes>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Name of the CDC replication.

‑‑sink

Option

Yes

Name of the CDC sink to use for replication. If not set, then the first sink will be used.

‑‑source

Option

Yes

Name of the CDC source to use for replication. If not set, then the first source will be used.

‑‑mode

Option

No

Replication mode. Possible values: 'ALL', 'NEW_DATA'. If not set, then 'ALL' mode will be used.

‑‑execution‑nodes

Option

No

Names of nodes (comma-separated list) that will host the CDC replication. If not set, then a random node will be used.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cdc replication create --name=myreplication --sink=mysink --source=mysource --mode=ALL

cdc replication delete

Deletes a CDC replication.

Syntax

cdc replication delete --name=<name> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Name of the CDC replication.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cdc replication delete --name=myreplication

cdc replication status

Shows CDC replication status.

Syntax

cdc replication status --name=<name> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Name of the CDC replication.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cdc replication status --name=myreplication

cdc replication stop

Stops a CDC replication.

Syntax

cdc replication stop --name=<name> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Name of the CDC replication.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cdc replication stop --name=myreplication

cdc replication start

Starts a CDC replication.

Syntax

cdc replication start --name=<name> [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑name

Option

Yes

Name of the CDC replication.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cdc replication start --name=myreplication

cdc replication list

Lists CDC replications.

Syntax

cdc replication list [--plain] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑plain

Flag

No

Display output with plain formatting.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cdc replication list

JWT Management Commands

These commands help you manage JWT tokens.

token revoke

Revokes a token.

Syntax

token revoke [--token=<token>] [--username=<username>] [--url=<clusterUrl>] [--profile=<profileName>] [--verbose]

Parameters

Parameter Type Required Description

‑‑token

Option

No

Specific token to revoke.

‑‑username

Option

No

Username to revoke all tokens for.

‑‑url

Option

No

URL of cluster endpoint.

‑‑profile

Option

No

Local CLI profile name (only available in non-interactive mode).

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

token revoke --username=admin

Miscellaneous Commands

These are general-purpose commands.

connect

Connects to an Ignite 3 node.

Syntax

connect --username=<username> --password=<password> [--verbose] <nodeUrl>

Parameters

Parameter Type Required Description

‑‑username

Option

Yes

Username to connect to cluster.

‑‑password

Option

Yes

Password to connect to cluster.

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

<nodeUrl>

Argument

Yes

URL of a node that will be used as a communication endpoint.

Example

connect --username=admin --password=password http://localhost:10300

disconnect

Disconnects from an Ignite 3 node.

Syntax

disconnect [--verbose]

Parameters

Parameter Type Required Description

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

disconnect

clear

Clears the screen.

Syntax

clear

Parameters

Parameter Type Required Description

None

This command takes no parameters.

Example

clear

cls

Clears the screen.

Syntax

cls [--verbose]

Parameters

Parameter Type Required Description

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

cls

exit

Exits the CLI.

Syntax

exit [--verbose]

Parameters

Parameter Type Required Description

‑‑verbose

Flag

No

Show additional information: logs, REST calls.

Example

exit

help

Display help information about the specified command.

Syntax

help [COMMAND]

Parameters

Parameter Type Required Description

[COMMAND]

Argument

No

The COMMAND to display the usage help message for.

Example

help cluster config show

version

Displays the current CLI tool version.

Syntax

version

Parameters

Parameter Type Required Description

None

This command takes no parameters.

Example

version

© 2025 GridGain Systems, Inc. All Rights Reserved. Privacy Policy | Legal Notices. GridGain® is a registered trademark of GridGain Systems, Inc.
Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation.

Last updated on Sep 29, 2025