This is an automated email from the ASF dual-hosted git repository.
namelchev pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/master by this push:
new 99a0368f8b1 IGNITE-24488 Documentation of distributed properties for
blocking new connections. (#12349)
99a0368f8b1 is described below
commit 99a0368f8b15182a24e5e29beb02dbc5015e8fa3
Author: Semyon Zikunov <[email protected]>
AuthorDate: Thu Sep 25 19:34:26 2025 +1000
IGNITE-24488 Documentation of distributed properties for blocking new
connections. (#12349)
---
docs/_docs/tools/control-script.adoc | 44 +++++++++++++++++++++++++++++++++---
1 file changed, 41 insertions(+), 3 deletions(-)
diff --git a/docs/_docs/tools/control-script.adoc
b/docs/_docs/tools/control-script.adoc
index 7e6430ce248..1436d75ed4b 100644
--- a/docs/_docs/tools/control-script.adoc
+++ b/docs/_docs/tools/control-script.adoc
@@ -1294,7 +1294,7 @@ Parameters:
== Working with Cluster Properties
-The `control.sh|bat` script provides an ability to work with
link:SQL/sql-statistics[SQL statistics,window=_blank] functionality.
+The `control.sh|bat` script allows administrators to view and modify
cluster-wide properties.
To get the full list of available properties, use the `--property list`
command. This command returns the list of all available properties to work with:
@@ -1308,7 +1308,7 @@ control.sh --property list
tab:Windows[]
[source,shell]
----
-control.bat --property list
+control.bat --property list
----
--
@@ -1324,7 +1324,7 @@ control.sh --property set --name 'statistics.usage.state'
--val 'ON'
tab:Windows[]
[source,shell]
----
-control.bat --property set --name 'statistics.usage.state' --val 'ON'
+control.bat --property set --name 'statistics.usage.state' --val 'ON'
----
--
@@ -1344,6 +1344,44 @@ control.bat --property get --name
'statistics.usage.state'
----
--
+NOTE: Available values depend on the property.
+For example, link:SQL/sql-statistics[SQL statistics,window=_blank] use
`ON|OFF|NO_UPDATE`, while link:#managing_cluster_connection_properties[Cluster
Connection Properties,window=_blank]
+use `true|false`.
+
+=== Managing Cluster Connection Properties
+
+You can control whether new client or server connections are accepted by the
cluster setting the cluster-wide properties.
+
+The following properties are available:
+
+[cols="3,5,2,2", opts="header"]
+|===
+|Property | Description | Available values | Default value
+|newClientNodeConnectionsEnabled | If true then new client node connections
allowed. | true / false | true
+|newServerNodeConnectionsEnabled | If true then new server node connections
allowed. | true / false | true
+|newThinConnectionsEnabled | If true then new thin client connections allowed.
| true / false | true
+|newJdbcConnectionsEnabled | If true then new JDBC connections allowed. | true
/ false | true
+|newOdbcConnectionsEnabled | If true then new ODBC connections allowed. | true
/ false | true
+|===
+
+NOTE: Setting a property to `false` affects only new connections. Existing
connections remain active.
+
+For example, the following command disables new thin client connections:
+
+[tabs]
+--
+tab:Unix[]
+[source,shell]
+----
+control.sh --property set --name newThinConnectionsEnabled --val false
+----
+tab:Windows[]
+[source,shell]
+----
+control.bat --property set --name newThinConnectionsEnabled --val false
+----
+--
+
== Manage cache metrics collection
The command provides an ability to enable, disable or show status of cache
metrics collection.
