GridGain CLI Tool

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 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 snapshot create

[--timestamp] [--url] (--all | --tables [,<tableNames>…​] [--tables [,<tableNames>…​]]…​)

Creates a new snapshot, optionally at the indicated timestamp, optionally for the indicated cluster URL, optionally for the specified tables only.

cluster snapshot delete

--id [--url]

Deletes the specified snapshot, optionally for the indicated cluster URL.

cluster snapshot restore

--id [--url] [--tables [,<tableNames>…​]]…​

Restores data from the specified snapshot, optionally for the indicated cluster URL, optionally for the specified tables only.

cluster snapshot status

[--all-nodes] [--plain] [--show-tables] [--id] [--url]

Provides information about the current status of the specified snapshot, optionally for the indicated cluster URL, optionally for the specified tables only. If no snapshot ID is specified, provides information about the status of all snapshots.

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.

recovery partitions restart

--table [--url] --zone [--nodes [,<nodeNames>…​]]…​ [--partitions [, <partitionIds>…​]]…​]

Restarts the indicated partitions of the specified table (if not specified, all existing partitions) on the indicated nodes in the indicated zones.

recovery partitions reset

--table [--url] --zone [--partitions [, <partitionIds>…​]]…​

Resets the indicated partitions (if not specified, all existing partitions) in the indicated zones (if not specified, in all existing zones). This operation is irreversible. It can lead to data loss. Use with caution, only when strictly necessary.

recovery partitions states

[--plain] [--url] [--partitions [, <partitionIds>…​]]…​ [--zones [, <zoneNames>…​]]…​ (--global | [--local [--nodes [,<nodeNames>…​]]…​])

Returns the partition states (local or global), optionally for the indicated nodes and/or zones and/or partitions.

recovery cluster reset for CMG

--url=<node-url> --cluster-management-group=<new-cmg-nodes>

Initiates CMG node group repair to restore the lost majority. The command is sent to the node indicated by the --url parameter, which must belong to the new-cmg-nodes RAFT group (a comma-separated list of nodes that belong to cluster’s physical topology).

recovery cluster reset for MG

--url=<existing-node-url> [--cluster-management-group=<new-cmg-nodes>] --metastorage-replication-factor=N

Initiates MG node group repair to restore the lost majority. N is the requested number of the voting RAFT nodes in the MG after repair. If you omit --cluster-management-group, the command takes the current CMG voting members set from the CMG leader; if CMG is not available, the command fails.

recovery cluster migrate

--old-cluster-url=<url-of-old-cluster-node> --new-cluster-url=<url-of-new-cluster-node>

Initiates migration of a CMG or MG node that did not take part in recovery performed by recovery cluster reset (because it was down or unavailable due to a network partition) to the new (recovered) cluster.

role create

[--url] <roleName>

Creates a new role, optionally for the indicated cluster endpoint URL. New roles do not have any privileges.

role delete

[--url] <roleName>

Deletes the specified role, optionally from the indicated cluster endpoint URL. Role with assigned privileges cannot be deleted.

role list

[--plain] [--url] [--user]

Lists roles, optionally for the indicated cluster endpoint URL, optionally filtered by user(s).

role show

[--with-privileges] [--with-users] [--url] <roleName>

Shows the role information, optionally including privileges assigned to the role and/or the users who have that role, optionally for the indicated cluster endpoint URL.

role privilege grant

[--on] [--url>] [--action[,<action>…​]]…​ --to=[,<roleName>…​] [--to [,<roleName>…​]]…​

Grants to the specified role a privilege (permission to perform the specified action on an the specified object). For more information, see User Permissions and Roles.

role privilege revoke

[--on] [--url] [--action [,<action>…​]]…​ [--from [,<roleName>…​]]…​

Revokes privilege(s) (permissions)(s) to perform the specified action on the specified object) from the role. For more information, see User Permissions and Roles.

user create

[--password] [--url] <username>

Creates a new user.

user delete

[--url] <username>

Deletes the user.

user edit

[--password] [--url] <username>

Edits user configuration.

user list

[--plain] [--url] [--role]

Provides a list of users on the server, optionally filtered by role.

user show

[--with-roles] [--url] <username>

Provides extended information about the specific user, optionally with information about roles assigned to that user.

user role assign

[--profile] [--url=<clusterUrl>] [-r [,<roleName>…​]]…​ [--to [,<username>…​]]…​

Assigns role(s) to the specified user.

user role revoke

[--profile>] [--url] [--from [,<username>…​]]…​ [-r [,<roleName>…​]]…​

Revokes role(s) from the specified user.

dcr create

[--plain] --name --source-cluster-address [--url] [--replication-nodes [,<replicationNodes>…​]]…​ [--username --password] [[--keyStorePath] [--keyStorePassword] --trustStorePath] [--trustStorePassword]]

Creates a replication from the source cluster to the current cluster.

dcr delete

[--url] <name>

Deletes replication specified by the cluster URL and replication name.

dcr flush

--flush-point [--url] <replicationName>

Sets a replication flush point with the provided ISO time.

dcr list

[--plain] [--url]

Lists all replications for the specified cluster, along with their statuses, optionally in a plain format.

dcr start

[--plain] [--schema] [--url] (--all | --tables [,<tableNames>…​]) <name>

Starts or resumes the replication specified by name.

dcr stop

[--plain] [--schema] [--url] (--all | --tables [,<tableNames>…​]) <name>

Stops replication specified by ID.

dcr status

[--plain] [--url] <name>

Shows the current status of the specific replication.

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.

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.

token revoke

[--url] (--token | --username)

Revokes the JWT token. Can revoke a specific token, or all tokens for the specified user.

version

Displays the current CLI tool version.