> For the complete documentation index, see [llms.txt](https://mariadb.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mariadb.com/docs/gridgain/gridgain-8/reference/cli-tool.md). # Control Script Reference for the GridGain control.sh|bat command line tool used to monitor and control clusters — full command list, syntax, and connection parameters. GridGain provides a command line script — `control.sh|bat` — that you can use to monitor and control your clusters. The script is located under the `/bin/` folder of the installation directory. You can define the `control.sh|bat` log directory via an environment variable: {% tabs %} {% tab title="Linux/Unix" %} ```shell $ CONTROL_JVM_OPTS=-Djava.util.logging.config.file= ./control.sh ``` {% endtab %} {% tab title="Windows" %} ```shell $ CONTROL_JVM_OPTS=-Djava.util.logging.config.file= ./control.bat ``` {% endtab %} {% endtabs %} ## Commands The control script supports the following commands (in alphabetical order): * [baseline add](#baseline-add) * [baseline autoadjust disable](#baseline-autoadjust-disable) * [baseline autoadjust enable](#baseline-autoadjust-enable) * [baseline scale\_down\_auto\_adjust](#baseline-scale_down_auto_adjust) * [baseline scale\_up\_auto\_adjust](#baseline-scale_up_auto_adjust) * [baseline remove](#baseline-remove) * [baseline set](#baseline-set) * [baseline version](#baseline-version) * [baseline](#baseline) * [cache check\_index\_inline\_sizes](#cache-check_index_inline_sizes) * [cache clear](#cache-clear) * [cache contention](#cache-contention) * [cache destroy](#cache-destroy) * [cache distribution](#cache-distribution) * [cache idle\_verify](#cache-idle_verify) * [cache indexes\_list](#cache-indexes_list) * [cache indexes\_force\_rebuild](#cache-indexes_force_rebuild) * [cache list](#cache-list) * [cache partition\_reconciliation\_cancel](#cache-partition_reconciliation_cancel) * [cache partition\_reconciliation](#cache-partition_reconciliation) * [cache reset\_lost\_partitions](#cache-reset_lost_partitions) * [cache validate\_indexes](#cache-validate_indexes) * [change-id](#change-id) * [change-tag](#change-tag) * [checkpoint](#checkpoint) * [checkpointing force](#checkpointing-force) * [defragmentation cancel](#defragmentation-cancel) * [defragmentation schedule](#defragmentation-schedule) * [defragmentation status](#defragmentation-status) * [diagnostic](#diagnostic) * [dr cache](#dr-cache) * [dr check-partition-counters](#dr-check-partition-counters) * [dr cleanup-partition-tree](#dr-cleanup-partition-tree) * [dr full-state-transfer cancel](#dr-full-state-transfer-cancel) * [dr full-state-transfer list](#dr-full-state-transfer-list) * [dr full-state-transfer start](#dr-full-state-transfer-start) * [dr node](#dr-node) * [dr pause](#dr-pause) * [dr rebuild-partition-tree](#dr-rebuild-partition-tree) * [dr repair-partition-counters](#dr-repair-partition-counters) * [dr reset-partition-tree](#dr-reset-partition-tree) * [dr resume](#dr-resume) * [dr state](#dr-state) * [dr topology](#dr-topology) * [encryption change\_cache\_key](#encryption-change_cache_key) * [encryption cache\_key\_ids](#encryption-cache_key_ids) * [encryption change\_master\_key](#encryption-change_master_key) * [encryption get\_master\_key\_name](#encryption-get_master_key_name) * [encryption reencryption\_rate\_limit](#encryption-reencryption_rate_limit) * [encryption reencryption\_status](#encryption-reencryption_status) * [encryption resume\_reencryption](#encryption-resume_reencryption) * [encryption suspend\_reencryption](#encryption-suspend_reencryption) * [kill sql](#kill-sql) * [kill client](#kill-client) * [kill continuous](#kill-continuous) * [kill scan](#kill-scan) * [meta details](#meta-details) * [meta list](#meta-list) * [meta remove](#meta-remove) * [meta update](#meta-update) * [metric](#metric) * [persistence backup](#persistence-backup) * [persistence clean](#persistence-clean) * [persistence](#persistence) * [property get](#property-get) * [property list](#property-list) * [property set](#property-set) * [rolling-upgrade finish](#rolling-upgrade-finish) * [rolling-upgrade force](#rolling-upgrade-force) * [rolling-upgrade start](#rolling-upgrade-start) * [rolling-upgrade status](#rolling-upgrade-status) * [set-state](#set-state) * [shutdown-policy](#shutdown-policy) * [snapshot cancel](#snapshot-cancel) * [snapshot create](#snapshot-create) * [snapshot restore](#snapshot-restore) * [snapshot status](#snapshot-status) * [state](#state) * [tracing-configuration](#tracing-configuration) * [tracing-configuration get](#tracing-configuration-get) * [tracing-configuration get\_all](#tracing-configuration-get_all) * [tracing-configuration reset](#tracing-configuration-reset) * [tracing-configuration reset\_all](#tracing-configuration-reset_all) * [tracing-configuration set](#tracing-configuration-set) * [tx --info](#tx-info) * [tx --kill](#tx-kill) * [warm-up](#warm-up) ## Script Syntax The control script has the following syntax: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat ``` {% endtab %} {% endtabs %} * `` – parameters the script uses to connect to a cluster node. These parameters are required for the commands that are executed on the cluster nodes. If no connection parameters are provided, the control script tries to connect to a node running on localhost (`localhost:11211`). * `` – one of the commands listed above. * `` – command-specific arguments. {% hint style="info" %} The `control.sh|bat` script commands use a legacy protocol that requires direct connections to all nodes in the cluster, not just the one you are running the command on. When you run the command on a coordinator node, it succeeds because that node has direct visibility to all other nodes. However, if you run the command from a node that is not the coordinator, it can fail if that node cannot reach all the others on the required port. {% endhint %} To resolve this issue, you can try the following: * Ensure that port 11211 is open between all nodes on your server subnet. * In some cases, if the wrong network interface is used, or a node has more than one network interface, you may need to explicitly specify the correct hostname or IP address by using the `--host` option and pass your hostname as an argument: ```shell ./control.sh --host your_hostname ``` ## Connection Parameters | Parameter | Description | Default Value | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- | | --host HOST\_OR\_IP | The host name or IP address of the node. | `localhost` | | --port PORT | The port to connect to. The port must be opened on the host specified in the `--host` property. | `11211` | | --user USER | The user name. | | | --password PASSWORD | The user password. | | | --ping-interval PING\_INTERVAL | The ping interval. | 5000 | | --ping-timeout PING\_TIMEOUT | The ping response timeout. | 30000 | | --ssl-protocol PROTOCOL1, PROTOCOL2... | A list of SSL protocols to try when connecting to the cluster. [Supported protocols](https://docs.oracle.com/javase/8/docs/technotes/guides/security/SunProviders.html#SunJSSE_Protocols). | `TLS` | | --ssl-cipher-suites CIPHER1,CIPHER2... | A list of SSL ciphers. [Supported ciphers](https://docs.oracle.com/javase/8/docs/technotes/guides/security/SunProviders.html#SupportedCipherSuites). | | | --ssl-key-algorithm ALG | The SSL key algorithm. | `SunX509` | | --keystore-type KEYSTORE\_TYPE | The keystore type. | `JKS` | | --keystore KEYSTORE\_PATH | The path to the keystore. Specify a keystore to enable SSL for the control script. | | | --keystore-password KEYSTORE\_PWD | The password to the keystore. | | | --truststore-type TRUSTSTORE\_TYPE | The type of the truststore. | `JKS` | | --truststore TRUSTSTORE\_PATH | The path to the truststore. | | | --truststore-password TRUSTSTORE\_PWD | The trustore password. | | ## Activation, Deactivation, and Topology Management You can use the control script to activate or deactivate your cluster, and manage the [Baseline Topology](/docs/gridgain/gridgain-8/architecture/cluster/baseline-topology.md). {% hint style="warning" %} Deactivation deallocates all memory resources, including your application data, on all cluster nodes and disables public cluster API. If you have in-memory caches that are not backed up by a persistent storage (neither [native persistent storage](/docs/gridgain/gridgain-8/architecture/storage/native-persistence.md) nor [external storage](/docs/gridgain/gridgain-8/gridgain8-development/caches-and-memory/persistence/external-storage.md)), you will lose the data and will have to repopulate these caches. {% endhint %} ### set-state Use this command to set a cluster's state: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --set-state [--yes] ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --set-state [--yes] ``` {% endtab %} {% endtabs %} The command arguments are as follows. | Argument | Description | Values | | -------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | state | The state to put the cluster in. |

- ACTIVE - sets the baseline topology of the cluster to the set of nodes available at the moment of activation. Activation is required only if you use native persistence.
- INACTIVE - deactivates the cluster.
- ACTIVE\_READ\_ONLY - sets cluster to read only mode: it will be active but cache updates will be denied.

| | --yes | Optional; if used, fast-forwards the command by automatically answering "yes" to all of the command's prompts. | | ### state To get the state of a cluster (activated or not), use the following syntax: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --state ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --state ``` {% endtab %} {% endtabs %} ### baseline To get a list of nodes registered in the [baseline topology](/docs/gridgain/gridgain-8/architecture/cluster/baseline-topology.md), run the following command: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --baseline ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --baseline ``` {% endtab %} {% endtabs %} The output contains the current topology version, the list of consistent IDs of the nodes included in the baseline topology, and the list of nodes that joined the cluster but were not added to the baseline topology. ```shell Command [BASELINE] started Arguments: --baseline -------------------------------------------------------------------------------- Cluster state: active Current topology version: 3 Current topology version: 3 (Coordinator: ConsistentId=dd3d3959-4fd6-4dc2-8199-bee213b34ff1, Order=1) Baseline nodes: ConsistentId=7d79a1b5-cbbd-4ab5-9665-e8af0454f178, State=ONLINE, Order=2 ConsistentId=dd3d3959-4fd6-4dc2-8199-bee213b34ff1, State=ONLINE, Order=1 -------------------------------------------------------------------------------- Number of baseline nodes: 2 Other nodes: ConsistentId=30e16660-49f8-4225-9122-c1b684723e97, Order=3 Number of other nodes: 1 Command [BASELINE] finished with code: 0 Control utility has completed execution at: 2019-12-24T16:53:08.392865 Execution time: 333 ms ``` ### baseline add To add a node (or multiple nodes) to the [baseline topology](/docs/gridgain/gridgain-8/architecture/cluster/baseline-topology.md), run the following command. {% hint style="info" %} Addition of a node starts the [rebalancing process](/docs/gridgain/gridgain-8/architecture/replication-and-consistency/data-rebalancing.md). {% endhint %} {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --baseline add [--yes] ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --baseline add [--yes] ``` {% endtab %} {% endtabs %} The command arguments are as follows. | Argument | Description | | ----------- | -------------------------------------------------------------------------------------------------------------- | | Id1,Id2,... | A comma-separated list of consistent IDs of the nodes to add. | | --yes | Optional; if used, fast-forwards the command by automatically answering "yes" to all of the command's prompts. | ### baseline remove To remove a node from the [baseline topology](/docs/gridgain/gridgain-8/architecture/cluster/baseline-topology.md), use the following command. {% hint style="info" %} Only offline nodes can be removed from the baseline topology. Shut down the node first and then use the `remove` command. This operation starts the [rebalancing process](/docs/gridgain/gridgain-8/architecture/replication-and-consistency/data-rebalancing.md), which will re-distribute the data across the nodes that remain in the baseline topology. {% endhint %} {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --baseline remove [--yes] ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --baseline remove [--yes] ``` {% endtab %} {% endtabs %} The command arguments are as follows. | Argument | Description | | ----------- | -------------------------------------------------------------------------------------------------------------- | | Id1,Id2,... | A comma-separated list of consistent IDs of the nodes to remove. | | --yes | Optional; if used, fast-forwards the command by automatically answering "yes" to all of the command's prompts. | ### baseline set You can set [baseline topology](/docs/gridgain/gridgain-8/architecture/cluster/baseline-topology.md) by providing a list of nodes (consistent IDs). The command syntax is as follows: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --baseline set [--yes] ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --baseline set [--yes] ``` {% endtab %} {% endtabs %} The command arguments are as follows. | Argument | Description | | ----------- | ----------------------------------------------------------------------------------------------------------------- | | Id1,Id2,... | A comma-separated list of consistent IDs of the nodes for setting baseline topology. | | --yes | Optional; if used, it fast-forwards the command by automatically answering "yes" to all of the command's prompts. | ### baseline version To restore a specific version of the [baseline topology](/docs/gridgain/gridgain-8/architecture/cluster/baseline-topology.md), use the following command: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --baseline version [--yes] ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --baseline version [--yes] ``` {% endtab %} {% endtabs %} The command arguments are as follows. | Argument | Description | | --------------- | -------------------------------------------------------------------------------------------------------------- | | topologyVersion | The version of the baseline topology to restore. | | --yes | Optional; if used, fast-forwards the command by automatically answering "yes" to all of the command's prompts. | ### baseline autoadjust enable {% hint style="warning" %} The `auto_adjust` command is deprecated and will be removed in a future release. Use [baseline scale\_up\_auto\_adjust](#baseline-scale_up_auto_adjust) and [baseline scale\_down\_auto\_adjust](#baseline-scale_down_auto_adjust) to control autoadjust instead. {% endhint %} [Baseline topology autoadjustment](/docs/gridgain/gridgain-8/architecture/cluster/baseline-topology.md#baseline-topology-autoadjustment) is an automatic update of baseline topology after the topology has been stable for a specific amount of time. For in-memory clusters, autoadjustment is enabled by default with the timeout set to 0. It means that baseline topology changes immediately after server nodes join or leave the cluster. For clusters with persistence, the automatic baseline adjustment is disabled by default. To enable autoadjust, use the following command: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --baseline auto_adjust enable timeout ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --baseline auto_adjust enable timeout ``` {% endtab %} {% endtabs %} The command arguments are as follows. | Argument | Description | Default Value | | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | timeout | The autoadjust timeout, in milliseconds. The baseline is set to the current topology when a given number of milliseconds has passed after the last JOIN/LEFT/FAIL event. Every new JOIN/LEFT/FAIL event restarts the timeout countdown. | `0` | ### baseline autoadjust disable {% hint style="warning" %} The `auto_adjust` command is deprecated and will be removed in a future release. Disabling it turns off both scale-up and scale-down autoadjustment. Use [baseline scale\_up\_auto\_adjust](#baseline-scale_up_auto_adjust) and [baseline scale\_down\_auto\_adjust](#baseline-scale_down_auto_adjust) to control autoadjust instead. {% endhint %} [Baseline topology autoadjustment](/docs/gridgain/gridgain-8/architecture/cluster/baseline-topology.md#baseline-topology-autoadjustment) is an automatic update of baseline topology after the topology has been stable for a specific amount of time. For clusters with persistence, the automatic baseline adjustment is disabled by default. For in-memory clusters, autoadjustment is enabled by default with the timeout set to 0. It means that baseline topology changes immediately after server nodes join or leave the cluster. To disable baseline autoadjustment, use the following command: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --baseline auto_adjust disable ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --baseline auto_adjust disable ``` {% endtab %} {% endtabs %} ### baseline scale\_up\_auto\_adjust You can configure [baseline autoadjustment](/docs/gridgain/gridgain-8/architecture/cluster/baseline-topology.md#baseline-topology-autoadjustment) separately for scale-up events — when server nodes join the cluster and are added to the baseline topology. This lets you use a different timeout for adding nodes than for removing them. For in-memory clusters, scale-up autoadjustment is enabled by default with the timeout set to 0. For clusters with persistence, it is disabled by default; when enabled, the default timeout is 5 minutes. To enable scale-up autoadjustment, use the following command: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --baseline scale_up_auto_adjust enable timeout ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --baseline scale_up_auto_adjust enable timeout ``` {% endtab %} {% endtabs %} To disable scale-up autoadjustment, use the following command: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --baseline scale_up_auto_adjust disable ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --baseline scale_up_auto_adjust disable ``` {% endtab %} {% endtabs %} The command arguments are as follows. | Argument | Description | Default Value | | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | timeout | The scale-up autoadjust timeout, in milliseconds. The baseline is set to the current topology when the given number of milliseconds has passed since the last node-join event. Every new join event restarts the timeout countdown. | `0` | ### baseline scale\_down\_auto\_adjust You can configure [baseline autoadjustment](/docs/gridgain/gridgain-8/architecture/cluster/baseline-topology.md#baseline-topology-autoadjustment) separately for scale-down events — when server nodes leave the cluster and are removed from the baseline topology. For in-memory clusters, scale-down autoadjustment is enabled by default with the timeout set to 0. For clusters with persistence, it is disabled by default. Note that on persistent clusters the default scale-down timeout is effectively infinite: even after you enable scale-down autoadjustment, departed nodes are not removed from the baseline automatically until you set a finite timeout. This prevents unintended data loss from removing persistent nodes. To enable scale-down autoadjustment, use the following command: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --baseline scale_down_auto_adjust enable timeout ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --baseline scale_down_auto_adjust enable timeout ``` {% endtab %} {% endtabs %} To disable scale-down autoadjustment, use the following command: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --baseline scale_down_auto_adjust disable ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --baseline scale_down_auto_adjust disable ``` {% endtab %} {% endtabs %} The command arguments are as follows. | Argument | Description | Default Value | | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | timeout | The scale-down autoadjust timeout, in milliseconds. The baseline is set to the current topology when the given number of milliseconds has passed since the last node-leave or node-fail event. Every new leave/fail event restarts the timeout countdown. | `0` | ## Transaction Management The control script allows you to get information about the transactions that are executed in the cluster, as well as to cancel specific transactions. ### tx --info The following command returns a list of transactions that meet the filter conditions (or all transactions if no filter is defined): {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --tx --info ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --tx --info ``` {% endtab %} {% endtabs %} The transaction filter parameters are as follows. | Parameter | Description | | ----------------------------------- | ----------------------------------------------------------------------- | | --xid XID | The transaction ID. | | --min-duration SECONDS | The minimum number of seconds a transaction has been executing. | | --min-size SIZE | The minimum transaction size. | | --label LABEL | The user label for transactions (you can use a regular expression). | | --servers\|--clients | Limits the scope of the operation to either the server or client nodes. | | --nodes nodeId1,nodeId2... | The list of consistent IDs of the nodes to get transactions from. | | --limit NUMBER | Limits the number of transactions to the given value. | | --order DURATION\|SIZE\|START\_TIME | The parameter to sort the output by. | ### tx --kill To cancel transactions, use the following command: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --tx --kill ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --tx --kill ``` {% endtab %} {% endtabs %} The transaction filter parameters are as follows. | Parameter | Description | | ----------------------------------- | ----------------------------------------------------------------------- | | --xid XID | The transaction ID. | | --min-duration SECONDS | The minimum number of seconds a transaction has been executing. | | --min-size SIZE | The minimum transaction size. | | --label LABEL | The user label for transactions (you can use a regular expression). | | --servers\|--clients | Limits the scope of the operation to either the server or client nodes. | | --nodes nodeId1,nodeId2... | The list of consistent IDs of the nodes to get transactions from. | | --limit NUMBER | Limits the number of transactions to the given value. | | --order DURATION\|SIZE\|START\_TIME | The parameter to sort the output by. | The command affects the following transactions: * ACTIVE * PREPARING * PREPARED For example, to cancel the transactions that have been running for more than 100 seconds, execute the following command: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --tx --min-duration 100 --kill ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --tx --min-duration 100 --kill ``` {% endtab %} {% endtabs %} ### cache contention Use this command to detects situations where multiple transactions are in contention to create a lock for the same key. The command is useful if you have long-running or hanging transactions. The command syntax is as follows: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --cache contention ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --cache contention ``` {% endtab %} {% endtabs %} The command arguments are as follows: | Argument | Description | | -------------- | ------------------------------------------------------------------------------------------------ | | min queue size | The minimum number of transactions to wait for a specific key for the contention to be detected. | | node id | Optional; the Id of the node to query for contentions | | max lines | Optional; the number of lines to be printed in the output. | Example: {% tabs %} {% tab title="Linux/Unix" %} ```shell # Reports all keys that are a point of contention for at least 5 transactions on all cluster nodes. control.sh --cache contention 5 # Reports all keys that are a point of contention for at least 5 transactions on a specific server node. control.sh --cache contention 5 f2ea-5f56-11e8-9c2d-fa7a ``` {% endtab %} {% tab title="Windows" %} ```shell # Reports all keys that are a point of contention for at least 5 transactions on all cluster nodes. control.bat --cache contention 5 # Reports all keys that are a point of contention for at least 5 transactions on a specific server node. control.bat --cache contention 5 f2ea-5f56-11e8-9c2d-fa7a ``` {% endtab %} {% endtabs %} If contended keys are detected, the command dumps extensive information including the keys, transactions, and nodes where the contention took place. Example: ``` [node=TcpDiscoveryNode [id=d9620450-eefa-4ab6-a821-644098f00001, addrs=[127.0.0.1], sockAddrs=[/127.0.0.1:47501], discPort=47501, order=2, intOrder=2, lastExchangeTime=1527169443913, loc=false, ver=2.5.0#20180518-sha1:02c9b2de, isClient=false]] // No contention on node d9620450-eefa-4ab6-a821-644098f00001. [node=TcpDiscoveryNode [id=03379796-df31-4dbd-80e5-09cef5000000, addrs=[127.0.0.1], sockAddrs=[/127.0.0.1:47500], discPort=47500, order=1, intOrder=1, lastExchangeTime=1527169443913, loc=false, ver=2.5.0#20180518-sha1:02c9b2de, isClient=false]] TxEntry [cacheId=1544803905, key=KeyCacheObjectImpl [part=0, val=0, hasValBytes=false], queue=10, op=CREATE, val=UserCacheObjectImpl [val=0, hasValBytes=false], tx=GridNearTxLocal[xid=e9754629361-00000000-0843-9f61-0000-000000000001, xidVersion=GridCacheVersion [topVer=138649441, order=1527169439646, nodeOrder=1], concurrency=PESSIMISTIC, isolation=REPEATABLE_READ, state=ACTIVE, invalidate=false, rollbackOnly=false, nodeId=03379796-df31-4dbd-80e5-09cef5000000, timeout=0, duration=1247], other=[]] TxEntry [cacheId=1544803905, key=KeyCacheObjectImpl [part=0, val=0, hasValBytes=false], queue=10, op=READ, val=null, tx=GridNearTxLocal[xid=8a754629361-00000000-0843-9f61-0000-000000000001, xidVersion=GridCacheVersion [topVer=138649441, order=1527169439656, nodeOrder=1], concurrency=PESSIMISTIC, isolation=REPEATABLE_READ, state=ACTIVE, invalidate=false, rollbackOnly=false, nodeId=03379796-df31-4dbd-80e5-09cef5000000, timeout=0, duration=1175], other=[]] TxEntry [cacheId=1544803905, key=KeyCacheObjectImpl [part=0, val=0, hasValBytes=false], queue=10, op=READ, val=null, tx=GridNearTxLocal[xid=6a754629361-00000000-0843-9f61-0000-000000000001, xidVersion=GridCacheVersion [topVer=138649441, order=1527169439654, nodeOrder=1], concurrency=PESSIMISTIC, isolation=REPEATABLE_READ, state=ACTIVE, invalidate=false, rollbackOnly=false, nodeId=03379796-df31-4dbd-80e5-09cef5000000, timeout=0, duration=1175], other=[]] TxEntry [cacheId=1544803905, key=KeyCacheObjectImpl [part=0, val=0, hasValBytes=false], queue=10, op=READ, val=null, tx=GridNearTxLocal[xid=7a754629361-00000000-0843-9f61-0000-000000000001, xidVersion=GridCacheVersion [topVer=138649441, order=1527169439655, nodeOrder=1], concurrency=PESSIMISTIC, isolation=REPEATABLE_READ, state=ACTIVE, invalidate=false, rollbackOnly=false, nodeId=03379796-df31-4dbd-80e5-09cef5000000, timeout=0, duration=1175], other=[]] TxEntry [cacheId=1544803905, key=KeyCacheObjectImpl [part=0, val=0, hasValBytes=false], queue=10, op=READ, val=null, tx=GridNearTxLocal[xid=4a754629361-00000000-0843-9f61-0000-000000000001, xidVersion=GridCacheVersion [topVer=138649441, order=1527169439652, nodeOrder=1], concurrency=PESSIMISTIC, isolation=REPEATABLE_READ, state=ACTIVE, invalidate=false, rollbackOnly=false, nodeId=03379796-df31-4dbd-80e5-09cef5000000, timeout=0, duration=1175], other=[]] // Node 03379796-df31-4dbd-80e5-09cef5000000 is place for contention on key KeyCacheObjectImpl [part=0, val=0, hasValBytes=false]. ``` ## Cache Management ### cache list This command is used for cache monitoring. It retrieves a list of deployed caches, their affinity/distribution parameters, and their distribution within cache groups. There is also a command option for viewing existing atomic sequences. Use the following command syntax: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --cache list ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --cache list ``` {% endtab %} {% endtabs %} The command arguments are as follows. | Argument | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | . | With this argument, the command lists all caches. | | account-.\* | With this argument, the command lists caches whose names start with "account-". | | . --groups | With this argument, the command displays info about cache group distribution for all caches. | | account-.\* --groups | With this argument, the command displays info about cache group distribution for the caches whose names start with "account-". | | . --seq | With this argument, the command displays info about all atomic sequences. | | account-.\* --groups | With this argument, the command displays info about the atomic sequences whose names start with "counter-". | ### cache reset\_lost\_partitions This command resets lost partitions in the specified caches. Refer to [Partition Loss Policy](/docs/gridgain/gridgain-8/architecture/replication-and-consistency/partition-loss-policy.md) for details. Use the following command syntax: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --cache reset_lost_partitions | --all ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --cache reset_lost_partitions | --all ``` {% endtab %} {% endtabs %} The command arguments are as follows. | Argument | Description | | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | cacheName1,cacheName2,... | A comma-separated list of the caches to be affected by the command. | | --all | Makes the command check all caches for lost partition, print a list of caches with lost partitions (if any are found), and reset lost partitions in all the caches it has found. | ### cache idle\_verify This command verifies counters and hash sums of primary and backup partitions for the specified caches or scache groups on an idle cluster and prints out the differences, if any. Use the following command syntax: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --cache idle_verify [--dump] [--skip-zeros] [--check-crc] [--exclude-caches ] [--cache-filter ALL|USER|SYSTEM|PERSISTENT|NOT_PERSISTENT] [cacheName1,...,cacheNameN] ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --cache idle_verify [--dump] [--skip-zeros] [--check-crc] [--exclude-caches ] [--cache-filter ALL|USER|SYSTEM|PERSISTENT|NOT_PERSISTENT] [cacheName1,...,cacheNameN] ``` {% endtab %} {% endtabs %} The command arguments are as follows. | Argument | Description | | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --dump | Writes the command response to a local file on each node (in addition to returning response in the terminal window). | | --skip-zeros | Skips zero-sized partitions. | | --check-crc | Checks the CRC-sum of pages stored on disk before verifying partition data consistency between primary and backup nodes. | | --exclude-caches | Excludes caches provided as a comma-separated list. | | --cache-filter | Limits the caches affected by the command to only USER caches, only user PERSISTENT caches, only user NOT\_PERSISTENT caches, only SYSTEM caches, or ALL of the above. | | cacheName1,...,cacheNameN | A comma-separated list of the caches to be affected by the command. | ### cache partition\_reconciliation Partition reconciliation is a process of consistency checking, with the goal to verify the internal data consistency invariants and fix the inconsistent entries. The main difference between `idle_verify` and `partition_reconciliation` is that the latter one can work under the load. If the topology is changed while the script is running, or if the task execution fails, the command is automatically cancelled. {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --cache partition_reconciliation [--repair {option}] [--fast-check] [--parallelism ] [--batch-size ] [--include-sensitive] [--recheck-attempts ] [--recheck-delay ] [--sensitive-mode {default|hash|plain}] ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --cache partition_reconciliation [--repair {option}] [--fast-check] [--parallelism ] [--batch-size ] [--include-sensitive] [--recheck-attempts ] [--recheck-delay ] [--sensitive-mode {default|hash|plain}] ``` {% endtab %} {% endtabs %} The command has the following optional arguments. | Argument | Description | Default Value | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | cache1,cache2,... | A comma-separated list of the caches to be affected by the command. If caches are not specified, the command is executed on all caches. | | | --repair {option} |

If specified, fixes all inconsistent data. You can choose the repair algorithm for the keys where the valid key is not obvious.

Warning: Do not use the repair argument if you have no intention of auto-fixing the partition reconciliation keys or values.

The following values can be used:
- print\_only - fixes only those conflicts where the key is present on all nodes. Conflicts with missing keys are printed in the report.
- latest - picks the latest value. If any partition value is NULL, selects the latest value from the existing NOT NULL partitions. This may result in restoring a removed key.
- primary - picks a value from the primary partition. Beware: this option may result in key removal.
- latest\_trust\_missing\_primary - picks the latest value from the primary partition, including NULL values. If the key was removed in the primary partition, it will also be removed in backup partitions. Beware: this option may result in key removal.
- latest\_skip\_missing\_primary - picks the latest value, skipping reconciliation for any keys that are missing in the primary partition. Beware: this option may leave some data inconsistent.
- mahority - picks the most common value, or one of the most common values randomly (if there is no consensus). If the missing value is a majority, the key is removed.
- remove - removes a key if a conflict cannot be resolved without a user algorithm.

| `PRINT_ONLY` | | --fast-check | Checks and repairs only those partitions that did not pass validation during the last partition map exchange. If not specified, all partitions are checked and repaired. | | | --parallelism | The maximum number of threads that can be involved in the reconciliation activities. If not specified, the number of the node's cores is used. | | | --batch-size | The number of keys to retrieve within one job. | 1000 | | --include-sensitive | Includes sensitive information in the printout: keys and values. | `false` | | --recheck-attempts | The number mount of recheck attempts for the potentially inconsistent keys. The recommended value is between 1 and 5. | 2 | | --recheck-delay | Recheck delay in seconds. | 5 | | --sensitive-mode |

The output mode of sensitive information. Possible values:
- default - same security level as defined for the cluster.
- hash - hashed representation of objects.
- plain - plain representation of objects.

| `default` | ### cache partition\_reconciliation\_cancel Use this command to safely stop the partition reconciliation process. All changes done before the cancellation are preserved. {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --cache partition_reconciliation_cancel ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --cache partition_reconciliation_cancel ``` {% endtab %} {% endtabs %} ### cache destroy Use this command to destroy caches. The syntax is as follows: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --cache destroy --caches |--destroy-all-caches ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --cache destroy --caches |--destroy-all-caches ``` {% endtab %} {% endtabs %} The command uses one of the following two arguments: | Argument | Description | | -------------------- | -------------------------------------------------------------- | | --caches | A comma-separated list of names of the caches to be destroyed. | | --destroy-all-caches | Destroys all user-created caches. | ### cache clear Use this command to clear caches. The syntax is as follows: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --cache clear --caches ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --cache clear --caches ``` {% endtab %} {% endtabs %} The command uses the following argument: | Argument | Description | | -------- | ------------------------------------------------------------ | | --caches | A comma-separated list of names of the caches to be cleared. | ## cache indexes\_list Gets the list of indexes. You can specify filters to narrow down the list. {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --cache indexes_list [--node-id node_id] [--group-name group_name] [--cache-name cache_name] [--index-name index_name] ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --cache indexes_list [--node-id node_id] [--group-name group_name] [--cache-name cache_name] [--index-name index_name] ``` {% endtab %} {% endtabs %} | Argument | Description | | ------------ | ------------------------------------------------------------------------------------------------------------------- | | --node-id | The node the command will be executed on. If not specified, the node is chosen automatically. | | --cache-name | If specified, the command output will be filtered to only include the caches matching the regular expression. | | --group-name | If specified, the command output will be filtered to only include the cache groups matching the regular expression. | | --index-name | If specified, the command output will be filtered to only include the indexes matching the regular expression. | ## cache indexes\_rebuild\_status Lists all caches the indexes for which are currently being rebuilt. {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --cache indexes_rebuild_status [--node-id node_id] ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --cache indexes_rebuild_status [--node-id node_id] ``` {% endtab %} {% endtabs %} | Argument | Description | | --------- | --------------------------------------------------------------------------------------------- | | --node-id | The node the command will be executed on. If not specified, the node is chosen automatically. | ## cache indexes\_force\_rebuild You can use the `control.sh|bat` script to manage the process of rebuilding indexes for specified caches or cache groups. {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --cache indexes_force_rebuild --node-id --cache-names ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --cache indexes_force_rebuild --node-id --cache-names ``` {% endtab %} {% endtabs %} The command arguments are as follows: | Argument | Description | | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --node-id | A comma-separated list of nodes to rebuild indexes on. If not specified, rebuild is scheduled on all nodes. | | --cache-names | A comma-separated list of cache names, optionally with indexes. If indexes are not specified, all indexes of the cache will be scheduled for the rebuild operation. Can be used in addition to cache group names. | | --group-names | A comma-separated list of cache group names. Can be used in addition to cache names. | ## Tracing Configuration Management The `control.sh|bat` script includes a set of commands that enable you to manage tracing configurations. {% hint style="info" %} The commands described in this section are experimental. They require the `IGNITE_ENABLE_EXPERIMENTAL_COMMAND` environment variable to be set to `true`. {% endhint %} ### tracing-configuration Use this command to print tracing configuration for all scopes and labels. The syntax is as follows: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --tracing-configuration ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --tracing-configuration ``` {% endtab %} {% endtabs %} ### tracing-configuration get\_all Use this command to print tracing configuration for all labels and, optionally, the specified `--scope`. The syntax is as follows: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --tracing-configuration get_all [--scope ] ``` {% endtab %} {% tab title="Windows" %} ```shell control.bat --tracing-configuration get_all [--scope ] ``` {% endtab %} {% endtabs %} The command uses the following argument: | Argument | Description | | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | --scope | The scope to print the tracing configuration for: `DISCOVERY`, `EXCHANGE`, `COMMUNICATION`, `TX`, `CACHE_API_WRITE`, `CACHE_API_READ`, or `SQL`. | ### tracing-configuration get Use this command to print tracing configuration for specified `--scope` and `--label`. The syntax is as follows: {% tabs %} {% tab title="Linux/Unix" %} ```shell control.sh --tracing-configuration get --scope [--label