77Adds or removes master-eligible nodes from the
88<<modules-discovery-voting,voting configuration exclusion list>>.
99
10- [float]
11- ==== Request
1210
13- `POST _cluster/voting_config_exclusions/<node_name>` +
11+ [[voting-config-exclusions-api-request]]
12+ ==== {api-request-title}
1413
15- `DELETE _cluster/voting_config_exclusions`
14+ `POST _cluster/voting_config_exclusions/{node_name}` +
1615
17- [float]
18- ==== Path parameters
16+ `DELETE _cluster/voting_config_exclusions`
1917
20- `node_name`::
21- A <<cluster-nodes,node filter>> that identifies {es} nodes.
2218
23- [float ]
24- ==== Description
19+ [[voting-config-exclusions-api-desc] ]
20+ ==== {api-description-title}
2521
2622By default, if there are more than three master-eligible nodes in the cluster
2723and you remove fewer than half of the master-eligible nodes in the cluster at
@@ -44,31 +40,45 @@ master-eligible nodes from a cluster in a short time period. They are not
4440required when removing master-ineligible nodes or fewer than half of the
4541master-eligible nodes.
4642
47- The <<modules-discovery-settings,`cluster.max_voting_config_exclusions`
48- setting>> limits the size of the voting configuration exclusion list. The
49- default value is `10`. Since voting configuration exclusions are persistent and
50- limited in number, you must clear the voting config exclusions list once the
51- exclusions are no longer required.
43+ For more information, see <<modules-discovery-removing-nodes>>.
44+
5245
53- There is also a
54- <<modules-discovery-settings,`cluster.auto_shrink_voting_configuration` setting>>,
55- which is set to true by default. If it is set to false, you must use this API to
56- maintain the voting configuration.
46+ [[voting-config-exclusions-api-path-params]]
47+ ==== {api-path-parms-title}
48+
49+ `{node_name}`::
50+ A <<cluster-nodes,node filter>> that identifies {es} nodes.
5751
58- For more information, see <<modules-discovery-removing-nodes>>.
5952
60- [float]
61- ==== Examples
53+ [[voting-config-exclusions-api-query-params]]
54+ ==== {api-query-parms-title}
55+
56+ `cluster.auto_shrink_voting_configuration`::
57+ (Optional, boolean) If `false`, you must use this API to maintain the voting
58+ configuration. Defaults to `true`.
59+
60+ `cluster.max_voting_config_exclusions`::
61+ (Optional, integer) Limits the size of the voting configuration exclusion
62+ list. The default value is `10`. Since voting configuration exclusions are
63+ persistent and limited in number, you must clear the voting config
64+ exclusions list once the exclusions are no longer required.
65+
66+
67+ [[voting-config-exclusions-api-example]]
68+ ==== {api-examples-title}
6269
6370Add `nodeId1` to the voting configuration exclusions list:
71+
6472[source,js]
6573--------------------------------------------------
6674POST /_cluster/voting_config_exclusions/nodeId1
6775--------------------------------------------------
6876// CONSOLE
6977// TEST[catch:bad_request]
7078
79+
7180Remove all exclusions from the list:
81+
7282[source,js]
7383--------------------------------------------------
7484DELETE /_cluster/voting_config_exclusions
0 commit comments