Edit

Ignite CLI Tool

Overview

The Ignite CLI tool uses REST API as a communication protocol between the node and the CLI, allowing you to configure the node. By default, the CLI tool runs in the interactive mode, but you can also execute commands without entering it.

When using the Ignite CLI tool, the arguments should be put in quotation marks, and the string should not include line breaks. For example:

cluster config update "ignite.security.authentication.providers.basic4={type=basic,username=name,password=pass}"

Otherwise, special POSIX characters in strings ({ and } in the above command) will be handled appropriately, leading to potentially unpredictable results.

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

cluster config update ignite.security.authentication.providers.basic4=\{type=basic,username=name,password=pass\}

Commands and Options

The following commands can be executed in the interactive CLI mode.

CLI Commands

These commands help you configure your CLI tool and cluster.

Command Parameters Description

Command	Parameters	Description
`cli config profile create`	`[--activate] [--copy-from] <profileName>`	Creates a profile with the given name, optionally by copying an existing profile, optionally activating the new profile upon creation.
`cli config profile activate`	`<profileName>`	Activates the profile identified by name.
`cli config profile list`		Lists configuration profiles.
`cli config profile show`		Gets the current profile details.
`cli config get`	`<key>`	Gets the value for the specified configuration key.
`cli config set`	`<String=String>…`	Sets configuration parameters using comma-separated input key-value pair(s).
`cli config show`		Shows the currently active configuration.
`cli config remove`	`<key>`	Removes the specified configuration key.

cli config profile create

[--activate] [--copy-from] <profileName>

Creates a profile with the given name, optionally by copying an existing profile, optionally activating the new profile upon creation.

cli config profile activate

<profileName>

Activates the profile identified by name.

cli config profile list

Lists configuration profiles.

cli config profile show

Gets the current profile details.

cli config get

<key>

Gets the value for the specified configuration key.

cli config set

<String=String>…

Sets configuration parameters using comma-separated input key-value pair(s).

cli config show

Shows the currently active configuration.

cli config remove

<key>

Removes the specified configuration key.

Cluster Commands

These commands let you manage your cluster.

Command Parameters Description

Command	Parameters	Description
`cluster config show`	`[--url] [<selector>]`	Shows configuration of the cluster indicated by the endpoint URL and, optionally, by a configuration path selector.
`cluster config update`	`[--url] <args>…`	Updates configuration of the cluster indicated by the endpoint URL with the provided argument values.
`cluster init`	`--name=<clusterName> [--url] [--cluster-management-group=<node name>[,<node name>…]] [--metastorage-group=<node name>[,<node name>…]] [--config=<config> \| --config-files=<file path>[,<file path>…]`	Initializes a cluster, optionally for the indicated cluster URL, optionally with Cluster Management Group and Cluster Metastorage nodes specified, with the cluster configuration optionally provided in a file or multiple files. The path to config files is resolved relative to the folder the CLI tool is started from.
`cluster metrics source disable`	`<srcName>`	Disables metrics from the specifies source on all nodes of the cluster.
`cluster metrics source enable`	`<srcName>`	Enables metrics for the specifies source on all nodes of the cluster.
`cluster metrics source list`		Prints a list of metric sources for each of the cluster’s nodes, along with each source’s status (enabled or disabled).
`cluster status`	`[--url]`	Displays the detailed status of the specified cluster.
`cluster topology physical`	`[--plain] [--url]`	Shows Physical Topology of the specified cluster, optionally in a plain format.
`cluster topology logical`	`[--plain] [--url]`	Shows Logical Topology of the specified cluster, optionally in a plain format.
`cluster unit deploy`	`--path [--url] --version [--nodes [, <nodes>…]]… <id>`	Deploys the specified version of a unit, from the specified path, optionally tp specific nodes.
`cluster unit undeploy`	`[--url] --version <id>`	Un-deploys the specified unit version, optionally for the specified cluster.
`cluster unit list`	`[--plain] [--url] [--status [,<statuses>…]]… [<unitId> [--version]]`	Lists cluster’s deployed units, optionally filtered by status.
`connect`	`[-u -p] <nodeUrl>`	Connects to the specified node, optionally with the specified user name (u) an password (p).
`disconnect`		Disconnects from the current cluster.

cluster config show

[--url] [<selector>]

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

cluster config update

[--url] <args>…

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

cluster init

--name=<clusterName> [--url] [--cluster-management-group=<node name>[,<node name>…]] [--metastorage-group=<node name>[,<node name>…]] [--config=<config> | --config-files=<file path>[,<file path>…]

Initializes a cluster, optionally for the indicated cluster URL, optionally with Cluster Management Group and Cluster Metastorage nodes specified, with the cluster configuration optionally provided in a file or multiple files. The path to config files is resolved relative to the folder the CLI tool is started from.

cluster metrics source disable

<srcName>

Disables metrics from the specifies source on all nodes of the cluster.

cluster metrics source enable

<srcName>

Enables metrics for the specifies source on all nodes of the cluster.

cluster metrics source list

Prints a list of metric sources for each of the cluster’s nodes, along with each source’s status (enabled or disabled).

cluster status

[--url]

Displays the detailed status of the specified cluster.

cluster topology physical

[--plain] [--url]

Shows Physical Topology of the specified cluster, optionally in a plain format.

cluster topology logical

[--plain] [--url]

Shows Logical Topology of the specified cluster, optionally in a plain format.

cluster unit deploy

--path [--url] --version [--nodes [, <nodes>…]]… <id>

Deploys the specified version of a unit, from the specified path, optionally tp specific nodes.

cluster unit undeploy

[--url] --version <id>

Un-deploys the specified unit version, optionally for the specified cluster.

cluster unit list

[--plain] [--url] [--status [,<statuses>…]]… [<unitId> [--version]]

Lists cluster’s deployed units, optionally filtered by status.

connect

[-u -p] <nodeUrl>

Connects to the specified node, optionally with the specified user name (u) an password (p).

disconnect

Disconnects from the current cluster.

Node Commands

These commands address specific node(s) in a cluster.

Command Parameters Description

Command	Parameters	Description
`node config show`	`[--url \| -n] [<selector>]`	Gets the specified node (n) configuration.
`node config update`	`[--url \| -n] <args>…`	Updates the local node configuration with the arguments in the HOCON format.
`node status`	`[--url \| -n]`	Shows the status of the default node, or a different one if specified.
`node version`	`[--url \| -n]`	Shows the node’s build version.
`node metric list`	`[--plain][--url \| -n]`	Lists node’s metrics.
`node metric source enable`	`[--url \| -n] <srcName>`	Enables a metric source for the node.
`node metric source disable`	`[--url \| -n] <srcName>`	Disables a metric source for the node.
`node metric source list`	`[--plain] [--url \| -n]`	Lists node metrics' sources.
`node unit list`	`[--plain] [--status [,<statuses>…]]…[<unitId> [--version]] [--url> \| -n]`	Lists node’s deployment units.

node config show

[--url | -n] [<selector>]

Gets the specified node (n) configuration.

node config update

[--url | -n] <args>…

Updates the local node configuration with the arguments in the HOCON format.

node status

[--url | -n]

Shows the status of the default node, or a different one if specified.

node version

[--url | -n]

Shows the node’s build version.

node metric list

[--plain][--url | -n]

Lists node’s metrics.

node metric source enable

[--url | -n] <srcName>

Enables a metric source for the node.

node metric source disable

[--url | -n] <srcName>

Disables a metric source for the node.

node metric source list

[--plain] [--url | -n]

Lists node metrics' sources.

node unit list

[--plain] [--status [,<statuses>…]]…[<unitId> [--version]] [--url> | -n]

Lists node’s deployment units.

Distribution Commands

These commands address partition distribution.

Command Parameters Description

Command	Parameters	Description
`distribution reset`	`[--zones <zoneNames>]`	Resets the algorithm state for partition distribution in all tables within the specified zones. Generates partition assignments "from scratch" (as if the same table (zone) was just created on the data nodes. This ensures data colocation between tables in a zone.

distribution reset

[--zones <zoneNames>]

Resets the algorithm state for partition distribution in all tables within the specified zones. Generates partition assignments "from scratch" (as if the same table (zone) was just created on the data nodes. This ensures data colocation between tables in a zone.

Miscellaneous Commands

These are general-purpose commands.

Command Parameters Description

Command	Parameters	Description
`cls`		Clears the terminal.
`exit`		Stops the current interactive session.
`help`	`<command or command group>`	Provides information on available command groups, commands in the specified group, or for the specified command.
`sql`	`[--plain] [--jdbc-url] [<command> \| --file]`	Executes the specified SQL query (command) or the queries included in the specified file, on the specified cluster.
`version`		Displays the current CLI tool version.

cls

Clears the terminal.

exit

Stops the current interactive session.

help

<command or command group>

Provides information on available command groups, commands in the specified group, or for the specified command.

sql

[--plain] [--jdbc-url] [<command> | --file]

Executes the specified SQL query (command) or the queries included in the specified file, on the specified cluster.

version

Displays the current CLI tool version.

© 2025 The Apache Software Foundation.
Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation.