Skip to content

Commit 9e649b7

Browse files
committed
Wrapped string values in quotes in cluster REST API object reference
1 parent 62d03c5 commit 9e649b7

File tree

1 file changed

+8
-8
lines changed
  • content/operate/rs/references/rest-api/objects/cluster

1 file changed

+8
-8
lines changed

content/operate/rs/references/rest-api/objects/cluster/_index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ An API object that represents the cluster.
1616
| Name | Type/Value | Description |
1717
|------|------------|-------------|
1818
| alert_settings | [alert_settings]({{< relref "/operate/rs/references/rest-api/objects/cluster/alert_settings" >}}) object | Cluster and node alert settings |
19-
| bigstore_driver | 'speedb'<br />'rocksdb' | Storage engine for [Auto Tiering]({{<relref "/operate/rs/databases/auto-tiering">}}) |
19+
| bigstore_driver | "speedb"<br />"rocksdb" | Storage engine for [Auto Tiering]({{<relref "/operate/rs/databases/auto-tiering">}}) |
2020
| <span class="break-all">cluster_ssh_public_key</span> | string | Cluster's autogenerated SSH public key |
2121
| cm_port | integer, (range: 1024-65535) | UI HTTPS listening port |
2222
| <span class="break-all">cm_session_timeout_minutes</span> | integer (default: 15) | The timeout (in minutes) for the session to the CM |
@@ -46,13 +46,13 @@ An API object that represents the cluster.
4646
| http_support | boolean (default: false) | Enable or turn off HTTP support |
4747
| logrotate_settings | [logrotate_settings]({{<relref "/operate/rs/references/rest-api/objects/cluster/logrotate_settings">}}) object | Settings for logrotate configuration |
4848
| metrics_auth | boolean (default: false) | If true, requires authentication for requests to the metrics exporter |
49-
| <span class="break-all">min_control_TLS_version</span> | '1.2'<br />'1.3' | The minimum version of TLS protocol which is supported at the control path |
50-
| min_data_TLS_version | '1.2'<br />'1.3' | The minimum version of TLS protocol which is supported at the data path |
51-
| <span class="break-all">min_sentinel_TLS_version</span> | '1.2'<br />'1.3' | The minimum version of TLS protocol which is supported at the data path |
49+
| <span class="break-all">min_control_TLS_version</span> | "1.2"<br />"1.3" | The minimum version of TLS protocol which is supported at the control path |
50+
| min_data_TLS_version | "1.2"<br />"1.3" | The minimum version of TLS protocol which is supported at the data path |
51+
| <span class="break-all">min_sentinel_TLS_version</span> | "1.2"<br />"1.3" | The minimum version of TLS protocol which is supported at the data path |
5252
| <span class="break-all">mtls_authorized_subjects</span> | array | {{<code>}}[{<br /> "CN": string,<br /> "O": string,<br /> "OU": [array of strings],<br /> "L": string,<br /> "ST": string,<br /> "C": string<br />}, ...]{{</code>}} A list of valid subjects used for additional certificate validations during TLS client authentication. All subject attributes are case-sensitive.<br />**Required subject fields**:<br />"CN" for Common Name<br />**Optional subject fields:**<br />"O" for Organization<br />"OU" for Organizational Unit (array of strings)<br />"L" for Locality (city)<br />"ST" for State/Province<br />"C" for 2-letter country code |
5353
| <span class="break-all">mtls_certificate_authentication</span> | boolean | Require authentication of client certificates for mTLS connections to the cluster. The API_CA certificate should be configured as a prerequisite. |
54-
| <span class="break-all">mtls_client_cert_subject_validation_type</span> | `disabled`<br />`san_cn`<br />`full_subject` | Enables additional certificate validations that further limit connections to clients with valid certificates during TLS client authentication.<br />Values:<br />**disabled**: Authenticates clients with valid certificates. No additional validations are enforced.<br />**san_cn**: A client certificate is valid only if its Common Name (CN) matches an entry in the list of valid subjects. Ignores other Subject attributes.<br />**full_subject**: A client certificate is valid only if its Subject attributes match an entry in the list of valid subjects. |
55-
| multi_commands_opt | **`disabled`**<br />`batch`<br />`force_disabled` | Determines the default `multi_commands_opt` setting for databases in the cluster. If set to `batch`, it reduces the overhead of transaction management by batching multiple commands into a single transaction.<br />Values:<br />**disabled**: Turns off the optimization for all databases except those that override it on the [bdb level]({{<relref "/operate/rs/references/rest-api/objects/bdb">}}). Default value.<br />**batch**: Enables the optimization on all databases except those that override it on the [bdb level]({{<relref "/operate/rs/references/rest-api/objects/bdb">}}).<br />**force_disabled**: Disables the optimization for all databases, even those that override it on the [bdb level]({{<relref "/operate/rs/references/rest-api/objects/bdb">}}). |
54+
| <span class="break-all">mtls_client_cert_subject_validation_type</span> | "disabled"<br />"san_cn"<br />"full_subject" | Enables additional certificate validations that further limit connections to clients with valid certificates during TLS client authentication.<br />Values:<br />**disabled**: Authenticates clients with valid certificates. No additional validations are enforced.<br />**san_cn**: A client certificate is valid only if its Common Name (CN) matches an entry in the list of valid subjects. Ignores other Subject attributes.<br />**full_subject**: A client certificate is valid only if its Subject attributes match an entry in the list of valid subjects. |
55+
| multi_commands_opt | **"disabled"**<br />"batch"<br />"force_disabled" | Determines the default `multi_commands_opt` setting for databases in the cluster. If set to `batch`, it reduces the overhead of transaction management by batching multiple commands into a single transaction.<br />Values:<br />**disabled**: Turns off the optimization for all databases except those that override it on the [bdb level]({{<relref "/operate/rs/references/rest-api/objects/bdb">}}). Default value.<br />**batch**: Enables the optimization on all databases except those that override it on the [bdb level]({{<relref "/operate/rs/references/rest-api/objects/bdb">}}).<br />**force_disabled**: Disables the optimization for all databases, even those that override it on the [bdb level]({{<relref "/operate/rs/references/rest-api/objects/bdb">}}). |
5656
| name | string | Cluster's fully qualified domain name (read-only) |
5757
| password_complexity | boolean (default: false) | Enforce password complexity policy |
5858
| <span class="break-all">password_expiration_duration</span> | integer (default: 0) | The number of days a password is valid until the user is required to replace it |
@@ -67,7 +67,7 @@ An API object that represents the cluster.
6767
| saslauthd_ldap_conf | string | saslauthd LDAP configuration |
6868
| <span class="break-all">sentinel_cipher_suites</span> | array | Specifies the list of enabled ciphers for the sentinel service. The supported ciphers are those implemented by the [cipher_suites.go](<https://golang.org/src/crypto/tls/cipher_suites.go>) package. |
6969
| <span class="break-all">sentinel_cipher_suites_tls_1_3<span> | string | Specifies the list of enabled TLS 1.3 ciphers for the discovery (sentinel) service. The supported ciphers are those implemented by the [cipher_suites.go](<https://golang.org/src/crypto/tls/cipher_suites.go>) package.(read-only) |
70-
| sentinel_tls_mode | 'allowed'<br />'disabled' <br />'required' | Determines whether the discovery service allows, blocks, or requires TLS connections (previously named `sentinel_ssl_policy`)<br />**allowed**: Allows both TLS and non-TLS connections<br />**disabled**: Allows only non-TLS connections<br />**required**: Allows only TLS connections |
70+
| sentinel_tls_mode | "allowed"<br />"disabled" <br />"required" | Determines whether the discovery service allows, blocks, or requires TLS connections (previously named `sentinel_ssl_policy`)<br />**allowed**: Allows both TLS and non-TLS connections<br />**disabled**: Allows only non-TLS connections<br />**required**: Allows only TLS connections |
7171
| slave_ha | boolean (default: false) | Enable the replica high-availability mechanism (read-only) |
7272
| <span class="break-all">slave_ha_bdb_cooldown_period</span> | integer (default: 86400) | Time in seconds between runs of the replica high-availability mechanism on different nodes on the same database (read-only) |
7373
| <span class="break-all">slave_ha_cooldown_period</span> | integer (default: 3600) | Time in seconds between runs of the replica high-availability mechanism on different nodes (read-only) |
@@ -76,7 +76,7 @@ An API object that represents the cluster.
7676
| smtp_host | string | SMTP server for automated emails |
7777
| smtp_password | string | SMTP server password |
7878
| smtp_port | integer | SMTP server port for automated emails |
79-
| smtp_tls_mode | 'none'<br />'starttls'<br />'tls' | Specifies which TLS mode to use for SMTP access |
79+
| smtp_tls_mode | "none"<br />"starttls"<br />"tls" | Specifies which TLS mode to use for SMTP access |
8080
| smtp_use_tls | boolean (default: false) | Use TLS for SMTP access (deprecated as of Redis Enterprise v4.3.3, use smtp_tls_mode field instead) |
8181
| smtp_username | string | SMTP server username (pattern does not allow special characters &,\<,>,") |
8282
| syncer_certificate | string | Cluster's syncer certificate |

0 commit comments

Comments
 (0)