From fb62eddb71e584cc3670aa86b4263b9734cbd461 Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Wed, 23 Sep 2026 14:07:48 +0100 Subject: [PATCH 1/4] DOC-7104: Migrate content/operate/rs/7.4/references/ (incl. rest-api) to render hooks Unit 10 of 15: converts the frozen 7.4 references tree (246 files, 167 carrying relref/callout shortcodes) from {{< relref >}} and {{< note >}}/{{< warning >}} shortcodes to plain markdown links and > [!NOTE]/> [!WARNING] blockquotes resolved by the DOC-6909 render hooks. The rest-api/ subtree (169 of the 246 files) is explicitly in scope per the ticket: it was generated once when 7.4 was frozen and never regenerated since, so a one-time conversion is safe and permanent. Real counts (re-measured by grep, not taken from the ticket estimate): 1029 relref shortcodes across 165 files, 20 callouts (16 note, 4 warning, 0 tip/info/alert) across 16 files; 14 files carried both. Post-conversion grep confirms 0 remaining shortcode-form relref/callout instances except one pre-existing defect (see below), and 167/246 files touched overall. One gotcha instance found and hand-fixed: cli-utilities/rladmin/_index.md had a {{}} indented inside a numbered list item, with only the header line indented and the continuation/closing lines flush left (the known converter limitation), plus a stray whitespace-only `>` artifact line left by the closing tag's indentation. Fixed by re-indenting all blockquote lines to match the list item and dropping the stray line; verified via rendered HTML that the
  • nesting is unchanged before/after (alert div closes inside the same
  • , immediately before , in both builds). Flagging, not fixing, a pre-existing defect: cli-utilities/redis-cli/_index.md line 153 has `[Redis commands reference]({{< relref "/commands/" >}}` with no closing `)` -- the link was already malformed before this migration (confirmed via `git show HEAD` on the original), so the relref-to-plain regex correctly left it unconverted rather than guessing. Left as-is per "a missed rewrite is fine, a wrong one is not" and the AGENTS.md rule to flag technical defects rather than silently fix them. No relref-missing-slash instances found in this unit. Verification: full-site hugo builds before/after (non-minified -- see below), diffed with the DOC-7104-diff-hrefs-fix build/diff_rendered_hrefs.py scoped to operate/rs/7.4/references: 244/244 pages compared, 0 href-set changes. The verification-only patched diff script was staged from origin/DOC-7104-diff-hrefs-fix, then unstaged and reverted before this commit; build/diff_rendered_hrefs.py carries no changes here. Build note: `hugo --minify` currently fails site-wide on this checkout with a pre-existing esbuild syntax error while minifying a script on /commands/cf.reserve, unrelated to this unit's path (confirmed pre-existing in unit 8). Verification builds ran without --minify; both before and after used identical flags, and rendered hrefs are unaffected by minification, so the comparison is still valid. Co-Authored-By: Claude Sonnet 5 --- .../rs/7.4/references/cli-utilities/_index.md | 5 +- .../cli-utilities/crdb-cli/_index.md | 6 +- .../cli-utilities/crdb-cli/crdb/create.md | 14 +- .../crdb-cli/crdb/purge-instance.md | 2 +- .../crdb-cli/crdb/remove-instance.md | 4 +- .../cli-utilities/crdb-cli/crdb/update.md | 6 +- .../cli-utilities/crdb-cli/task/status.md | 2 +- .../cli-utilities/redis-cli/_index.md | 26 +- .../cli-utilities/rladmin/_index.md | 9 +- .../references/cli-utilities/rladmin/bind.md | 6 +- .../rladmin/cluster/certificate.md | 2 +- .../cli-utilities/rladmin/cluster/config.md | 6 +- .../cli-utilities/rladmin/failover.md | 2 +- .../cli-utilities/rladmin/migrate.md | 12 +- .../cli-utilities/rladmin/node/addr.md | 4 +- .../cli-utilities/rladmin/node/enslave.md | 6 +- .../rladmin/node/external-addr.md | 6 +- .../rladmin/node/maintenance-mode.md | 6 +- .../rladmin/node/recovery-path.md | 2 +- .../cli-utilities/rladmin/node/remove.md | 2 +- .../cli-utilities/rladmin/node/snapshot.md | 5 +- .../cli-utilities/rladmin/placement.md | 2 +- .../cli-utilities/rladmin/recover.md | 4 +- .../references/cli-utilities/rladmin/tune.md | 34 +- .../cli-utilities/rladmin/upgrade.md | 8 +- .../cli-utilities/rladmin/verify.md | 8 +- .../references/client_references/_index.md | 12 +- .../rs/7.4/references/clustering-redis.md | 2 +- .../rs/7.4/references/compatibility/_index.md | 6 +- .../compatibility/commands/_index.md | 2 +- .../compatibility/commands/cluster.md | 66 ++-- .../compatibility/commands/connection.md | 50 +-- .../compatibility/commands/data-types.md | 298 +++++++++--------- .../compatibility/commands/generic.md | 66 ++-- .../compatibility/commands/pub-sub.md | 28 +- .../compatibility/commands/scripting.md | 42 +-- .../compatibility/commands/server.md | 152 ++++----- .../compatibility/commands/transactions.md | 12 +- .../compatibility/config-settings.md | 2 +- .../rs/7.4/references/compatibility/resp.md | 24 +- .../rs/7.4/references/memtier-benchmark.md | 4 +- .../rs/7.4/references/metrics/_index.md | 32 +- .../rs/7.4/references/metrics/auto-tiering.md | 10 +- .../references/metrics/database-operations.md | 24 +- .../7.4/references/metrics/resource-usage.md | 12 +- .../rs/7.4/references/rest-api/_index.md | 20 +- .../7.4/references/rest-api/objects/_index.md | 2 +- .../7.4/references/rest-api/objects/alert.md | 2 +- .../references/rest-api/objects/bdb/_index.md | 22 +- .../rest-api/objects/bdb/backup_location.md | 7 +- .../objects/bdb/dataset_import_sources.md | 9 +- .../objects/bdb/replica_sources_status.md | 2 +- .../rest-api/objects/bdb/replica_sync.md | 4 +- .../rest-api/objects/bootstrap/_index.md | 8 +- .../objects/bootstrap/node_identity.md | 6 +- .../rest-api/objects/cluster/_index.md | 2 +- .../objects/cluster/alert_settings.md | 16 +- .../rest-api/objects/cluster_settings.md | 2 +- .../rest-api/objects/crdb/_index.md | 4 +- .../rest-api/objects/crdb/database_config.md | 6 +- .../objects/crdb/health_report/_index.md | 4 +- .../rest-api/objects/crdb/instance_info.md | 4 +- .../rest-api/objects/crdb/modify_request.md | 4 +- .../objects/db_alerts_settings/_index.md | 36 +-- .../rest-api/objects/job_scheduler/_index.md | 12 +- .../7.4/references/rest-api/objects/ldap.md | 2 +- .../rest-api/objects/ldap_mapping.md | 2 +- .../7.4/references/rest-api/objects/module.md | 2 +- .../rest-api/objects/module_metadata.md | 2 +- .../7.4/references/rest-api/objects/node.md | 2 +- .../references/rest-api/objects/redis_acl.md | 2 +- .../7.4/references/rest-api/objects/role.md | 2 +- .../objects/services_configuration/_index.md | 14 +- .../rest-api/objects/shard/_index.md | 8 +- .../rest-api/objects/statistics/_index.md | 28 +- .../7.4/references/rest-api/objects/user.md | 2 +- .../rs/7.4/references/rest-api/permissions.md | 4 +- .../rs/7.4/references/rest-api/quick-start.md | 28 +- .../references/rest-api/requests/_index.md | 2 +- .../rest-api/requests/actions/_index.md | 8 +- .../rest-api/requests/actions/bdb.md | 4 +- .../rest-api/requests/bdbs/_index.md | 59 ++-- .../rest-api/requests/bdbs/actions/_index.md | 16 +- .../bdbs/actions/backup_reset_status.md | 2 +- .../rest-api/requests/bdbs/actions/export.md | 4 +- .../bdbs/actions/export_reset_status.md | 2 +- .../rest-api/requests/bdbs/actions/import.md | 11 +- .../bdbs/actions/import_reset_status.md | 2 +- .../bdbs/actions/optimize_shards_placement.md | 11 +- .../rest-api/requests/bdbs/actions/recover.md | 6 +- .../rest-api/requests/bdbs/alerts.md | 18 +- .../requests/bdbs/crdt_sources-alerts.md | 16 +- .../rest-api/requests/bdbs/debuginfo.md | 4 +- .../rest-api/requests/bdbs/modules/_index.md | 4 +- .../rest-api/requests/bdbs/modules/config.md | 2 +- .../rest-api/requests/bdbs/modules/upgrade.md | 4 +- .../rest-api/requests/bdbs/passwords.md | 6 +- .../rest-api/requests/bdbs/peer_stats.md | 8 +- .../requests/bdbs/replica_sources-alerts.md | 16 +- .../rest-api/requests/bdbs/shards.md | 2 +- .../rest-api/requests/bdbs/stats/_index.md | 8 +- .../rest-api/requests/bdbs/stats/last.md | 8 +- .../requests/bdbs/sync_source_stats.md | 8 +- .../requests/bdbs/syncer_state/_index.md | 7 +- .../requests/bdbs/syncer_state/crdt.md | 2 +- .../requests/bdbs/syncer_state/replica.md | 2 +- .../rest-api/requests/bdbs/upgrade.md | 4 +- .../rest-api/requests/bootstrap/_index.md | 6 +- .../rest-api/requests/bootstrap/validate.md | 2 +- .../rest-api/requests/cluster/_index.md | 10 +- .../rest-api/requests/cluster/actions.md | 12 +- .../rest-api/requests/cluster/alerts.md | 8 +- .../requests/cluster/auditing-db-conns.md | 18 +- .../requests/cluster/certificates/_index.md | 6 +- .../rest-api/requests/cluster/check.md | 2 +- .../rest-api/requests/cluster/debuginfo.md | 2 +- .../rest-api/requests/cluster/ldap.md | 10 +- .../requests/cluster/module-capabilities.md | 2 +- .../rest-api/requests/cluster/policy.md | 8 +- .../cluster/services_configuration.md | 10 +- .../rest-api/requests/cluster/stats/_index.md | 4 +- .../rest-api/requests/cluster/stats/last.md | 4 +- .../rest-api/requests/crdb_tasks/_index.md | 4 +- .../rest-api/requests/crdbs/_index.md | 16 +- .../rest-api/requests/crdbs/flush.md | 2 +- .../rest-api/requests/crdbs/health_report.md | 2 +- .../rest-api/requests/crdbs/purge.md | 2 +- .../rest-api/requests/crdbs/updates.md | 9 +- .../rest-api/requests/debuginfo/_index.md | 10 +- .../rest-api/requests/debuginfo/all/_index.md | 4 +- .../rest-api/requests/debuginfo/all/bdb.md | 4 +- .../requests/debuginfo/node/_index.md | 4 +- .../rest-api/requests/debuginfo/node/bdb.md | 4 +- .../requests/endpoints-stats/_index.md | 9 +- .../rest-api/requests/jsonschema/_index.md | 2 +- .../rest-api/requests/ldap_mappings/_index.md | 18 +- .../rest-api/requests/license/_index.md | 6 +- .../rest-api/requests/logs/_index.md | 2 +- .../rest-api/requests/modules/_index.md | 32 +- .../rest-api/requests/modules/config.md | 2 +- .../rest-api/requests/modules/upgrade.md | 4 +- .../node_master_healthcheck/_index.md | 2 +- .../rest-api/requests/nodes/_index.md | 17 +- .../rest-api/requests/nodes/actions.md | 20 +- .../rest-api/requests/nodes/alerts.md | 12 +- .../rest-api/requests/nodes/check.md | 2 +- .../rest-api/requests/nodes/debuginfo.md | 4 +- .../rest-api/requests/nodes/snapshots.md | 4 +- .../rest-api/requests/nodes/stats/_index.md | 8 +- .../rest-api/requests/nodes/stats/last.md | 8 +- .../rest-api/requests/nodes/status.md | 8 +- .../rest-api/requests/ocsp/_index.md | 10 +- .../rest-api/requests/ocsp/status.md | 4 +- .../references/rest-api/requests/ocsp/test.md | 4 +- .../rest-api/requests/proxies/_index.md | 16 +- .../rest-api/requests/redis_acls/_index.md | 22 +- .../rest-api/requests/roles/_index.md | 22 +- .../rest-api/requests/shards/_index.md | 4 +- .../requests/shards/actions/_index.md | 4 +- .../requests/shards/actions/migrate.md | 12 +- .../rest-api/requests/shards/stats/_index.md | 10 +- .../rest-api/requests/shards/stats/last.md | 8 +- .../rest-api/requests/suffix/_index.md | 2 +- .../rest-api/requests/suffixes/_index.md | 2 +- .../rest-api/requests/users/_index.md | 32 +- .../rest-api/requests/users/authorize.md | 2 +- .../rs/7.4/references/upgrade-paths.md | 4 +- 167 files changed, 1006 insertions(+), 1026 deletions(-) diff --git a/content/operate/rs/7.4/references/cli-utilities/_index.md b/content/operate/rs/7.4/references/cli-utilities/_index.md index ca71cd0b0e..8b0e86d73c 100644 --- a/content/operate/rs/7.4/references/cli-utilities/_index.md +++ b/content/operate/rs/7.4/references/cli-utilities/_index.md @@ -24,9 +24,8 @@ Administrators can use these CLI tools to manage and test a Redis Enterprise clu The `/opt/redislabs/bin/` directory also contains utilities used internally by Redis Enterprise Software and for troubleshooting. -{{}} -Do not use these tools for normal operations. -{{}} +> [!WARNING] +> Do not use these tools for normal operations. | Utility | Description | |---------|-------------| diff --git a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/_index.md b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/_index.md index 3f5296ab2a..a859e43529 100644 --- a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/_index.md +++ b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/_index.md @@ -12,7 +12,7 @@ weight: $weight url: '/operate/rs/7.4/references/cli-utilities/crdb-cli/' --- -An [Active-Active database]({{< relref "/operate/rs/7.4/databases/active-active/_index.md" >}}) (also known as CRDB or conflict-free replicated database) +An [Active-Active database](/content/operate/rs/7.4/databases/active-active/_index.md) (also known as CRDB or conflict-free replicated database) replicates your data across Redis Enterprise Software clusters located in geographically distributed regions. Active-Active databases allow read-write access in all locations, making them ideal for distributed applications that require fast response times and disaster recovery. @@ -21,7 +21,7 @@ Each cluster that hosts an instance is called a **participating cluster**. An Active-Active database requires two or more participating clusters. Each instance is responsible for updating the instances that reside on other participating clusters with the transactions it receives. -Write conflicts are resolved using [conflict-free replicated data types]({{< relref "/operate/rs/7.4/databases/active-active" >}}) (CRDTs). +Write conflicts are resolved using [conflict-free replicated data types](/content/operate/rs/7.4/databases/active-active/_index.md) (CRDTs). To programmatically maintain an Active-Active database and its instances, you can use the `crdb-cli` command-line tool. @@ -45,6 +45,6 @@ By default, the command runs immediately and displays the result in the output. If you use the `--no-wait` flag, the command runs in the background so that your application is not delayed by the response. -Use the [`crdb-cli task` commands]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/task/" >}}) to manage Active-Active database tasks. +Use the [`crdb-cli task` commands](/content/operate/rs/7.4/references/cli-utilities/crdb-cli/task/_index.md) to manage Active-Active database tasks. For each `crdb-cli` command, you can use `--help` for additional information about the command. diff --git a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/create.md b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/create.md index 7470410f1f..b4e4952617 100644 --- a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/create.md +++ b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/create.md @@ -44,7 +44,7 @@ crdb-cli crdb create --name Before you create an Active-Active database, you must have: - At least two participating clusters -- [Network connectivity]({{< relref "/operate/rs/7.4/networking/port-configurations" >}}) between the participating clusters +- [Network connectivity](/content/operate/rs/7.4/networking/port-configurations.md) between the participating clusters ### Parameters @@ -60,18 +60,18 @@ Before you create an Active-Active database, you must have: | wait | | Prevents `crdb-cli` from running another command before this command finishes | | no-wait | | `crdb-cli` can run another command before this command finishes | | compression | 0-6 | The level of data compression:

    0 = No compression

    6 = High compression and resource load (Default: 3) | -| causal-consistency | true
    false (*default*) | [Causal consistency]({{< relref "/operate/rs/7.4/databases/active-active/causal-consistency.md" >}}) applies updates to all instances in the order they were received | +| causal-consistency | true
    false (*default*) | [Causal consistency](/content/operate/rs/7.4/databases/active-active/causal-consistency.md) applies updates to all instances in the order they were received | | password \ | string | Password for access to the database | -| replication | true
    false (*default*) | Activates or deactivates [database replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication.md" >}}) where every master shard replicates to a replica shard | +| replication | true
    false (*default*) | Activates or deactivates [database replication](/content/operate/rs/7.4/databases/durability-ha/replication.md) where every master shard replicates to a replica shard | | encryption | true
    false (*default*) | Activates or deactivates encryption | -| sharding | true (*default*)
    false | Activates or deactivates sharding (also known as [database clustering]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering.md" >}})). Cannot be updated after the database is created | +| sharding | true (*default*)
    false | Activates or deactivates sharding (also known as [database clustering](/content/operate/rs/7.4/databases/durability-ha/clustering.md)). Cannot be updated after the database is created | | shards-count \ | integer | If sharding is enabled, this specifies the number of Redis shards for each database instance | -| oss-cluster | true
    false (*default*) | Activates [OSS cluster API]({{< relref "/operate/rs/7.4/clusters/optimize/oss-cluster-api" >}}) | -| shard-key-regex \ | string | If clustering is enabled, this defines a regex rule (also known as a [hashing policy]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering#custom-hashing-policy" >}})) that determines which keys are located in each shard (defaults to `{u'regex': u'.*\\{(?.*)\\}.*'}, {u'regex': u'(?.*)'} `) | +| oss-cluster | true
    false (*default*) | Activates [OSS cluster API](/content/operate/rs/7.4/clusters/optimize/oss-cluster-api.md) | +| shard-key-regex \ | string | If clustering is enabled, this defines a regex rule (also known as a [hashing policy](/content/operate/rs/7.4/databases/durability-ha/clustering.md#custom-hashing-policy)) that determines which keys are located in each shard (defaults to `{u'regex': u'.*\\{(?.*)\\}.*'}, {u'regex': u'(?.*)'} `) | | bigstore | true

    false (*default*) | If true, the database uses Auto Tiering to add flash memory to the database | | bigstore-ram-size \ | size in bytes, kilobytes (KB), or gigabytes (GB) | Maximum RAM limit for databases with Auto Tiering enabled | | with-module
      name=\,
      version=\,
      args=\ | strings | Creates a database with a specific module | -| eviction-policy | noeviction (*default*)
    allkeys-lru
    allkeys-lfu
    allkeys-random
    volatile-lru
    volatile-lfu
    volatile-random
    volatile-ttl | Sets [eviction policy]({{< relref "/operate/rs/7.4/databases/memory-performance/eviction-policy" >}}) | +| eviction-policy | noeviction (*default*)
    allkeys-lru
    allkeys-lfu
    allkeys-random
    volatile-lru
    volatile-lfu
    volatile-random
    volatile-ttl | Sets [eviction policy](/content/operate/rs/7.4/databases/memory-performance/eviction-policy.md) | | proxy-policy | all-nodes
    all-master-shards
    single | Sets proxy policy | diff --git a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance.md b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance.md index a6ee794df3..ab74e62d8a 100644 --- a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance.md +++ b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance.md @@ -20,7 +20,7 @@ crdb-cli crdb purge-instance --crdb-guid [ --no-wait ] ``` -Once this command finishes, the other replicas must remove this instance with [`crdb-cli crdb remove-instance --force`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/remove-instance" >}}). +Once this command finishes, the other replicas must remove this instance with [`crdb-cli crdb remove-instance --force`](/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/remove-instance.md). ### Parameters diff --git a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/remove-instance.md b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/remove-instance.md index 59c69ea22f..96882cf665 100644 --- a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/remove-instance.md +++ b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/remove-instance.md @@ -24,7 +24,7 @@ If the cluster cannot communicate with the instance that you want to remove, you 1. Use the `--force` option to remove the instance from the Active-Active database without purging the data from the instance. -1. Run [`crdb-cli crdb purge-instance`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance" >}}) from the removed instance to delete the Active-Active database and its data. +1. Run [`crdb-cli crdb purge-instance`](/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance.md) from the removed instance to delete the Active-Active database and its data. ### Parameters @@ -32,7 +32,7 @@ If the cluster cannot communicate with the instance that you want to remove, you |------------------------------|--------|------------| | crdb-guid | string | The GUID of the database (required) | | instance-id | string | The ID of the local instance to remove (required) | -| force | | Removes the instance without purging data from the instance.
    If --force is specified, you must run [`crdb-cli crdb purge-instance`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance" >}}) from the removed instance. | +| force | | Removes the instance without purging data from the instance.
    If --force is specified, you must run [`crdb-cli crdb purge-instance`](/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance.md) from the removed instance. | | no-wait | | Does not wait for the task to complete | ### Returns diff --git a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/update.md b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/update.md index b37adf423c..a7fd0ae26b 100644 --- a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/update.md +++ b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/update.md @@ -31,7 +31,7 @@ crdb-cli crdb update --crdb-guid [--update-module name=,featureset_version=] ``` -If you want to change the configuration of the local instance only, use [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) instead. +If you want to change the configuration of the local instance only, use [`rladmin`](/content/operate/rs/7.4/references/cli-utilities/rladmin/_index.md) instead. ### Parameters @@ -40,7 +40,7 @@ If you want to change the configuration of the local instance only, use [`rladmi | crdb-guid \ | string | GUID of the Active-Active database (required) | | bigstore-ram-size \ | size in bytes, kilobytes (KB), or gigabytes (GB) | Maximum RAM limit for the databases with Auto Tiering enabled, if activated | | memory-size \ | size in bytes, kilobytes (KB), or gigabytes (GB) | Maximum database memory (required) | -| causal-consistency | true
    false | [Causal consistency]({{< relref "/operate/rs/7.4/databases/active-active/causal-consistency.md" >}}) applies updates to all instances in the order they were received | +| causal-consistency | true
    false | [Causal consistency](/content/operate/rs/7.4/databases/active-active/causal-consistency.md) applies updates to all instances in the order they were received | | compression | 0-6 | The level of data compression:

    0 = No compression

    6 = High compression and resource load (Default: 3) | | credentials id=\,username=\,password=\ | strings | Updates the credentials for access to the instance | | default-db-config \ | | Default database configuration from stdin | @@ -49,7 +49,7 @@ If you want to change the configuration of the local instance only, use [`rladmi | force | | Force an update even if there are no changes | | no-wait | | Do not wait for the command to finish | | oss-cluster | true
    false | Activates or deactivates OSS Cluster mode | -| eviction-policy | noeviction
    allkeys-lru
    allkeys-lfu
    allkeys-random
    volatile-lru
    volatile-lfu
    volatile-random
    volatile-ttl | Updates [eviction policy]({{< relref "/operate/rs/7.4/databases/memory-performance/eviction-policy" >}}) | +| eviction-policy | noeviction
    allkeys-lru
    allkeys-lfu
    allkeys-random
    volatile-lru
    volatile-lfu
    volatile-random
    volatile-ttl | Updates [eviction policy](/content/operate/rs/7.4/databases/memory-performance/eviction-policy.md) | | featureset-version | true
    false | Updates to latest FeatureSet version | | update-module name=\,featureset_version=\ | strings | Update a module to the specified version | diff --git a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/task/status.md b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/task/status.md index 108926c011..8bf8e22de8 100644 --- a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/task/status.md +++ b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/task/status.md @@ -27,7 +27,7 @@ crdb-cli task status --task-id The `--verbose` and `--no-verbose` options are mutually incompatible; specify one or the other. -The `404 Not Found` error indicates an invalid task ID. Use the [`task list`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/task/list" >}}) command to determine available task IDs. +The `404 Not Found` error indicates an invalid task ID. Use the [`task list`](/content/operate/rs/7.4/references/cli-utilities/crdb-cli/task/list.md) command to determine available task IDs. ### Returns diff --git a/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md b/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md index 968544f2be..dd77cf0b2f 100644 --- a/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md +++ b/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md @@ -14,9 +14,9 @@ weight: $weight url: '/operate/rs/7.4/references/cli-utilities/redis-cli/' --- -The `redis-cli` command-line utility lets you interact with a Redis database. With `redis-cli`, you can run [Redis commands]({{< relref "/commands" >}}) directly from the command-line terminal or with [interactive mode](#interactive-mode). +The `redis-cli` command-line utility lets you interact with a Redis database. With `redis-cli`, you can run [Redis commands](/commands) directly from the command-line terminal or with [interactive mode](#interactive-mode). -If you want to run Redis commands without `redis-cli`, you can [connect to a database with Redis Insight]({{< relref "/develop/tools/insight/" >}}) and use the built-in [CLI]({{< relref "/develop/tools/insight/" >}}) prompt instead. +If you want to run Redis commands without `redis-cli`, you can [connect to a database with Redis Insight](/content/develop/tools/insight/_index.md) and use the built-in [CLI](/content/develop/tools/insight/_index.md) prompt instead. ## Install `redis-cli` @@ -24,11 +24,11 @@ When you install Redis Enterprise Software or Redis Open Source, it also install To learn how to install Redis and `redis-cli`, see the following installation guides: -- [Redis Open Source]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) +- [Redis Open Source](/content/operate/oss_and_stack/install/install-stack/_index.md) -- [Redis Enterprise Software]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) +- [Redis Enterprise Software](/content/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md) -- [Redis Enterprise Software with Docker]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart" >}}) +- [Redis Enterprise Software with Docker](/content/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart.md) ## Connect to a database @@ -57,7 +57,7 @@ To connect to a Redis Enterprise Software or Redis Cloud database over TLS: 1. Download or copy the Redis Enterprise server (or proxy) certificates. - - For Redis Cloud, see [Download certificates]({{< relref "/operate/rc/security/database-security/tls-ssl#download-certificates" >}}) for detailed instructions on how to download the server certificates (`redis_ca.pem`) from the [Redis Cloud console](https://cloud.redis.io/). + - For Redis Cloud, see [Download certificates](/content/operate/rc/security/database-security/tls-ssl.md#download-certificates) for detailed instructions on how to download the server certificates (`redis_ca.pem`) from the [Redis Cloud console](https://cloud.redis.io/). - For Redis Enterprise Software, copy the proxy certificate from the Cluster Manager UI (**Cluster > Security > Certificates > Server authentication**) or from a cluster node (`/etc/opt/redislabs/proxy_cert.pem`). @@ -103,15 +103,15 @@ $ redis-cli -h -p 12000 GET mykey "Hello world" ``` -For more information, see [Command line usage]({{< relref "/develop/tools/cli" >}}#command-line-usage). +For more information, see [Command line usage](/content/develop/tools/cli.md#command-line-usage). ## Interactive mode -In `redis-cli` [interactive mode]({{< relref "/develop/tools/cli" >}}#interactive-mode), you can: +In `redis-cli` [interactive mode](/content/develop/tools/cli.md#interactive-mode), you can: - Run any `redis-cli` command without prefacing it with `redis-cli`. -- Enter `?` for more information about how to use the `HELP` command and [set `redis-cli` preferences]({{< relref "/develop/tools/cli" >}}#preferences). -- Enter [`HELP`]({{< relref "/develop/tools/cli" >}}#showing-help-about-redis-commands) followed by the name of a command for more information about the command and its options. +- Enter `?` for more information about how to use the `HELP` command and [set `redis-cli` preferences](/content/develop/tools/cli.md#preferences). +- Enter [`HELP`](/content/develop/tools/cli.md#showing-help-about-redis-commands) followed by the name of a command for more information about the command and its options. - Press the `Tab` key for command completion. - Enter `exit` or `quit` or press `Control+D` to exit interactive mode and return to the terminal prompt. @@ -131,7 +131,7 @@ OK ### Check slowlog -Run [`slowlog get`]({{< relref "/commands/slowlog-get" >}}) for a list of recent slow commands: +Run [`slowlog get`](/content/commands/slowlog-get.md) for a list of recent slow commands: ```sh redis-cli -h -p slowlog get @@ -145,9 +145,9 @@ Scan the database for big keys: redis-cli -h -p --bigkeys ``` -See [Scanning for big keys]({{< relref "/develop/tools/cli" >}}#scanning-for-big-keys) for more information. +See [Scanning for big keys](/content/develop/tools/cli.md#scanning-for-big-keys) for more information. ## More info -- [Redis CLI documentation]({{< relref "/develop/tools/cli" >}}) +- [Redis CLI documentation](/content/develop/tools/cli.md) - [Redis commands reference]({{< relref "/commands/" >}} diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/_index.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/_index.md index 58c3833ebb..41234f928e 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/_index.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/_index.md @@ -30,15 +30,14 @@ To open the `rladmin` shell: 1. Run: `rladmin` - {{}} -If the CLI does not recognize the `rladmin` command, -run this command to load the necessary configuration first: `bash -l` - {{}} + > [!NOTE] + > If the CLI does not recognize the `rladmin` command, + > run this command to load the necessary configuration first: `bash -l` In the `rladmin` shell, you can: - Run any `rladmin` command without prefacing it with `rladmin`. - Enter `?` to view the full list of available commands. -- Enter [`help`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/help" >}}) followed by the name of a command for a detailed explanation of the command and its usage. +- Enter [`help`](/content/operate/rs/7.4/references/cli-utilities/rladmin/help.md) followed by the name of a command for a detailed explanation of the command and its usage. - Press the `Tab` key for command completion. - Enter `exit` or press `Control+D` to exit the `rladmin` shell and return to the terminal prompt. diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/bind.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/bind.md index 31c0944b34..46b59a03d3 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/bind.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/bind.md @@ -40,7 +40,7 @@ rladmin bind Returns `Finished successfully` if the list of excluded proxies was successfully changed. Otherwise, it returns an error. -Use [`rladmin status endpoints`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the policy changed. +Use [`rladmin status endpoints`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-endpoints) to verify that the policy changed. ### Example @@ -86,7 +86,7 @@ rladmin bind Returns `Finished successfully` if the list of included proxies was successfully changed. Otherwise, it returns an error. -Use [`rladmin status endpoints`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the policy changed. +Use [`rladmin status endpoints`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-endpoints) to verify that the policy changed. ### Example @@ -134,7 +134,7 @@ rladmin bind Returns `Finished successfully` if the proxy policy was successfully changed. Otherwise, it returns an error. -Use [`rladmin status endpoints`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the policy changed. +Use [`rladmin status endpoints`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-endpoints) to verify that the policy changed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/certificate.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/certificate.md index c6ee1581bd..e2de7f1fe5 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/certificate.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/certificate.md @@ -24,7 +24,7 @@ rladmin cluster certificate [ key_file ] ``` -To set a certificate for a specific service, use the corresponding certificate name. See the [certificates table]({{< relref "/operate/rs/7.4/security/certificates" >}}) for the list of cluster certificates and their descriptions. +To set a certificate for a specific service, use the corresponding certificate name. See the [certificates table](/content/operate/rs/7.4/security/certificates/_index.md) for the list of cluster certificates and their descriptions. ### Parameters diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config.md index e601a8f7bd..c1aa8b90d1 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config.md @@ -59,9 +59,9 @@ Updates the cluster configuration. | Parameter | Type/Value | Description | |-----------|------------|-------------| -| audit_address | string | TCP/IP address where a listener can capture [audit event notifications]({{< relref "/operate/rs/7.4/security/audit-events" >}}) | -| audit_port | string | Port where a listener can capture [audit event notifications]({{< relref "/operate/rs/7.4/security/audit-events" >}}) | -| audit_protocol | `tcp`
    `local` | Protocol used for [audit event notifications]({{< relref "/operate/rs/7.4/security/audit-events" >}})
    For production systems, only `tcp` is supported. | +| audit_address | string | TCP/IP address where a listener can capture [audit event notifications](/content/operate/rs/7.4/security/audit-events.md) | +| audit_port | string | Port where a listener can capture [audit event notifications](/content/operate/rs/7.4/security/audit-events.md) | +| audit_protocol | `tcp`
    `local` | Protocol used for [audit event notifications](/content/operate/rs/7.4/security/audit-events.md)
    For production systems, only `tcp` is supported. | | control_cipher_suites | list of ciphers | Cipher suites used for TLS connections to the Cluster Manager UI (specified in the format understood by the BoringSSL library)
    (previously named `cipher_suites`) | | cm_port | integer | UI server listening port | | cm_session_timeout_minutes | integer | Timeout in minutes for the CM session diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/failover.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/failover.md index a699ade44f..d0ede0ed36 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/failover.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/failover.md @@ -34,7 +34,7 @@ rladmin failover Returns `Finished successfully` if the failover completed. Otherwise, it returns an error. -Use [`rladmin status shards`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-shards" >}}) to verify that the failover completed. +Use [`rladmin status shards`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-shards) to verify that the failover completed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/migrate.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/migrate.md index 9d477be9ad..58ae2fcd83 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/migrate.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/migrate.md @@ -16,7 +16,7 @@ url: '/operate/rs/7.4/references/cli-utilities/rladmin/migrate/' Moves Redis Enterprise shards or endpoints to a new node in the same cluster. -For more information about shard migration use cases and considerations, see [Migrate database shards]({{}}). +For more information about shard migration use cases and considerations, see [Migrate database shards](/content/operate/rs/7.4/databases/migrate-shards.md). ## `migrate all_master_shards` @@ -42,7 +42,7 @@ rladmin migrate { db { db: | } | node } Returns `Done` if the migration completed successfully. Otherwise, returns an error. -Use [`rladmin status shards`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. +Use [`rladmin status shards`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-shards) to verify the migration completed. ### Example @@ -93,7 +93,7 @@ rladmin migrate node Returns `Done` if the migration completed successfully. Otherwise, returns an error. -Use [`rladmin status shards`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. +Use [`rladmin status shards`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-shards) to verify the migration completed. ### Example @@ -148,7 +148,7 @@ rladmin migrate { db { db: | } | node } Returns `Done` if the migration completed successfully. Otherwise, returns an error. -Use [`rladmin status shards`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. +Use [`rladmin status shards`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-shards) to verify the migration completed. ### Example @@ -202,7 +202,7 @@ rladmin migrate [ db { db: | } ] Returns a list of steps to perform the migration. If the `commit` flag is set, the steps will run and return `Finished successfully` if they were completed. Otherwise, returns an error. -Use [`rladmin status endpoints`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the endpoints were moved. +Use [`rladmin status endpoints`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-endpoints) to verify that the endpoints were moved. ### Example @@ -248,7 +248,7 @@ rladmin migrate shard Returns `Done` if the migration completed successfully. Otherwise, returns an error. -Use [`rladmin status shards`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. +Use [`rladmin status shards`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-shards) to verify the migration completed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/addr.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/addr.md index d376e77d99..0857ba48fc 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/addr.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/addr.md @@ -13,7 +13,7 @@ weight: $weight url: '/operate/rs/7.4/references/cli-utilities/rladmin/node/addr/' --- -Sets the internal IP address of a node. You can only set the internal IP address when the node is down. See [Change internal IP address]({{< relref "/operate/rs/7.4/networking/multi-ip-ipv6#change-internal-ip-address" >}}) for detailed instructions. +Sets the internal IP address of a node. You can only set the internal IP address when the node is down. See [Change internal IP address](/content/operate/rs/7.4/networking/multi-ip-ipv6.md#change-internal-ip-address) for detailed instructions. ```sh rladmin node addr set @@ -30,7 +30,7 @@ rladmin node addr set Returns `Updated successfully` if the IP address was set. Otherwise, it returns an error. -Use [`rladmin status nodes`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the internal IP address was changed. +Use [`rladmin status nodes`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-nodes) to verify the internal IP address was changed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/enslave.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/enslave.md index 733c03479d..c9293f0cf2 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/enslave.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/enslave.md @@ -37,7 +37,7 @@ rladmin node enslave Returns `OK` if the roles were successfully changed. Otherwise, it returns an error. -Use [`rladmin status shards`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-shards" >}}) to verify that the roles were changed. +Use [`rladmin status shards`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-shards) to verify that the roles were changed. ### Example @@ -93,7 +93,7 @@ rladmin node enslave endpoints_only Returns `OK` if the roles were successfully changed. Otherwise, it returns an error. -Use [`rladmin status endpoints`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the roles were changed. +Use [`rladmin status endpoints`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-endpoints) to verify that the roles were changed. ### Example @@ -133,7 +133,7 @@ rladmin node enslave shards_only Returns `OK` if the roles were successfully changed. Otherwise, it returns an error. -Use [`rladmin status shards`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-shards" >}}) to verify that the roles were changed. +Use [`rladmin status shards`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-shards) to verify that the roles were changed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/external-addr.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/external-addr.md index 875bcb9379..1f5fe03b0b 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/external-addr.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/external-addr.md @@ -35,7 +35,7 @@ rladmin node external_addr Returns `Updated successfully` if the IP address was added. Otherwise, it returns an error. -Use [`rladmin status nodes`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the external IP address was added. +Use [`rladmin status nodes`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-nodes) to verify the external IP address was added. ### Example @@ -70,7 +70,7 @@ rladmin node external_addr Returns `Updated successfully` if the IP addresses were set. Otherwise, it returns an error. -Use [`rladmin status nodes`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the external IP address was set. +Use [`rladmin status nodes`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-nodes) to verify the external IP address was set. ### Example @@ -104,7 +104,7 @@ rladmin node external_addr Returns `Updated successfully` if the IP address was removed. Otherwise, it returns an error. -Use [`rladmin status nodes`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the external IP address was removed. +Use [`rladmin status nodes`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-nodes) to verify the external IP address was removed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/maintenance-mode.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/maintenance-mode.md index 5b2c80394d..c2c32b5d1d 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/maintenance-mode.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/maintenance-mode.md @@ -13,7 +13,7 @@ weight: $weight url: '/operate/rs/7.4/references/cli-utilities/rladmin/node/maintenance-mode/' --- -Configures [quorum-only mode]({{< relref "/operate/rs/7.4/clusters/maintenance-mode#activate-maintenance-mode" >}}) on a node. +Configures [quorum-only mode](/content/operate/rs/7.4/clusters/maintenance-mode.md#activate-maintenance-mode) on a node. ## `node maintenance_mode on` @@ -47,7 +47,7 @@ rladmin node maintenance_mode on Returns `OK` if the node was converted successfully. If the cluster does not have enough resources to migrate the shards, the process returns a warning. -Use [`rladmin status nodes`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the node became a quorum node. +Use [`rladmin status nodes`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-nodes) to verify the node became a quorum node. ### Example @@ -91,7 +91,7 @@ rladmin node maintenance_mode off Returns `OK` if the node was restored successfully. -Use [`rladmin status nodes`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the node was restored. +Use [`rladmin status nodes`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-nodes) to verify the node was restored. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/recovery-path.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/recovery-path.md index 393f38a52e..1f8cb29284 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/recovery-path.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/recovery-path.md @@ -13,7 +13,7 @@ weight: $weight url: '/operate/rs/7.4/references/cli-utilities/rladmin/node/recovery-path/' --- -Sets the node's local recovery path, which specifies the directory where [persistence files]({{< relref "/operate/rs/7.4/databases/configure/database-persistence" >}}) are stored. You can use these persistence files to [recover a failed database]({{< relref "/operate/rs/7.4/databases/recover" >}}). +Sets the node's local recovery path, which specifies the directory where [persistence files](/content/operate/rs/7.4/databases/configure/database-persistence.md) are stored. You can use these persistence files to [recover a failed database](/content/operate/rs/7.4/databases/recover.md). ```sh rladmin node recovery_path set diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/remove.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/remove.md index 1442ec4928..308cb8dffb 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/remove.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/remove.md @@ -30,7 +30,7 @@ rladmin node remove [ wait_for_persistence { enabled | disabled } ] Returns `OK` if the node was removed successfully. Otherwise, it returns an error. -Use [`rladmin status nodes`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify that the node was removed. +Use [`rladmin status nodes`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-nodes) to verify that the node was removed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/snapshot.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/snapshot.md index e7c5a20dc7..f85fddc1e2 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/snapshot.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/snapshot.md @@ -52,9 +52,8 @@ Deletes an existing snapshot of a node. rladmin node snapshot delete ``` -{{}} -You cannot use this command to delete a snapshot created by maintenance mode. As of Redis Enterprise Software version 7.4.2, only the latest maintenance mode snapshot is kept. -{{}} +> [!NOTE] +> You cannot use this command to delete a snapshot created by maintenance mode. As of Redis Enterprise Software version 7.4.2, only the latest maintenance mode snapshot is kept. ### Parameters diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/placement.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/placement.md index 972ca6136f..8554551dc6 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/placement.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/placement.md @@ -33,7 +33,7 @@ rladmin placement Returns the new shard placement policy if the policy was changed successfully. Otherwise, it returns an error. -Use [`rladmin status databases`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-databases" >}}) to verify that the failover completed. +Use [`rladmin status databases`](/content/operate/rs/7.4/references/cli-utilities/rladmin/status.md#status-databases) to verify that the failover completed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/recover.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/recover.md index 57a2f4bc97..30634453ef 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/recover.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/recover.md @@ -13,9 +13,9 @@ weight: $weight url: '/operate/rs/7.4/references/cli-utilities/rladmin/recover/' --- -Recovers databases in recovery mode after events such as cluster failure, and restores the databases' configurations and data from stored persistence files. See [Recover a failed database]({{< relref "/operate/rs/7.4/databases/recover" >}}) for detailed instructions. +Recovers databases in recovery mode after events such as cluster failure, and restores the databases' configurations and data from stored persistence files. See [Recover a failed database](/content/operate/rs/7.4/databases/recover.md) for detailed instructions. -Database persistence files are stored in `/var/opt/redislabs/persist/redis/` by default, but you can specify a different directory to use for database recovery with [`rladmin node recovery_path set `]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/node/recovery-path" >}}). +Database persistence files are stored in `/var/opt/redislabs/persist/redis/` by default, but you can specify a different directory to use for database recovery with [`rladmin node recovery_path set `](/content/operate/rs/7.4/references/cli-utilities/rladmin/node/recovery-path.md). ## `recover all` diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/tune.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/tune.md index df8157d552..844af4f840 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/tune.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/tune.md @@ -56,13 +56,13 @@ rladmin tune cluster |----------------------------------------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------| | acl_pubsub_default | `resetchannels`
    `allchannels` | Default pub/sub ACL rule for all databases in the cluster:
    •`resetchannels` blocks access to all channels (restrictive)
    •`allchannels` allows access to all channels (permissive) | | automatic_node_offload | `enabled`
    `disabled` | Define whether automatic node offload migration will take place | -| data_internode_encryption | `enabled`
    `disabled` | Activates or deactivates [internode encryption]({{< relref "/operate/rs/7.4/security/encryption/internode-encryption" >}}) for new databases | -| db_conns_auditing | `enabled`
    `disabled` | Activates or deactivates [connection auditing]({{< relref "/operate/rs/7.4/security/audit-events" >}}) by default for new databases of a cluster | +| data_internode_encryption | `enabled`
    `disabled` | Activates or deactivates [internode encryption](/content/operate/rs/7.4/security/encryption/internode-encryption.md) for new databases | +| db_conns_auditing | `enabled`
    `disabled` | Activates or deactivates [connection auditing](/content/operate/rs/7.4/security/audit-events.md) by default for new databases of a cluster | | default_concurrent_restore_actions | integer
    `all` | Default number of concurrent actions when restoring a node from a snapshot (positive integer or "all") | -| default_non_sharded_proxy_policy | `single`

    `all-master-shards`

    `all-nodes` | Default [proxy policy]({{< relref "/operate/rs/7.4/databases/configure/proxy-policy" >}}) for newly created non-sharded databases' endpoints | +| default_non_sharded_proxy_policy | `single`

    `all-master-shards`

    `all-nodes` | Default [proxy policy](/content/operate/rs/7.4/databases/configure/proxy-policy.md) for newly created non-sharded databases' endpoints | | default_redis_version | version number | The default Redis database compatibility version used to create new databases.

    The value parameter should be a version number in the form of "x.y" where _x_ represents the major version number and _y_ represents the minor version number. The final value corresponds to the desired version of Redis.

    You cannot set _default_redis_version_ to a value higher than that supported by the current _redis_upgrade_policy_ value. | -| default_sharded_proxy_policy | `single`

    `all-master-shards`

    `all-nodes` | Default [proxy policy]({{< relref "/operate/rs/7.4/databases/configure/proxy-policy" >}}) for newly created sharded databases' endpoints | -| default_shards_placement | `dense`
    `sparse` | New databases place shards according to the default [shard placement policy]({{< relref "/operate/rs/7.4/databases/memory-performance/shard-placement-policy" >}}) | +| default_sharded_proxy_policy | `single`

    `all-master-shards`

    `all-nodes` | Default [proxy policy](/content/operate/rs/7.4/databases/configure/proxy-policy.md) for newly created sharded databases' endpoints | +| default_shards_placement | `dense`
    `sparse` | New databases place shards according to the default [shard placement policy](/content/operate/rs/7.4/databases/memory-performance/shard-placement-policy.md) | | expose_hostnames_for_all_suffixes | `enabled`
    `disabled` | Exposes hostnames for all DNS suffixes | | failure_detection_sensitivity | `high`
    `low` | Predefined thresholds and timeouts for failure detection (previously known as `watchdog_profile`)
    • `high` (previously `local-network`) – high failure detection sensitivity, lower thresholds, faster failure detection and failover
    • `low` (previously `cloud`) – low failure detection sensitivity, higher tolerance for latency variance (also called network jitter) | | login_lockout_counter_reset_after | time in seconds | Time after failed login attempt before the counter resets to 0 | @@ -79,17 +79,17 @@ rladmin tune cluster | repl_diskless | `enabled`
    `disabled` | Activates or deactivates diskless replication (can be overridden per database) | | resp3_default | `enabled`
    `disabled` | Determines the default value of the `resp3` option upon upgrading a database to version 7.2 (defaults to `enabled`) | | show_internals | `enabled`
    `disabled` | Controls the visibility of internal databases that are only used for the cluster's management | -| slave_ha | `enabled`
    `disabled` | Activates or deactivates [replica high availability]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}) in the cluster
    (enabled by default; use [`rladmin tune db`](#tune-db) to change `slave_ha` for a specific database)

    Deprecated as of Redis Enterprise Software v7.2.4. | -| slave_ha_bdb_cooldown_period | time in seconds (default: 7200) | Time (in seconds) a database must wait after its shards are relocated by [replica high availability]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}) before it can go through another shard migration if another node fails (default is 2 hours) | -| slave_ha_cooldown_period | time in seconds (default: 3600) | Time (in seconds) [replica high availability]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}) must wait after relocating shards due to node failure before performing another shard migration for any database in the cluster (default is 1 hour) | -| slave_ha_grace_period | time in seconds (default: 600) | Time (in seconds) between when a node fails and when [replica high availability]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}) starts relocating shards to another node | +| slave_ha | `enabled`
    `disabled` | Activates or deactivates [replica high availability](/content/operate/rs/7.4/databases/configure/replica-ha.md) in the cluster
    (enabled by default; use [`rladmin tune db`](#tune-db) to change `slave_ha` for a specific database)

    Deprecated as of Redis Enterprise Software v7.2.4. | +| slave_ha_bdb_cooldown_period | time in seconds (default: 7200) | Time (in seconds) a database must wait after its shards are relocated by [replica high availability](/content/operate/rs/7.4/databases/configure/replica-ha.md) before it can go through another shard migration if another node fails (default is 2 hours) | +| slave_ha_cooldown_period | time in seconds (default: 3600) | Time (in seconds) [replica high availability](/content/operate/rs/7.4/databases/configure/replica-ha.md) must wait after relocating shards due to node failure before performing another shard migration for any database in the cluster (default is 1 hour) | +| slave_ha_grace_period | time in seconds (default: 600) | Time (in seconds) between when a node fails and when [replica high availability](/content/operate/rs/7.4/databases/configure/replica-ha.md) starts relocating shards to another node | | watchdog_profile | `cloud`
    `local-network` | Watchdog profiles with preconfigured thresholds and timeouts (deprecated as of Redis Enterprise Software v6.4.2-69; use `failure_detection_sensitivity` instead)
    • `cloud` is suitable for common cloud environments and has a higher tolerance for latency variance (also called network jitter).
    • `local-network` is suitable for dedicated LANs and has better failure detection and failover times. | ### Returns Returns `Finished successfully` if the cluster configuration was changed. Otherwise, it returns an error. -Use [`rladmin info cluster`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/info#info-cluster" >}}) to verify the cluster configuration was changed. +Use [`rladmin info cluster`](/content/operate/rs/7.4/references/cli-utilities/rladmin/info.md#info-cluster) to verify the cluster configuration was changed. ### Example @@ -156,13 +156,13 @@ rladmin tune db { db: | } | continue_on_error | | Flag that skips tuning shards that can't be reached | | crdt_repl_backlog | value in MB
    `auto` | Size of the Active-Active replication buffer | | crdt_xadd_id_uniqueness_mode | `liberal`
    `semi-strict`
    `strict` | XADD's behavior in an Active-Active database, defined as liberal, semi-strict, or strict (see descriptions below) | -| data_internode_encryption | `enabled`
    `disabled` | Activates or deactivates [internode encryption]({{< relref "/operate/rs/7.4/security/encryption/internode-encryption" >}}) for the database | -| db_conns_auditing | `enabled`
    `disabled` | Activates or deactivates database [connection auditing]({{< relref "/operate/rs/7.4/security/audit-events" >}}) for a database | +| data_internode_encryption | `enabled`
    `disabled` | Activates or deactivates [internode encryption](/content/operate/rs/7.4/security/encryption/internode-encryption.md) for the database | +| db_conns_auditing | `enabled`
    `disabled` | Activates or deactivates database [connection auditing](/content/operate/rs/7.4/security/audit-events.md) for a database | | gradual_src_mode | `enabled`
    `disabled` | Activates or deactivates gradual sync of sources | | gradual_sync_max_shards_per_source | integer | Number of shards per sync source that can be replicated in parallel (positive integer) | | gradual_sync_mode | `enabled`
    `disabled`
    `auto` | Activates, deactivates, or automatically determines gradual sync of source shards | | master_persistence | `enabled`
    `disabled` | If enabled, persists the primary shard in addition to replica shards in a replicated and persistent database. | -| max_aof_file_size | size in MB | Maximum size (in MB, if not specified) of [AoF]({{< relref "/glossary/_index.md#letter-a" >}}) file (minimum value is 10 GB) | +| max_aof_file_size | size in MB | Maximum size (in MB, if not specified) of [AoF](/content/glossary/_index.md#letter-a) file (minimum value is 10 GB) | | max_aof_load_time | time in seconds | Time limit in seconds to load a shard from an append-only file (AOF). If exceeded, an AOF rewrite is initiated to decrease future load time.
    Minimum: 2700 seconds (45 minutes)
    Default: 3600 seconds (1 hour) | | max_client_pipeline | integer | Maximum commands in the proxy's pipeline per client connection (max value is 2047, default value is 200) | | max_connections | integer | Maximum client connections to the database's endpoint (default value is 0, which is unlimited) | @@ -198,7 +198,7 @@ rladmin tune db { db: | } Returns `Finished successfully` if the database configuration was changed. Otherwise, it returns an error. -Use [`rladmin info db`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/info#info-db" >}}) to verify the database configuration was changed. +Use [`rladmin info db`](/content/operate/rs/7.4/references/cli-utilities/rladmin/info.md#info-db) to verify the database configuration was changed. ### Example @@ -233,13 +233,13 @@ tune node { | all } | max_redis_forks | integer | Maximum number of background processes forked from shards that may exist on the node at any given time | | max_redis_servers | integer | Maximum number of shards allowed to reside on the node | | max_slave_full_syncs | integer | Maximum number of simultaneous replica full-syncs that may be running at any given time (0: Unlimited, -1: Use cluster settings) | -| quorum_only | `enabled`
    `disabled` | If activated, configures the node as a [quorum-only node]({{< relref "/glossary/_index.md#letter-p" >}}) | +| quorum_only | `enabled`
    `disabled` | If activated, configures the node as a [quorum-only node](/content/glossary/_index.md#letter-p) | ### Returns Returns `Finished successfully` if the node configuration was changed. Otherwise, it returns an error. -Use [`rladmin info node`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/info#info-node" >}}) to verify the node configuration was changed. +Use [`rladmin info node`](/content/operate/rs/7.4/references/cli-utilities/rladmin/info.md#info-node) to verify the node configuration was changed. ### Example @@ -279,7 +279,7 @@ rladmin tune proxy { | all } Returns `OK` if the proxy configuration was changed. Otherwise, it returns an error. -Use [`rladmin info proxy`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/info#info-proxy" >}}) to verify the proxy configuration was changed. +Use [`rladmin info proxy`](/content/operate/rs/7.4/references/cli-utilities/rladmin/info.md#info-proxy) to verify the proxy configuration was changed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/upgrade.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/upgrade.md index 28524f0807..075aa78ee8 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/upgrade.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/upgrade.md @@ -17,7 +17,7 @@ url: '/operate/rs/7.4/references/cli-utilities/rladmin/upgrade/' Schedules a restart of the primary and replica processes of a database and then upgrades the database to the latest version of Redis. -For more information, see [Upgrade an existing Redis Software Deployment]({{< relref "/operate/rs/7.4/installing-upgrading/upgrading" >}}). +For more information, see [Upgrade an existing Redis Software Deployment](/content/operate/rs/7.4/installing-upgrading/upgrading/_index.md). ```sh rladmin upgrade db { db: | } @@ -32,7 +32,7 @@ rladmin upgrade db { db: | } [ { latest_with_modules | and module module_name version module_args } ] ``` -As of v6.2.4, the default behavior for `upgrade db` has changed. It is now controlled by a new parameter that sets the default upgrade policy used to create new databases and to upgrade ones already in the cluster. To learn more, see [`tune cluster default_redis_version`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}). +As of v6.2.4, the default behavior for `upgrade db` has changed. It is now controlled by a new parameter that sets the default upgrade policy used to create new databases and to upgrade ones already in the cluster. To learn more, see [`tune cluster default_redis_version`](/content/operate/rs/7.4/references/cli-utilities/rladmin/tune.md#tune-cluster). ### Parameters @@ -73,7 +73,7 @@ Done Upgrades Redis modules in use by a specific database. -For more information, see [Upgrade modules]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module" >}}). +For more information, see [Upgrade modules](/content/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module.md). ```sh rladmin upgrade module @@ -92,7 +92,7 @@ rladmin upgrade module | version | module version number | Upgrades the module to the specified version | | module_args | 'keep_args'
    string | Module configuration options | -For more information about module configuration options, see [Module configuration options]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database#module-configuration-options" >}}). +For more information about module configuration options, see [Module configuration options](/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database.md#module-configuration-options). ### Returns diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/verify.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/verify.md index 05744281af..9a06a9cb39 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/verify.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/verify.md @@ -23,15 +23,15 @@ Prints a balance report that displays all of the unbalanced endpoints or nodes i rladmin verify balance [ node ] ``` -The [proxy policy]({{< relref "/operate/rs/7.4/databases/configure/proxy-policy#proxy-policies" >}}) determines which nodes or endpoints to report as unbalanced. +The [proxy policy](/content/operate/rs/7.4/databases/configure/proxy-policy.md#proxy-policies) determines which nodes or endpoints to report as unbalanced. A node is unbalanced if: - `all-nodes` proxy policy and the node has no endpoint An endpoint is unbalanced in the following cases: - `single` proxy policy and one of the following is true: - - Shard placement is [`sparse`]({{< relref "/operate/rs/7.4/databases/memory-performance/shard-placement-policy.md#sparse-shard-placement-policy" >}}) and none of the master shards are on the node - - Shard placement is [`dense`]({{< relref "/operate/rs/7.4/databases/memory-performance/shard-placement-policy.md#dense-shard-placement-policy" >}}) and some master shards are on a different node from the endpoint + - Shard placement is [`sparse`](/content/operate/rs/7.4/databases/memory-performance/shard-placement-policy.md#sparse-shard-placement-policy) and none of the master shards are on the node + - Shard placement is [`dense`](/content/operate/rs/7.4/databases/memory-performance/shard-placement-policy.md#dense-shard-placement-policy) and some master shards are on a different node from the endpoint - `all-master-shards` proxy policy and one of the following is true: - None of the master shards are on the node - Some master shards are on a different node from the endpoint @@ -68,7 +68,7 @@ NODE:ID DB:ID NAME ENDPOINT:ID PROXY_POLICY LOCAL SHARDS TOTAL SHARDS ## `verify rack_aware` -Verifies that the cluster complies with the rack awareness policy and reports any discovered rack collisions, if [rack-zone awareness]({{< relref "/operate/rs/7.4/clusters/configure/rack-zone-awareness" >}}) is enabled. +Verifies that the cluster complies with the rack awareness policy and reports any discovered rack collisions, if [rack-zone awareness](/content/operate/rs/7.4/clusters/configure/rack-zone-awareness.md) is enabled. ```sh rladmin verify rack_aware diff --git a/content/operate/rs/7.4/references/client_references/_index.md b/content/operate/rs/7.4/references/client_references/_index.md index 38ae158df9..3b7857f17c 100644 --- a/content/operate/rs/7.4/references/client_references/_index.md +++ b/content/operate/rs/7.4/references/client_references/_index.md @@ -19,15 +19,15 @@ To connect to Redis instances from within your application, use a Redis client l | Language | Client name | | :---------- | :------------- | -| .Net | [StackExchange.Redis]({{< relref "/develop/clients/dotnet" >}}) | -| Go | [go-redis]({{< relref "/develop/clients/go" >}}) | -| Java | [Jedis]({{< relref "/develop/clients/jedis" >}}) (Synchronous) and [Lettuce]({{< relref "/develop/clients/lettuce" >}}) (Asynchronous) | -| Node.js | [node-redis]({{< relref "/develop/clients/nodejs" >}}) | -| Python | [redis-py]({{< relref "/develop/clients/redis-py" >}}) | +| .Net | [StackExchange.Redis](/content/develop/clients/dotnet/_index.md) | +| Go | [go-redis](/content/develop/clients/go/_index.md) | +| Java | [Jedis](/content/develop/clients/jedis/_index.md) (Synchronous) and [Lettuce](/content/develop/clients/lettuce/_index.md) (Asynchronous) | +| Node.js | [node-redis](/content/develop/clients/nodejs/_index.md) | +| Python | [redis-py](/content/develop/clients/redis-py/_index.md) | Select a client name to see its quick start. ## Other clients For a list of community-driven Redis clients, which are available for more programming languages, see -[Community-supported clients]({{< relref "/develop/clients#community-supported-clients" >}}). +[Community-supported clients](/content/develop/clients/_index.md#community-supported-clients). diff --git a/content/operate/rs/7.4/references/clustering-redis.md b/content/operate/rs/7.4/references/clustering-redis.md index e36858bf17..946493c8d5 100644 --- a/content/operate/rs/7.4/references/clustering-redis.md +++ b/content/operate/rs/7.4/references/clustering-redis.md @@ -28,4 +28,4 @@ There are several solutions to clustering Redis, most notable of which is the [R Redis Enterprise Software and Redis Cloud were built from the ground up to provide a Redis cluster of any size while supporting all Redis commands. Your dataset is distributed across multiple shards in multiple nodes of the Redis cluster and is constantly monitored to ensure optimal performance. When needed, more shards and nodes can be added to your dataset so it can scale continuously and limitlessly. -Redis Enterprise clusters provide a single endpoint to connect to, and do not require any code changes or special configuration from the application’s perspective. For more information on setting up and using Redis Enterprise clusters, see [Database clustering]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering/" >}}). +Redis Enterprise clusters provide a single endpoint to connect to, and do not require any code changes or special configuration from the application’s perspective. For more information on setting up and using Redis Enterprise clusters, see [Database clustering](/content/operate/rs/7.4/databases/durability-ha/clustering.md). diff --git a/content/operate/rs/7.4/references/compatibility/_index.md b/content/operate/rs/7.4/references/compatibility/_index.md index 80d81954e2..5cc49b6fd1 100644 --- a/content/operate/rs/7.4/references/compatibility/_index.md +++ b/content/operate/rs/7.4/references/compatibility/_index.md @@ -13,14 +13,14 @@ weight: $weight tocEmbedHeaders: true url: '/operate/rs/7.4/references/compatibility/' --- -Both Redis Enterprise Software and [Redis Cloud]({{< relref "/operate/rc" >}}) are compatible with Redis Open Source. +Both Redis Enterprise Software and [Redis Cloud](/content/operate/rc/_index.md) are compatible with Redis Open Source. {{< embed-md "rc-rs-oss-compatibility.md" >}} ## RESP compatibility -Redis Enterprise Software and Redis Cloud support RESP2 and RESP3. See [RESP compatibility with Redis Enterprise]({{< relref "/operate/rs/7.4/references/compatibility/resp" >}}) for more information. +Redis Enterprise Software and Redis Cloud support RESP2 and RESP3. See [RESP compatibility with Redis Enterprise](/content/operate/rs/7.4/references/compatibility/resp.md) for more information. ## Compatibility with open source Redis Cluster API -Redis Enterprise supports [Redis OSS Cluster API]({{< relref "/operate/rs/7.4/clusters/optimize/oss-cluster-api" >}}) if it is enabled for a database. For more information, see [Enable OSS Cluster API]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api" >}}). +Redis Enterprise supports [Redis OSS Cluster API](/content/operate/rs/7.4/clusters/optimize/oss-cluster-api.md) if it is enabled for a database. For more information, see [Enable OSS Cluster API](/content/operate/rs/7.4/databases/configure/oss-cluster-api.md). diff --git a/content/operate/rs/7.4/references/compatibility/commands/_index.md b/content/operate/rs/7.4/references/compatibility/commands/_index.md index e7b2883053..e217f6ee35 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/_index.md +++ b/content/operate/rs/7.4/references/compatibility/commands/_index.md @@ -13,7 +13,7 @@ weight: 30 url: '/operate/rs/7.4/references/compatibility/commands/' --- -Learn which Redis Open Source commands are compatible with Redis Enterprise Software and [Redis Cloud]({{< relref "/operate/rc" >}}). +Learn which Redis Open Source commands are compatible with Redis Enterprise Software and [Redis Cloud](/content/operate/rc/_index.md). Select a command group for more details about compatibility with standard and Active-Active Redis Enterprise. diff --git a/content/operate/rs/7.4/references/compatibility/commands/cluster.md b/content/operate/rs/7.4/references/compatibility/commands/cluster.md index c71be369f2..6d26f0d664 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/cluster.md +++ b/content/operate/rs/7.4/references/compatibility/commands/cluster.md @@ -12,40 +12,40 @@ weight: 10 url: '/operate/rs/7.4/references/compatibility/commands/cluster/' --- -[Clustering in Redis Enterprise Software]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering" >}}) and [Redis Cloud]({{< relref "/operate/rc/databases/configuration/clustering" >}}) differs from the [Redis Open Source cluster]({{}}) and works with all standard Redis clients. +[Clustering in Redis Enterprise Software](/content/operate/rs/7.4/databases/durability-ha/clustering.md) and [Redis Cloud](/content/operate/rc/databases/configuration/clustering.md) differs from the [Redis Open Source cluster](/content/operate/oss_and_stack/management/scaling.md) and works with all standard Redis clients. -Redis Enterprise blocks most [cluster commands]({{< relref "/commands" >}}?group=cluster). If you try to use a blocked cluster command, it returns an error. +Redis Enterprise blocks most [cluster commands](/commands?group=cluster). If you try to use a blocked cluster command, it returns an error. | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [ASKING]({{< relref "/commands/asking" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER ADDSLOTS]({{< relref "/commands/cluster-addslots" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER ADDSLOTSRANGE]({{< relref "/commands/cluster-addslotsrange" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER BUMPEPOCH]({{< relref "/commands/cluster-bumpepoch" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER COUNT-FAILURE-REPORTS]({{< relref "/commands/cluster-count-failure-reports" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER COUNTKEYSINSLOT]({{< relref "/commands/cluster-countkeysinslot" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER DELSLOTS]({{< relref "/commands/cluster-delslots" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER DELSLOTSRANGE]({{< relref "/commands/cluster-delslotsrange" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER FAILOVER]({{< relref "/commands/cluster-failover" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER FLUSHSLOTS]({{< relref "/commands/cluster-flushslots" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER FORGET]({{< relref "/commands/cluster-forget" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER GETKEYSINSLOT]({{< relref "/commands/cluster-getkeysinslot" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER HELP]({{< relref "/commands/cluster-help" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api" >}}). | -| [CLUSTER INFO]({{< relref "/commands/cluster-info" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api" >}}). | -| [CLUSTER KEYSLOT]({{< relref "/commands/cluster-keyslot" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api" >}}). | -| [CLUSTER LINKS]({{< relref "/commands/cluster-links" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER MEET]({{< relref "/commands/cluster-meet" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER MYID]({{< relref "/commands/cluster-myid" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER MYSHARDID]({{< relref "/commands/cluster-myshardid" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER NODES]({{< relref "/commands/cluster-nodes" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api" >}}). | -| [CLUSTER REPLICAS]({{< relref "/commands/cluster-replicas" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER REPLICATE]({{< relref "/commands/cluster-replicate" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER RESET]({{< relref "/commands/cluster-reset" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER SAVECONFIG]({{< relref "/commands/cluster-saveconfig" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER SET-CONFIG-EPOCH]({{< relref "/commands/cluster-set-config-epoch" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER SETSLOT]({{< relref "/commands/cluster-setslot" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLUSTER SHARDS]({{< relref "/commands/cluster-shards" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api" >}}). | -| [CLUSTER SLAVES]({{< relref "/commands/cluster-slaves" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | Deprecated as of Redis v5.0.0. | -| [CLUSTER SLOTS]({{< relref "/commands/cluster-slots" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api" >}}). Deprecated as of Redis v7.0.0. | -| [READONLY]({{< relref "/commands/readonly" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [READWRITE]({{< relref "/commands/readwrite" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [ASKING](/content/commands/asking.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER ADDSLOTS](/content/commands/cluster-addslots.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER ADDSLOTSRANGE](/content/commands/cluster-addslotsrange.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER BUMPEPOCH](/content/commands/cluster-bumpepoch.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER COUNT-FAILURE-REPORTS](/content/commands/cluster-count-failure-reports.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER COUNTKEYSINSLOT](/content/commands/cluster-countkeysinslot.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER DELSLOTS](/content/commands/cluster-delslots.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER DELSLOTSRANGE](/content/commands/cluster-delslotsrange.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER FAILOVER](/content/commands/cluster-failover.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER FLUSHSLOTS](/content/commands/cluster-flushslots.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER FORGET](/content/commands/cluster-forget.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER GETKEYSINSLOT](/content/commands/cluster-getkeysinslot.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER HELP](/content/commands/cluster-help.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Only supported with the [OSS cluster API](/content/operate/rs/7.4/databases/configure/oss-cluster-api.md). | +| [CLUSTER INFO](/content/commands/cluster-info.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Only supported with the [OSS cluster API](/content/operate/rs/7.4/databases/configure/oss-cluster-api.md). | +| [CLUSTER KEYSLOT](/content/commands/cluster-keyslot.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Only supported with the [OSS cluster API](/content/operate/rs/7.4/databases/configure/oss-cluster-api.md). | +| [CLUSTER LINKS](/content/commands/cluster-links.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER MEET](/content/commands/cluster-meet.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER MYID](/content/commands/cluster-myid.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER MYSHARDID](/content/commands/cluster-myshardid.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER NODES](/content/commands/cluster-nodes.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Only supported with the [OSS cluster API](/content/operate/rs/7.4/databases/configure/oss-cluster-api.md). | +| [CLUSTER REPLICAS](/content/commands/cluster-replicas.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER REPLICATE](/content/commands/cluster-replicate.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER RESET](/content/commands/cluster-reset.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER SAVECONFIG](/content/commands/cluster-saveconfig.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER SET-CONFIG-EPOCH](/content/commands/cluster-set-config-epoch.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER SETSLOT](/content/commands/cluster-setslot.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLUSTER SHARDS](/content/commands/cluster-shards.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Only supported with the [OSS cluster API](/content/operate/rs/7.4/databases/configure/oss-cluster-api.md). | +| [CLUSTER SLAVES](/content/commands/cluster-slaves.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | Deprecated as of Redis v5.0.0. | +| [CLUSTER SLOTS](/content/commands/cluster-slots.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Only supported with the [OSS cluster API](/content/operate/rs/7.4/databases/configure/oss-cluster-api.md). Deprecated as of Redis v7.0.0. | +| [READONLY](/content/commands/readonly.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [READWRITE](/content/commands/readwrite.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | diff --git a/content/operate/rs/7.4/references/compatibility/commands/connection.md b/content/operate/rs/7.4/references/compatibility/commands/connection.md index 80899aca95..73337998a7 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/connection.md +++ b/content/operate/rs/7.4/references/compatibility/commands/connection.md @@ -12,32 +12,32 @@ weight: 10 url: '/operate/rs/7.4/references/compatibility/commands/connection/' --- -The following tables show which Redis Open Source [connection management commands]({{< relref "/commands" >}}?group=connection) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. +The following tables show which Redis Open Source [connection management commands](/commands?group=connection) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [AUTH]({{< relref "/commands/auth" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [CLIENT CACHING]({{< relref "/commands/client-caching" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLIENT GETNAME]({{< relref "/commands/client-getname" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [CLIENT GETREDIR]({{< relref "/commands/client-getredir" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLIENT ID]({{< relref "/commands/client-id" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Because Redis Enterprise clustering allows [multiple active proxies]({{< relref "/operate/rs/7.4/databases/configure/proxy-policy" >}}), `CLIENT ID` cannot guarantee incremental IDs between clients that connect to different nodes under multi proxy policies. | -| [CLIENT INFO]({{< relref "/commands/client-info" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [CLIENT KILL]({{< relref "/commands/client-kill" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [CLIENT LIST]({{< relref "/commands/client-list" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [CLIENT NO-EVICT]({{< relref "/commands/client-no-evict" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLIENT NO-TOUCH]({{< relref "/commands/client-no-touch" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [CLIENT PAUSE]({{< relref "/commands/client-pause" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLIENT REPLY]({{< relref "/commands/client-reply" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [CLIENT SETINFO]({{< relref "/commands/client-setinfo" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [CLIENT SETNAME]({{< relref "/commands/client-setname" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [CLIENT TRACKING]({{< relref "/commands/client-tracking" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLIENT TRACKINGINFO]({{< relref "/commands/client-trackinginfo" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CLIENT UNBLOCK]({{< relref "/commands/client-unblock" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [CLIENT UNPAUSE]({{< relref "/commands/client-unpause" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [ECHO]({{< relref "/commands/echo" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [HELLO]({{< relref "/commands/hello" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PING]({{< relref "/commands/ping" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [QUIT]({{< relref "/commands/quit" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v7.2.0. | -| [RESET]({{< relref "/commands/reset" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [SELECT]({{< relref "/commands/select" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | Redis Enterprise does not support shared databases due to potential negative performance impacts and blocks any related commands. The `SELECT` command is supported solely for compatibility with Redis Open Source but does not perform any operations in Redis Enterprise. | +| [AUTH](/content/commands/auth.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [CLIENT CACHING](/content/commands/client-caching.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLIENT GETNAME](/content/commands/client-getname.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [CLIENT GETREDIR](/content/commands/client-getredir.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLIENT ID](/content/commands/client-id.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Because Redis Enterprise clustering allows [multiple active proxies](/content/operate/rs/7.4/databases/configure/proxy-policy.md), `CLIENT ID` cannot guarantee incremental IDs between clients that connect to different nodes under multi proxy policies. | +| [CLIENT INFO](/content/commands/client-info.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [CLIENT KILL](/content/commands/client-kill.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [CLIENT LIST](/content/commands/client-list.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [CLIENT NO-EVICT](/content/commands/client-no-evict.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLIENT NO-TOUCH](/content/commands/client-no-touch.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [CLIENT PAUSE](/content/commands/client-pause.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLIENT REPLY](/content/commands/client-reply.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [CLIENT SETINFO](/content/commands/client-setinfo.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [CLIENT SETNAME](/content/commands/client-setname.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [CLIENT TRACKING](/content/commands/client-tracking.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLIENT TRACKINGINFO](/content/commands/client-trackinginfo.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CLIENT UNBLOCK](/content/commands/client-unblock.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [CLIENT UNPAUSE](/content/commands/client-unpause.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [ECHO](/content/commands/echo.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HELLO](/content/commands/hello.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PING](/content/commands/ping.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [QUIT](/content/commands/quit.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v7.2.0. | +| [RESET](/content/commands/reset.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [SELECT](/content/commands/select.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | Redis Enterprise does not support shared databases due to potential negative performance impacts and blocks any related commands. The `SELECT` command is supported solely for compatibility with Redis Open Source but does not perform any operations in Redis Enterprise. | diff --git a/content/operate/rs/7.4/references/compatibility/commands/data-types.md b/content/operate/rs/7.4/references/compatibility/commands/data-types.md index b9d1081c60..e364adb118 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/data-types.md +++ b/content/operate/rs/7.4/references/compatibility/commands/data-types.md @@ -20,201 +20,201 @@ The following tables show which Redis Open source data type commands are compati | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [BITCOUNT]({{< relref "/commands/bitcount" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [BITFIELD]({{< relref "/commands/bitfield" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [BITFIELD_RO]({{< relref "/commands/bitfield_ro" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [BITOP]({{< relref "/commands/bitop" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [BITPOS]({{< relref "/commands/bitpos" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [GETBIT]({{< relref "/commands/getbit" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SETBIT]({{< relref "/commands/setbit" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [BITCOUNT](/content/commands/bitcount.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [BITFIELD](/content/commands/bitfield.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [BITFIELD_RO](/content/commands/bitfield_ro.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [BITOP](/content/commands/bitop.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [BITPOS](/content/commands/bitpos.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [GETBIT](/content/commands/getbit.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SETBIT](/content/commands/setbit.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | ## Geospatial indices commands | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [GEOADD]({{< relref "/commands/geoadd" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [GEODIST]({{< relref "/commands/geodist" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [GEOHASH]({{< relref "/commands/geohash" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [GEOPOS]({{< relref "/commands/geopos" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [GEORADIUS]({{< relref "/commands/georadius" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [GEORADIUS_RO]({{< relref "/commands/georadius_ro" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [GEORADIUSBYMEMBER]({{< relref "/commands/georadiusbymember" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [GEORADIUSBYMEMBER_RO]({{< relref "/commands/georadiusbymember_ro" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [GEOSEARCH]({{< relref "/commands/geosearch" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [GEOSEARCHSTORE]({{< relref "/commands/geosearchstore" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [GEOADD](/content/commands/geoadd.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [GEODIST](/content/commands/geodist.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [GEOHASH](/content/commands/geohash.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [GEOPOS](/content/commands/geopos.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [GEORADIUS](/content/commands/georadius.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [GEORADIUS_RO](/content/commands/georadius_ro.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [GEORADIUSBYMEMBER](/content/commands/georadiusbymember.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [GEORADIUSBYMEMBER_RO](/content/commands/georadiusbymember_ro.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [GEOSEARCH](/content/commands/geosearch.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [GEOSEARCHSTORE](/content/commands/geosearchstore.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | ## Hash commands | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [HDEL]({{< relref "/commands/hdel" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [HEXISTS]({{< relref "/commands/hexists" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [HGET]({{< relref "/commands/hget" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [HGETALL]({{< relref "/commands/hgetall" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [HINCRBY]({{< relref "/commands/hincrby" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [HINCRBYFLOAT]({{< relref "/commands/hincrbyfloat" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [HKEYS]({{< relref "/commands/hkeys" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [HLEN]({{< relref "/commands/hlen" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [HMGET]({{< relref "/commands/hmget" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [HMSET]({{< relref "/commands/hmset" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v4.0.0. | -| [HRANDFIELD]({{< relref "/commands/hrandfield" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [HSCAN]({{< relref "/commands/hscan" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [HSET]({{< relref "/commands/hset" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [HSETNX]({{< relref "/commands/hsetnx" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [HSTRLEN]({{< relref "/commands/hstrlen" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [HVALS]({{< relref "/commands/hvals" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HDEL](/content/commands/hdel.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HEXISTS](/content/commands/hexists.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HGET](/content/commands/hget.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HGETALL](/content/commands/hgetall.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HINCRBY](/content/commands/hincrby.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HINCRBYFLOAT](/content/commands/hincrbyfloat.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HKEYS](/content/commands/hkeys.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HLEN](/content/commands/hlen.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HMGET](/content/commands/hmget.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HMSET](/content/commands/hmset.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v4.0.0. | +| [HRANDFIELD](/content/commands/hrandfield.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HSCAN](/content/commands/hscan.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HSET](/content/commands/hset.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HSETNX](/content/commands/hsetnx.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HSTRLEN](/content/commands/hstrlen.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [HVALS](/content/commands/hvals.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | ## HyperLogLog commands | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [PFADD]({{< relref "/commands/pfadd" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PFCOUNT]({{< relref "/commands/pfcount" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PFDEBUG]({{< relref "/commands/pfdebug" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [PFMERGE]({{< relref "/commands/pfmerge" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PFSELFTEST]({{< relref "/commands/pfselftest" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [PFADD](/content/commands/pfadd.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PFCOUNT](/content/commands/pfcount.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PFDEBUG](/content/commands/pfdebug.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [PFMERGE](/content/commands/pfmerge.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PFSELFTEST](/content/commands/pfselftest.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | ## List commands | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [BLMOVE]({{< relref "/commands/blmove" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [BLMPOP]({{< relref "/commands/blmpop" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [BLPOP]({{< relref "/commands/blpop" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [BRPOP]({{< relref "/commands/brpop" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [BRPOPLPUSH]({{< relref "/commands/brpoplpush" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [LINDEX]({{< relref "/commands/lindex" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [LINSERT]({{< relref "/commands/linsert" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [LLEN]({{< relref "/commands/llen" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [LMOVE]({{< relref "/commands/lmove" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [LMPOP]({{< relref "/commands/lmpop" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [LPOP]({{< relref "/commands/lpop" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [LPOS]({{< relref "/commands/lpos" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [LPUSH]({{< relref "/commands/lpush" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [LPUSHX]({{< relref "/commands/lpushx" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [LRANGE]({{< relref "/commands/lrange" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [LREM]({{< relref "/commands/lrem" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [LSET]({{< relref "/commands/lset" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [LTRIM]({{< relref "/commands/ltrim" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [RPOP]({{< relref "/commands/rpop" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [RPOPLPUSH]({{< relref "/commands/rpoplpush" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [RPUSH]({{< relref "/commands/rpush" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [RPUSHX]({{< relref "/commands/rpushx" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [BLMOVE](/content/commands/blmove.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [BLMPOP](/content/commands/blmpop.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [BLPOP](/content/commands/blpop.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [BRPOP](/content/commands/brpop.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [BRPOPLPUSH](/content/commands/brpoplpush.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [LINDEX](/content/commands/lindex.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [LINSERT](/content/commands/linsert.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [LLEN](/content/commands/llen.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [LMOVE](/content/commands/lmove.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [LMPOP](/content/commands/lmpop.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [LPOP](/content/commands/lpop.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [LPOS](/content/commands/lpos.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [LPUSH](/content/commands/lpush.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [LPUSHX](/content/commands/lpushx.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [LRANGE](/content/commands/lrange.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [LREM](/content/commands/lrem.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [LSET](/content/commands/lset.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [LTRIM](/content/commands/ltrim.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [RPOP](/content/commands/rpop.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [RPOPLPUSH](/content/commands/rpoplpush.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [RPUSH](/content/commands/rpush.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [RPUSHX](/content/commands/rpushx.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | ## Set commands | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [SADD]({{< relref "/commands/sadd" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SCARD]({{< relref "/commands/scard" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SDIFF]({{< relref "/commands/sdiff" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SDIFFSTORE]({{< relref "/commands/sdiffstore" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SINTER]({{< relref "/commands/sinter" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SINTERCARD]({{< relref "/commands/sintercard" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SINTERSTORE]({{< relref "/commands/sinterstore" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SISMEMBER]({{< relref "/commands/sismember" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SMEMBERS]({{< relref "/commands/smembers" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SMISMEMBER]({{< relref "/commands/smismember" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SMOVE]({{< relref "/commands/smove" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SPOP]({{< relref "/commands/spop" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SRANDMEMBER]({{< relref "/commands/srandmember" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SREM]({{< relref "/commands/srem" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SSCAN]({{< relref "/commands/sscan" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SUNION]({{< relref "/commands/sunion" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SUNIONSTORE]({{< relref "/commands/sunionstore" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SADD](/content/commands/sadd.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SCARD](/content/commands/scard.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SDIFF](/content/commands/sdiff.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SDIFFSTORE](/content/commands/sdiffstore.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SINTER](/content/commands/sinter.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SINTERCARD](/content/commands/sintercard.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SINTERSTORE](/content/commands/sinterstore.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SISMEMBER](/content/commands/sismember.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SMEMBERS](/content/commands/smembers.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SMISMEMBER](/content/commands/smismember.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SMOVE](/content/commands/smove.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SPOP](/content/commands/spop.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SRANDMEMBER](/content/commands/srandmember.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SREM](/content/commands/srem.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SSCAN](/content/commands/sscan.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SUNION](/content/commands/sunion.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SUNIONSTORE](/content/commands/sunionstore.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | ## Sorted set commands | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [BZMPOP]({{< relref "/commands/bzmpop" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [BZPOPMAX]({{< relref "/commands/bzpopmax" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [BZPOPMIN]({{< relref "/commands/bzpopmin" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZADD]({{< relref "/commands/zadd" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZCARD]({{< relref "/commands/zcard" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZCOUNT]({{< relref "/commands/zcount" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZDIFF]({{< relref "/commands/zdiff" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZDIFFSTORE]({{< relref "/commands/zdiffstore" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZINCRBY]({{< relref "/commands/zincrby" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZINTER]({{< relref "/commands/zinter" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZINTERCARD]({{< relref "/commands/zintercard" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZINTERSTORE]({{< relref "/commands/zinterstore" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZLEXCOUNT]({{< relref "/commands/zlexcount" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZMPOP]({{< relref "/commands/zmpop" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZMSCORE]({{< relref "/commands/zmscore" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZPOPMAX]({{< relref "/commands/zpopmax" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZPOPMIN]({{< relref "/commands/zpopmin" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZRANDMEMBER]({{< relref "/commands/zrandmember" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZRANGE]({{< relref "/commands/zrange" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZRANGEBYLEX]({{< relref "/commands/zrangebylex" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [ZRANGEBYSCORE]({{< relref "/commands/zrangebyscore" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [ZRANGESTORE]({{< relref "/commands/zrangestore" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZRANK]({{< relref "/commands/zrank" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZREM]({{< relref "/commands/zrem" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZREMRANGEBYLEX]({{< relref "/commands/zremrangebylex" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZREMRANGEBYRANK]({{< relref "/commands/zremrangebyrank" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZREMRANGEBYSCORE]({{< relref "/commands/zremrangebyscore" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZREVRANGE]({{< relref "/commands/zrevrange" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [ZREVRANGEBYLEX]({{< relref "/commands/zrevrangebylex" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [ZREVRANGEBYSCORE]({{< relref "/commands/zrevrangebyscore" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [ZREVRANK]({{< relref "/commands/zrevrank" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZSCAN]({{< relref "/commands/zscan" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZSCORE]({{< relref "/commands/zscore" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZUNION]({{< relref "/commands/zunion" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [ZUNIONSTORE]({{< relref "/commands/zunionstore" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [BZMPOP](/content/commands/bzmpop.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [BZPOPMAX](/content/commands/bzpopmax.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [BZPOPMIN](/content/commands/bzpopmin.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZADD](/content/commands/zadd.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZCARD](/content/commands/zcard.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZCOUNT](/content/commands/zcount.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZDIFF](/content/commands/zdiff.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZDIFFSTORE](/content/commands/zdiffstore.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZINCRBY](/content/commands/zincrby.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZINTER](/content/commands/zinter.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZINTERCARD](/content/commands/zintercard.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZINTERSTORE](/content/commands/zinterstore.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZLEXCOUNT](/content/commands/zlexcount.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZMPOP](/content/commands/zmpop.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZMSCORE](/content/commands/zmscore.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZPOPMAX](/content/commands/zpopmax.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZPOPMIN](/content/commands/zpopmin.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZRANDMEMBER](/content/commands/zrandmember.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZRANGE](/content/commands/zrange.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZRANGEBYLEX](/content/commands/zrangebylex.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [ZRANGEBYSCORE](/content/commands/zrangebyscore.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [ZRANGESTORE](/content/commands/zrangestore.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZRANK](/content/commands/zrank.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZREM](/content/commands/zrem.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZREMRANGEBYLEX](/content/commands/zremrangebylex.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZREMRANGEBYRANK](/content/commands/zremrangebyrank.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZREMRANGEBYSCORE](/content/commands/zremrangebyscore.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZREVRANGE](/content/commands/zrevrange.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [ZREVRANGEBYLEX](/content/commands/zrevrangebylex.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [ZREVRANGEBYSCORE](/content/commands/zrevrangebyscore.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [ZREVRANK](/content/commands/zrevrank.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZSCAN](/content/commands/zscan.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZSCORE](/content/commands/zscore.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZUNION](/content/commands/zunion.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [ZUNIONSTORE](/content/commands/zunionstore.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | ## Stream commands | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [XACK]({{< relref "/commands/xack" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [XADD]({{< relref "/commands/xadd" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [XAUTOCLAIM]({{< relref "/commands/xautoclaim" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [XCLAIM]({{< relref "/commands/xclaim" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [XDEL]({{< relref "/commands/xdel" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [XGROUP]({{< relref "/commands/xgroup" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [XINFO]({{< relref "/commands/xinfo" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [XLEN]({{< relref "/commands/xlen" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [XPENDING]({{< relref "/commands/xpending" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [XRANGE]({{< relref "/commands/xrange" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [XREAD]({{< relref "/commands/xread" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [XREADGROUP]({{< relref "/commands/xreadgroup" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [XREVRANGE]({{< relref "/commands/xrevrange" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [XSETID]({{< relref "/commands/xsetid" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [XTRIM]({{< relref "/commands/xtrim" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [XACK](/content/commands/xack.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [XADD](/content/commands/xadd.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [XAUTOCLAIM](/content/commands/xautoclaim.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [XCLAIM](/content/commands/xclaim.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [XDEL](/content/commands/xdel.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [XGROUP](/content/commands/xgroup.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [XINFO](/content/commands/xinfo.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [XLEN](/content/commands/xlen.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [XPENDING](/content/commands/xpending.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [XRANGE](/content/commands/xrange.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [XREAD](/content/commands/xread.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [XREADGROUP](/content/commands/xreadgroup.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [XREVRANGE](/content/commands/xrevrange.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [XSETID](/content/commands/xsetid.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [XTRIM](/content/commands/xtrim.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | ## String commands | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [APPEND]({{< relref "/commands/append" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [DECR]({{< relref "/commands/decr" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [DECRBY]({{< relref "/commands/decrby" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [GET]({{< relref "/commands/get" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [GETDEL]({{< relref "/commands/getdel" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [GETEX]({{< relref "/commands/getex" >}}) | ✅ Standard
    ✅ Active-Active\* | ✅ Standard
    ✅ Active-Active\* | \*Not supported for HyperLogLog. | -| [GETRANGE]({{< relref "/commands/getrange" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [GETSET]({{< relref "/commands/getset" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [INCR]({{< relref "/commands/incr" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [INCRBY]({{< relref "/commands/incrby" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [INCRBYFLOAT]({{< relref "/commands/incrbyfloat" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [LCS]({{< relref "/commands/lcs" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [MGET]({{< relref "/commands/mget" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [MSET]({{< relref "/commands/mset" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [MSETNX]({{< relref "/commands/msetnx" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PSETEX]({{< relref "/commands/psetex" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SET]({{< relref "/commands/set" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SETEX]({{< relref "/commands/setex" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SETNX]({{< relref "/commands/setnx" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SETRANGE]({{< relref "/commands/setrange" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [APPEND](/content/commands/append.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [DECR](/content/commands/decr.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [DECRBY](/content/commands/decrby.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [GET](/content/commands/get.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [GETDEL](/content/commands/getdel.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [GETEX](/content/commands/getex.md) | ✅ Standard
    ✅ Active-Active\* | ✅ Standard
    ✅ Active-Active\* | \*Not supported for HyperLogLog. | +| [GETRANGE](/content/commands/getrange.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [GETSET](/content/commands/getset.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [INCR](/content/commands/incr.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [INCRBY](/content/commands/incrby.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [INCRBYFLOAT](/content/commands/incrbyfloat.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [LCS](/content/commands/lcs.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [MGET](/content/commands/mget.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [MSET](/content/commands/mset.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [MSETNX](/content/commands/msetnx.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PSETEX](/content/commands/psetex.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SET](/content/commands/set.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SETEX](/content/commands/setex.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SETNX](/content/commands/setnx.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SETRANGE](/content/commands/setrange.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | | STRALGO | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | Deprecated as of Redis v7.0.0. | -| [STRLEN]({{< relref "/commands/strlen" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SUBSTR]({{< relref "/commands/substr" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | Deprecated as of Redis v2.0.0. | +| [STRLEN](/content/commands/strlen.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SUBSTR](/content/commands/substr.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | Deprecated as of Redis v2.0.0. | diff --git a/content/operate/rs/7.4/references/compatibility/commands/generic.md b/content/operate/rs/7.4/references/compatibility/commands/generic.md index 6f6a569e5d..76705d7228 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/generic.md +++ b/content/operate/rs/7.4/references/compatibility/commands/generic.md @@ -12,40 +12,40 @@ weight: 10 url: '/operate/rs/7.4/references/compatibility/commands/generic/' --- -The following table shows which Redis Open Source [key (generic) commands]({{< relref "/commands" >}}?group=generic) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. +The following table shows which Redis Open Source [key (generic) commands](/commands?group=generic) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [COPY]({{< relref "/commands/copy" >}}) | ✅ Standard
    ✅ Active-Active\* | ✅ Standard
    ✅ Active-Active\* | For Active-Active or clustered databases, the source and destination keys must be in the same hash slot.

    \*Not supported for stream consumer group info. | -| [DEL]({{< relref "/commands/del" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [DUMP]({{< relref "/commands/dump" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [EXISTS]({{< relref "/commands/exists" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [EXPIRE]({{< relref "/commands/expire" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [EXPIREAT]({{< relref "/commands/expireat" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [EXPIRETIME]({{< relref "/commands/expiretime" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [KEYS]({{< relref "/commands/keys" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [MIGRATE]({{< relref "/commands/migrate" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [MOVE]({{< relref "/commands/move" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | Redis Enterprise does not support shared databases due to potential negative performance impacts and blocks any related commands. | -| [OBJECT ENCODING]({{< relref "/commands/object-encoding" >}}) | ✅ Standard
    ❌ Active-Active | ✅ Standard
    ❌ Active-Active | For Active-Active databases, use `CRDT.DEBUG ENCODING` instead. | -| [OBJECT FREQ]({{< relref "/commands/object-freq" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [OBJECT IDLETIME]({{< relref "/commands/object-idletime" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [OBJECT REFCOUNT]({{< relref "/commands/object-refcount" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PERSIST]({{< relref "/commands/persist" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PEXPIRE]({{< relref "/commands/pexpire" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PEXPIREAT]({{< relref "/commands/pexpireat" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PEXPIRETIME]({{< relref "/commands/pexpiretime" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PTTL]({{< relref "/commands/pttl" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [RANDOMKEY]({{< relref "/commands/randomkey" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [RENAME]({{< relref "/commands/rename" >}}) | ✅ Standard
    ✅ Active-Active\* | ✅ Standard
    ✅ Active-Active\* | For Active-Active or clustered databases, the original key and new key must be in the same hash slot.

    \*Not supported for stream consumer group info. | -| [RENAMENX]({{< relref "/commands/renamenx" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | For Active-Active or clustered databases, the original key and new key must be in the same hash slot. | -| [RESTORE]({{< relref "/commands/restore" >}}) | ✅ Standard
    ❌ Active-Active\* | ✅ Standard
    ❌ Active-Active\* | \*Only supported for module keys. | -| [SCAN]({{< relref "/commands/scan" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SORT]({{< relref "/commands/sort" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SORT_RO]({{< relref "/commands/sort_ro" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [TOUCH]({{< relref "/commands/touch" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [TTL]({{< relref "/commands/ttl" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [TYPE]({{< relref "/commands/type" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [UNLINK]({{< relref "/commands/unlink" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [WAIT]({{< relref "/commands/wait" >}}) | ✅ Standard
    ❌ Active-Active\* | ❌ Standard**
    ❌ Active-Active | \*For Active-Active databases, `WAIT` commands are supported for primary and replica shard replication. You can contact support to enable `WAIT` for local replicas only. `WAIT` is not supported for cross-instance replication.

    \*\*`WAIT` commands are supported on Redis Cloud Flexible subscriptions. | -| [WAITAOF]({{< relref "/commands/waitaof" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [COPY](/content/commands/copy.md) | ✅ Standard
    ✅ Active-Active\* | ✅ Standard
    ✅ Active-Active\* | For Active-Active or clustered databases, the source and destination keys must be in the same hash slot.

    \*Not supported for stream consumer group info. | +| [DEL](/content/commands/del.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [DUMP](/content/commands/dump.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [EXISTS](/content/commands/exists.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [EXPIRE](/content/commands/expire.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [EXPIREAT](/content/commands/expireat.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [EXPIRETIME](/content/commands/expiretime.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [KEYS](/content/commands/keys.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [MIGRATE](/content/commands/migrate.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [MOVE](/content/commands/move.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | Redis Enterprise does not support shared databases due to potential negative performance impacts and blocks any related commands. | +| [OBJECT ENCODING](/content/commands/object-encoding.md) | ✅ Standard
    ❌ Active-Active | ✅ Standard
    ❌ Active-Active | For Active-Active databases, use `CRDT.DEBUG ENCODING` instead. | +| [OBJECT FREQ](/content/commands/object-freq.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [OBJECT IDLETIME](/content/commands/object-idletime.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [OBJECT REFCOUNT](/content/commands/object-refcount.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PERSIST](/content/commands/persist.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PEXPIRE](/content/commands/pexpire.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PEXPIREAT](/content/commands/pexpireat.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PEXPIRETIME](/content/commands/pexpiretime.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PTTL](/content/commands/pttl.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [RANDOMKEY](/content/commands/randomkey.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [RENAME](/content/commands/rename.md) | ✅ Standard
    ✅ Active-Active\* | ✅ Standard
    ✅ Active-Active\* | For Active-Active or clustered databases, the original key and new key must be in the same hash slot.

    \*Not supported for stream consumer group info. | +| [RENAMENX](/content/commands/renamenx.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | For Active-Active or clustered databases, the original key and new key must be in the same hash slot. | +| [RESTORE](/content/commands/restore.md) | ✅ Standard
    ❌ Active-Active\* | ✅ Standard
    ❌ Active-Active\* | \*Only supported for module keys. | +| [SCAN](/content/commands/scan.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SORT](/content/commands/sort.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SORT_RO](/content/commands/sort_ro.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [TOUCH](/content/commands/touch.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [TTL](/content/commands/ttl.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [TYPE](/content/commands/type.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [UNLINK](/content/commands/unlink.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [WAIT](/content/commands/wait.md) | ✅ Standard
    ❌ Active-Active\* | ❌ Standard**
    ❌ Active-Active | \*For Active-Active databases, `WAIT` commands are supported for primary and replica shard replication. You can contact support to enable `WAIT` for local replicas only. `WAIT` is not supported for cross-instance replication.

    \*\*`WAIT` commands are supported on Redis Cloud Flexible subscriptions. | +| [WAITAOF](/content/commands/waitaof.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | diff --git a/content/operate/rs/7.4/references/compatibility/commands/pub-sub.md b/content/operate/rs/7.4/references/compatibility/commands/pub-sub.md index 620d4455fb..ff8c76c941 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/pub-sub.md +++ b/content/operate/rs/7.4/references/compatibility/commands/pub-sub.md @@ -12,20 +12,20 @@ weight: 10 url: '/operate/rs/7.4/references/compatibility/commands/pub-sub/' --- -The following table shows which Redis Open Source [pub/sub commands]({{< relref "/commands" >}}?group=pubsub) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. +The following table shows which Redis Open Source [pub/sub commands](/commands?group=pubsub) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [PSUBSCRIBE]({{< relref "/commands/psubscribe" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PUBLISH]({{< relref "/commands/publish" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PUBSUB CHANNELS]({{< relref "/commands/pubsub-channels" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PUBSUB NUMPAT]({{< relref "/commands/pubsub-numpat" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PUBSUB NUMSUB]({{< relref "/commands/pubsub-numsub" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PUBSUB SHARDCHANNELS]({{< relref "/commands/pubsub-shardchannels" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PUBSUB SHARDNUMSUB]({{< relref "/commands/pubsub-shardnumsub" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [PUNSUBSCRIBE]({{< relref "/commands/punsubscribe" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SPUBLISH]({{< relref "/commands/spublish" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SSUBSCRIBE]({{< relref "/commands/ssubscribe" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SUBSCRIBE]({{< relref "/commands/subscribe" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SUNSUBSCRIBE]({{< relref "/commands/sunsubscribe" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [UNSUBSCRIBE]({{< relref "/commands/unsubscribe" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PSUBSCRIBE](/content/commands/psubscribe.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PUBLISH](/content/commands/publish.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PUBSUB CHANNELS](/content/commands/pubsub-channels.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PUBSUB NUMPAT](/content/commands/pubsub-numpat.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PUBSUB NUMSUB](/content/commands/pubsub-numsub.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PUBSUB SHARDCHANNELS](/content/commands/pubsub-shardchannels.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PUBSUB SHARDNUMSUB](/content/commands/pubsub-shardnumsub.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [PUNSUBSCRIBE](/content/commands/punsubscribe.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SPUBLISH](/content/commands/spublish.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SSUBSCRIBE](/content/commands/ssubscribe.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SUBSCRIBE](/content/commands/subscribe.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SUNSUBSCRIBE](/content/commands/sunsubscribe.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [UNSUBSCRIBE](/content/commands/unsubscribe.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | diff --git a/content/operate/rs/7.4/references/compatibility/commands/scripting.md b/content/operate/rs/7.4/references/compatibility/commands/scripting.md index e4d7377e26..47b2aa3029 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/scripting.md +++ b/content/operate/rs/7.4/references/compatibility/commands/scripting.md @@ -12,34 +12,34 @@ weight: 10 url: '/operate/rs/7.4/references/compatibility/commands/scripting/' --- -The following table shows which Redis Open Source [scripting and function commands]({{< relref "/commands" >}}?group=scripting) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. +The following table shows which Redis Open Source [scripting and function commands](/commands?group=scripting) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. ## Function commands | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [FCALL]({{< relref "/commands/fcall" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [FCALL_RO]({{< relref "/commands/fcall_ro" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [FUNCTION DELETE]({{< relref "/commands/function-delete" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [FUNCTION DUMP]({{< relref "/commands/function-dump" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [FUNCTION FLUSH]({{< relref "/commands/function-flush" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [FUNCTION HELP]({{< relref "/commands/function-help" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [FUNCTION KILL]({{< relref "/commands/function-kill" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [FUNCTION LIST]({{< relref "/commands/function-list" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [FUNCTION LOAD]({{< relref "/commands/function-load" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [FUNCTION RESTORE]({{< relref "/commands/function-restore" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [FUNCTION STATS]({{< relref "/commands/function-stats" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [FCALL](/content/commands/fcall.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [FCALL_RO](/content/commands/fcall_ro.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [FUNCTION DELETE](/content/commands/function-delete.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [FUNCTION DUMP](/content/commands/function-dump.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [FUNCTION FLUSH](/content/commands/function-flush.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [FUNCTION HELP](/content/commands/function-help.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [FUNCTION KILL](/content/commands/function-kill.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [FUNCTION LIST](/content/commands/function-list.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [FUNCTION LOAD](/content/commands/function-load.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [FUNCTION RESTORE](/content/commands/function-restore.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [FUNCTION STATS](/content/commands/function-stats.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | ## Scripting commands | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [EVAL]({{< relref "/commands/eval" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [EVAL_RO]({{< relref "/commands/eval_ro" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [EVALSHA]({{< relref "/commands/evalsha" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [EVALSHA_RO]({{< relref "/commands/evalsha_ro" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SCRIPT DEBUG]({{< relref "/commands/script-debug" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [SCRIPT EXISTS]({{< relref "/commands/script-exists" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SCRIPT FLUSH]({{< relref "/commands/script-flush" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SCRIPT KILL]({{< relref "/commands/script-kill" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SCRIPT LOAD]({{< relref "/commands/script-load" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [EVAL](/content/commands/eval.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [EVAL_RO](/content/commands/eval_ro.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [EVALSHA](/content/commands/evalsha.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [EVALSHA_RO](/content/commands/evalsha_ro.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SCRIPT DEBUG](/content/commands/script-debug.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [SCRIPT EXISTS](/content/commands/script-exists.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SCRIPT FLUSH](/content/commands/script-flush.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SCRIPT KILL](/content/commands/script-kill.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SCRIPT LOAD](/content/commands/script-load.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | diff --git a/content/operate/rs/7.4/references/compatibility/commands/server.md b/content/operate/rs/7.4/references/compatibility/commands/server.md index 9a5749b48e..f8919a5622 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/server.md +++ b/content/operate/rs/7.4/references/compatibility/commands/server.md @@ -13,126 +13,126 @@ weight: 10 url: '/operate/rs/7.4/references/compatibility/commands/server/' --- -The following tables show which Redis Open Source [server management commands]({{< relref "/commands" >}}?group=server) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. +The following tables show which Redis Open Source [server management commands](/commands?group=server) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. ## Access control commands -Several access control list (ACL) commands are not available in Redis Enterprise. Instead, you can manage access controls from the [Redis Enterprise Software Cluster Manager UI]({{< relref "/operate/rs/7.4/security/access-control" >}}) and the [Redis Cloud console]({{< relref "/operate/rc/security/access-control/data-access-control/role-based-access-control.md" >}}). +Several access control list (ACL) commands are not available in Redis Enterprise. Instead, you can manage access controls from the [Redis Enterprise Software Cluster Manager UI](/content/operate/rs/7.4/security/access-control/_index.md) and the [Redis Cloud console](/content/operate/rc/security/access-control/data-access-control/role-based-access-control.md). | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [ACL CAT]({{< relref "/commands/acl-cat" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts]({{}}). | -| [ACL DELUSER]({{< relref "/commands/acl-deluser" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [ACL DRYRUN]({{< relref "/commands/acl-dryrun" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Might reply with "unknown user" for LDAP users even if `AUTH` succeeds. | -| [ACL GENPASS]({{< relref "/commands/acl-genpass" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [ACL GETUSER]({{< relref "/commands/acl-getuser" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts]({{}}). | -| [ACL HELP]({{< relref "/commands/acl-help" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts]({{}}). | -| [ACL LIST]({{< relref "/commands/acl-list" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts]({{}}). | -| [ACL LOAD]({{< relref "/commands/acl-load" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [ACL LOG]({{< relref "/commands/acl-log" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [ACL SAVE]({{< relref "/commands/acl-save" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [ACL SETUSER]({{< relref "/commands/acl-setuser" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [ACL USERS]({{< relref "/commands/acl-users" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts]({{}}). | -| [ACL WHOAMI]({{< relref "/commands/acl-whoami" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts]({{}}). | +| [ACL CAT](/content/commands/acl-cat.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | +| [ACL DELUSER](/content/commands/acl-deluser.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [ACL DRYRUN](/content/commands/acl-dryrun.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Might reply with "unknown user" for LDAP users even if `AUTH` succeeds. | +| [ACL GENPASS](/content/commands/acl-genpass.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [ACL GETUSER](/content/commands/acl-getuser.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | +| [ACL HELP](/content/commands/acl-help.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | +| [ACL LIST](/content/commands/acl-list.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | +| [ACL LOAD](/content/commands/acl-load.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [ACL LOG](/content/commands/acl-log.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [ACL SAVE](/content/commands/acl-save.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [ACL SETUSER](/content/commands/acl-setuser.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [ACL USERS](/content/commands/acl-users.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | +| [ACL WHOAMI](/content/commands/acl-whoami.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | ## Configuration commands | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [CONFIG GET]({{< relref "/commands/config-get" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | [Only supports a subset of configuration settings.]({{< relref "/operate/rs/7.4/references/compatibility/config-settings" >}}) | -| [CONFIG RESETSTAT]({{< relref "/commands/config-resetstat" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [CONFIG REWRITE]({{< relref "/commands/config-rewrite" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [CONFIG SET]({{< relref "/commands/config-set" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | [Only supports a subset of configuration settings.]({{< relref "/operate/rs/7.4/references/compatibility/config-settings" >}}) | +| [CONFIG GET](/content/commands/config-get.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | [Only supports a subset of configuration settings.](/content/operate/rs/7.4/references/compatibility/config-settings.md) | +| [CONFIG RESETSTAT](/content/commands/config-resetstat.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [CONFIG REWRITE](/content/commands/config-rewrite.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [CONFIG SET](/content/commands/config-set.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | [Only supports a subset of configuration settings.](/content/operate/rs/7.4/references/compatibility/config-settings.md) | ## General server commands | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [COMMAND]({{< relref "/commands/command" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [COMMAND COUNT]({{< relref "/commands/command-count" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [COMMAND DOCS]({{< relref "/commands/command-docs" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [COMMAND GETKEYS]({{< relref "/commands/command-getkeys" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [COMMAND GETKEYSANDFLAGS]({{< relref "/commands/command-getkeysandflags" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [COMMAND HELP]({{< relref "/commands/command-help" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [COMMAND INFO]({{< relref "/commands/command-info" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [COMMAND LIST]({{< relref "/commands/command-list" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [DEBUG]({{< relref "/commands/debug" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [FLUSHALL]({{< relref "/commands/flushall" >}}) | ✅ Standard
    ❌ Active-Active\* | ✅ Standard
    ❌ Active-Active | \*Can use the [Active-Active flush API request]({{< relref "/operate/rs/7.4/references/rest-api/requests/crdbs/flush" >}}). | -| [FLUSHDB]({{< relref "/commands/flushdb" >}}) | ✅ Standard
    ❌ Active-Active\* | ✅ Standard
    ❌ Active-Active | \*Can use the [Active-Active flush API request]({{< relref "/operate/rs/7.4/references/rest-api/requests/crdbs/flush" >}}). | -| [LOLWUT]({{< relref "/commands/lolwut" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SHUTDOWN]({{< relref "/commands/shutdown" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [SWAPDB]({{< relref "/commands/swapdb" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [TIME]({{< relref "/commands/time" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [COMMAND](/content/commands/command.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [COMMAND COUNT](/content/commands/command-count.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [COMMAND DOCS](/content/commands/command-docs.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [COMMAND GETKEYS](/content/commands/command-getkeys.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [COMMAND GETKEYSANDFLAGS](/content/commands/command-getkeysandflags.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [COMMAND HELP](/content/commands/command-help.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [COMMAND INFO](/content/commands/command-info.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [COMMAND LIST](/content/commands/command-list.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [DEBUG](/content/commands/debug.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [FLUSHALL](/content/commands/flushall.md) | ✅ Standard
    ❌ Active-Active\* | ✅ Standard
    ❌ Active-Active | \*Can use the [Active-Active flush API request](/content/operate/rs/7.4/references/rest-api/requests/crdbs/flush.md). | +| [FLUSHDB](/content/commands/flushdb.md) | ✅ Standard
    ❌ Active-Active\* | ✅ Standard
    ❌ Active-Active | \*Can use the [Active-Active flush API request](/content/operate/rs/7.4/references/rest-api/requests/crdbs/flush.md). | +| [LOLWUT](/content/commands/lolwut.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SHUTDOWN](/content/commands/shutdown.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [SWAPDB](/content/commands/swapdb.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [TIME](/content/commands/time.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | ## Module commands -For Redis Enterprise Software, you can [manage Redis modules]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/" >}}) from the Cluster Manager UI or with [REST API requests]({{< relref "/operate/rs/7.4/references/rest-api/requests/modules" >}}). +For Redis Enterprise Software, you can [manage Redis modules](/content/operate/oss_and_stack/stack-with-enterprise/install/_index.md) from the Cluster Manager UI or with [REST API requests](/content/operate/rs/7.4/references/rest-api/requests/modules/_index.md). -Redis Cloud manages modules for you and lets you [enable modules]({{< relref "/operate/rc/databases/create-database#modules" >}}) when you create a database. +Redis Cloud manages modules for you and lets you [enable modules](/content/operate/rc/databases/create-database/_index.md#modules) when you create a database. | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [MODULE HELP]({{< relref "/commands/module-help" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [MODULE LIST]({{< relref "/commands/module-list" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [MODULE LOAD]({{< relref "/commands/module-load" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [MODULE LOADEX]({{< relref "/commands/module-loadex" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [MODULE UNLOAD]({{< relref "/commands/module-unload" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [MODULE HELP](/content/commands/module-help.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [MODULE LIST](/content/commands/module-list.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [MODULE LOAD](/content/commands/module-load.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [MODULE LOADEX](/content/commands/module-loadex.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [MODULE UNLOAD](/content/commands/module-unload.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | ## Monitoring commands -Although Redis Enterprise does not support certain monitoring commands, you can use the Cluster Manager UI to view Redis Enterprise Software [metrics]({{< relref "/operate/rs/7.4/clusters/monitoring" >}}) and [logs]({{< relref "/operate/rs/7.4/clusters/logging" >}}) or the Redis Cloud console to view Redis Cloud [metrics]({{< relref "/operate/rc/databases/monitor-performance" >}}) and [logs]({{< relref "/operate/rc/logs-reports/system-logs" >}}). +Although Redis Enterprise does not support certain monitoring commands, you can use the Cluster Manager UI to view Redis Enterprise Software [metrics](/content/operate/rs/7.4/clusters/monitoring/_index.md) and [logs](/content/operate/rs/7.4/clusters/logging/_index.md) or the Redis Cloud console to view Redis Cloud [metrics](/content/operate/rc/databases/monitor-performance.md) and [logs](/content/operate/rc/logs-reports/system-logs.md). | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [DBSIZE]({{< relref "/commands/dbsize" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [INFO]({{< relref "/commands/info" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | In Redis Enterprise, `INFO` returns a different set of fields than Redis Open Source.
    Not supported for [scripts]({{}}). | -| [LATENCY DOCTOR]({{< relref "/commands/latency-doctor" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [LATENCY GRAPH]({{< relref "/commands/latency-graph" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [LATENCY HELP]({{< relref "/commands/latency-help" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [LATENCY HISTOGRAM]({{< relref "/commands/latency-histogram" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [LATENCY HISTORY]({{< relref "/commands/latency-history" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [LATENCY LATEST]({{< relref "/commands/latency-latest" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [LATENCY RESET]({{< relref "/commands/latency-reset" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [MEMORY DOCTOR]({{< relref "/commands/memory-doctor" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [MEMORY HELP]({{< relref "/commands/memory-help" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts]({{}}) in Redis versions earlier than 7. | -| [MEMORY MALLOC-STATS]({{< relref "/commands/memory-malloc-stats" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [MEMORY PURGE]({{< relref "/commands/memory-purge" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [MEMORY STATS]({{< relref "/commands/memory-stats" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [MEMORY USAGE]({{< relref "/commands/memory-usage" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts]({{}}) in Redis versions earlier than 7. | -| [MONITOR]({{< relref "/commands/monitor" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [SLOWLOG GET]({{< relref "/commands/slowlog-get" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts]({{}}). | -| [SLOWLOG LEN]({{< relref "/commands/slowlog-len" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts]({{}}). | -| [SLOWLOG RESET]({{< relref "/commands/slowlog-reset" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts]({{}}). | +| [DBSIZE](/content/commands/dbsize.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [INFO](/content/commands/info.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | In Redis Enterprise, `INFO` returns a different set of fields than Redis Open Source.
    Not supported for [scripts](/content/develop/programmability/_index.md). | +| [LATENCY DOCTOR](/content/commands/latency-doctor.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [LATENCY GRAPH](/content/commands/latency-graph.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [LATENCY HELP](/content/commands/latency-help.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [LATENCY HISTOGRAM](/content/commands/latency-histogram.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [LATENCY HISTORY](/content/commands/latency-history.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [LATENCY LATEST](/content/commands/latency-latest.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [LATENCY RESET](/content/commands/latency-reset.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [MEMORY DOCTOR](/content/commands/memory-doctor.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [MEMORY HELP](/content/commands/memory-help.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md) in Redis versions earlier than 7. | +| [MEMORY MALLOC-STATS](/content/commands/memory-malloc-stats.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [MEMORY PURGE](/content/commands/memory-purge.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [MEMORY STATS](/content/commands/memory-stats.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [MEMORY USAGE](/content/commands/memory-usage.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md) in Redis versions earlier than 7. | +| [MONITOR](/content/commands/monitor.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [SLOWLOG GET](/content/commands/slowlog-get.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | +| [SLOWLOG LEN](/content/commands/slowlog-len.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | +| [SLOWLOG RESET](/content/commands/slowlog-reset.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | ## Persistence commands -Data persistence and backup commands are not available in Redis Enterprise. Instead, you can [manage data persistence]({{< relref "/operate/rs/7.4/databases/configure/database-persistence" >}}) and [backups]({{< relref "/operate/rs/7.4/databases/import-export/schedule-backups" >}}) from the Redis Enterprise Software Cluster Manager UI and the [Redis Cloud console]({{< relref "/operate/rc/databases/view-edit-database#durability-section" >}}). +Data persistence and backup commands are not available in Redis Enterprise. Instead, you can [manage data persistence](/content/operate/rs/7.4/databases/configure/database-persistence.md) and [backups](/content/operate/rs/7.4/databases/import-export/schedule-backups.md) from the Redis Enterprise Software Cluster Manager UI and the [Redis Cloud console](/content/operate/rc/databases/view-edit-database.md#durability-section). | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [BGREWRITEAOF]({{< relref "/commands/bgrewriteaof" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [BGSAVE]({{< relref "/commands/bgsave" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [LASTSAVE]({{< relref "/commands/lastsave" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [SAVE]({{< relref "/commands/save" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [BGREWRITEAOF](/content/commands/bgrewriteaof.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [BGSAVE](/content/commands/bgsave.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [LASTSAVE](/content/commands/lastsave.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [SAVE](/content/commands/save.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | ## Replication commands -Redis Enterprise automatically manages [replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication" >}}). +Redis Enterprise automatically manages [replication](/content/operate/rs/7.4/databases/durability-ha/replication.md). | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [FAILOVER]({{< relref "/commands/failover" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [MIGRATE]({{< relref "/commands/migrate" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [PSYNC]({{< relref "/commands/psync" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [REPLCONF]({{< relref "/commands/replconf" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [REPLICAOF]({{< relref "/commands/replicaof" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [RESTORE-ASKING]({{< relref "/commands/restore-asking" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [ROLE]({{< relref "/commands/role" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | -| [SLAVEOF]({{< relref "/commands/slaveof" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | Deprecated as of Redis v5.0.0. | -| [SYNC]({{< relref "/commands/sync" >}}) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [FAILOVER](/content/commands/failover.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [MIGRATE](/content/commands/migrate.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [PSYNC](/content/commands/psync.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [REPLCONF](/content/commands/replconf.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [REPLICAOF](/content/commands/replicaof.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [RESTORE-ASKING](/content/commands/restore-asking.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [ROLE](/content/commands/role.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | +| [SLAVEOF](/content/commands/slaveof.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | Deprecated as of Redis v5.0.0. | +| [SYNC](/content/commands/sync.md) | ❌ Standard
    ❌ Active-Active | ❌ Standard
    ❌ Active-Active | | diff --git a/content/operate/rs/7.4/references/compatibility/commands/transactions.md b/content/operate/rs/7.4/references/compatibility/commands/transactions.md index 8590b18a7b..a86becb725 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/transactions.md +++ b/content/operate/rs/7.4/references/compatibility/commands/transactions.md @@ -12,12 +12,12 @@ weight: 10 url: '/operate/rs/7.4/references/compatibility/commands/transactions/' --- -The following table shows which Redis Open Source [transaction commands]({{< relref "/commands" >}}?group=transactions) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. +The following table shows which Redis Open Source [transaction commands](/commands?group=transactions) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [DISCARD]({{< relref "/commands/discard" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [EXEC]({{< relref "/commands/exec" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [MULTI]({{< relref "/commands/multi" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [UNWATCH]({{< relref "/commands/unwatch" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | -| [WATCH]({{< relref "/commands/watch" >}}) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [DISCARD](/content/commands/discard.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [EXEC](/content/commands/exec.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [MULTI](/content/commands/multi.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [UNWATCH](/content/commands/unwatch.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | +| [WATCH](/content/commands/watch.md) | ✅ Standard
    ✅ Active-Active | ✅ Standard
    ✅ Active-Active | | diff --git a/content/operate/rs/7.4/references/compatibility/config-settings.md b/content/operate/rs/7.4/references/compatibility/config-settings.md index 4cc081897a..6efbe64270 100644 --- a/content/operate/rs/7.4/references/compatibility/config-settings.md +++ b/content/operate/rs/7.4/references/compatibility/config-settings.md @@ -12,7 +12,7 @@ weight: 50 url: '/operate/rs/7.4/references/compatibility/config-settings/' --- -Redis Enterprise Software and [Redis Cloud]({{< relref "/operate/rc" >}}) only support a subset of [Redis Open Source configuration settings]({{}}). Using [`CONFIG GET`]({{< relref "/commands/config-get" >}}) or [`CONFIG SET`]({{< relref "/commands/config-set" >}}) with unsupported configuration settings returns an error. +Redis Enterprise Software and [Redis Cloud](/content/operate/rc/_index.md) only support a subset of [Redis Open Source configuration settings](/content/operate/oss_and_stack/management/config.md). Using [`CONFIG GET`](/content/commands/config-get.md) or [`CONFIG SET`](/content/commands/config-set.md) with unsupported configuration settings returns an error. | Setting | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| diff --git a/content/operate/rs/7.4/references/compatibility/resp.md b/content/operate/rs/7.4/references/compatibility/resp.md index a7fbd96488..d756c74d02 100644 --- a/content/operate/rs/7.4/references/compatibility/resp.md +++ b/content/operate/rs/7.4/references/compatibility/resp.md @@ -12,7 +12,7 @@ weight: 80 url: '/operate/rs/7.4/references/compatibility/resp/' --- -RESP (Redis Serialization Protocol) is the protocol that clients use to communicate with Redis databases. See the [RESP protocol specification]({{< relref "/develop/reference/protocol-spec" >}}) for more information. +RESP (Redis Serialization Protocol) is the protocol that clients use to communicate with Redis databases. See the [RESP protocol specification](/content/develop/reference/protocol-spec.md) for more information. ## Supported RESP versions @@ -20,9 +20,8 @@ RESP (Redis Serialization Protocol) is the protocol that clients use to communic - RESP3 is supported by Redis Enterprise 7.2 and later. -{{}} -Redis Enterprise versions that support RESP3 continue to support RESP2. -{{}} +> [!NOTE] +> Redis Enterprise versions that support RESP3 continue to support RESP2. ## Enable RESP3 for a database {#enable-resp3} @@ -39,7 +38,7 @@ To use RESP3 with a Redis Enterprise Software database: 1. Enable RESP3 support for your database (`enabled` by default): - - [`rladmin tune db`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-db" >}}): + - [`rladmin tune db`](/content/operate/rs/7.4/references/cli-utilities/rladmin/tune.md#tune-db): ```sh rladmin tune db db: resp3 enabled @@ -47,7 +46,7 @@ To use RESP3 with a Redis Enterprise Software database: You can use the database name in place of `db:` in the preceding command. - - [Update database configuration]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs#put-bdbs" >}}) REST API request: + - [Update database configuration](/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md#put-bdbs) REST API request: ```sh PUT /v1/bdbs/ @@ -58,7 +57,7 @@ To use RESP3 with a Redis Enterprise Software database: To deactivate RESP3 support for a database: -- [`rladmin tune db`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-db" >}}): +- [`rladmin tune db`](/content/operate/rs/7.4/references/cli-utilities/rladmin/tune.md#tune-db): ```sh rladmin tune db db: resp3 disabled @@ -66,7 +65,7 @@ To use RESP3 with a Redis Enterprise Software database: You can use the database name in place of `db:` in the preceding command. -- [Update database configuration]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs#put-bdbs" >}}) REST API request: +- [Update database configuration](/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md#put-bdbs) REST API request: ```sh PUT /v1/bdbs/ @@ -75,9 +74,8 @@ To use RESP3 with a Redis Enterprise Software database: When RESP3 is deactivated, connected clients that use RESP3 are disconnected from the database. -{{}} -You cannot use sharded pub/sub if you deactivate RESP3 support. -{{}} +> [!NOTE] +> You cannot use sharded pub/sub if you deactivate RESP3 support. ## Change default RESP3 option @@ -95,13 +93,13 @@ To change `resp3_default` to `disabled`, use one of the following methods: 1. Click **Save**. -- [`rladmin tune cluster`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}) +- [`rladmin tune cluster`](/content/operate/rs/7.4/references/cli-utilities/rladmin/tune.md#tune-cluster) ```sh rladmin tune cluster resp3_default disabled ``` -- [Update cluster policy]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: +- [Update cluster policy](/content/operate/rs/7.4/references/rest-api/requests/cluster/policy.md#put-cluster-policy) REST API request: ```sh PUT /v1/cluster/policy diff --git a/content/operate/rs/7.4/references/memtier-benchmark.md b/content/operate/rs/7.4/references/memtier-benchmark.md index a7fbfe5ea4..0d00ac70dc 100644 --- a/content/operate/rs/7.4/references/memtier-benchmark.md +++ b/content/operate/rs/7.4/references/memtier-benchmark.md @@ -57,8 +57,8 @@ You can run all of these tests on Amazon AWS with these hosts: To learn how to install Redis Enterprise Software and set up a cluster, see: -- [Redis Enterprise Software quickstart]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) for a test installation -- [Install and upgrade]({{< relref "/operate/rs/7.4/installing-upgrading" >}}) for a production installation +- [Redis Enterprise Software quickstart](/content/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md) for a test installation +- [Install and upgrade](/content/operate/rs/7.4/installing-upgrading/_index.md) for a production installation These tests use a quorum node to reduce AWS EC2 instance use while maintaining the three nodes required to support a quorum node in case of node failure. Quorum nodes can be on less powerful instances because they do not have shards or support traffic. diff --git a/content/operate/rs/7.4/references/metrics/_index.md b/content/operate/rs/7.4/references/metrics/_index.md index 5c792112b2..06d6533a0d 100644 --- a/content/operate/rs/7.4/references/metrics/_index.md +++ b/content/operate/rs/7.4/references/metrics/_index.md @@ -13,37 +13,37 @@ weight: $weight url: '/operate/rs/7.4/references/metrics/' --- -In the Redis Enterprise Cluster Manager UI, you can see real-time performance metrics for clusters, nodes, databases, and shards, and configure alerts that send notifications based on alert parameters. Select the **Metrics** tab to view the metrics for each component. For more information, see [Monitoring with metrics and alerts]({{< relref "/operate/rs/7.4/clusters/monitoring" >}}). +In the Redis Enterprise Cluster Manager UI, you can see real-time performance metrics for clusters, nodes, databases, and shards, and configure alerts that send notifications based on alert parameters. Select the **Metrics** tab to view the metrics for each component. For more information, see [Monitoring with metrics and alerts](/content/operate/rs/7.4/clusters/monitoring/_index.md). See the following topics for metrics definitions: -- [Database operations]({{< relref "/operate/rs/7.4/references/metrics/database-operations" >}}) for database metrics -- [Resource usage]({{< relref "/operate/rs/7.4/references/metrics/resource-usage" >}}) for resource and database usage metrics -- [Auto Tiering]({{< relref "/operate/rs/7.4/references/metrics/auto-tiering" >}}) for additional metrics for [Auto Tiering ]({{< relref "/operate/rs/7.4/databases/auto-tiering" >}}) databases +- [Database operations](/content/operate/rs/7.4/references/metrics/database-operations.md) for database metrics +- [Resource usage](/content/operate/rs/7.4/references/metrics/resource-usage.md) for resource and database usage metrics +- [Auto Tiering](/content/operate/rs/7.4/references/metrics/auto-tiering.md) for additional metrics for [Auto Tiering ](/content/operate/rs/7.4/databases/auto-tiering/_index.md) databases ## Prometheus metrics To collect and display metrics data from your databases and other cluster components, -you can connect your [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/) server to your Redis Enterprise Software cluster. See [Metrics in Prometheus]({{< relref "/integrate/prometheus-with-redis-enterprise/prometheus-metrics-definitions" >}}) for a list of available metrics. +you can connect your [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/) server to your Redis Enterprise Software cluster. See [Metrics in Prometheus](/content/integrate/prometheus-with-redis-enterprise/prometheus-metrics-definitions.md) for a list of available metrics. We recommend you use Prometheus and Grafana to view metrics history and trends. -See [Prometheus integration]({{< relref "/integrate/prometheus-with-redis-enterprise/" >}}) to learn how to connect Prometheus and Grafana to your Redis Enterprise database. +See [Prometheus integration](/content/integrate/prometheus-with-redis-enterprise/_index.md) to learn how to connect Prometheus and Grafana to your Redis Enterprise database. ## Limitations ### Shard limit -Metrics information is not shown for clusters with more than 128 shards. For large clusters, we recommend you use [Prometheus and Grafana]({{< relref "/integrate/prometheus-with-redis-enterprise/" >}}) to view metrics. +Metrics information is not shown for clusters with more than 128 shards. For large clusters, we recommend you use [Prometheus and Grafana](/content/integrate/prometheus-with-redis-enterprise/_index.md) to view metrics. ### Metrics not shown during shard migration -The following metrics are not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). If you view these metrics while resharding, the graph will be blank. +The following metrics are not measured during [shard migration](/content/operate/rs/7.4/databases/configure/replica-ha.md). If you view these metrics while resharding, the graph will be blank. -- [Evicted objects/sec]({{< relref "/operate/rs/7.4/references/metrics/database-operations#evicted-objectssec" >}}) -- [Expired objects/sec]({{< relref "/operate/rs/7.4/references/metrics/database-operations#expired-objectssec" >}}) -- [Read misses/sec]({{< relref "/operate/rs/7.4/references/metrics/database-operations#read-missessec" >}}) -- [Write misses/sec]({{< relref "/operate/rs/7.4/references/metrics/database-operations#write-missessec" >}}) -- [Total keys]({{< relref "/operate/rs/7.4/references/metrics/database-operations#total-keys" >}}) -- [Incoming traffic]({{< relref "/operate/rs/7.4/references/metrics/resource-usage#incoming-traffic" >}}) -- [Outgoing traffic]({{< relref "/operate/rs/7.4/references/metrics/resource-usage#outgoing-traffic" >}}) -- [Used memory]({{< relref "/operate/rs/7.4/references/metrics/resource-usage#used-memory" >}}) +- [Evicted objects/sec](/content/operate/rs/7.4/references/metrics/database-operations.md#evicted-objectssec) +- [Expired objects/sec](/content/operate/rs/7.4/references/metrics/database-operations.md#expired-objectssec) +- [Read misses/sec](/content/operate/rs/7.4/references/metrics/database-operations.md#read-missessec) +- [Write misses/sec](/content/operate/rs/7.4/references/metrics/database-operations.md#write-missessec) +- [Total keys](/content/operate/rs/7.4/references/metrics/database-operations.md#total-keys) +- [Incoming traffic](/content/operate/rs/7.4/references/metrics/resource-usage.md#incoming-traffic) +- [Outgoing traffic](/content/operate/rs/7.4/references/metrics/resource-usage.md#outgoing-traffic) +- [Used memory](/content/operate/rs/7.4/references/metrics/resource-usage.md#used-memory) diff --git a/content/operate/rs/7.4/references/metrics/auto-tiering.md b/content/operate/rs/7.4/references/metrics/auto-tiering.md index e05170480a..cb3d687448 100644 --- a/content/operate/rs/7.4/references/metrics/auto-tiering.md +++ b/content/operate/rs/7.4/references/metrics/auto-tiering.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/7.4/references/metrics/auto-tiering/' --- -These metrics are additional metrics for [Auto Tiering ]({{< relref "/operate/rs/7.4/databases/auto-tiering" >}}) databases. +These metrics are additional metrics for [Auto Tiering ](/content/operate/rs/7.4/databases/auto-tiering/_index.md) databases. #### % Values in RAM @@ -25,13 +25,13 @@ If the percent of values in RAM is low for a subset of the database's shards, it #### Values in flash -Number of keys with values stored in flash, not including [replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication" >}}). +Number of keys with values stored in flash, not including [replication](/content/operate/rs/7.4/databases/durability-ha/replication.md). **Components measured**: Database and Shard #### Values in RAM -Number of keys with values stored in RAM, not including [replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication" >}}). +Number of keys with values stored in RAM, not including [replication](/content/operate/rs/7.4/databases/durability-ha/replication.md). **Components measured**: Database and Shard @@ -85,7 +85,7 @@ Ratio between the used logical flash memory and the physical flash memory that i #### Used RAM -Total size of data stored in RAM, including keys, values, overheads, and [replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication" >}}) (if enabled). +Total size of data stored in RAM, including keys, values, overheads, and [replication](/content/operate/rs/7.4/databases/durability-ha/replication.md) (if enabled). **Components measured**: Database and Shard @@ -122,7 +122,7 @@ These RoF statistics can be calculated from other metrics. - RoF average key size with overhead ([ram_dataset_overhead](#ram-dataset-overhead) * [used_ram](#used-ram)) - / ([total_keys]({{< relref "/operate/rs/7.4/references/metrics/database-operations#total-keys" >}}) * 2) + / ([total_keys](/content/operate/rs/7.4/references/metrics/database-operations.md#total-keys) * 2) - RoF average value size in RAM diff --git a/content/operate/rs/7.4/references/metrics/database-operations.md b/content/operate/rs/7.4/references/metrics/database-operations.md index e16c666073..4298082007 100644 --- a/content/operate/rs/7.4/references/metrics/database-operations.md +++ b/content/operate/rs/7.4/references/metrics/database-operations.md @@ -16,9 +16,9 @@ url: '/operate/rs/7.4/references/metrics/database-operations/' Number of objects evicted from the database per second. -Objects are evicted from the database according to the [eviction policy]({{< relref "/operate/rs/7.4/databases/memory-performance/eviction-policy" >}}). +Objects are evicted from the database according to the [eviction policy](/content/operate/rs/7.4/databases/memory-performance/eviction-policy.md). -Object information is not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). +Object information is not measured during [shard migration](/content/operate/rs/7.4/databases/configure/replica-ha.md). **Components measured**: Database and Shard @@ -26,7 +26,7 @@ Object information is not measured during [shard migration]({{< relref "/operate Number of expired objects per second. -Object information is not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). +Object information is not measured during [shard migration](/content/operate/rs/7.4/databases/configure/replica-ha.md). **Components measured**: Database and Shard @@ -40,7 +40,7 @@ Ratio of the number of operations on existing keys out of the total number of op The number of [read operations](#readssec) per second on keys that do not exist. -Read misses are not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). +Read misses are not measured during [shard migration](/content/operate/rs/7.4/databases/configure/replica-ha.md). **Components measured**: Database @@ -48,7 +48,7 @@ Read misses are not measured during [shard migration]({{< relref "/operate/rs/7. Number of [write operations](#writessec) per second on keys that do not exist. -Write misses are not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). +Write misses are not measured during [shard migration](/content/operate/rs/7.4/databases/configure/replica-ha.md). **Components measured**: Database and Shard @@ -88,7 +88,7 @@ Number of total operations per second, which includes [read operations](#readsse Number of total read operations per second. -To find out which commands are read operations, run the following command with [`redis-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/redis-cli" >}}): +To find out which commands are read operations, run the following command with [`redis-cli`](/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md): ```sh ACL CAT read @@ -100,7 +100,7 @@ ACL CAT read Number of total write operations per second. -To find out which commands are write operations, run the following command with [`redis-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/redis-cli" >}}): +To find out which commands are write operations, run the following command with [`redis-cli`](/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md): ```sh ACL CAT write @@ -110,17 +110,17 @@ ACL CAT write #### Pending writes min -Minimum number of write operations queued per [Active-Active]({{< relref "/operate/rs/7.4/databases/active-active" >}}) replica database. +Minimum number of write operations queued per [Active-Active](/content/operate/rs/7.4/databases/active-active/_index.md) replica database. #### Pending writes max -Maximum number of write operations queued per [Active-Active]({{< relref "/operate/rs/7.4/databases/active-active" >}}) replica database. +Maximum number of write operations queued per [Active-Active](/content/operate/rs/7.4/databases/active-active/_index.md) replica database. ### Other commands/sec Number of operations per second that are not [read operations](#readssec) or [write operations](#writessec). -Examples of other operations include [PING]({{< relref "/commands/ping" >}}), [AUTH]({{< relref "/commands/auth" >}}), and [INFO]({{< relref "/commands/info" >}}). +Examples of other operations include [PING](/content/commands/ping.md), [AUTH](/content/commands/auth.md), and [INFO](/content/commands/info.md). **Components measured**: Database @@ -128,9 +128,9 @@ Examples of other operations include [PING]({{< relref "/commands/ping" >}}), [A Total number of keys in the dataset. -Does not include replicated keys, even if [replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication" >}}) is enabled. +Does not include replicated keys, even if [replication](/content/operate/rs/7.4/databases/durability-ha/replication.md) is enabled. -Total keys is not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). +Total keys is not measured during [shard migration](/content/operate/rs/7.4/databases/configure/replica-ha.md). **Components measured**: Database diff --git a/content/operate/rs/7.4/references/metrics/resource-usage.md b/content/operate/rs/7.4/references/metrics/resource-usage.md index 980e35b527..f121e903a2 100644 --- a/content/operate/rs/7.4/references/metrics/resource-usage.md +++ b/content/operate/rs/7.4/references/metrics/resource-usage.md @@ -50,7 +50,7 @@ Remaining unused disk space. ## Memory ### Used memory -Total memory used by the database, including RAM, [Flash]({{< relref "/operate/rs/7.4/databases/auto-tiering" >}}) (if enabled), and [replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication" >}}) (if enabled). +Total memory used by the database, including RAM, [Flash](/content/operate/rs/7.4/databases/auto-tiering/_index.md) (if enabled), and [replication](/content/operate/rs/7.4/databases/durability-ha/replication.md) (if enabled). Used memory does not include: @@ -62,7 +62,7 @@ Used memory does not include: - A database snapshot process - AOF rewrite process -Used memory is not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). +Used memory is not measured during [shard migration](/content/operate/rs/7.4/databases/configure/replica-ha.md). **Components measured**: Database and Shard @@ -89,23 +89,23 @@ Percent of memory used by Redis out of the [memory limit](#memory-limit). Total incoming traffic to the database in bytes/sec. -All incoming traffic is not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). +All incoming traffic is not measured during [shard migration](/content/operate/rs/7.4/databases/configure/replica-ha.md). **Components measured**: Cluster, Node and Database #### Incoming traffic compressed -Total incoming compressed traffic (in bytes/sec) per [Active-Active]({{< relref "/operate/rs/7.4/databases/active-active" >}}) replica database. +Total incoming compressed traffic (in bytes/sec) per [Active-Active](/content/operate/rs/7.4/databases/active-active/_index.md) replica database. #### Incoming traffic uncompressed -Total incoming uncompressed traffic (in bytes/sec) per [Active-Active]({{< relref "/operate/rs/7.4/databases/active-active" >}}) replica database. +Total incoming uncompressed traffic (in bytes/sec) per [Active-Active](/content/operate/rs/7.4/databases/active-active/_index.md) replica database. ### Outgoing traffic Total outgoing traffic from the database in bytes per second. -Outgoing traffic is not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). +Outgoing traffic is not measured during [shard migration](/content/operate/rs/7.4/databases/configure/replica-ha.md). **Components measured**: Cluster, Node and Database diff --git a/content/operate/rs/7.4/references/rest-api/_index.md b/content/operate/rs/7.4/references/rest-api/_index.md index 7eca191d25..09e55d2caa 100644 --- a/content/operate/rs/7.4/references/rest-api/_index.md +++ b/content/operate/rs/7.4/references/rest-api/_index.md @@ -16,10 +16,10 @@ Here, you'll find the details of the API and how to use it. For more info, see: -- Supported [request endpoints]({{< relref "/operate/rs/7.4/references/rest-api/requests" >}}), organized by path -- Supported [objects]({{< relref "/operate/rs/7.4/references/rest-api/objects" >}}), both request and response -- Built-in roles and associated [permissions]({{< relref "/operate/rs/7.4/references/rest-api/permissions" >}}) -- [Redis Enterprise Software REST API quick start]({{< relref "/operate/rs/7.4/references/rest-api/quick-start" >}}) with examples +- Supported [request endpoints](/content/operate/rs/7.4/references/rest-api/requests/_index.md), organized by path +- Supported [objects](/content/operate/rs/7.4/references/rest-api/objects/_index.md), both request and response +- Built-in roles and associated [permissions](/content/operate/rs/7.4/references/rest-api/permissions.md) +- [Redis Enterprise Software REST API quick start](/content/operate/rs/7.4/references/rest-api/quick-start.md) with examples ## Authentication @@ -34,23 +34,23 @@ curl -u "demo@redislabs.com:password" \ https://localhost:9443/v1/bdbs ``` -For more examples, see the [Redis Enterprise Software REST API quick start]({{< relref "/operate/rs/7.4/references/rest-api/quick-start" >}}). +For more examples, see the [Redis Enterprise Software REST API quick start](/content/operate/rs/7.4/references/rest-api/quick-start.md). ### Permissions -By default, the admin user is authorized for access to all endpoints. Use [role-based access controls]({{< relref "/operate/rs/7.4/security/access-control" >}}) and [role permissions]({{< relref "/operate/rs/7.4/references/rest-api/permissions" >}}) to manage access. +By default, the admin user is authorized for access to all endpoints. Use [role-based access controls](/content/operate/rs/7.4/security/access-control/_index.md) and [role permissions](/content/operate/rs/7.4/references/rest-api/permissions.md) to manage access. -If a user attempts to access an endpoint that is not allowed in their role, the request will fail with a [`403 Forbidden`](https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden) status code. For more details on which user roles can access certain endpoints, see [Permissions]({{< relref "/operate/rs/7.4/references/rest-api/permissions" >}}). +If a user attempts to access an endpoint that is not allowed in their role, the request will fail with a [`403 Forbidden`](https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden) status code. For more details on which user roles can access certain endpoints, see [Permissions](/content/operate/rs/7.4/references/rest-api/permissions.md). ### Certificates -The Redis Enterprise Software REST API uses [Self-signed certificates]({{< relref "/operate/rs/7.4/security/certificates" >}}) to ensure the product is secure. When you use the default self-signed certificates, the HTTPS requests will fail with `SSL certificate problem: self signed certificate` unless you turn off SSL certificate verification. +The Redis Enterprise Software REST API uses [Self-signed certificates](/content/operate/rs/7.4/security/certificates/_index.md) to ensure the product is secure. When you use the default self-signed certificates, the HTTPS requests will fail with `SSL certificate problem: self signed certificate` unless you turn off SSL certificate verification. ## Ports All calls must be made over SSL to port 9443. For the API to work, port 9443 must be exposed to incoming traffic or mapped to a different port. -If you are using a [Redis Enterprise Software Docker image]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart" >}}), run the following command to start the Docker image with port 9443 exposed: +If you are using a [Redis Enterprise Software Docker image](/content/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart.md), run the following command to start the Docker image with port 9443 exposed: ```sh docker run -p 9443:9443 redislabs/redis @@ -67,7 +67,7 @@ Specify the version in the request [URI](https://en.wikipedia.org/wiki/Uniform_R | POST `/v1/bdbs` | A version 1 request for the `/bdbs` endpoint. | | POST `/v2/bdbs` | A version 2 request for the `/bdbs` endpoint. | -When an endpoint supports multiple versions, each version is documented on the corresponding endpoint. For example, the [bdbs request]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/" >}}) page documents POST requests for [version 1]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/#post-bdbs-v1" >}}) and [version 2]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/#post-bdbs-v2" >}}). +When an endpoint supports multiple versions, each version is documented on the corresponding endpoint. For example, the [bdbs request](/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md) page documents POST requests for [version 1](/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md#post-bdbs-v1) and [version 2](/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md#post-bdbs-v2). ## Headers diff --git a/content/operate/rs/7.4/references/rest-api/objects/_index.md b/content/operate/rs/7.4/references/rest-api/objects/_index.md index b04f4f1689..4006249ac2 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/_index.md @@ -12,7 +12,7 @@ weight: 40 url: '/operate/rs/7.4/references/rest-api/objects/' --- -Certain [REST API requests]({{< relref "/operate/rs/7.4/references/rest-api/requests" >}}) require you to include specific objects in the request body. Many requests also return objects in the response body. +Certain [REST API requests](/content/operate/rs/7.4/references/rest-api/requests/_index.md) require you to include specific objects in the request body. Many requests also return objects in the response body. Both REST API requests and responses represent these objects as [JSON](https://www.json.org). diff --git a/content/operate/rs/7.4/references/rest-api/objects/alert.md b/content/operate/rs/7.4/references/rest-api/objects/alert.md index 73e4e8e565..cc686d640a 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/alert.md +++ b/content/operate/rs/7.4/references/rest-api/objects/alert.md @@ -13,7 +13,7 @@ url: '/operate/rs/7.4/references/rest-api/objects/alert/' You can view, configure, and enable various alerts for the cluster. -Alerts are bound to a cluster object (such as a [BDB]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) or [node]({{< relref "/operate/rs/7.4/references/rest-api/objects/node" >}})), and the cluster's state determines whether the alerts turn on or off. +Alerts are bound to a cluster object (such as a [BDB](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md) or [node](/content/operate/rs/7.4/references/rest-api/objects/node.md)), and the cluster's state determines whether the alerts turn on or off. Name | Type/Value | Description | Writable |-------|------------|-------------|----------| diff --git a/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md b/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md index 4a1b58169b..5f5938f369 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md @@ -36,7 +36,7 @@ An API object that represents a managed database in the cluster. | backup_history | integer (default: 0); Backup history retention policy (number of days, 0 is forever) | | backup_interval | integer; Interval in seconds in which automatic backup will be initiated | | backup_interval_offset | integer; Offset (in seconds) from round backup interval when automatic backup will be initiated (should be less than backup_interval) | -| backup_location | [complex object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/backup_location" >}}); Target for automatic database backups.
    Call `GET` `/jsonschema` to retrieve the object's structure. | +| backup_location | [complex object](/content/operate/rs/7.4/references/rest-api/objects/bdb/backup_location.md); Target for automatic database backups.
    Call `GET` `/jsonschema` to retrieve the object's structure. | | backup_progress | number, (range: 0-100); Database scheduled periodic backup progress (percentage) (read-only) | | backup_status | Status of scheduled periodic backup process (read-only)
    Values:
    'exporting'
    'succeeded'
    'failed' | | bigstore | boolean (default: false); Database bigstore option | @@ -56,16 +56,16 @@ An API object that represents a managed database in the cluster. | crdt_repl_backlog_size | string; Active-Active replication backlog size ('auto' or size in bytes) | | crdt_replica_id | integer; Local replica ID, for internal use only. | | crdt_replicas | string; Replica set configuration, for internal use only. | -| crdt_sources | array of [syncer_sources]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/syncer_sources" >}}) objects; Remote endpoints/peers of CRDB database to sync from. See the 'bdb -\> replica_sources' section | -| crdt_sync | Enable, disable, or pause syncing from specified crdt_sources. Applicable only for Active-Active databases. See [replica_sync]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync" >}}) for more details.
    Values:
    'enabled'
    **'disabled'**
    'paused'
    'stopped' | +| crdt_sources | array of [syncer_sources](/content/operate/rs/7.4/references/rest-api/objects/bdb/syncer_sources.md) objects; Remote endpoints/peers of CRDB database to sync from. See the 'bdb -\> replica_sources' section | +| crdt_sync | Enable, disable, or pause syncing from specified crdt_sources. Applicable only for Active-Active databases. See [replica_sync](/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync.md) for more details.
    Values:
    'enabled'
    **'disabled'**
    'paused'
    'stopped' | | crdt_sync_dist | boolean; Enable/disable distributed syncer in master-master | | crdt_syncer_auto_oom_unlatch | boolean (default: true); Syncer automatically attempts to recover synchronisation from peers after this database throws an Out-Of-Memory error. Otherwise, the syncer exits | | crdt_xadd_id_uniqueness_mode | XADD strict ID uniqueness mode. CRDT only.
    Values:
    ‘liberal’
    **‘strict’**
    ‘semi-strict’ | | created_time | string; The date and time the database was created (read-only) | | data_internode_encryption | boolean; Should the data plane internode communication for this database be encrypted | -| data_persistence | Database on-disk persistence policy. For snapshot persistence, a [snapshot_policy]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/snapshot_policy" >}}) must be provided
    Values:
    **'disabled'**
    'snapshot'
    'aof' | -| dataset_import_sources | [complex object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/dataset_import_sources" >}}); Array of source file location description objects to import from when performing an import action. This is write-only and cannot be read after set.
    Call `GET /v1/jsonschema` to retrieve the object's structure. | -| db_conns_auditing | boolean; Enables/deactivates [database connection auditing]({{< relref "/operate/rs/7.4/security/audit-events" >}}) | +| data_persistence | Database on-disk persistence policy. For snapshot persistence, a [snapshot_policy](/content/operate/rs/7.4/references/rest-api/objects/bdb/snapshot_policy.md) must be provided
    Values:
    **'disabled'**
    'snapshot'
    'aof' | +| dataset_import_sources | [complex object](/content/operate/rs/7.4/references/rest-api/objects/bdb/dataset_import_sources.md); Array of source file location description objects to import from when performing an import action. This is write-only and cannot be read after set.
    Call `GET /v1/jsonschema` to retrieve the object's structure. | +| db_conns_auditing | boolean; Enables/deactivates [database connection auditing](/content/operate/rs/7.4/security/audit-events.md) | | default_user | boolean (default: true); Allow/disallow a default user to connect | | disabled_commands | string (default: ); Redis commands which are disabled in db | | dns_address_master | string; Database private address endpoint FQDN (read-only) (deprecated as of Redis Enterprise v4.3.3) | @@ -116,8 +116,8 @@ An API object that represents a managed database in the cluster. | recovery_wait_time | integer (default: -1); Defines how many seconds to wait for the persistence file to become available during auto recovery. After the wait time expires, auto recovery completes with potential data loss. The default `-1` means to wait forever. | | redis_version | string; Version of the redis-server processes: e.g. 6.0, 5.0-big | | repl_backlog_size | string; Redis replication backlog size ('auto' or size in bytes) | -| replica_sources | array of [syncer_sources]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/syncer_sources" >}}) objects; Remote endpoints of database to sync from. See the 'bdb -\> replica_sources' section | -| [replica_sync]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync" >}}) | Enable, disable, or pause syncing from specified replica_sources
    Values:
    'enabled'
    **'disabled'**
    'paused'
    'stopped' | +| replica_sources | array of [syncer_sources](/content/operate/rs/7.4/references/rest-api/objects/bdb/syncer_sources.md) objects; Remote endpoints of database to sync from. See the 'bdb -\> replica_sources' section | +| [replica_sync](/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync.md) | Enable, disable, or pause syncing from specified replica_sources
    Values:
    'enabled'
    **'disabled'**
    'paused'
    'stopped' | | replica_sync_dist | boolean; Enable/disable distributed syncer in replica-of | | replication | boolean (default: false); In-memory database replication mode | | resp3 | boolean (default: true); Enables or deactivates RESP3 support | @@ -134,11 +134,11 @@ An API object that represents a managed database in the cluster. | slave_buffer | Redis replica output buffer limits
    Values:
    'auto'
    value in MB
    hard:soft:time | | slave_ha | boolean; Enable replica high availability mechanism for this database (default takes the cluster setting) | | slave_ha_priority | integer; Priority of the BDB in replica high availability mechanism | -| snapshot_policy | array of [snapshot_policy]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/snapshot_policy" >}}) objects; Policy for snapshot-based data persistence. A dataset snapshot will be taken every N secs if there are at least M writes changes in the dataset | +| snapshot_policy | array of [snapshot_policy](/content/operate/rs/7.4/references/rest-api/objects/bdb/snapshot_policy.md) objects; Policy for snapshot-based data persistence. A dataset snapshot will be taken every N secs if there are at least M writes changes in the dataset | | ssl | boolean (default: false); Require SSL authenticated and encrypted connections to the database (deprecated as of Redis Enterprise v5.0.1) | -| [status]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/status" >}}) | Database lifecycle status (read-only)
    Values:
    'pending'
    'active'
    'active-change-pending'
    'delete-pending'
    'import-pending'
    'creation-failed'
    'recovery' | +| [status](/content/operate/rs/7.4/references/rest-api/objects/bdb/status.md) | Database lifecycle status (read-only)
    Values:
    'pending'
    'active'
    'active-change-pending'
    'delete-pending'
    'import-pending'
    'creation-failed'
    'recovery' | | support_syncer_reconf | boolean; Determines whether the syncer handles its own configuration changes. If false, the DMC restarts the syncer upon a configuration change. | -| sync | (deprecated as of Redis Enterprise v5.0.1, use [replica_sync]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync" >}}) or crdt_sync instead) Enable, disable, or pause syncing from specified sync_sources
    Values:
    'enabled'
    **'disabled'**
    'paused'
    'stopped' | +| sync | (deprecated as of Redis Enterprise v5.0.1, use [replica_sync](/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync.md) or crdt_sync instead) Enable, disable, or pause syncing from specified sync_sources
    Values:
    'enabled'
    **'disabled'**
    'paused'
    'stopped' | | sync_dedicated_threads | integer (range: 0-10) (default: 5); Number of dedicated Replica Of threads | | sync_sources | {{}}[{
    "uid": integer,
    "uri": string,
    "compression": integer,
    "status": string,
    "rdb_transferred": integer,
    "rdb_size": integer,
    "last_update": string,
    "lag": integer,
    "last_error": string
    }, ...]{{    }} (deprecated as of Redis Enterprise v5.0.1, instead use replica_sources or crdt_sources) Remote endpoints of database to sync from. See the 'bdb -\> replica_sources' section
    **uid**: Numeric unique identification of this source
    **uri**: Source Redis URI
    **compression**: Compression level for the replication link
    **status**: Sync status of this source
    **rdb_transferred**: Number of bytes transferred from the source's RDB during the syncing phase
    **rdb_size**: The source's RDB size to be transferred during the syncing phase
    **last_update**: Time last update was received from the source
    **lag**: Lag in millisec between source and destination (while synced)
    **last_error**: Last error encountered when syncing from the source | | syncer_log_level | Minimum syncer log level to log. Only logs with this level or higher will be logged.
    Values:
    ‘crit’
    ‘error’
    ‘warn’
    **‘info’**
    ‘trace’
    ‘debug’ | diff --git a/content/operate/rs/7.4/references/rest-api/objects/bdb/backup_location.md b/content/operate/rs/7.4/references/rest-api/objects/bdb/backup_location.md index 0991403182..7ea7cbdaa8 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/bdb/backup_location.md +++ b/content/operate/rs/7.4/references/rest-api/objects/bdb/backup_location.md @@ -65,7 +65,7 @@ You can also connect to a storage service that uses the S3 protocol but is not h To connect to an S3-compatible storage location: -1. Configure the S3 URL with [`rladmin cluster config`]({{}}): +1. Configure the S3 URL with [`rladmin cluster config`](/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config.md): ```sh rladmin cluster config s3_url @@ -103,9 +103,8 @@ To connect to an S3-compatible storage location: | sas_token | string | Token to authenticate with shared access signature | | subdir | string | Path to the backup directory in the Blob Storage container (optional) | -{{}} -`account_key` and `sas_token` are mutually exclusive -{{}} +> [!NOTE] +> `account_key` and `sas_token` are mutually exclusive ### NAS/Local Storage diff --git a/content/operate/rs/7.4/references/rest-api/objects/bdb/dataset_import_sources.md b/content/operate/rs/7.4/references/rest-api/objects/bdb/dataset_import_sources.md index f00f044a29..71cb157642 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/bdb/dataset_import_sources.md +++ b/content/operate/rs/7.4/references/rest-api/objects/bdb/dataset_import_sources.md @@ -23,7 +23,7 @@ You can import data to a database from the following location types: - Microsoft Azure Storage - NAS/Local Storage -The source file to import should be in the [RDB]({{< relref "/operate/rs/7.4/databases/configure/database-persistence.md" >}}) format. It can also be in a compressed (gz) RDB file. +The source file to import should be in the [RDB](/content/operate/rs/7.4/databases/configure/database-persistence.md) format. It can also be in a compressed (gz) RDB file. Supply an array of dataset import source objects to import data from multiple files. @@ -71,7 +71,7 @@ You can also connect to a storage service that uses the S3 protocol but is not h To connect to an S3-compatible storage location: -1. Configure the S3 URL with [`rladmin cluster config`]({{}}): +1. Configure the S3 URL with [`rladmin cluster config`](/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config.md): ```sh rladmin cluster config s3_url @@ -108,9 +108,8 @@ To connect to an S3-compatible storage location: | sas_token | string | Token to authenticate with shared access signature | | subdir | string | Path to the backup directory in the Blob Storage container (optional) | -{{}} -`account_key` and `sas_token` are mutually exclusive -{{}} +> [!NOTE] +> `account_key` and `sas_token` are mutually exclusive ### NAS/Local Storage diff --git a/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sources_status.md b/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sources_status.md index 4f914e4b42..1609fe4deb 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sources_status.md +++ b/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sources_status.md @@ -12,7 +12,7 @@ weight: $weight url: '/operate/rs/7.4/references/rest-api/objects/bdb/replica_sources_status/' --- -The `replica_sources` status field relates to the [Replica Of]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/create.md" >}}) feature, which enables the creation of a Redis database (single- or multi-shard) that synchronizes data from another Redis database (single- or multi-shard). +The `replica_sources` status field relates to the [Replica Of](/content/operate/rs/7.4/databases/import-export/replica-of/create.md) feature, which enables the creation of a Redis database (single- or multi-shard) that synchronizes data from another Redis database (single- or multi-shard). The status field represents the Replica Of sync status for a specific sync source. diff --git a/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync.md b/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync.md index f7ae8725ef..7e0196b675 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync.md +++ b/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync.md @@ -12,9 +12,9 @@ weight: $weight url: '/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync/' --- -The BDB `replica_sync` field relates to the [Replica Of]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/create.md" >}}) feature, which enables the creation of a Redis database (single- or multi-shard) that synchronizes data from another Redis database (single- or multi-shard). +The BDB `replica_sync` field relates to the [Replica Of](/content/operate/rs/7.4/databases/import-export/replica-of/create.md) feature, which enables the creation of a Redis database (single- or multi-shard) that synchronizes data from another Redis database (single- or multi-shard). -You can use the `replica_sync` field to enable, disable, or pause the [Replica Of]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/create.md" >}}) sync process. The BDB `crdt_sync` field has a similar purpose for the Redis CRDB. +You can use the `replica_sync` field to enable, disable, or pause the [Replica Of](/content/operate/rs/7.4/databases/import-export/replica-of/create.md) sync process. The BDB `crdt_sync` field has a similar purpose for the Redis CRDB. Possible BDB sync values: diff --git a/content/operate/rs/7.4/references/rest-api/objects/bootstrap/_index.md b/content/operate/rs/7.4/references/rest-api/objects/bootstrap/_index.md index 4b46651825..ca845b279e 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/bootstrap/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/bootstrap/_index.md @@ -17,10 +17,10 @@ A bootstrap configuration object. | Name | Type/Value | Description | |------|------------|-------------| | action | 'create_cluster'
    'join_cluster'
    'recover_cluster' | Action to perform | -| cluster | [cluster_identity]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap/cluster_identity" >}}) object | Cluster to join or create | +| cluster | [cluster_identity](/content/operate/rs/7.4/references/rest-api/objects/bootstrap/cluster_identity.md) object | Cluster to join or create | | cnm_https_port | integer | Port to join a cluster with non-default cnm_https port | | crdb_coordinator_port | integer, (range: 1024-65535) (default: 9081) | CRDB coordinator port | -| credentials | [credentials]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap/credentials" >}}) object | Cluster admin credentials | +| credentials | [credentials](/content/operate/rs/7.4/references/rest-api/objects/bootstrap/credentials.md) object | Cluster admin credentials | | dns_suffixes | {{}} [{ "name": string, @@ -35,8 +35,8 @@ A bootstrap configuration object. | gossip_envoy_admin_port | integer, (range: 1024-65535) | Gossip envoy admin port| | license | string | License string. If not provided, a trial license is set by default. | | max_retries | integer | Max number of retries in case of recoverable errors | -| node | [node_identity]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap/node_identity" >}}) object | Node description | -| policy | [policy]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap/policy" >}}) object | Policy object | +| node | [node_identity](/content/operate/rs/7.4/references/rest-api/objects/bootstrap/node_identity.md) object | Node description | +| policy | [policy](/content/operate/rs/7.4/references/rest-api/objects/bootstrap/policy.md) object | Policy object | | recovery_filename | string | Name of backup file to recover from | | required_version | string | This node can only join the cluster if all nodes in the cluster have a version greater than the required_version | | retry_time | integer | Max waiting time between retries (in seconds) | diff --git a/content/operate/rs/7.4/references/rest-api/objects/bootstrap/node_identity.md b/content/operate/rs/7.4/references/rest-api/objects/bootstrap/node_identity.md index 702a51abde..604d915006 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/bootstrap/node_identity.md +++ b/content/operate/rs/7.4/references/rest-api/objects/bootstrap/node_identity.md @@ -16,6 +16,6 @@ url: '/operate/rs/7.4/references/rest-api/objects/bootstrap/node_identity/' |------|------------|-------------| | bigstore_driver | 'rocksdb' | Bigstore driver name or none (deprecated) | | bigstore_enabled | boolean | Bigstore enabled or disabled | -| identity | [identity]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap/identity" >}}) object | Node identity | -| limits | [limits]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap/limits" >}}) object | Node limits | -| paths | [paths]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap/paths" >}}) object | Storage paths object | +| identity | [identity](/content/operate/rs/7.4/references/rest-api/objects/bootstrap/identity.md) object | Node identity | +| limits | [limits](/content/operate/rs/7.4/references/rest-api/objects/bootstrap/limits.md) object | Node limits | +| paths | [paths](/content/operate/rs/7.4/references/rest-api/objects/bootstrap/paths.md) object | Storage paths object | diff --git a/content/operate/rs/7.4/references/rest-api/objects/cluster/_index.md b/content/operate/rs/7.4/references/rest-api/objects/cluster/_index.md index 1fd70b8119..1604ca3ac2 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/cluster/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/cluster/_index.md @@ -16,7 +16,7 @@ An API object that represents the cluster. | Name | Type/Value | Description | |------|------------|-------------| -| alert_settings | [alert_settings]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings" >}}) object | Cluster and node alert settings | +| alert_settings | [alert_settings](/content/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings.md) object | Cluster and node alert settings | | bigstore_driver | 'speedb'
    'rocksdb' | Storage engine for Auto Tiering | | cluster_ssh_public_key | string | Cluster's autogenerated SSH public key | | cm_port | integer, (range: 1024-65535) | UI HTTPS listening port | diff --git a/content/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings.md b/content/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings.md index efe35eae2c..96dcdf9b8d 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings.md +++ b/content/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings.md @@ -14,7 +14,7 @@ url: '/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings/' | Name | Type/Value | Description | |------|------------|-------------| -| cluster_certs_about_to_expire | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Cluster certificate will expire in x days | +| cluster_certs_about_to_expire | [cluster_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) object | Cluster certificate will expire in x days | | cluster_even_node_count | boolean (default: false) | True high availability requires an odd number of nodes in the cluster | | cluster_flash_overcommit | boolean (default: false) | Flash memory committed to databases is larger than cluster total flash memory | | cluster_inconsistent_redis_sw | boolean (default: false) | Some shards in the cluster are running different versions of Redis software | @@ -32,12 +32,12 @@ url: '/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings/' | cluster_too_few_nodes_for_replication | boolean (default: false) | Replication requires at least 2 nodes in the cluster | | node_aof_slow_disk_io | boolean (default: false) | AOF reaching disk I/O limits | node_checks_error | boolean (default: false) | Some node checks have failed | -| node_cpu_utilization | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node CPU utilization has reached the threshold value (% of the utilization limit) | -| node_ephemeral_storage | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node ephemeral storage has reached the threshold value (% of the storage limit) | +| node_cpu_utilization | [cluster_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) object | Node CPU utilization has reached the threshold value (% of the utilization limit) | +| node_ephemeral_storage | [cluster_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) object | Node ephemeral storage has reached the threshold value (% of the storage limit) | | node_failed | boolean (default: false) | Node failed | -| node_free_flash | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node flash storage has reached the threshold value (% of the storage limit) | +| node_free_flash | [cluster_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) object | Node flash storage has reached the threshold value (% of the storage limit) | | node_insufficient_disk_aofrw | boolean (default: false) | Insufficient AOF disk space | -| node_internal_certs_about_to_expire | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object| Internal certificate on node will expire in x days | -| node_memory | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node memory has reached the threshold value (% of the memory limit) | -| node_net_throughput | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node network throughput has reached the threshold value (bytes/s) | -| node_persistent_storage | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node persistent storage has reached the threshold value (% of the storage limit) | +| node_internal_certs_about_to_expire | [cluster_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) object| Internal certificate on node will expire in x days | +| node_memory | [cluster_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) object | Node memory has reached the threshold value (% of the memory limit) | +| node_net_throughput | [cluster_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) object | Node network throughput has reached the threshold value (bytes/s) | +| node_persistent_storage | [cluster_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) object | Node persistent storage has reached the threshold value (% of the storage limit) | diff --git a/content/operate/rs/7.4/references/rest-api/objects/cluster_settings.md b/content/operate/rs/7.4/references/rest-api/objects/cluster_settings.md index c8b7bbebd1..de6ce0063f 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/cluster_settings.md +++ b/content/operate/rs/7.4/references/rest-api/objects/cluster_settings.md @@ -23,7 +23,7 @@ Cluster resources management policy | bigstore_provision_node_threshold | integer | Minimum free memory (excluding reserved memory) allowed on a node before new shards can no longer be added to it | | bigstore_provision_node_threshold_p | integer | Minimum free memory (excluding reserved memory) allowed on a node before new shards can no longer be added to it | | data_internode_encryption | boolean | Enable/deactivate encryption of the data plane internode communication | -| db_conns_auditing | boolean | [Audit connections]({{< relref "/operate/rs/7.4/security/audit-events" >}}) for new databases by default if set to true. | +| db_conns_auditing | boolean | [Audit connections](/content/operate/rs/7.4/security/audit-events.md) for new databases by default if set to true. | | default_concurrent_restore_actions | integer | Default number of restore actions allowed at the same time. Set to 0 to allow any number of simultaneous restore actions. | | default_fork_evict_ram | boolean | If true, the bdbs should evict data from RAM to ensure successful replication or persistence | | default_non_sharded_proxy_policy | `single`

    `all-master-shards`

    `all-nodes` | Default proxy_policy for newly created non-sharded databases' endpoints | diff --git a/content/operate/rs/7.4/references/rest-api/objects/crdb/_index.md b/content/operate/rs/7.4/references/rest-api/objects/crdb/_index.md index baf343fe99..13d00c6424 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/crdb/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/crdb/_index.md @@ -18,10 +18,10 @@ An object that represents an Active-Active database. |------|------------|-------------| | guid | string | The global unique ID of the Active-Active database | | causal_consistency | boolean | Enables causal consistency across CRDT instances | -| default_db_config| [CRDB database_config]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/database_config" >}}) object | Default database configuration applied to all instances in the CRDB object. In most cases, instances should use the same configuration. If you need to override `default_db_config` or add configuration values for specific instances, you can use `db_config` in individual [instance objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/instance_info" >}}). | +| default_db_config| [CRDB database_config](/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md) object | Default database configuration applied to all instances in the CRDB object. In most cases, instances should use the same configuration. If you need to override `default_db_config` or add configuration values for specific instances, you can use `db_config` in individual [instance objects](/content/operate/rs/7.4/references/rest-api/objects/crdb/instance_info.md). | | encryption | boolean | Encrypt communication | | featureset_version | integer | Active-Active database active FeatureSet version -| instances | array of [CRDB instance_info]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/instance_info" >}}) objects | | +| instances | array of [CRDB instance_info](/content/operate/rs/7.4/references/rest-api/objects/crdb/instance_info.md) objects | | | local_databases | {{}}[{ "bdb_uid": string, "id": integer diff --git a/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md b/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md index fec7809d08..c259cf19e3 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md +++ b/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md @@ -13,9 +13,9 @@ url: '/operate/rs/7.4/references/rest-api/objects/crdb/database_config/' An object that represents the database configuration. This configuration object is used in two contexts within CRDB objects: -- As `default_db_config` in the main [CRDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb" >}}) for settings that apply to all instances. In most cases, instances should use the same configuration. +- As `default_db_config` in the main [CRDB object](/content/operate/rs/7.4/references/rest-api/objects/crdb/_index.md) for settings that apply to all instances. In most cases, instances should use the same configuration. -- As `db_config` in individual [instance objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/instance_info" >}}) to override `default_db_config` or add configuration values for specific instances. Use `db_config` only when an instance needs different settings than the default configuration. +- As `db_config` in individual [instance objects](/content/operate/rs/7.4/references/rest-api/objects/crdb/instance_info.md) to override `default_db_config` or add configuration values for specific instances. Use `db_config` only when an instance needs different settings than the default configuration. | Name | Type/Value | Description | |------|------------|-------------| @@ -41,5 +41,5 @@ An object that represents the database configuration. This configuration object | shard_key_regex | `[{ "regex": string }, ...]` | Custom keyname-based sharding rules (required if sharding is enabled)

    To use the default rules you should set the value to:
    `[{"regex": ".*\\{(?.*)\\}.*"}, {"regex": "(?.*)"}]` | | shards_count | integer | Number of database shards | | shards_placement | string | Control the density of shards: should they reside on as few or as many nodes as possible | -| snapshot_policy | array of [snapshot_policy]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/snapshot_policy" >}}) objects | Policy for snapshot-based data persistence (required) | +| snapshot_policy | array of [snapshot_policy](/content/operate/rs/7.4/references/rest-api/objects/bdb/snapshot_policy.md) objects | Policy for snapshot-based data persistence (required) | | tls_mode | string | Encrypt communication | diff --git a/content/operate/rs/7.4/references/rest-api/objects/crdb/health_report/_index.md b/content/operate/rs/7.4/references/rest-api/objects/crdb/health_report/_index.md index 3cab372e3d..9508ebb079 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/crdb/health_report/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/crdb/health_report/_index.md @@ -18,7 +18,7 @@ An object that represents an Active-Active database health report. |------|------------|-------------| | active_config_version | integer | Active configuration version | | cluster_name | string | Name of local Active-Active cluster | -| configurations | array of [health_report_configuration]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/health_report/health_report_configuration" >}}) objects | Stored database configurations | +| configurations | array of [health_report_configuration](/content/operate/rs/7.4/references/rest-api/objects/crdb/health_report/health_report_configuration.md) objects | Stored database configurations | | connection_error | string | Error string if remote cluster is not available | | connections | {{}} [{ @@ -29,5 +29,5 @@ An object that represents an Active-Active database health report. "status": "up | down" } ], "status": string -}, ...] {{}} | Connections to other clusters and their statuses. A replication link's `bdb_uid` is the unique ID of a local database instance ([bdb]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}})) in the current cluster. The `replica_uid` is the unique ID of the database's remote replica, located in the connected cluster. | +}, ...] {{    }} | Connections to other clusters and their statuses. A replication link's `bdb_uid` is the unique ID of a local database instance ([bdb](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md)) in the current cluster. The `replica_uid` is the unique ID of the database's remote replica, located in the connected cluster. | | name | string | Name of the Active-Active database | diff --git a/content/operate/rs/7.4/references/rest-api/objects/crdb/instance_info.md b/content/operate/rs/7.4/references/rest-api/objects/crdb/instance_info.md index d91a71e56d..3f3162644b 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/crdb/instance_info.md +++ b/content/operate/rs/7.4/references/rest-api/objects/crdb/instance_info.md @@ -16,7 +16,7 @@ An object that represents Active-Active instance info. | Name | Type/Value | Description | |------|------------|-------------| | id | integer | Unique instance ID | -| cluster | [CRDB cluster_info]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/cluster_info" >}}) object | | +| cluster | [CRDB cluster_info](/content/operate/rs/7.4/references/rest-api/objects/crdb/cluster_info.md) object | | | compression | integer | Compression level when syncing from this source | -| db_config | [CRDB database_config]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/database_config" >}}) object | Database configuration for this specific instance. Use `db_config` only when you need to override or add configuration values that differ from the `default_db_config` in the main [CRDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb" >}}). | +| db_config | [CRDB database_config](/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md) object | Database configuration for this specific instance. Use `db_config` only when you need to override or add configuration values that differ from the `default_db_config` in the main [CRDB object](/content/operate/rs/7.4/references/rest-api/objects/crdb/_index.md). | | db_uid | string | ID of local database instance. This field is likely to be empty for instances other than the local one. | diff --git a/content/operate/rs/7.4/references/rest-api/objects/crdb/modify_request.md b/content/operate/rs/7.4/references/rest-api/objects/crdb/modify_request.md index 440c115458..771f67c456 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/crdb/modify_request.md +++ b/content/operate/rs/7.4/references/rest-api/objects/crdb/modify_request.md @@ -15,8 +15,8 @@ An object to update an Active-Active database. | Name | Type/Value | Description | |------|------------|-------------| -| add_instances | array of [CRDB instance_info]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/instance_info" >}}) objects | List of new CRDB instances | -| crdb | [CRDB]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb" >}}) object | An object that represents an Active-Active database | +| add_instances | array of [CRDB instance_info](/content/operate/rs/7.4/references/rest-api/objects/crdb/instance_info.md) objects | List of new CRDB instances | +| crdb | [CRDB](/content/operate/rs/7.4/references/rest-api/objects/crdb/_index.md) object | An object that represents an Active-Active database | | force_update | boolean | (Warning: This flag can cause unintended and dangerous changes) Force the configuration update and increment the configuration version even if there is no change to the configuration parameters. If you use force, you can mistakenly cause the other instances to update to the configuration version even though it was not changed. | | remove_instances | array of integers | List of unique instance IDs | | remove_instances.force_remove | boolean | Force removal of instance from the Active-Active database. Before we remove an instance from an Active-Active database, all of the operations that the instance received from clients must be propagated to the other instances. This is the safe method to remove an instance from the Active-Active database. If the instance does not have connectivity to other instances, the propagation fails and removal fails. To remove an instance that does not have connectivity to other instances, you must use the force flag. The removed instance keeps its data and configuration for the instance. After you remove an instance by force, you must use the purge_instances API on the removed instance. | diff --git a/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/_index.md b/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/_index.md index 8384f64231..9bca4506cf 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/_index.md @@ -16,21 +16,21 @@ An API object that represents the database alerts configuration. | Name | Type/Value | Description | |------|------------|-------------| -| bdb_backup_delayed | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Periodic backup has been delayed for longer than specified threshold value (minutes) | -| bdb_crdt_src_high_syncer_lag | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | CRDB source sync lag is higher than specified threshold value (seconds) | -| bdb_crdt_src_syncer_connection_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | CRDB source sync had a connection error while trying to connect to replica source | -| bdb_crdt_src_syncer_general_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | CRDB sync encountered in general error | -| bdb_high_latency | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Latency is higher than specified threshold value (microsec) | -| bdb_high_syncer_lag | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of sync lag is higher than specified threshold value (seconds) (deprecated as of Redis Enterprise v5.0.1) | -| bdb_high_throughput | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Throughput is higher than specified threshold value (requests / sec) | -| bdb_long_running_action | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | An alert for state machines that are running for too long | -| bdb_low_throughput | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Throughput is lower than specified threshold value (requests / sec) | -| bdb_ram_dataset_overhead | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Dataset RAM overhead of a shard has reached the threshold value (% of its RAM limit) | -| bdb_ram_values | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Percent of values kept in a shard's RAM is lower than (% of its key count) | -| bdb_replica_src_high_syncer_lag | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of source sync lag is higher than specified threshold value (seconds) | -| bdb_replica_src_syncer_connection_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of source sync has connection error while trying to connect replica source | -| bdb_replica_src_syncer_general_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of sync encountered in general error | -| bdb_shard_num_ram_values | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Number of values kept in a shard's RAM is lower than (values) | -| bdb_size | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Dataset size has reached the threshold value \(% of the memory limit) | -| bdb_syncer_connection_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of sync has connection error while trying to connect replica source (deprecated as of Redis Enterprise v5.0.1) | -| bdb_syncer_general_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of sync encountered in general error (deprecated as of Redis Enterprise v5.0.1) | +| bdb_backup_delayed | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Periodic backup has been delayed for longer than specified threshold value (minutes) | +| bdb_crdt_src_high_syncer_lag | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | CRDB source sync lag is higher than specified threshold value (seconds) | +| bdb_crdt_src_syncer_connection_error | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | CRDB source sync had a connection error while trying to connect to replica source | +| bdb_crdt_src_syncer_general_error | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | CRDB sync encountered in general error | +| bdb_high_latency | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Latency is higher than specified threshold value (microsec) | +| bdb_high_syncer_lag | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Replica of sync lag is higher than specified threshold value (seconds) (deprecated as of Redis Enterprise v5.0.1) | +| bdb_high_throughput | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Throughput is higher than specified threshold value (requests / sec) | +| bdb_long_running_action | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | An alert for state machines that are running for too long | +| bdb_low_throughput | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Throughput is lower than specified threshold value (requests / sec) | +| bdb_ram_dataset_overhead | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Dataset RAM overhead of a shard has reached the threshold value (% of its RAM limit) | +| bdb_ram_values | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Percent of values kept in a shard's RAM is lower than (% of its key count) | +| bdb_replica_src_high_syncer_lag | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Replica of source sync lag is higher than specified threshold value (seconds) | +| bdb_replica_src_syncer_connection_error | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Replica of source sync has connection error while trying to connect replica source | +| bdb_replica_src_syncer_general_error | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Replica of sync encountered in general error | +| bdb_shard_num_ram_values | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Number of values kept in a shard's RAM is lower than (values) | +| bdb_size | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Dataset size has reached the threshold value \(% of the memory limit) | +| bdb_syncer_connection_error | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Replica of sync has connection error while trying to connect replica source (deprecated as of Redis Enterprise v5.0.1) | +| bdb_syncer_general_error | [bdb_alert_settings_with_threshold](/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Replica of sync encountered in general error (deprecated as of Redis Enterprise v5.0.1) | diff --git a/content/operate/rs/7.4/references/rest-api/objects/job_scheduler/_index.md b/content/operate/rs/7.4/references/rest-api/objects/job_scheduler/_index.md index 7dacc3d874..20e963b6fb 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/job_scheduler/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/job_scheduler/_index.md @@ -16,9 +16,9 @@ An API object that represents the job scheduler settings in the cluster. | Name | Type/Value | Description | |------|------------|-------------| -| backup_job_settings | [backup_job_settings]({{< relref "/operate/rs/7.4/references/rest-api/objects/job_scheduler/backup_job_settings" >}}) object | Backup job settings | -| cert_rotation_job_settings | [cert_rotation_job_settings]({{< relref "/operate/rs/7.4/references/rest-api/objects/job_scheduler/cert_rotation_job_settings" >}}) object | Job settings for internal certificate rotation | -| log_rotation_job_settings | [log_rotation_job_settings]({{< relref "/operate/rs/7.4/references/rest-api/objects/job_scheduler/log_rotation_job_settings" >}}) object | Log rotation job settings | -| node_checks_job_settings | [node_checks_job_settings]({{< relref "/operate/rs/7.4/references/rest-api/objects/job_scheduler/node_checks_job_settings" >}}) object | Node checks job settings | -| redis_cleanup_job_settings | [redis_cleanup_job_settings]({{< relref "/operate/rs/7.4/references/rest-api/objects/job_scheduler/redis_cleanup_job_settings" >}}) object | Redis cleanup job settings (deprecated as of Redis Enterprise v6.4.2, replaced with persistence_cleanup_scan_interval) | -| rotate_ccs_job_settings | [rotate_ccs_job_settings]({{< relref "/operate/rs/7.4/references/rest-api/objects/job_scheduler/rotate_ccs_job_settings" >}}) object | Rotate CCS job settings | +| backup_job_settings | [backup_job_settings](/content/operate/rs/7.4/references/rest-api/objects/job_scheduler/backup_job_settings.md) object | Backup job settings | +| cert_rotation_job_settings | [cert_rotation_job_settings](/content/operate/rs/7.4/references/rest-api/objects/job_scheduler/cert_rotation_job_settings.md) object | Job settings for internal certificate rotation | +| log_rotation_job_settings | [log_rotation_job_settings](/content/operate/rs/7.4/references/rest-api/objects/job_scheduler/log_rotation_job_settings.md) object | Log rotation job settings | +| node_checks_job_settings | [node_checks_job_settings](/content/operate/rs/7.4/references/rest-api/objects/job_scheduler/node_checks_job_settings.md) object | Node checks job settings | +| redis_cleanup_job_settings | [redis_cleanup_job_settings](/content/operate/rs/7.4/references/rest-api/objects/job_scheduler/redis_cleanup_job_settings.md) object | Redis cleanup job settings (deprecated as of Redis Enterprise v6.4.2, replaced with persistence_cleanup_scan_interval) | +| rotate_ccs_job_settings | [rotate_ccs_job_settings](/content/operate/rs/7.4/references/rest-api/objects/job_scheduler/rotate_ccs_job_settings.md) object | Rotate CCS job settings | diff --git a/content/operate/rs/7.4/references/rest-api/objects/ldap.md b/content/operate/rs/7.4/references/rest-api/objects/ldap.md index e52617d580..9f434a3a86 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/ldap.md +++ b/content/operate/rs/7.4/references/rest-api/objects/ldap.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/7.4/references/rest-api/objects/ldap/' --- -An API object that represents the cluster's [LDAP]({{< relref "/operate/rs/7.4/security/access-control/ldap" >}}) configuration. +An API object that represents the cluster's [LDAP](/content/operate/rs/7.4/security/access-control/ldap/_index.md) configuration. | Name | Type/Value | Description | |------|------------|-------------| diff --git a/content/operate/rs/7.4/references/rest-api/objects/ldap_mapping.md b/content/operate/rs/7.4/references/rest-api/objects/ldap_mapping.md index 6d55c6d90c..b0752db27c 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/ldap_mapping.md +++ b/content/operate/rs/7.4/references/rest-api/objects/ldap_mapping.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/7.4/references/rest-api/objects/ldap_mapping/' --- -An API object that represents an [LDAP mapping]({{< relref "/operate/rs/7.4/security/access-control/ldap/map-ldap-groups-to-roles" >}}) between an LDAP group and [roles]({{< relref "/operate/rs/7.4/references/rest-api/objects/role" >}}). +An API object that represents an [LDAP mapping](/content/operate/rs/7.4/security/access-control/ldap/map-ldap-groups-to-roles.md) between an LDAP group and [roles](/content/operate/rs/7.4/references/rest-api/objects/role.md). | Name | Type/Value | Description | |------|------------|-------------| diff --git a/content/operate/rs/7.4/references/rest-api/objects/module.md b/content/operate/rs/7.4/references/rest-api/objects/module.md index 86d07b11d4..e5945b868d 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/module.md +++ b/content/operate/rs/7.4/references/rest-api/objects/module.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/7.4/references/rest-api/objects/module/' --- -Represents a [Redis module]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}}). +Represents a [Redis module](/content/operate/oss_and_stack/stack-with-enterprise/_index.md). | Name | Type/Value | Description | |------|------------|-------------| diff --git a/content/operate/rs/7.4/references/rest-api/objects/module_metadata.md b/content/operate/rs/7.4/references/rest-api/objects/module_metadata.md index 0b13c4d03b..b04eb5b09f 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/module_metadata.md +++ b/content/operate/rs/7.4/references/rest-api/objects/module_metadata.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/7.4/references/rest-api/objects/module_metadata/' --- -Represents a [Redis module]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}}). +Represents a [Redis module](/content/operate/oss_and_stack/stack-with-enterprise/_index.md). | Name | Type/Value | Description | |------|------------|-------------| diff --git a/content/operate/rs/7.4/references/rest-api/objects/node.md b/content/operate/rs/7.4/references/rest-api/objects/node.md index df7a410a35..74b24a5c29 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/node.md +++ b/content/operate/rs/7.4/references/rest-api/objects/node.md @@ -20,7 +20,7 @@ An API object that represents a node in the cluster. | addr | string | Internal IP address of node | | architecture | string | Hardware architecture (read-only) | | bigredis_storage_path | string | Flash storage path (read-only) | -| bigstore_driver | 'ibm-capi-ga1'
    'ibm-capi-ga2'
    'ibm-capi-ga4'
    'speedb'
    'rocksdb' | Bigstore driver name or none (deprecated as of Redis Enterprise v7.2, use the [cluster object]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster" >}})'s bigstore_driver instead) | +| bigstore_driver | 'ibm-capi-ga1'
    'ibm-capi-ga2'
    'ibm-capi-ga4'
    'speedb'
    'rocksdb' | Bigstore driver name or none (deprecated as of Redis Enterprise v7.2, use the [cluster object](/content/operate/rs/7.4/references/rest-api/objects/cluster/_index.md)'s bigstore_driver instead) | | bigstore_size | integer | Storage size of bigstore storage (read-only) | | cores | integer | Total number of CPU cores (read-only) | | ephemeral_storage_path | string | Ephemeral storage path (read-only) | diff --git a/content/operate/rs/7.4/references/rest-api/objects/redis_acl.md b/content/operate/rs/7.4/references/rest-api/objects/redis_acl.md index 036ebe763a..9cb0a99616 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/redis_acl.md +++ b/content/operate/rs/7.4/references/rest-api/objects/redis_acl.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/7.4/references/rest-api/objects/redis_acl/' --- -An API object that represents a Redis [access control list (ACL)]({{< relref "/operate/rs/7.4/security/access-control/create-db-roles" >}}) +An API object that represents a Redis [access control list (ACL)](/content/operate/rs/7.4/security/access-control/create-db-roles.md) | Name | Type/Value | Description | |------|------------|-------------| diff --git a/content/operate/rs/7.4/references/rest-api/objects/role.md b/content/operate/rs/7.4/references/rest-api/objects/role.md index 10a588b692..6d43b131db 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/role.md +++ b/content/operate/rs/7.4/references/rest-api/objects/role.md @@ -18,5 +18,5 @@ An API object that represents a role. | uid | integer | Role's unique ID | | account_id | integer | SM account ID | | action_uid | string | Action UID. If it exists, progress can be tracked by the GET /actions/{uid} API (read-only) | -| management | 'admin'
    'db_member'
    'db_viewer'
    'cluster_member'
    'cluster_viewer'
    'none' | [Management role]({{< relref "/operate/rs/7.4/references/rest-api/permissions#roles" >}}) | +| management | 'admin'
    'db_member'
    'db_viewer'
    'cluster_member'
    'cluster_viewer'
    'none' | [Management role](/content/operate/rs/7.4/references/rest-api/permissions.md#roles) | | name | string | Role's name | diff --git a/content/operate/rs/7.4/references/rest-api/objects/services_configuration/_index.md b/content/operate/rs/7.4/references/rest-api/objects/services_configuration/_index.md index e6357bb1e6..ead9d535c6 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/services_configuration/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/services_configuration/_index.md @@ -16,10 +16,10 @@ Optional cluster services settings | Name | Type/Value | Description | |------|------------|-------------| -| alert_mgr | [alert_mgr]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration/alert_mgr" >}}) object | Whether to enable/disable the alert manager processes | -| cm_server | [cm_server]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration/cm_server" >}}) object | Whether to enable/disable the CM server | -| crdb_coordinator | [crdb_coordinator]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration/crdb_coordinator" >}}) object | Whether to enable/disable the CRDB coordinator process | -| crdb_worker | [crdb_worker]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration/crdb_worker" >}}) object | Whether to enable/disable the CRDB worker processes | -| mdns_server | [mdns_server]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration/mdns_server" >}}) object | Whether to enable/disable the multicast DNS server | -| pdns_server | [pdns_server]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration/pdns_server" >}}) object | Whether to enable/disable the PDNS server | -| stats_archiver | [stats_archiver]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration/stats_archiver" >}}) object | Whether to enable/disable the stats archiver service | +| alert_mgr | [alert_mgr](/content/operate/rs/7.4/references/rest-api/objects/services_configuration/alert_mgr.md) object | Whether to enable/disable the alert manager processes | +| cm_server | [cm_server](/content/operate/rs/7.4/references/rest-api/objects/services_configuration/cm_server.md) object | Whether to enable/disable the CM server | +| crdb_coordinator | [crdb_coordinator](/content/operate/rs/7.4/references/rest-api/objects/services_configuration/crdb_coordinator.md) object | Whether to enable/disable the CRDB coordinator process | +| crdb_worker | [crdb_worker](/content/operate/rs/7.4/references/rest-api/objects/services_configuration/crdb_worker.md) object | Whether to enable/disable the CRDB worker processes | +| mdns_server | [mdns_server](/content/operate/rs/7.4/references/rest-api/objects/services_configuration/mdns_server.md) object | Whether to enable/disable the multicast DNS server | +| pdns_server | [pdns_server](/content/operate/rs/7.4/references/rest-api/objects/services_configuration/pdns_server.md) object | Whether to enable/disable the PDNS server | +| stats_archiver | [stats_archiver](/content/operate/rs/7.4/references/rest-api/objects/services_configuration/stats_archiver.md) object | Whether to enable/disable the stats archiver service | diff --git a/content/operate/rs/7.4/references/rest-api/objects/shard/_index.md b/content/operate/rs/7.4/references/rest-api/objects/shard/_index.md index 080fd1792b..446fcf0033 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/shard/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/shard/_index.md @@ -18,14 +18,14 @@ An API object that represents a Redis shard in a database. |------|------------|-------------| | uid | string | Cluster unique ID of shard | | assigned_slots | string | Shards hash slot range | -| backup | [backup]({{< relref "/operate/rs/7.4/references/rest-api/objects/shard/backup" >}}) object | Current status of scheduled periodic backup process | +| backup | [backup](/content/operate/rs/7.4/references/rest-api/objects/shard/backup.md) object | Current status of scheduled periodic backup process | | bdb_uid | integer | The ID of the database this shard belongs to | | bigstore_ram_weight | number | Shards RAM distribution weight | | detailed_status | 'busy'
    'down'
    'importing'
    'loading'
    'ok'
    'timeout'
    'trimming'
    'unknown' | A more detailed status of the shard | -| loading | [loading]({{< relref "/operate/rs/7.4/references/rest-api/objects/shard/loading" >}}) object | Current status of dump file loading | +| loading | [loading](/content/operate/rs/7.4/references/rest-api/objects/shard/loading.md) object | Current status of dump file loading | | node_uid | string | The ID of the node this shard is located on | -| redis_info | redis_info object | A sub-dictionary of the [Redis INFO command]({{< relref "/commands/info" >}}) | +| redis_info | redis_info object | A sub-dictionary of the [Redis INFO command](/content/commands/info.md) | | report_timestamp | string | The time in which the shard's info was collected (read-only) | | role | 'master'
    'slave' | Role of this shard | | status | 'active'
    'inactive'
    'trimming' | The current status of the shard | -| sync | [sync]({{< relref "/operate/rs/7.4/references/rest-api/objects/shard/sync.md" >}}) object | Shard's current sync status and progress | +| sync | [sync](/content/operate/rs/7.4/references/rest-api/objects/shard/sync.md) object | Shard's current sync status and progress | diff --git a/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md b/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md index 4a980658ba..9cfa1998f3 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md @@ -15,13 +15,13 @@ url: '/operate/rs/7.4/references/rest-api/objects/statistics/' ## Statistics overview Clusters, databases, nodes, and shards collect various statistics at regular time intervals. View the statistics for these objects using `GET stats` requests to their respective endpoints: -- [Cluster stats]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/stats" >}}) -- [Database stats]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/stats" >}}) -- [Node stats]({{< relref "/operate/rs/7.4/references/rest-api/requests/nodes/stats" >}}) -- [Shard stats]({{< relref "/operate/rs/7.4/references/rest-api/requests/shards/stats" >}}) +- [Cluster stats](/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/_index.md) +- [Database stats](/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/_index.md) +- [Node stats](/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/_index.md) +- [Shard stats](/content/operate/rs/7.4/references/rest-api/requests/shards/stats/_index.md) View endpoint stats using `GET` requests, see: -- [Endpoint stats]({{< relref "/operate/rs/7.4/references/rest-api/requests/endpoints-stats" >}}) +- [Endpoint stats](/content/operate/rs/7.4/references/rest-api/requests/endpoints-stats/_index.md) ### Response object @@ -40,14 +40,13 @@ Statistics returned from API requests always contain the following fields: The statistics returned by the API also contain fields that represent the values of different metrics for an object during the specified time interval. More details about the metrics relevant to each object: -- [Cluster metrics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics/cluster-metrics" >}}) -- [DB metrics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics/db-metrics" >}}) -- [Node metrics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics/node-metrics" >}}) -- [Shard metrics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics/shard-metrics" >}}) +- [Cluster metrics](/content/operate/rs/7.4/references/rest-api/objects/statistics/cluster-metrics.md) +- [DB metrics](/content/operate/rs/7.4/references/rest-api/objects/statistics/db-metrics.md) +- [Node metrics](/content/operate/rs/7.4/references/rest-api/objects/statistics/node-metrics.md) +- [Shard metrics](/content/operate/rs/7.4/references/rest-api/objects/statistics/shard-metrics.md) -{{}} -Certain statistics are not documented because they are for internal use only and should be ignored. Some statistics will only appear in API responses when they are relevant. -{{}} +> [!NOTE] +> Certain statistics are not documented because they are for internal use only and should be ignored. Some statistics will only appear in API responses when they are relevant. ### Optional URL parameters @@ -73,6 +72,5 @@ The system retains a maximum number of most recent samples for each interval. The actual number of samples returned by a `GET stats` request depends on how many samples are available and any filters applied by the optional URL parameters. For example, newly created objects (clusters, nodes, databases, or shards) or a narrow time filter range will return fewer samples. -{{}} -To reduce load generated by stats collection, relatively inactive databases or shards (less than 5 ops/sec) do not collect 1sec stats at one second intervals. Instead, they collect 1sec stats every 2-5 seconds but still retain the same maximum number of samples. -{{}} +> [!NOTE] +> To reduce load generated by stats collection, relatively inactive databases or shards (less than 5 ops/sec) do not collect 1sec stats at one second intervals. Instead, they collect 1sec stats every 2-5 seconds but still retain the same maximum number of samples. diff --git a/content/operate/rs/7.4/references/rest-api/objects/user.md b/content/operate/rs/7.4/references/rest-api/objects/user.md index 8393983060..1b1857cbaf 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/user.md +++ b/content/operate/rs/7.4/references/rest-api/objects/user.md @@ -27,6 +27,6 @@ An API object that represents a Redis Enterprise user. | password | string | User's password. If `password_hash_method` is set to `1`, the password should be hashed using SHA-256. The format before hashing is `username:clustername:password`. | | password_hash_method | '1' | Used when password is passed pre-hashed to specify the hashing method | | password_issue_date | string | The date in which the password was set (read-only) | -| role | 'admin'
    'cluster_member'
    'cluster_viewer'
    'db_member'
    **'db_viewer'**
    'none' | User's [role]({{< relref "/operate/rs/7.4/references/rest-api/permissions#roles" >}}) | +| role | 'admin'
    'cluster_member'
    'cluster_viewer'
    'db_member'
    **'db_viewer'**
    'none' | User's [role](/content/operate/rs/7.4/references/rest-api/permissions.md#roles) | | role_uids | array of integers | UIDs of user's roles for role-based access control | | status | 'active'
    'locked' | User sign-in status (read-only)
    **active**: able to sign in
    **locked**: unable to sign in | diff --git a/content/operate/rs/7.4/references/rest-api/permissions.md b/content/operate/rs/7.4/references/rest-api/permissions.md index cd5ddfe0b4..0614b67390 100644 --- a/content/operate/rs/7.4/references/rest-api/permissions.md +++ b/content/operate/rs/7.4/references/rest-api/permissions.md @@ -12,9 +12,9 @@ weight: 60 url: '/operate/rs/7.4/references/rest-api/permissions/' --- -Some Redis Enterprise [REST API requests]({{< relref "/operate/rs/7.4/references/rest-api/requests" >}}) may require the user to have specific permissions. +Some Redis Enterprise [REST API requests](/content/operate/rs/7.4/references/rest-api/requests/_index.md) may require the user to have specific permissions. -Administrators can assign a predefined role to a user with the [Cluster Manager UI]({{< relref "/operate/rs/7.4/security/access-control/create-users" >}}) or a [`PUT /v1/users/{uid}` API request]({{< relref "/operate/rs/7.4/references/rest-api/requests/users#put-user" >}}) to grant necessary permissions to them. +Administrators can assign a predefined role to a user with the [Cluster Manager UI](/content/operate/rs/7.4/security/access-control/create-users.md) or a [`PUT /v1/users/{uid}` API request](/content/operate/rs/7.4/references/rest-api/requests/users/_index.md#put-user) to grant necessary permissions to them. ## Roles diff --git a/content/operate/rs/7.4/references/rest-api/quick-start.md b/content/operate/rs/7.4/references/rest-api/quick-start.md index a103f645dd..3a19ee50af 100644 --- a/content/operate/rs/7.4/references/rest-api/quick-start.md +++ b/content/operate/rs/7.4/references/rest-api/quick-start.md @@ -19,13 +19,13 @@ No matter which method you use to send API requests, there are a few common conc | Type | Description | |------|-------------| -| [Authentication]({{< relref "/operate/rs/7.4/references/rest-api#authentication" >}}) | Use [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication) with your cluster username (email) and password | -| [Ports]({{< relref "/operate/rs/7.4/references/rest-api#ports" >}}) | All calls are made to port 9443 by default | -| [Versions]({{< relref "/operate/rs/7.4/references/rest-api#versions" >}}) | Specify the version in the request [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) | -| [Headers]({{< relref "/operate/rs/7.4/references/rest-api#headers" >}}) | `Accept` and `Content-Type` should be `application/json` | -| [Response types and error codes]({{< relref "/operate/rs/7.4/references/rest-api#response-types-and-error-codes" >}}) | A response of `200 OK` means success; otherwise, the request failed due to an error | +| [Authentication](/content/operate/rs/7.4/references/rest-api/_index.md#authentication) | Use [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication) with your cluster username (email) and password | +| [Ports](/content/operate/rs/7.4/references/rest-api/_index.md#ports) | All calls are made to port 9443 by default | +| [Versions](/content/operate/rs/7.4/references/rest-api/_index.md#versions) | Specify the version in the request [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) | +| [Headers](/content/operate/rs/7.4/references/rest-api/_index.md#headers) | `Accept` and `Content-Type` should be `application/json` | +| [Response types and error codes](/content/operate/rs/7.4/references/rest-api/_index.md#response-types-and-error-codes) | A response of `200 OK` means success; otherwise, the request failed due to an error | -For more information, see [Redis Enterprise Software REST API]({{< relref "/operate/rs/7.4/references/rest-api/" >}}). +For more information, see [Redis Enterprise Software REST API](/content/operate/rs/7.4/references/rest-api/_index.md). ## cURL example requests @@ -39,7 +39,7 @@ You can use the following options to build a cURL request: | -H | Request header, can be specified multiple times | | -u | Username and password information | | -d | JSON data for PUT or POST requests | -| -F | Form data for PUT or POST requests, such as for the [`POST /v1/modules`]({{< relref "/operate/rs/7.4/references/rest-api/requests/modules/#post-module" >}}) or [`POST /v2/modules`]({{< relref "/operate/rs/7.4/references/rest-api/requests/modules/#post-module-v2" >}}) endpoint | +| -F | Form data for PUT or POST requests, such as for the [`POST /v1/modules`](/content/operate/rs/7.4/references/rest-api/requests/modules/_index.md#post-module) or [`POST /v2/modules`](/content/operate/rs/7.4/references/rest-api/requests/modules/_index.md#post-module-v2) endpoint | | -k | Turn off SSL verification | | -i | Show headers and status code as well as the response body | @@ -47,7 +47,7 @@ See the [cURL documentation](https://curl.se/docs/) for more information. ### GET request -Use the following cURL command to get a list of databases with the [GET `/v1/bdbs/`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/#get-all-bdbs" >}}) endpoint. +Use the following cURL command to get a list of databases with the [GET `/v1/bdbs/`](/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md#get-all-bdbs) endpoint. ```sh $ curl -X GET -H "accept: application/json" \ @@ -76,11 +76,11 @@ x-envoy-upstream-service-time: 25 In the response body, the `uid` is the database ID. You can use the database ID to view or update the database using the API. -For more information about the fields returned by [GET `/v1/bdbs/`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/#get-all-bdbs" >}}), see the [`bdbs` object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/" >}}). +For more information about the fields returned by [GET `/v1/bdbs/`](/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md#get-all-bdbs), see the [`bdbs` object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md). ### PUT request -Once you have the database ID, you can use [PUT `/v1/bdbs/`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/#put-bdbs" >}}) to update the configuration of the database. +Once you have the database ID, you can use [PUT `/v1/bdbs/`](/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md#put-bdbs) to update the configuration of the database. For example, you can pass the database `uid` 1 as a URL parameter and use the `-d` option to specify the new `name` when you send the request. This changes the database's `name` from `tr01` to `database1`: @@ -108,7 +108,7 @@ x-envoy-upstream-service-time: 159 } ``` -For more information about the fields you can update with [PUT `/v1/bdbs/`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/#put-bdbs" >}}), see the [`bdbs` object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/" >}}). +For more information about the fields you can update with [PUT `/v1/bdbs/`](/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md#put-bdbs), see the [`bdbs` object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md). ## Client examples @@ -116,7 +116,7 @@ You can also use client libraries to make API requests in your preferred languag To follow these examples, you need: -- A [Redis Enterprise Software]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) node +- A [Redis Enterprise Software](/content/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md) node - Python 3 and the [requests](https://pypi.org/project/requests/) Python library - [node.js](https://nodejs.dev/) and [node-fetch](https://www.npmjs.com/package/node-fetch) @@ -319,5 +319,5 @@ PUT https://[host]:[port]/v1/bdbs/1 ## More info -- [Redis Enterprise Software REST API]({{< relref "/operate/rs/7.4/references/rest-api/" >}}) -- [Redis Enterprise Software REST API requests]({{< relref "/operate/rs/7.4/references/rest-api/requests/" >}}) +- [Redis Enterprise Software REST API](/content/operate/rs/7.4/references/rest-api/_index.md) +- [Redis Enterprise Software REST API requests](/content/operate/rs/7.4/references/rest-api/requests/_index.md) diff --git a/content/operate/rs/7.4/references/rest-api/requests/_index.md b/content/operate/rs/7.4/references/rest-api/requests/_index.md index 6eb05eb7ac..88bb2a7d98 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/_index.md @@ -22,6 +22,6 @@ Some requests may also require: - URL parameters - [Query parameters](https://en.wikipedia.org/wiki/Query_string) - [JSON](http://www.json.org) request body -- [Permissions]({{< relref "/operate/rs/7.4/references/rest-api/permissions" >}}) +- [Permissions](/content/operate/rs/7.4/references/rest-api/permissions.md) {{< table-children columnNames="Request,Description" columnSources="LinkTitle,Description" enableLinks="LinkTitle" >}} diff --git a/content/operate/rs/7.4/references/rest-api/requests/actions/_index.md b/content/operate/rs/7.4/references/rest-api/requests/actions/_index.md index 6236919717..bce5003459 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/actions/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/actions/_index.md @@ -30,7 +30,7 @@ Get the status of all actions (executing, queued, or completed) on all entities | Permission name | |-----------------| -| [view_status_of_cluster_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action](/content/operate/rs/7.4/references/rest-api/permissions.md#view_status_of_cluster_action) | ### Request {#get-all-request} @@ -42,7 +42,7 @@ GET /v1/actions ### Response {#get-all-response} -Returns a JSON array of [action objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}) and an array of [state-machine objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/state-machine" >}}). +Returns a JSON array of [action objects](/content/operate/rs/7.4/references/rest-api/objects/action.md) and an array of [state-machine objects](/content/operate/rs/7.4/references/rest-api/objects/state-machine.md). Regardless of an action’s source, each action in the response contains the following attributes: `name`, `action_uid`, `status`, and `progress`. @@ -100,7 +100,7 @@ Get the status of a currently executing, queued, or completed action. | Permission name | |-----------------| -| [view_status_of_cluster_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action](/content/operate/rs/7.4/references/rest-api/permissions.md#view_status_of_cluster_action) | ### Request {#get-request} @@ -118,7 +118,7 @@ GET /v1/actions/{uid} ### Response {#get-response} -Returns an [action object]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}). +Returns an [action object](/content/operate/rs/7.4/references/rest-api/objects/action.md). Regardless of an action’s source, each action contains the following attributes: `name`, `action_uid`, `status`, and `progress`. diff --git a/content/operate/rs/7.4/references/rest-api/requests/actions/bdb.md b/content/operate/rs/7.4/references/rest-api/requests/actions/bdb.md index 35faf90723..04232dd1f5 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/actions/bdb.md +++ b/content/operate/rs/7.4/references/rest-api/requests/actions/bdb.md @@ -28,7 +28,7 @@ Get the status of all currently executing, pending, or completed state-machine-r | Permission name | |-----------------| -| [view_status_of_cluster_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action](/content/operate/rs/7.4/references/rest-api/permissions.md#view_status_of_cluster_action) | ### Request {#get-request} @@ -46,7 +46,7 @@ GET /v1/actions/bdb/1 ### Response {#get-response} -Returns an array of JSON objects with attributes from [actions]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}) and [state machines]({{< relref "/operate/rs/7.4/references/rest-api/objects/state-machine" >}}). +Returns an array of JSON objects with attributes from [actions](/content/operate/rs/7.4/references/rest-api/objects/action.md) and [state machines](/content/operate/rs/7.4/references/rest-api/objects/state-machine.md). Each action contains the following attributes: `name`, `action_uid`, `status`, and `progress`. diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md index 959db950d0..6a51a5aa39 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md @@ -35,7 +35,7 @@ Get all databases in the cluster. | Permission name | Roles | |-----------------|---------| -| [view_all_bdbs_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_bdbs_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_all_bdbs_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_bdbs_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-all-request} @@ -60,7 +60,7 @@ GET /v1/bdbs?fields=uid,name ### Response {#get-all-response} -The response body contains a JSON array with all databases, represented as [BDB objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}). +The response body contains a JSON array with all databases, represented as [BDB objects](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md). #### Body @@ -125,7 +125,7 @@ Get a single database. | Permission name | Roles | |-----------------|-------| -| [view_bdb_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_bdb_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} @@ -158,7 +158,7 @@ GET /v1/bdbs/1 ### Response {#get-response} -Returns a [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}). +Returns a [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md). #### Example JSON body @@ -184,17 +184,17 @@ PUT /v1/bdbs/{int: uid} ``` Update the configuration of an active database. -If called with the `dry_run` URL query string, the function will validate the [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) against the existing database, but will not invoke the state machine that will update it. +If called with the `dry_run` URL query string, the function will validate the [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md) against the existing database, but will not invoke the state machine that will update it. This is the basic version of the update request. See [Update database and perform action](#put-bdbs-action) to send an update request with an additional action. -To track this request's progress, poll the [`/actions/` endpoint]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/actions" >}}) with the action_uid returned in the response body. +To track this request's progress, poll the [`/actions/` endpoint](/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/_index.md) with the action_uid returned in the response body. ### Permissions | Permission name | Roles | |-----------------|-------| -| [update_bdb]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_bdb" >}}) | admin
    cluster_member
    db_member | +| [update_bdb](/content/operate/rs/7.4/references/rest-api/permissions.md#update_bdb) | admin
    cluster_member
    db_member | ### Request {#put-request} @@ -216,7 +216,7 @@ PUT /v1/bdbs/1 | Field | Type | Description | |---------|------|---------------| -| dry_run | | Validate the new [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) but don't apply the update. | +| dry_run | | Validate the new [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md) but don't apply the update. | #### URL parameters @@ -226,7 +226,7 @@ PUT /v1/bdbs/1 #### Body -Include a [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) with updated fields in the request body. +Include a [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md) with updated fields in the request body. ##### Example JSON body @@ -241,7 +241,7 @@ The above request attempts to modify a database configuration to enable in-memor ### Response {#put-response} -Returns the updated [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}). +Returns the updated [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md). #### Example JSON body @@ -296,13 +296,13 @@ PUT /v1/bdbs/{int: uid}/{action} ``` Update the configuration of an active database and perform an additional action. -If called with the `dry_run` URL query string, the function will validate the [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) against the existing database, but will not invoke the state machine that will update it. +If called with the `dry_run` URL query string, the function will validate the [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md) against the existing database, but will not invoke the state machine that will update it. #### Permissions | Permission name | Roles | |-----------------|-------| -| [update_bdb_with_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_bdb_with_action" >}}) | admin
    cluster_member
    db_member | +| [update_bdb_with_action](/content/operate/rs/7.4/references/rest-api/permissions.md#update_bdb_with_action) | admin
    cluster_member
    db_member | ### Request {#put-request-action} @@ -332,11 +332,11 @@ The above request resets the admin password after updating the database. | Field | Type | Description | |---------|------|---------------| -| dry_run | | Validate the new [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) but don't apply the update. | +| dry_run | | Validate the new [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md) but don't apply the update. | #### Body -Include a [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) with updated fields in the request body. +Include a [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md) with updated fields in the request body. ##### Example JSON body @@ -349,13 +349,12 @@ Include a [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/b The above request attempts to modify a database configuration to enable in-memory data replication and append-only file data persistence. -{{}} -To change the shard hashing policy, you must flush all keys from the database. -{{}} +> [!NOTE] +> To change the shard hashing policy, you must flush all keys from the database. ### Response {#put-response-action} -If the request succeeds, the response body returns the updated [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}). If an error occurs, the response body may include an error code and message with more details. +If the request succeeds, the response body returns the updated [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md). If an error occurs, the response body may include an error code and message with more details. #### Status codes {#put-status-codes-action} @@ -400,7 +399,7 @@ POST /v1/bdbs ``` Create a new database in the cluster. -The request must contain a single JSON [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) with the configuration parameters for the new database. +The request must contain a single JSON [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md) with the configuration parameters for the new database. The following parameters are required to create the database: @@ -409,9 +408,9 @@ The following parameters are required to create the database: | name | string | Name of the new database | | memory_size | integer | Size of the database, in bytes | -If passed with the `dry_run` URL query string, the function will validate the [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}), but will not invoke the state machine that will create it. +If passed with the `dry_run` URL query string, the function will validate the [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md), but will not invoke the state machine that will create it. -To track this request's progress, poll the [`/actions/` endpoint]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/actions" >}}) with the `action_uid` returned in the response body. +To track this request's progress, poll the [`/actions/` endpoint](/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/_index.md) with the `action_uid` returned in the response body. The cluster will use default configuration for any missing database field. The cluster creates a database UID if it is missing. @@ -419,7 +418,7 @@ The cluster will use default configuration for any missing database field. The c | Permission name | Roles | |-----------------|-------| -| [create_bdb]({{< relref "/operate/rs/7.4/references/rest-api/permissions#create_bdb" >}}) | admin
    cluster_member
    db_member | +| [create_bdb](/content/operate/rs/7.4/references/rest-api/permissions.md#create_bdb) | admin
    cluster_member
    db_member | ### Request {#post-request-v1} @@ -441,11 +440,11 @@ POST /v1/bdbs | Field | Type | Description | |-------|------|-------------| -| dry_run | | Validate the new [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) but don't create the database. | +| dry_run | | Validate the new [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md) but don't create the database. | #### Body -Include a [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) in the request body. +Include a [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md) in the request body. The following parameters are required to create the database: @@ -472,7 +471,7 @@ The above request is an attempt to create a Redis database with a user-specified ### Response {#post-response-v1} -The response includes the newly created [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}). +The response includes the newly created [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md). #### Example JSON body @@ -535,7 +534,7 @@ When errors are reported, the server may return a JSON object with `error_code` ```sh POST /v2/bdbs ``` -Create a new database in the cluster. See [`POST /v1/bdbs`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs#post-bdbs-v1" >}}) for more information. +Create a new database in the cluster. See [`POST /v1/bdbs`](/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md#post-bdbs-v1) for more information. The database's configuration should be under the "bdb" field. @@ -565,11 +564,11 @@ POST /v2/bdbs | Field | Type | Description | |-------|------|-------------| -| dry_run | | Validate the new [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) but don't create the database. | +| dry_run | | Validate the new [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md) but don't create the database. | #### Body -Include a JSON object that contains a [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) and an optional `recovery_plan` object in the request body. +Include a JSON object that contains a [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md) and an optional `recovery_plan` object in the request body. ##### Example JSON body @@ -595,7 +594,7 @@ Include a JSON object that contains a [BDB object]({{< relref "/operate/rs/7.4/r ### Response {#post-response-v2} -The response includes the newly created [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}). +The response includes the newly created [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md). #### Example JSON body @@ -621,7 +620,7 @@ Delete an active database. | Permission name | Roles | |-----------------|-------| -| [delete_bdb]({{< relref "/operate/rs/7.4/references/rest-api/permissions#delete_bdb" >}}) | admin
    cluster_member
    db_member | +| [delete_bdb](/content/operate/rs/7.4/references/rest-api/permissions.md#delete_bdb) | admin
    cluster_member
    db_member | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/_index.md index 66a3867745..e5849103cb 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/_index.md @@ -17,31 +17,31 @@ url: '/operate/rs/7.4/references/rest-api/requests/bdbs/actions/' | Method | Path | Description | |--------|------|-------------| -| [PUT]({{< relref "./backup_reset_status#put-bdbs-actions-backup-reset-status" >}}) | `/v1/bdbs/{uid}/actions/backup_reset_status` | Reset database backup status | +| [PUT](./backup_reset_status#put-bdbs-actions-backup-reset-status) | `/v1/bdbs/{uid}/actions/backup_reset_status` | Reset database backup status | ## Export | Method | Path | Description | |--------|------|-------------| -| [PUT]({{< relref "./export_reset_status#put-bdbs-actions-export-reset-status" >}}) | `/v1/bdbs/{uid}/actions/export_reset_status` | Reset database export status | -| [POST]({{< relref "./export#post-bdbs-actions-export" >}}) | `/v1/bdbs/{uid}/actions/export` | Initiate database export | +| [PUT](./export_reset_status#put-bdbs-actions-export-reset-status) | `/v1/bdbs/{uid}/actions/export_reset_status` | Reset database export status | +| [POST](./export#post-bdbs-actions-export) | `/v1/bdbs/{uid}/actions/export` | Initiate database export | ## Import | Method | Path | Description | |--------|------|-------------| -| [PUT]({{< relref "./import_reset_status#put-bdbs-actions-import-reset-status" >}}) | `/v1/bdbs/{uid}/actions/import_reset_status` | Reset database import status | -| [POST]({{< relref "./import#post-bdbs-actions-import" >}}) | `/v1/bdbs/{uid}/actions/import` | Initiate manual dataset import | +| [PUT](./import_reset_status#put-bdbs-actions-import-reset-status) | `/v1/bdbs/{uid}/actions/import_reset_status` | Reset database import status | +| [POST](./import#post-bdbs-actions-import) | `/v1/bdbs/{uid}/actions/import` | Initiate manual dataset import | ## Optimize shards placement | Method | Path | Description | |--------|------|-------------| -| [GET]({{< relref "./optimize_shards_placement#get-bdbs-actions-optimize-shards-placement" >}}) | `/v1/bdbs/{uid}/actions/optimize_shards_placement` | Get optimized shards placement for a database | +| [GET](./optimize_shards_placement#get-bdbs-actions-optimize-shards-placement) | `/v1/bdbs/{uid}/actions/optimize_shards_placement` | Get optimized shards placement for a database | ## Recover | Method | Path | Description | |--------|------|-------------| -| [GET]({{}}) | `/v1/bdbs/{uid}/actions/recover` | Get database recovery plan | -| [POST]({{}}) | `/v1/bdbs/{uid}/actions/recover` | Recover database | +| [GET](/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/recover.md#get-bdbs-actions-recover) | `/v1/bdbs/{uid}/actions/recover` | Get database recovery plan | +| [POST](/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/recover.md#post-bdbs-actions-recover) | `/v1/bdbs/{uid}/actions/recover` | Recover database | diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/backup_reset_status.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/backup_reset_status.md index 37af6b8f4c..86a988f4b6 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/backup_reset_status.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/backup_reset_status.md @@ -28,7 +28,7 @@ Resets the database's `backup_status` to idle if a backup is not in progress and | Permission name | Roles | |-----------------|-------| -| [reset_bdb_current_backup_status]({{< relref "/operate/rs/7.4/references/rest-api/permissions#reset_bdb_current_backup_status" >}}) | admin
    cluster_member
    db_member | +| [reset_bdb_current_backup_status](/content/operate/rs/7.4/references/rest-api/permissions.md#reset_bdb_current_backup_status) | admin
    cluster_member
    db_member | ### Request {#put-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export.md index ceb36e50d7..457d448669 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export.md @@ -28,7 +28,7 @@ Initiate a database export. | Permission name | Roles | |-----------------|-------| -| [start_bdb_export]({{< relref "/operate/rs/7.4/references/rest-api/permissions#start_bdb_export" >}}) | admin
    cluster_member
    db_member | +| [start_bdb_export](/content/operate/rs/7.4/references/rest-api/permissions.md#start_bdb_export) | admin
    cluster_member
    db_member | ### Request {#post-request} @@ -59,7 +59,7 @@ The request body should contain a JSON object with the following export paramete | Field | Type | Description | |-------|------|-------------| -| export_location | [backup_location/export_location]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/backup_location" >}}) object | Details for the export destination. Call [`GET /v1/jsonschema`]({{< relref "/operate/rs/7.4/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `backup_location` field to retrieve the object's structure. | +| export_location | [backup_location/export_location](/content/operate/rs/7.4/references/rest-api/objects/bdb/backup_location.md) object | Details for the export destination. Call [`GET /v1/jsonschema`](/content/operate/rs/7.4/references/rest-api/requests/jsonschema/_index.md#get-jsonschema) on the bdb object and review the `backup_location` field to retrieve the object's structure. | | email_notification | boolean | Enable/disable an email notification on export failure/ completion. (optional) | ##### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export_reset_status.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export_reset_status.md index 481eacfcfe..74ca1bb543 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export_reset_status.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export_reset_status.md @@ -26,7 +26,7 @@ Resets the database's `export_status` to idle if an export is not in progress an | Permission name | Roles | |-----------------|-------| -| [reset_bdb_current_export_status]({{< relref "/operate/rs/7.4/references/rest-api/permissions#reset_bdb_current_export_status" >}}) | admin
    cluster_member
    db_member | +| [reset_bdb_current_export_status](/content/operate/rs/7.4/references/rest-api/permissions.md#reset_bdb_current_export_status) | admin
    cluster_member
    db_member | ### Request {#put-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import.md index a68212489c..259fe7f0fa 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import.md @@ -28,7 +28,7 @@ Initiate a manual import process. | Permission name | Roles | |-----------------|-------| -| [start_bdb_import]({{< relref "/operate/rs/7.4/references/rest-api/permissions#start_bdb_import" >}}) | admin
    cluster_member
    db_member | +| [start_bdb_import](/content/operate/rs/7.4/references/rest-api/permissions.md#start_bdb_import) | admin
    cluster_member
    db_member | ### Request {#post-request} @@ -54,16 +54,15 @@ POST /v1/bdbs/1/actions/import #### Body -The request _may_ contain a subset of the [BDB JSON object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}), which includes the following import-related attributes: +The request _may_ contain a subset of the [BDB JSON object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md), which includes the following import-related attributes: | Field | Type | Description | |-------|------|-------------| -| dataset_import_sources | array of [dataset_import_sources]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/dataset_import_sources" >}}) objects | Details for the import sources. Call [`GET /v1/jsonschema`]({{< relref "/operate/rs/7.4/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `dataset_import_sources` field to retrieve the object's structure. | +| dataset_import_sources | array of [dataset_import_sources](/content/operate/rs/7.4/references/rest-api/objects/bdb/dataset_import_sources.md) objects | Details for the import sources. Call [`GET /v1/jsonschema`](/content/operate/rs/7.4/references/rest-api/requests/jsonschema/_index.md#get-jsonschema) on the bdb object and review the `dataset_import_sources` field to retrieve the object's structure. | | email_notification | boolean | Enable/disable an email notification on import failure/ completion. (optional) | -{{}} -Other attributes are not allowed and will cause the request to fail. -{{}} +> [!NOTE] +> Other attributes are not allowed and will cause the request to fail. ##### Example JSON Body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import_reset_status.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import_reset_status.md index bdfb8d7d27..0c63d70ba2 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import_reset_status.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import_reset_status.md @@ -26,7 +26,7 @@ Reset the database’s `import_status` to idle if a backup is not in progress an | Permission name | Roles | |-----------------|-------| -| [reset_bdb_current_import_status]({{< relref "/operate/rs/7.4/references/rest-api/permissions#reset_bdb_current_import_status" >}}) | admin
    cluster_member
    db_member | +| [reset_bdb_current_import_status](/content/operate/rs/7.4/references/rest-api/permissions.md#reset_bdb_current_import_status) | admin
    cluster_member
    db_member | ### Request {#put-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md index 40d57812f7..c753911548 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md @@ -29,7 +29,7 @@ Get optimized shards placement for the given database. | Permission name | Roles | |-----------------|-------| -| [view_bdb_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_bdb_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} @@ -125,9 +125,9 @@ To rearrange the database shards, you can submit the blueprint returned in this ## Rearrange database shards {#put-bdbs-rearrange-shards} -Use the blueprint returned by the [`GET` `/v1/bdbs/{uid}/actions/optimize_shards_placement`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement#get-bdbs-actions-optimize-shards-placement" >}}) request as the value of the `shards_blueprint` field to rearrange the database shards. +Use the blueprint returned by the [`GET` `/v1/bdbs/{uid}/actions/optimize_shards_placement`](/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md#get-bdbs-actions-optimize-shards-placement) request as the value of the `shards_blueprint` field to rearrange the database shards. -To ensure that the optimized shard placement is relevant for the current cluster state, pass the `cluster-state-id`, taken from the response header of the `GET` request, in the [`PUT` `/v1/bdbs/{uid}`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs#put-bdbs" >}}) request headers. +To ensure that the optimized shard placement is relevant for the current cluster state, pass the `cluster-state-id`, taken from the response header of the `GET` request, in the [`PUT` `/v1/bdbs/{uid}`](/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md#put-bdbs) request headers. The cluster will reject the update if its state was changed since the optimal shards placement was obtained. @@ -166,6 +166,5 @@ PUT /v1/bdbs/1 } ``` -{{}} -If you submit such an optimized blueprint, it may cause strain on the cluster and its resources. Use with caution. -{{}} +> [!WARNING] +> If you submit such an optimized blueprint, it may cause strain on the cluster and its resources. Use with caution. diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/recover.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/recover.md index 5e65b4e5b0..5a86d70e6b 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/recover.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/recover.md @@ -29,7 +29,7 @@ Fetches the recovery plan for a database. The recovery plan provides information | Permission name | Roles | |-----------------|-------| -| [view_bdb_recovery_plan]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_recovery_plan" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_bdb_recovery_plan](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_recovery_plan) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} @@ -90,13 +90,13 @@ Returns a JSON object that represents the database's recovery plan, including re POST /v1/bdbs/{int: uid}/actions/recover ``` -Initiates [recovery for a database]({{}}) in a recoverable state where all the database's files are available after [cluster recovery]({{}}). +Initiates [recovery for a database](/content/operate/rs/databases/recover.md) in a recoverable state where all the database's files are available after [cluster recovery](/content/operate/rs/7.4/clusters/cluster-recovery.md). #### Required permissions | Permission name | Roles | |-----------------|-------| -| [start_bdb_recovery]({{< relref "/operate/rs/7.4/references/rest-api/permissions#start_bdb_recovery" >}}) | admin
    cluster_member
    db_member | +| [start_bdb_recovery](/content/operate/rs/7.4/references/rest-api/permissions.md#start_bdb_recovery) | admin
    cluster_member
    db_member | ### Request {#post-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/alerts.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/alerts.md index b2e32d3cef..d6ab123290 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/alerts.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/alerts.md @@ -29,7 +29,7 @@ Get all alert states for all databases. | Permission name | |-----------------| -| [view_all_bdbs_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_bdbs_alerts" >}}) | +| [view_all_bdbs_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_bdbs_alerts) | ### Request {#get-all-request} @@ -46,7 +46,7 @@ Get all alert states for all databases. ### Response {#get-all-response} -Returns a hash of alert UIDs and the [alerts]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) states for each database. +Returns a hash of alert UIDs and the [alerts](/content/operate/rs/7.4/references/rest-api/objects/alert.md) states for each database. #### Example JSON body @@ -87,7 +87,7 @@ Get all alert states for a database. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_alerts) | ### Request {#get-request-alerts} @@ -104,7 +104,7 @@ Get all alert states for a database. ### Response {#get-response-alerts} -Returns a hash of [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects](/content/operate/rs/7.4/references/rest-api/objects/alert.md) and their states. #### Example JSON body @@ -143,7 +143,7 @@ Get a database alert state. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_alerts) | ### Request {#get-request} @@ -169,7 +169,7 @@ Get a database alert state. ### Response {#get-response} -Returns an [alert object]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}). +Returns an [alert object](/content/operate/rs/7.4/references/rest-api/objects/alert.md). #### Example JSON body @@ -206,7 +206,7 @@ Updates a database's alerts configuration. | Permission name | |-----------------| -| [update_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_bdb_alerts" >}}) | +| [update_bdb_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#update_bdb_alerts) | ### Request {#post-request} @@ -264,11 +264,11 @@ If passed with the dry_run URL query string, the function will validate the aler #### Request body -The request must contain a single JSON object with one or many database [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}). +The request must contain a single JSON object with one or many database [alert objects](/content/operate/rs/7.4/references/rest-api/objects/alert.md). ### Response {#post-response} -The response includes the updated database [alerts]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}). +The response includes the updated database [alerts](/content/operate/rs/7.4/references/rest-api/objects/alert.md). ### Status codes {#post-status-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/crdt_sources-alerts.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/crdt_sources-alerts.md index 5a42aad26f..a6490c4ee1 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/crdt_sources-alerts.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/crdt_sources-alerts.md @@ -29,7 +29,7 @@ Get all alert states for all CRDT sources of all CRDBs. | Permission name | |-----------------| -| [view_all_bdbs_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_bdbs_alerts" >}}) | +| [view_all_bdbs_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_bdbs_alerts) | ### Request {#get-all-request} @@ -46,7 +46,7 @@ Get all alert states for all CRDT sources of all CRDBs. ### Response {#get-all-response} -Returns a hash of alert UIDs and the [alerts states]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) for each local BDB of CRDB. +Returns a hash of alert UIDs and the [alerts states](/content/operate/rs/7.4/references/rest-api/objects/alert.md) for each local BDB of CRDB. #### Example JSON body @@ -87,7 +87,7 @@ Get all alert states for all crdt sources for a specific local bdb of a CRDB. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_alerts) | ### Request {#get-request-all-crdt-alerts} @@ -110,7 +110,7 @@ Get all alert states for all crdt sources for a specific local bdb of a CRDB. ### Response {#get-response-all-crdt-alerts} -Returns a hash of [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects](/content/operate/rs/7.4/references/rest-api/objects/alert.md) and their states. #### Example JSON body @@ -150,7 +150,7 @@ of a CRDB. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_alerts) | ### Request {#get-request-crdt-alerts} @@ -174,7 +174,7 @@ of a CRDB. ### Response {#get-response-crdt-alerts} -Returns a hash of [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects](/content/operate/rs/7.4/references/rest-api/objects/alert.md) and their states. #### Example JSON body @@ -213,7 +213,7 @@ Get a BDB alert state. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_alerts) | ### Request {#get-request-alert} @@ -239,7 +239,7 @@ Get a BDB alert state. ### Response {#get-response-alert} -Returns an [alert object]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}). +Returns an [alert object](/content/operate/rs/7.4/references/rest-api/objects/alert.md). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo.md index 85b7bdb474..afc38f7e3b 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo.md @@ -27,7 +27,7 @@ Downloads a tar file that contains debug info from all databases. | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-all-request} @@ -65,7 +65,7 @@ Downloads a tar file that contains debug info from the database specified by `bd | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/_index.md index 9f232f74f3..fd54b06b61 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/_index.md @@ -16,9 +16,9 @@ url: '/operate/rs/7.4/references/rest-api/requests/bdbs/modules/' ## Configure module | Method | Path | Description | |--------|------|-------------| -| [POST]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/modules/config#post-bdb-modules-config" >}}) | `/v1/bdbs/{uid}/modules/config` | Configure module | +| [POST](/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/config.md#post-bdb-modules-config) | `/v1/bdbs/{uid}/modules/config` | Configure module | ## Upgrade module | Method | Path | Description | |--------|------|-------------| -| [POST]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/modules/upgrade#post-bdb-modules-upgrade" >}}) | `/v1/bdbs/{uid}/modules/upgrade` | Upgrade module | +| [POST](/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/upgrade.md#post-bdb-modules-upgrade) | `/v1/bdbs/{uid}/modules/upgrade` | Upgrade module | diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/config.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/config.md index fe053c693d..9eb7c8f045 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/config.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/config.md @@ -26,7 +26,7 @@ Use the module runtime configuration command (if defined) to configure new argum | Permission name | |-----------------| -| [edit_bdb_module]({{< relref "/operate/rs/7.4/references/rest-api/permissions#edit_bdb_module" >}}) | +| [edit_bdb_module](/content/operate/rs/7.4/references/rest-api/permissions.md#edit_bdb_module) | ### Request {#post-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/upgrade.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/upgrade.md index 9ce3a26a79..f48c4bd4d9 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/upgrade.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/upgrade.md @@ -26,7 +26,7 @@ Upgrades module version on a specific BDB. | Permission name | |-----------------| -| [edit_bdb_module]({{< relref "/operate/rs/7.4/references/rest-api/permissions#edit_bdb_module" >}}) | +| [edit_bdb_module](/content/operate/rs/7.4/references/rest-api/permissions.md#edit_bdb_module) | ### Request {#post-request} @@ -67,7 +67,7 @@ Upgrades module version on a specific BDB. ### Response {#post-response} -Returns the upgraded [module object]({{< relref "/operate/rs/7.4/references/rest-api/objects/module" >}}). +Returns the upgraded [module object](/content/operate/rs/7.4/references/rest-api/objects/module.md). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/passwords.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/passwords.md index deb7e657cf..1e0ca51b5b 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/passwords.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/passwords.md @@ -28,7 +28,7 @@ Set a single password for the bdb's default user (i.e., for `AUTH` `}}) | +| [update_bdb](/content/operate/rs/7.4/references/rest-api/permissions.md#update_bdb) | ### Request {#put-request} @@ -89,7 +89,7 @@ Add a password to the bdb's default user (i.e., for `AUTH` `` aut | Permission name | |-----------------| -| [update_bdb]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_bdb" >}}) | +| [update_bdb](/content/operate/rs/7.4/references/rest-api/permissions.md#update_bdb) | ### Request {#post-request} @@ -148,7 +148,7 @@ Delete a password from the bdb's default user (i.e., for `AUTH` ` | Permission name | |-----------------| -| [update_bdb]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_bdb" >}}) | +| [update_bdb](/content/operate/rs/7.4/references/rest-api/permissions.md#update_bdb) | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/peer_stats.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/peer_stats.md index 4e8f3e9fda..f833ba3691 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/peer_stats.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/peer_stats.md @@ -29,7 +29,7 @@ Get statistics for all peer instances of a local CRDB instance. | Permission name | Roles | |-----------------|-------| -| [view_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_stats" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_bdb_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_stats) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-all-request} @@ -62,7 +62,7 @@ GET /v1/bdbs/1/peer_stats?interval=5min ### Response {#get-all-response} -Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all CRDB peer instances. +Returns [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for all CRDB peer instances. #### Example JSON body @@ -121,7 +121,7 @@ Get statistics for a specific CRDB peer instance. | Permission name | Roles | |-----------------|-------| -| [view_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_stats" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_bdb_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_stats) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} @@ -155,7 +155,7 @@ GET /v1/bdbs/1/peer_stats/3?interval=5min ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for a specific CRDB peer instance. +Returns [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for a specific CRDB peer instance. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/replica_sources-alerts.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/replica_sources-alerts.md index f74be5c6db..7f6d96e5f9 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/replica_sources-alerts.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/replica_sources-alerts.md @@ -29,7 +29,7 @@ Get all alert states for all replica sources of all BDBs. | Permission name | |-----------------| -| [view_all_bdbs_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_bdbs_alerts" >}}) | +| [view_all_bdbs_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_bdbs_alerts) | ### Request {#get-all-request} @@ -48,7 +48,7 @@ Get all alert states for all replica sources of all BDBs. Returns a hash of alert UIDs and the alerts states for each BDB. -See [REST API alerts overview]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) for a description of the alert state object. +See [REST API alerts overview](/content/operate/rs/7.4/references/rest-api/objects/alert.md) for a description of the alert state object. #### Example JSON body @@ -89,7 +89,7 @@ Get all alert states for all replica sources of a specific bdb. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_alerts) | ### Request {#get-request-all-replica-alerts} @@ -112,7 +112,7 @@ Get all alert states for all replica sources of a specific bdb. ### Response {#get-response-all-replica-alerts} -Returns a hash of [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects](/content/operate/rs/7.4/references/rest-api/objects/alert.md) and their states. #### Example JSON body @@ -151,7 +151,7 @@ Get all alert states for a specific replica source of a bdb. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_alerts) | ### Request {#get-request-replica-alerts} @@ -175,7 +175,7 @@ Get all alert states for a specific replica source of a bdb. ### Response {#get-response-replica-alerts} -Returns a hash of [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects](/content/operate/rs/7.4/references/rest-api/objects/alert.md) and their states. #### Example JSON body @@ -214,7 +214,7 @@ Get a replica source alert state of a specific bdb. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_alerts) | ### Request {#get-request-alert} @@ -240,7 +240,7 @@ Get a replica source alert state of a specific bdb. ### Response {#get-response-alert} -Returns an [alert state object]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}). +Returns an [alert state object](/content/operate/rs/7.4/references/rest-api/objects/alert.md). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/shards.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/shards.md index 7c0e2f8ac6..bbda1df533 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/shards.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/shards.md @@ -43,7 +43,7 @@ Gets the status for all shards that belong to the specified database. ### Response {#get-response} -The response body contains a JSON array with all shards, represented as [shard objects]({{}}). +The response body contains a JSON array with all shards, represented as [shard objects](/content/operate/rs/7.4/references/rest-api/objects/shard/_index.md). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/_index.md index 15e5ac22c9..4f7eacb4c5 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/_index.md @@ -30,7 +30,7 @@ Get statistics for all databases. | Permission name | Roles | |-----------------|-------| -| [view_all_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_bdb_stats" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_all_bdb_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_bdb_stats) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-all-request} @@ -57,7 +57,7 @@ GET /v1/bdbs/stats?interval=1hour&stime=2014-08-28T10:00:00Z ### Response {#get-all-response} -Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all databases. +Returns [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for all databases. #### Example JSON body @@ -171,7 +171,7 @@ Get statistics for a specific database. | Permission name | Roles | |-----------------|-------| -| [view_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_stats" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_bdb_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_stats) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} @@ -204,7 +204,7 @@ GET /v1/bdbs/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for a specific database. +Returns [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for a specific database. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/last.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/last.md index 2b630c0e15..971c7ebc9a 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/last.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/last.md @@ -29,7 +29,7 @@ Get the most recent statistics for all databases. | Permission name | Roles | |-----------------|-------| -| [view_all_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_bdb_stats" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_all_bdb_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_bdb_stats) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-all-request} @@ -60,7 +60,7 @@ Get the most recent statistics for all databases. ### Response {#get-all-response} -Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all databases. +Returns [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for all databases. #### Example JSON body @@ -147,7 +147,7 @@ Get the most recent statistics for a specific database. | Permission name | Roles | |-----------------|-------| -| [view_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_stats" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_bdb_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_stats) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} @@ -178,7 +178,7 @@ GET /v1/bdbs/stats/last/1?metrics=no_of_keys,used_memory ### Response {#get-response} -Returns the most recent [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for a specific database. +Returns the most recent [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for a specific database. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/sync_source_stats.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/sync_source_stats.md index b5ffe3e298..273e13b805 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/sync_source_stats.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/sync_source_stats.md @@ -29,7 +29,7 @@ Get stats for all syncer sources of a local database. | Permission name | Roles | |-----------------|-------| -| [view_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_stats" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_bdb_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_stats) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-all-request} @@ -62,7 +62,7 @@ GET /v1/bdbs/1/sync_source_stats?interval=5min ### Response {#get-all-response} -Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all syncer sources. +Returns [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for all syncer sources. #### Example JSON body @@ -112,7 +112,7 @@ Get stats for a specific syncer (Replica Of) instance. | Permission name | Roles | |-----------------|-------| -| [view_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_stats" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_bdb_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_stats) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} @@ -146,7 +146,7 @@ GET /v1/bdbs/1/sync_source_stats/1?interval=5min ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for a specific syncer instance. +Returns [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for a specific syncer instance. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/_index.md index 7128502722..006b521e8e 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/_index.md @@ -25,15 +25,14 @@ GET /v1/bdbs/{int: uid}/syncer_state Get a CRDB's syncer state as JSON. -{{}} -This endpoint is deprecated as of Redis Enterprise Software version 7.2.4 and will be removed in a future release. Use [`/v1/bdbs//syncer_state/crdt`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/crdt" >}}) instead. -{{}} +> [!WARNING] +> This endpoint is deprecated as of Redis Enterprise Software version 7.2.4 and will be removed in a future release. Use [`/v1/bdbs//syncer_state/crdt`](/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/crdt.md) instead. ### Permissions | Permission name | Roles | |-----------------|---------| -| [view_bdb_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_bdb_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/crdt.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/crdt.md index e40faacdc3..bedb0d46cc 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/crdt.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/crdt.md @@ -28,7 +28,7 @@ Get a CRDB's syncer state as JSON. | Permission name | Roles | |-----------------|---------| -| [view_bdb_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_bdb_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/replica.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/replica.md index 67db359d0a..ede3408882 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/replica.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/replica.md @@ -28,7 +28,7 @@ Get a CRDB replica's syncer state as JSON. | Permission name | Roles | |-----------------|---------| -| [view_bdb_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_bdb_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_bdb_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/upgrade.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/upgrade.md index b58829d295..84bea8028e 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/upgrade.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/upgrade.md @@ -26,7 +26,7 @@ Upgrade a database. | Permission name | |-----------------| -| [update_bdb_with_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_bdb_with_action" >}}) | +| [update_bdb_with_action](/content/operate/rs/7.4/references/rest-api/permissions.md#update_bdb_with_action) | ### Request {#post-request} @@ -67,7 +67,7 @@ Upgrade a database. ### Response {#post-response} -Returns the upgraded [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}). +Returns the upgraded [BDB object](/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bootstrap/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bootstrap/_index.md index dc11581005..a923b158c4 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bootstrap/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bootstrap/_index.md @@ -58,7 +58,7 @@ The `bootstrap_status` object contains the following information: | error_code | If state is `error`, this error code describes the type of error encountered. | | error_details | An error-specific object that may contain additional information about the error. A common field in use is `message` which provides a more verbose error message. -The `local_node_info` object is a subset of a [node object]({{< relref "/operate/rs/7.4/references/rest-api/objects/node" >}}) that provides information about the node configuration. +The `local_node_info` object is a subset of a [node object](/content/operate/rs/7.4/references/rest-api/objects/node.md) that provides information about the node configuration. #### Example JSON body @@ -141,7 +141,7 @@ POST /v1/bootstrap/{action} Initiate bootstrapping. The request must contain a bootstrap configuration JSON object, as -described in [Object attributes]({{< relref "/operate/rs/7.4/references/rest-api/objects/" >}}) or a minimal subset. +described in [Object attributes](/content/operate/rs/7.4/references/rest-api/objects/_index.md) or a minimal subset. Bootstrapping is permitted only when the current bootstrap state is `idle` or `error` (in which case the process will restart with the new @@ -226,7 +226,7 @@ POST /v1/bootstrap/create_cluster #### Request body -Include a [bootstrap object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap" >}}) in the request body. +Include a [bootstrap object](/content/operate/rs/7.4/references/rest-api/objects/bootstrap/_index.md) in the request body. ### Response {#post-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bootstrap/validate.md b/content/operate/rs/7.4/references/rest-api/requests/bootstrap/validate.md index cd32b05af9..ab04c17c95 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bootstrap/validate.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bootstrap/validate.md @@ -33,7 +33,7 @@ returns with a response. #### Request body -The request must contain a [bootstrap configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap" >}}), similar to the one used for actual bootstrapping. +The request must contain a [bootstrap configuration object](/content/operate/rs/7.4/references/rest-api/objects/bootstrap/_index.md), similar to the one used for actual bootstrapping. ### Response {#post-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/_index.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/_index.md index 65d64a3e54..78270b6314 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/_index.md @@ -28,7 +28,7 @@ Get cluster info. | Permission name | |-----------------| -| [view_cluster_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_info" >}}) | +| [view_cluster_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_cluster_info) | ### Request {#get-request} @@ -45,7 +45,7 @@ Get cluster info. ### Response {#get-response} -Returns a [cluster object]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster" >}}). +Returns a [cluster object](/content/operate/rs/7.4/references/rest-api/objects/cluster/_index.md). #### Example JSON body @@ -78,14 +78,14 @@ Returns a [cluster object]({{< relref "/operate/rs/7.4/references/rest-api/objec Update cluster settings. If called with the `dry_run` URL query string, the function will -validate the [cluster object]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster" >}}), but will not apply the requested +validate the [cluster object](/content/operate/rs/7.4/references/rest-api/objects/cluster/_index.md), but will not apply the requested changes. #### Required permissions | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster](/content/operate/rs/7.4/references/rest-api/permissions.md#update_cluster) | ### Request {#put-request} @@ -125,7 +125,7 @@ The above request will enable email alerts and alert reporting for node failures #### Request body -Include a [cluster object]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster" >}}) with updated fields in the request body. +Include a [cluster object](/content/operate/rs/7.4/references/rest-api/objects/cluster/_index.md) with updated fields in the request body. ### Response {#put-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/actions.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/actions.md index 65e57c915e..9e06385b04 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/actions.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/actions.md @@ -29,7 +29,7 @@ Get the status of all currently executing, queued, or completed cluster actions. | Permission name | |-----------------| -| [view_status_of_cluster_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action](/content/operate/rs/7.4/references/rest-api/permissions.md#view_status_of_cluster_action) | ### Request {#get-all-request} @@ -39,7 +39,7 @@ Get the status of all currently executing, queued, or completed cluster actions. ### Response {#get-all-response} -Returns a JSON array of [action objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}). +Returns a JSON array of [action objects](/content/operate/rs/7.4/references/rest-api/objects/action.md). #### Example JSON body @@ -72,7 +72,7 @@ Get the status of a currently executing, queued, or completed cluster action. | Permission name | |-----------------| -| [view_status_of_cluster_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action](/content/operate/rs/7.4/references/rest-api/permissions.md#view_status_of_cluster_action) | ### Request {#get-request} @@ -88,7 +88,7 @@ Get the status of a currently executing, queued, or completed cluster action. ### Response {#get-response} -Returns an [action object]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}). +Returns an [action object](/content/operate/rs/7.4/references/rest-api/objects/action.md). #### Example JSON body @@ -125,7 +125,7 @@ removed as soon as the new one is submitted. | Permission name | |-----------------| -| [start_cluster_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#start_cluster_action" >}}) | +| [start_cluster_action](/content/operate/rs/7.4/references/rest-api/permissions.md#start_cluster_action) | ### Request {#post-request} @@ -173,7 +173,7 @@ a previously executed and completed action. | Permission name | |-----------------| -| [cancel_cluster_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#cancel_cluster_action" >}}) | +| [cancel_cluster_action](/content/operate/rs/7.4/references/rest-api/permissions.md#cancel_cluster_action) | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/alerts.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/alerts.md index 85795b066f..088f497a3a 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/alerts.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/alerts.md @@ -27,7 +27,7 @@ Get all alert states for the cluster object. | Permission name | |-----------------| -| [view_cluster_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_alerts" >}}) | +| [view_cluster_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_cluster_alerts) | ### Request {#get-all-request} @@ -50,7 +50,7 @@ Get all alert states for the cluster object. ### Response {#get-all-response} -Returns a hash of [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects](/content/operate/rs/7.4/references/rest-api/objects/alert.md) and their states. #### Example JSON body @@ -85,7 +85,7 @@ Get a cluster alert state. | Permission name | |-----------------| -| [view_cluster_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_alerts" >}}) | +| [view_cluster_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_cluster_alerts) | ### Request {#get-request} @@ -108,7 +108,7 @@ Get a cluster alert state. ### Response {#get-response} -Returns an [alert object]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}). +Returns an [alert object](/content/operate/rs/7.4/references/rest-api/objects/alert.md). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/auditing-db-conns.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/auditing-db-conns.md index 716c96fff1..7d128d1477 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/auditing-db-conns.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/auditing-db-conns.md @@ -22,13 +22,13 @@ url: '/operate/rs/7.4/references/rest-api/requests/cluster/auditing-db-conns/' GET /v1/cluster/auditing/db_conns -Gets the configuration settings for [auditing database connections]({{< relref "/operate/rs/7.4/security/audit-events" >}}). +Gets the configuration settings for [auditing database connections](/content/operate/rs/7.4/security/audit-events.md). #### Required permissions | Permission name | |-----------------| -| [view_cluster_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_info" >}}) | +| [view_cluster_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_cluster_info) | ### Request {#get-request} @@ -46,7 +46,7 @@ Gets the configuration settings for [auditing database connections]({{< relref " ### Response {#get-response} -Returns a [database connection auditing configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/db-conns-auditing-config" >}}). +Returns a [database connection auditing configuration object](/content/operate/rs/7.4/references/rest-api/objects/db-conns-auditing-config.md). #### Example JSON body @@ -79,13 +79,13 @@ When errors are reported, the server may return a JSON object with `error_code` PUT /v1/cluster/auditing/db_conns -Updates the configuration settings for [auditing database connections]({{< relref "/operate/rs/7.4/security/audit-events" >}}). +Updates the configuration settings for [auditing database connections](/content/operate/rs/7.4/security/audit-events.md). #### Required permissions | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster](/content/operate/rs/7.4/references/rest-api/permissions.md#update_cluster) | ### Request {#put-request} @@ -114,11 +114,11 @@ Updates the configuration settings for [auditing database connections]({{< relre #### Request body -Include a [database connection auditing configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/db-conns-auditing-config" >}}) with updated fields in the request body. +Include a [database connection auditing configuration object](/content/operate/rs/7.4/references/rest-api/objects/db-conns-auditing-config.md) with updated fields in the request body. ### Response {#put-response} -Returns the updated [database connection auditing configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/db-conns-auditing-config" >}}). +Returns the updated [database connection auditing configuration object](/content/operate/rs/7.4/references/rest-api/objects/db-conns-auditing-config.md). #### Example JSON body @@ -151,13 +151,13 @@ When errors are reported, the server may return a JSON object with `error_code` DELETE /v1/cluster/auditing/db_conns -Resets the configuration settings for [auditing database connections]({{< relref "/operate/rs/7.4/security/audit-events" >}}). +Resets the configuration settings for [auditing database connections](/content/operate/rs/7.4/security/audit-events.md). #### Required permissions | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster](/content/operate/rs/7.4/references/rest-api/permissions.md#update_cluster) | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/_index.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/_index.md index a568fe751b..442daeaef8 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/_index.md @@ -31,7 +31,7 @@ Get the cluster's certificates. | Permission name | |-----------------| -| [view_cluster_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_info" >}}) | +| [view_cluster_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_cluster_info) | ### Request {#get-request} @@ -76,7 +76,7 @@ PUT /v1/cluster/update_cert Replaces an existing certificate on all nodes within the cluster with a new certificate. The new certificate must pass validation before it can replace the old certificate. -See the [certificates table]({{< relref "/operate/rs/7.4/security/certificates" >}}) for the list of cluster certificates and their descriptions. +See the [certificates table](/content/operate/rs/7.4/security/certificates/_index.md) for the list of cluster certificates and their descriptions. ### Request {#put-request} @@ -122,7 +122,7 @@ Otherwise, retry the certificate update in case the failure was due to a tempora Removes the specified cluster certificate from both CCS and disk across all nodes. Only optional certificates can be deleted through -this endpoint. See the [certificates table]({{< relref "/operate/rs/7.4/security/certificates" >}}) for the list of cluster certificates and their descriptions. +this endpoint. See the [certificates table](/content/operate/rs/7.4/security/certificates/_index.md) for the list of cluster certificates and their descriptions. ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/check.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/check.md index 181a038a77..2a5321b1e5 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/check.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/check.md @@ -38,7 +38,7 @@ Runs the following checks on all cluster nodes: | Permission name | |-----------------| -| [view_all_nodes_checks]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_nodes_checks" >}}) | +| [view_all_nodes_checks](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_nodes_checks) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo.md index 4a6a1044c0..739f5da7fe 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo.md @@ -26,7 +26,7 @@ Downloads a tar file that contains debug info from all nodes and databases. | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/ldap.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/ldap.md index 81c03a80f9..8cd5707c4a 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/ldap.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/ldap.md @@ -28,7 +28,7 @@ Get the LDAP configuration. | Permission name | |-----------------| -| [view_ldap_config]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_ldap_config" >}}) | +| [view_ldap_config](/content/operate/rs/7.4/references/rest-api/permissions.md#view_ldap_config) | ### Request {#get-request} @@ -45,7 +45,7 @@ Get the LDAP configuration. ### Response {#get-response} -Returns an [LDAP object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ldap" >}}). +Returns an [LDAP object](/content/operate/rs/7.4/references/rest-api/objects/ldap.md). #### Example JSON body @@ -81,7 +81,7 @@ Set or update the cluster LDAP configuration. | Permission name | |-----------------| -| [config_ldap]({{< relref "/operate/rs/7.4/references/rest-api/permissions#config_ldap" >}}) | +| [config_ldap](/content/operate/rs/7.4/references/rest-api/permissions.md#config_ldap) | ### Request {#put-request} @@ -114,7 +114,7 @@ Set or update the cluster LDAP configuration. #### Request body -Include an [LDAP object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ldap" >}}) with updated fields in the request body. +Include an [LDAP object](/content/operate/rs/7.4/references/rest-api/objects/ldap.md) with updated fields in the request body. ### Response {#put-response} @@ -145,7 +145,7 @@ Clear the LDAP configuration. | Permission name | |-----------------| -| [config_ldap]({{< relref "/operate/rs/7.4/references/rest-api/permissions#config_ldap" >}}) | +| [config_ldap](/content/operate/rs/7.4/references/rest-api/permissions.md#config_ldap) | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/module-capabilities.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/module-capabilities.md index 3bbae5fb26..d48356728f 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/module-capabilities.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/module-capabilities.md @@ -26,7 +26,7 @@ List possible Redis module capabilities. | Permission name | |-----------------| -| [view_cluster_modules]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_modules" >}}) | +| [view_cluster_modules](/content/operate/rs/7.4/references/rest-api/permissions.md#view_cluster_modules) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/policy.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/policy.md index 7646155ab7..1ab27b04cd 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/policy.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/policy.md @@ -27,7 +27,7 @@ Gets the cluster's current policy settings. | Permission name | |-----------------| -| [view_cluster_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_info" >}}) | +| [view_cluster_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_cluster_info) | ### Request {#get-request} @@ -45,7 +45,7 @@ Gets the cluster's current policy settings. ### Response {#get-response} -Returns a [cluster settings object]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster_settings" >}}). +Returns a [cluster settings object](/content/operate/rs/7.4/references/rest-api/objects/cluster_settings.md). #### Example JSON body @@ -77,7 +77,7 @@ Update cluster policy settings. | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster](/content/operate/rs/7.4/references/rest-api/permissions.md#update_cluster) | ### Request {#put-request} @@ -103,7 +103,7 @@ Update cluster policy settings. #### Request body -Include a [cluster settings object]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster_settings" >}}) with updated fields in the request body. +Include a [cluster settings object](/content/operate/rs/7.4/references/rest-api/objects/cluster_settings.md) with updated fields in the request body. ### Response {#put-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration.md index 1dda89ebae..74fd7c7c2a 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration.md @@ -27,7 +27,7 @@ Get cluster services settings. | Permission name | |-----------------| -| [view_cluster_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_info" >}}) | +| [view_cluster_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_cluster_info) | ### Request {#get-request} @@ -44,7 +44,7 @@ Get cluster services settings. ### Response {#get-response} -Returns a [services configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration" >}}). +Returns a [services configuration object](/content/operate/rs/7.4/references/rest-api/objects/services_configuration/_index.md). #### Example JSON body @@ -76,7 +76,7 @@ Update the cluster services settings. | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster](/content/operate/rs/7.4/references/rest-api/permissions.md#update_cluster) | ### Request {#put-request} @@ -104,11 +104,11 @@ Update the cluster services settings. #### Request body -Include a [services configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration" >}}) with updated fields in the request body. +Include a [services configuration object](/content/operate/rs/7.4/references/rest-api/objects/services_configuration/_index.md) with updated fields in the request body. ### Response {#put-response} -Returns the updated [services configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration" >}}). +Returns the updated [services configuration object](/content/operate/rs/7.4/references/rest-api/objects/services_configuration/_index.md). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/_index.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/_index.md index 8f7105b98f..d5c8ea4c54 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/_index.md @@ -29,7 +29,7 @@ Get cluster statistics. | Permission name | Roles | |-----------------|-------| -| [view_cluster_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_stats" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_cluster_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_cluster_stats) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} @@ -56,7 +56,7 @@ GET /v1/cluster/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for the cluster. +Returns [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for the cluster. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/last.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/last.md index 0d0efb1886..85a608c36a 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/last.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/last.md @@ -26,7 +26,7 @@ Get the most recent cluster statistics. | Permission name | |-----------------| -| [view_cluster_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_stats" >}}) | +| [view_cluster_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_cluster_stats) | ### Request {#get-request} @@ -52,7 +52,7 @@ Get the most recent cluster statistics. ### Response {#get-response} -Returns the most recent [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for the cluster. +Returns the most recent [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for the cluster. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdb_tasks/_index.md b/content/operate/rs/7.4/references/rest-api/requests/crdb_tasks/_index.md index 94ba85f0b3..19bbdf4105 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdb_tasks/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdb_tasks/_index.md @@ -37,7 +37,7 @@ GET /v1/crdb_tasks ### Response {#get-all-response} -Returns a JSON array of [CRDB task objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb_task" >}}). +Returns a JSON array of [CRDB task objects](/content/operate/rs/7.4/references/rest-api/objects/crdb_task.md). #### Status codes {#get-all-status-codes} @@ -80,7 +80,7 @@ The status of a completed task is kept for 500 seconds by default. ### Response {#get-response} -Returns a [CRDB task object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object](/content/operate/rs/7.4/references/rest-api/objects/crdb_task.md). ### Status codes {#get-status-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdbs/_index.md b/content/operate/rs/7.4/references/rest-api/requests/crdbs/_index.md index 7666e69eaa..1aadeef3d8 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdbs/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdbs/_index.md @@ -46,7 +46,7 @@ GET /v1/crdbs ### Response {#get-all-response} -Returns a JSON array of [CRDB objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb" >}}). +Returns a JSON array of [CRDB objects](/content/operate/rs/7.4/references/rest-api/objects/crdb/_index.md). ##### Status codes {#get-all-status-codes} @@ -92,7 +92,7 @@ Get a specific Active-Active database. ### Response {#get-response} -Returns a [CRDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb" >}}). +Returns a [CRDB object](/content/operate/rs/7.4/references/rest-api/objects/crdb/_index.md). #### Status codes {#get-status-codes} @@ -110,7 +110,7 @@ PATCH /v1/crdbs/{crdb_guid} Update an Active-Active database's configuration. -In order to add or remove instances, use [`POST crdbs/{crdb_guid}/updates`]({{< relref "/operate/rs/7.4/references/rest-api/requests/crdbs/updates#post-crdbs-updates" >}}) instead. +In order to add or remove instances, use [`POST crdbs/{crdb_guid}/updates`](/content/operate/rs/7.4/references/rest-api/requests/crdbs/updates.md#post-crdbs-updates) instead. ### Request {#patch-request} @@ -135,11 +135,11 @@ In order to add or remove instances, use [`POST crdbs/{crdb_guid}/updates` #### Request body -Include a [CRDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb" >}}) with updated fields in the request body. +Include a [CRDB object](/content/operate/rs/7.4/references/rest-api/objects/crdb/_index.md) with updated fields in the request body. ### Response {#patch-response} -Returns a [CRDB task object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object](/content/operate/rs/7.4/references/rest-api/objects/crdb_task.md). #### Status codes {#patch-status-codes} @@ -182,7 +182,7 @@ Create a new Active-Active database. #### Request body -Include a [CRDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb" >}}), which defines the Active-Active database, in the request body. +Include a [CRDB object](/content/operate/rs/7.4/references/rest-api/objects/crdb/_index.md), which defines the Active-Active database, in the request body. ##### Example body @@ -230,7 +230,7 @@ This JSON body creates an Active-Active database without TLS and with two partic ### Response {#post-response} -Returns a [CRDB task object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object](/content/operate/rs/7.4/references/rest-api/objects/crdb_task.md). #### Status codes {#post-status-codes} @@ -272,7 +272,7 @@ Delete an Active-Active database. ### Response {#delete-response} -Returns a [CRDB task object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object](/content/operate/rs/7.4/references/rest-api/objects/crdb_task.md). #### Status codes {#delete-status-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdbs/flush.md b/content/operate/rs/7.4/references/rest-api/requests/crdbs/flush.md index f88aed8bd0..b7ec2ef2d6 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdbs/flush.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdbs/flush.md @@ -55,7 +55,7 @@ PUT /v1/crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79/flush ### Response {#put-response} -Returns a [CRDB task object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object](/content/operate/rs/7.4/references/rest-api/objects/crdb_task.md). #### Status codes {#put-status-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdbs/health_report.md b/content/operate/rs/7.4/references/rest-api/requests/crdbs/health_report.md index 880163e03e..cf3a37b2f7 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdbs/health_report.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdbs/health_report.md @@ -42,7 +42,7 @@ Get a health report for an Active-Active database. ### Response {#get-response} -Returns a JSON array of [CRDB health report objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/health_report" >}}). +Returns a JSON array of [CRDB health report objects](/content/operate/rs/7.4/references/rest-api/objects/crdb/health_report/_index.md). ### Status codes {#get-status-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdbs/purge.md b/content/operate/rs/7.4/references/rest-api/requests/crdbs/purge.md index 4283ec4f86..81dcb0c6a1 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdbs/purge.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdbs/purge.md @@ -51,7 +51,7 @@ removed instance). ### Response {#put-response} -Returns a [CRDB task object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object](/content/operate/rs/7.4/references/rest-api/objects/crdb_task.md). ### Status codes {#put-status-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdbs/updates.md b/content/operate/rs/7.4/references/rest-api/requests/crdbs/updates.md index 8a185a683e..df259fd755 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdbs/updates.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdbs/updates.md @@ -22,9 +22,8 @@ url: '/operate/rs/7.4/references/rest-api/requests/crdbs/updates/' Modify Active-Active configuration. -{{}} -This is a very powerful API request and can cause damage if used incorrectly. -{{}} +> [!WARNING] +> This is a very powerful API request and can cause damage if used incorrectly. In order to add or remove instances, you must use this API. For simple configuration updates, it is recommended to use PATCH on /crdbs/{crdb_guid} instead. @@ -59,11 +58,11 @@ When you update db_config, it changes the configuration of the database that you #### Request body -Include a [CRDB modify_request object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/modify_request" >}}) with updated fields in the request body. +Include a [CRDB modify_request object](/content/operate/rs/7.4/references/rest-api/objects/crdb/modify_request.md) with updated fields in the request body. ### Response {#post-response} -Returns a [CRDB task object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object](/content/operate/rs/7.4/references/rest-api/objects/crdb_task.md). ### Status codes {#post-status-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/_index.md b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/_index.md index ffa5a19872..642d1e25e7 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/_index.md @@ -13,7 +13,7 @@ url: '/operate/rs/7.4/references/rest-api/requests/debuginfo/' --- {{}} -These REST API paths are deprecated as of Redis Enterprise Software version 7.4.2. Use the new paths [`/v1/cluster/debuginfo`]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo" >}}), [`/v1/nodes/debuginfo`]({{< relref "/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo" >}}), and [`/v1/bdbs/debuginfo`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo" >}}) instead. +These REST API paths are deprecated as of Redis Enterprise Software version 7.4.2. Use the new paths [`/v1/cluster/debuginfo`](/content/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo.md), [`/v1/nodes/debuginfo`](/content/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo.md), and [`/v1/bdbs/debuginfo`](/content/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo.md) instead. {{}} Downloads a support package, which includes logs and information about the cluster, nodes, databases, and shards, as a tar file called `filename.tar.gz`. Extract the files from the tar file to access the debug info. @@ -22,12 +22,12 @@ Downloads a support package, which includes logs and information about the clust | Method | Path | Description | |--------|------|-------------| -| [GET]({{< relref "./all#get-all-debuginfo" >}}) | `/v1/debuginfo/all` | Gets debug info for all nodes | -| [GET]({{< relref "./all/bdb#get-all-debuginfo-bdb" >}}) | `/v1/debuginfo/all/bdb/{bdb_uid}` | Gets debug info for a database from all nodes | +| [GET](./all#get-all-debuginfo) | `/v1/debuginfo/all` | Gets debug info for all nodes | +| [GET](./all/bdb#get-all-debuginfo-bdb) | `/v1/debuginfo/all/bdb/{bdb_uid}` | Gets debug info for a database from all nodes | ## Get debug info for the current node | Method | Path | Description | |--------|------|-------------| -| [GET]({{< relref "./node#get-debuginfo-node" >}}) | `/v1/debuginfo/node` | Gets debug info for the current node | -| [GET]({{< relref "./node/bdb#get-debuginfo-node-bdb" >}}) | `/v1/debuginfo/node/bdb/{bdb_uid}` | Gets debug info for a database from the current node | +| [GET](./node#get-debuginfo-node) | `/v1/debuginfo/node` | Gets debug info for the current node | +| [GET](./node/bdb#get-debuginfo-node-bdb) | `/v1/debuginfo/node/bdb/{bdb_uid}` | Gets debug info for a database from the current node | diff --git a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/_index.md b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/_index.md index d780c7e262..38052bf9e1 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/_index.md @@ -14,7 +14,7 @@ url: '/operate/rs/7.4/references/rest-api/requests/debuginfo/all/' --- {{}} -This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/cluster/debuginfo`]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo" >}}) instead. +This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/cluster/debuginfo`](/content/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo.md) instead. {{}} | Method | Path | Description | @@ -31,7 +31,7 @@ Downloads a tar file that contains debug info from all nodes. | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-all-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/bdb.md b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/bdb.md index a25969eb93..4dbea16c82 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/bdb.md +++ b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/bdb.md @@ -13,7 +13,7 @@ url: '/operate/rs/7.4/references/rest-api/requests/debuginfo/all/bdb/' --- {{}} -This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/bdbs/debuginfo`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo" >}}) instead. +This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/bdbs/debuginfo`](/content/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo.md) instead. {{}} | Method | Path | Description | @@ -30,7 +30,7 @@ Downloads a tar file that contains debug info for the specified database (`bdb_u | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-all-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/_index.md b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/_index.md index 6e110de7a2..76cede5acf 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/_index.md @@ -14,7 +14,7 @@ url: '/operate/rs/7.4/references/rest-api/requests/debuginfo/node/' --- {{}} -This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/nodes/debuginfo`]({{< relref "/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo" >}}) instead. +This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/nodes/debuginfo`](/content/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo.md) instead. {{}} | Method | Path | Description | @@ -31,7 +31,7 @@ Downloads a tar file that contains debug info for the current node. | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb.md b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb.md index f2545af119..f30547dbd4 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb.md +++ b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb.md @@ -13,7 +13,7 @@ url: '/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb/' --- {{}} -This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/bdbs/debuginfo`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo" >}}) instead. +This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/bdbs/debuginfo`](/content/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo.md) instead. {{}} | Method | Path | Description | @@ -30,7 +30,7 @@ Downloads a tar file that contains debug info for the specified database (`bdb_u | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/endpoints-stats/_index.md b/content/operate/rs/7.4/references/rest-api/requests/endpoints-stats/_index.md index 13a90dbc57..8d3b2636dd 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/endpoints-stats/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/endpoints-stats/_index.md @@ -23,16 +23,15 @@ url: '/operate/rs/7.4/references/rest-api/requests/endpoints-stats/' Get statistics for all endpoint-proxy links. -{{}} -This method will return both endpoints and listeners stats for backwards -compatability. -{{}} +> [!NOTE] +> This method will return both endpoints and listeners stats for backwards +> compatability. #### Required permissions | Permission name | |-----------------| -| [view_endpoint_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_endpoint_stats" >}}) | +| [view_endpoint_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_endpoint_stats) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/jsonschema/_index.md b/content/operate/rs/7.4/references/rest-api/requests/jsonschema/_index.md index c119b6daff..1ccaebc4db 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/jsonschema/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/jsonschema/_index.md @@ -21,7 +21,7 @@ url: '/operate/rs/7.4/references/rest-api/requests/jsonschema/' GET /v1/jsonschema -Get the JSON schema of various [Redis Enterprise REST API objects]({{< relref "/operate/rs/7.4/references/rest-api/objects" >}}). +Get the JSON schema of various [Redis Enterprise REST API objects](/content/operate/rs/7.4/references/rest-api/objects/_index.md). ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/ldap_mappings/_index.md b/content/operate/rs/7.4/references/rest-api/requests/ldap_mappings/_index.md index d309f98e5f..f6840ee96e 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/ldap_mappings/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/ldap_mappings/_index.md @@ -31,7 +31,7 @@ Get all LDAP mappings. | Permission name | |-----------------| -| [view_all_ldap_mappings_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_ldap_mappings_info" >}}) | +| [view_all_ldap_mappings_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_ldap_mappings_info) | ### Request {#get-all-request} @@ -48,7 +48,7 @@ Get all LDAP mappings. ### Response {#get-all-response} -Returns a JSON array of [LDAP mapping objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/ldap_mapping" >}}). +Returns a JSON array of [LDAP mapping objects](/content/operate/rs/7.4/references/rest-api/objects/ldap_mapping.md). #### Example JSON body @@ -83,7 +83,7 @@ Get a specific LDAP mapping. | Permission name | |-----------------| -| [view_ldap_mapping_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_ldap_mapping_info" >}}) | +| [view_ldap_mapping_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_ldap_mapping_info) | ### Request {#get-request} @@ -106,7 +106,7 @@ Get a specific LDAP mapping. ### Response {#get-response} -Returns an [LDAP mapping object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ldap_mapping" >}}). +Returns an [LDAP mapping object](/content/operate/rs/7.4/references/rest-api/objects/ldap_mapping.md). #### Example JSON body @@ -151,7 +151,7 @@ Update an existing ldap_mapping object. | Permission name | |-----------------| -| [update_ldap_mapping]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_ldap_mapping" >}}) | +| [update_ldap_mapping](/content/operate/rs/7.4/references/rest-api/permissions.md#update_ldap_mapping) | ### Request {#put-request} @@ -181,7 +181,7 @@ Update an existing ldap_mapping object. #### Request body -Include an [LDAP mapping object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ldap_mapping" >}}) with updated fields in the request body. +Include an [LDAP mapping object](/content/operate/rs/7.4/references/rest-api/objects/ldap_mapping.md) with updated fields in the request body. ### Response {#put-response} @@ -233,7 +233,7 @@ Create a new LDAP mapping. | Permission name | |-----------------| -| [create_ldap_mapping]({{< relref "/operate/rs/7.4/references/rest-api/permissions#create_ldap_mapping" >}}) | +| [create_ldap_mapping](/content/operate/rs/7.4/references/rest-api/permissions.md#create_ldap_mapping) | ### Request {#post-request} @@ -262,7 +262,7 @@ Create a new LDAP mapping. #### Request body -Include an [LDAP mapping object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ldap_mapping" >}}) in the request body. +Include an [LDAP mapping object](/content/operate/rs/7.4/references/rest-api/objects/ldap_mapping.md) in the request body. ### Response {#post-response} @@ -309,7 +309,7 @@ Delete an LDAP mapping object. | Permission name | |-----------------| -| [delete_ldap_mapping]({{< relref "/operate/rs/7.4/references/rest-api/permissions#delete_ldap_mapping" >}}) | +| [delete_ldap_mapping](/content/operate/rs/7.4/references/rest-api/permissions.md#delete_ldap_mapping) | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/license/_index.md b/content/operate/rs/7.4/references/rest-api/requests/license/_index.md index 072b35b69f..4dfb3bdac8 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/license/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/license/_index.md @@ -29,7 +29,7 @@ and supported features. | Permission name | |-----------------| -| [view_license]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_license" >}}) | +| [view_license](/content/operate/rs/7.4/references/rest-api/permissions.md#view_license) | ### Request {#get-request} @@ -98,13 +98,13 @@ Returns a JSON object that contains the license details: Validate and install a new license string. -If you do not provide a valid license, the cluster behaves as if the license was deleted. See [Expired cluster license]({{< relref "/operate/rs/7.4/clusters/configure/license-keys#expired-cluster-license" >}}) for a list of available actions and restrictions. +If you do not provide a valid license, the cluster behaves as if the license was deleted. See [Expired cluster license](/content/operate/rs/7.4/clusters/configure/license-keys.md#expired-cluster-license) for a list of available actions and restrictions. #### Required permissions | Permission name | |-----------------| -| [install_new_license]({{< relref "/operate/rs/7.4/references/rest-api/permissions#install_new_license" >}}) | +| [install_new_license](/content/operate/rs/7.4/references/rest-api/permissions.md#install_new_license) | ### Request {#put-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/logs/_index.md b/content/operate/rs/7.4/references/rest-api/requests/logs/_index.md index 0952ffe848..e277552481 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/logs/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/logs/_index.md @@ -27,7 +27,7 @@ Get cluster events log. | Permission name | |-----------------| -| [view_logged_events]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_logged_events" >}}) | +| [view_logged_events](/content/operate/rs/7.4/references/rest-api/permissions.md#view_logged_events) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/modules/_index.md b/content/operate/rs/7.4/references/rest-api/requests/modules/_index.md index bb05387907..8b662b12c7 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/modules/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/modules/_index.md @@ -34,7 +34,7 @@ List available modules, i.e. modules stored within the CCS. | Permission name | Roles | |-----------------|-------| -| [view_cluster_modules]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_modules" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_cluster_modules](/content/operate/rs/7.4/references/rest-api/permissions.md#view_cluster_modules) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#list-request} @@ -53,7 +53,7 @@ GET /v1/modules ### Response {#list-response} -Returns a JSON array of [module objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/module" >}}). +Returns a JSON array of [module objects](/content/operate/rs/7.4/references/rest-api/objects/module.md). #### Status codes {#list-status-codes} @@ -73,7 +73,7 @@ Get specific available modules, i.e. modules stored within the CCS. | Permission name | Roles | |-----------------|-------| -| [view_cluster_modules]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_modules" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_cluster_modules](/content/operate/rs/7.4/references/rest-api/permissions.md#view_cluster_modules) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} @@ -98,7 +98,7 @@ GET /v1/modules/1 ### Response {#get-response} -Returns a [module object]({{< relref "/operate/rs/7.4/references/rest-api/objects/module" >}}). +Returns a [module object](/content/operate/rs/7.4/references/rest-api/objects/module.md). ### Status codes {#get-status-codes} @@ -113,22 +113,21 @@ Returns a [module object]({{< relref "/operate/rs/7.4/references/rest-api/object POST /v1/modules ``` -{{}} -`POST /v1/modules` is deprecated as of Redis Enterprise Software version 7.2. Use [`POST /v2/modules`](#post-module-v2) instead. -{{}} +> [!NOTE] +> `POST /v1/modules` is deprecated as of Redis Enterprise Software version 7.2. Use [`POST /v2/modules`](#post-module-v2) instead. Uploads a new module to the cluster. The request must contain a Redis module, bundled using [RedisModule Packer](https://github.com/RedisLabs/RAMP). For modules in Redis Stack, download the module from the [download center](https://redis.io/downloads/). -See [Install a module on a cluster]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster#rest-api-method" >}}) for more information. +See [Install a module on a cluster](/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster.md#rest-api-method) for more information. #### Permissions | Permission name | Roles | |-----------------|-------| -| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | admin | +| [update_cluster](/content/operate/rs/7.4/references/rest-api/permissions.md#update_cluster) | admin | ### Request {#post-request} @@ -214,13 +213,13 @@ Asynchronously uploads a new module to the cluster. The request must contain a Redis module bundled using [RedisModule Packer](https://github.com/RedisLabs/RAMP). -For modules in Redis Stack, download the module from the [download center](https://redis.io/downloads/#software). See [Install a module on a cluster]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster#rest-api-method" >}}) for more information. +For modules in Redis Stack, download the module from the [download center](https://redis.io/downloads/#software). See [Install a module on a cluster](/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster.md#rest-api-method) for more information. #### Permissions | Permission name | Roles | |-----------------|-------| -| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | admin | +| [update_cluster](/content/operate/rs/7.4/references/rest-api/permissions.md#update_cluster) | admin | ### Request {#post-request-v2} @@ -242,7 +241,7 @@ POST /v2/modules ### Response {#post-response-v2} -Returns a [module object]({{< relref "/operate/rs/7.4/references/rest-api/objects/module" >}}) with an additional `action_uid` field. +Returns a [module object](/content/operate/rs/7.4/references/rest-api/objects/module.md) with an additional `action_uid` field. You can use the `action_uid` to track the progress of the module upload. @@ -314,9 +313,8 @@ Possible `error_code` values include [`/v1/modules` error codes](#post-error-cod DELETE /v1/modules/{string: uid} ``` -{{}} -`DELETE /v1/modules` is deprecated as of Redis Enterprise Software version 7.2. Use [`DELETE /v2/modules`](#delete-module-v2) instead. -{{}} +> [!NOTE] +> `DELETE /v1/modules` is deprecated as of Redis Enterprise Software version 7.2. Use [`DELETE /v2/modules`](#delete-module-v2) instead. Delete a module. @@ -324,7 +322,7 @@ Delete a module. | Permission name | Roles | |-----------------|-------| -| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | admin | +| [update_cluster](/content/operate/rs/7.4/references/rest-api/permissions.md#update_cluster) | admin | ### Request {#delete-request} @@ -377,7 +375,7 @@ Delete a module. | Permission name | Roles | |-----------------|-------| -| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | admin | +| [update_cluster](/content/operate/rs/7.4/references/rest-api/permissions.md#update_cluster) | admin | ### Request {#delete-request-v2} diff --git a/content/operate/rs/7.4/references/rest-api/requests/modules/config.md b/content/operate/rs/7.4/references/rest-api/requests/modules/config.md index 40caab3062..521afe5f7e 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/modules/config.md +++ b/content/operate/rs/7.4/references/rest-api/requests/modules/config.md @@ -26,7 +26,7 @@ Use the module runtime configuration command (if defined) to configure new argum | Permission name | |-----------------| -| [edit_bdb_module]({{< relref "/operate/rs/7.4/references/rest-api/permissions#edit_bdb_module" >}}) | +| [edit_bdb_module](/content/operate/rs/7.4/references/rest-api/permissions.md#edit_bdb_module) | ### Request {#post-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/modules/upgrade.md b/content/operate/rs/7.4/references/rest-api/requests/modules/upgrade.md index ab08610e26..1b44941323 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/modules/upgrade.md +++ b/content/operate/rs/7.4/references/rest-api/requests/modules/upgrade.md @@ -26,7 +26,7 @@ Upgrades the module version on a specific database. | Permission name | |-----------------| -| [edit_bdb_module]({{< relref "/operate/rs/7.4/references/rest-api/permissions#edit_bdb_module" >}}) | +| [edit_bdb_module](/content/operate/rs/7.4/references/rest-api/permissions.md#edit_bdb_module) | ### Request {#post-request} @@ -67,7 +67,7 @@ Upgrades the module version on a specific database. ### Response {#post-response} -Returns the upgraded [module object]({{< relref "/operate/rs/7.4/references/rest-api/objects/module" >}}). +Returns the upgraded [module object](/content/operate/rs/7.4/references/rest-api/objects/module.md). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/node_master_healthcheck/_index.md b/content/operate/rs/7.4/references/rest-api/requests/node_master_healthcheck/_index.md index 5c86418b16..c4aa7926af 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/node_master_healthcheck/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/node_master_healthcheck/_index.md @@ -30,7 +30,7 @@ Checks whether the current node has a valid connection to the cluster's primary | Permission name | Roles | |-----------------|-------| -| [view_cluster_info]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer
    user_manager | +| [view_cluster_info](/content/operate/rs/references/rest-api/permissions.md#view_cluster_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer
    user_manager | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/_index.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/_index.md index 0d8c197fcf..981670951a 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/_index.md @@ -31,7 +31,7 @@ Get all cluster nodes. | Permission name | Roles | |-----------------|-------| -| [view_all_nodes_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_nodes_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_all_nodes_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_nodes_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-all-request} @@ -50,7 +50,7 @@ GET /v1/nodes ### Response {#get-all-response} -Returns a JSON array of [node objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/node" >}}). +Returns a JSON array of [node objects](/content/operate/rs/7.4/references/rest-api/objects/node.md). #### Example JSON body @@ -115,7 +115,7 @@ Get a single cluster node. | Permission name | Roles | |-----------------|-------| -| [view_node_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_node_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_node_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} @@ -140,7 +140,7 @@ GET /v1/nodes/1 ### Response {#get-response} -Returns a [node object]({{< relref "/operate/rs/7.4/references/rest-api/objects/node" >}}). +Returns a [node object](/content/operate/rs/7.4/references/rest-api/objects/node.md). #### Example JSON body @@ -165,7 +165,7 @@ Returns a [node object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ PUT /v1/nodes/{int: uid} ``` -Update a [node object]({{< relref "/operate/rs/7.4/references/rest-api/objects/node" >}}). +Update a [node object](/content/operate/rs/7.4/references/rest-api/objects/node.md). Currently, you can edit the following attributes: @@ -177,15 +177,14 @@ Currently, you can edit the following attributes: - `accept_servers` -{{}} -You can only update the `addr` attribute for offline nodes. Otherwise, the request returns an error. -{{}} +> [!NOTE] +> You can only update the `addr` attribute for offline nodes. Otherwise, the request returns an error. ### Permissions | Permission name | Roles | |-----------------|-------| -| [update_node]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_node" >}}) | admin | +| [update_node](/content/operate/rs/7.4/references/rest-api/permissions.md#update_node) | admin | ### Request {#put-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/actions.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/actions.md index a04045aa64..651042db63 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/actions.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/actions.md @@ -33,7 +33,7 @@ actions on all nodes. | Permission name | Roles | |-----------------|-------| -| [view_status_of_all_node_actions]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_status_of_all_node_actions" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_status_of_all_node_actions](/content/operate/rs/7.4/references/rest-api/permissions.md#view_status_of_all_node_actions) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-all-request} @@ -52,7 +52,7 @@ GET /v1/nodes/actions ### Response {#get-all-response} -Returns a list of [action objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}). +Returns a list of [action objects](/content/operate/rs/7.4/references/rest-api/objects/action.md). ### Status codes {#get-all-status-codes} @@ -72,7 +72,7 @@ Get the status of all actions on a specific node. | Permission name | Roles | |-----------------|-------| -| [view_status_of_node_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_status_of_node_action" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_status_of_node_action](/content/operate/rs/7.4/references/rest-api/permissions.md#view_status_of_node_action) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request-all-actions} @@ -97,7 +97,7 @@ GET /v1/nodes/1/actions ### Response {#get-response-all-actions} -Returns a JSON object that includes a list of [action objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}) for the specified node. +Returns a JSON object that includes a list of [action objects](/content/operate/rs/7.4/references/rest-api/objects/action.md) for the specified node. If no actions are available, the response will include an empty array. @@ -155,7 +155,7 @@ GET /v1/nodes/1/actions/remove ### Response {#get-response} -Returns an [action object]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}) for the specified node. +Returns an [action object](/content/operate/rs/7.4/references/rest-api/objects/action.md) for the specified node. ### Error codes {#get-error-codes} @@ -191,7 +191,7 @@ removed as soon as the new one is submitted. | Permission name | Roles | |-----------------|-------| -| [start_node_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#start_node_action" >}}) | admin | +| [start_node_action](/content/operate/rs/7.4/references/rest-api/permissions.md#start_node_action) | admin | ### Request {#post-request} @@ -220,7 +220,7 @@ Currently supported actions are: - By default, the remove node action completes after all resources migrate off the removed node. Node removal does not wait for migrated shards' persistence files to be created on the new nodes. - To change node removal to wait for the creation of new persistence files for all migrated shards, set `wait_for_persistence` to `true` in the request body or [update the cluster policy]({{}}) `persistent_node_removal` to `true` to change the cluster's default behavior. + To change node removal to wait for the creation of new persistence files for all migrated shards, set `wait_for_persistence` to `true` in the request body or [update the cluster policy](/content/operate/rs/7.4/references/rest-api/requests/cluster/policy.md#put-cluster-policy) `persistent_node_removal` to `true` to change the cluster's default behavior. ```sh POST /v1/nodes//actions/remove @@ -229,7 +229,7 @@ Currently supported actions are: } ``` -- `maintenance_on`: Creates a snapshot of the node, migrates shards to other nodes, and prepares the node for maintenance. See [maintenance mode]({{< relref "/operate/rs/7.4/clusters/maintenance-mode" >}}) for more information. +- `maintenance_on`: Creates a snapshot of the node, migrates shards to other nodes, and prepares the node for maintenance. See [maintenance mode](/content/operate/rs/7.4/clusters/maintenance-mode.md) for more information. - As of Redis Enterprise Software version 7.4.2, a new node snapshot is created only if no maintenance mode snapshots already exist or if you set `"overwrite_snapshot": true` in the request body. @@ -261,7 +261,7 @@ Currently supported actions are: } ``` -- `maintenance_off`: Restores node to its previous state before maintenance started. See [maintenance mode]({{< relref "/operate/rs/7.4/clusters/maintenance-mode" >}}) for more information. +- `maintenance_off`: Restores node to its previous state before maintenance started. See [maintenance mode](/content/operate/rs/7.4/clusters/maintenance-mode.md) for more information. - By default, it uses the latest node snapshot. @@ -323,7 +323,7 @@ previously executed and completed action. | Permission name | |-----------------| -| [cancel_node_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#cancel_node_action" >}}) | +| [cancel_node_action](/content/operate/rs/7.4/references/rest-api/permissions.md#cancel_node_action) | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/alerts.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/alerts.md index 95675a2d2e..415b5bb1dc 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/alerts.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/alerts.md @@ -28,7 +28,7 @@ Get all alert states for all nodes. | Permission name | |-----------------| -| [view_all_nodes_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_nodes_alerts" >}}) | +| [view_all_nodes_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_nodes_alerts) | ### Request {#get-all-request} @@ -51,7 +51,7 @@ Get all alert states for all nodes. ### Response {#get-all-response} -Returns a hash of node UIDs and the [alert states]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) for each node. +Returns a hash of node UIDs and the [alert states](/content/operate/rs/7.4/references/rest-api/objects/alert.md) for each node. #### Example JSON body @@ -91,7 +91,7 @@ Get all alert states for a node. | Permission name | |-----------------| -| [view_node_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_alerts" >}}) | +| [view_node_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_node_alerts) | ### Request {#get-request-all-alerts} @@ -116,7 +116,7 @@ Get all alert states for a node. ### Response {#get-response-all-alerts} -Returns a hash of [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) and their states for a specific node. +Returns a hash of [alert objects](/content/operate/rs/7.4/references/rest-api/objects/alert.md) and their states for a specific node. #### Example JSON body @@ -154,7 +154,7 @@ Get a node alert state. | Permission name | |-----------------| -| [view_node_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_alerts" >}}) | +| [view_node_alerts](/content/operate/rs/7.4/references/rest-api/permissions.md#view_node_alerts) | ### Request {#get-request} @@ -179,7 +179,7 @@ Get a node alert state. ### Response {#get-response} -Returns an [alert object]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}). +Returns an [alert object](/content/operate/rs/7.4/references/rest-api/objects/alert.md). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/check.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/check.md index 9cf59b382a..076da07523 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/check.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/check.md @@ -38,7 +38,7 @@ Runs the following checks on a cluster node: | Permission name | |-----------------| -| [view_node_check]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_check" >}}) | +| [view_node_check](/content/operate/rs/7.4/references/rest-api/permissions.md#view_node_check) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo.md index 5f192927e5..747db3e198 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo.md @@ -27,7 +27,7 @@ Downloads a tar file that contains debug info from all nodes. | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-all-request} @@ -64,7 +64,7 @@ Downloads a tar file that contains debug info from a specific node. | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/snapshots.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/snapshots.md index d19fbf4472..20484d9bdc 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/snapshots.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/snapshots.md @@ -29,7 +29,7 @@ Get all cluster node snapshots of the specified node. | Permission name | Roles | |-----------------|-------| -| [view_node_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_node_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_node_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} @@ -92,7 +92,7 @@ Delete a cluster node snapshot. Snapshots created by maintenance mode are not de | Permission name | Roles | |-----------------|-------| -| [update_node]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_node" >}}) | admin | +| [update_node](/content/operate/rs/7.4/references/rest-api/permissions.md#update_node) | admin | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/_index.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/_index.md index 24a17da6f3..c6bb6e956f 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/_index.md @@ -30,7 +30,7 @@ Get statistics for all nodes. | Permission name | |-----------------| -| [view_all_nodes_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_nodes_stats" >}}) | +| [view_all_nodes_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_nodes_stats) | ### Request {#get-all-request} @@ -57,7 +57,7 @@ GET /v1/nodes/stats?interval=1hour&stime=2014-08-28T10:00:00Z ### Response {#get-all-response} -Returns a JSON array of [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all nodes. +Returns a JSON array of [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for all nodes. #### Example JSON body @@ -143,7 +143,7 @@ Get statistics for a node. | Permission name | |-----------------| -| [view_node_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_stats" >}}) | +| [view_node_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_node_stats) | ### Request {#get-request} @@ -176,7 +176,7 @@ GET /v1/nodes/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for the specified node. +Returns [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for the specified node. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/last.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/last.md index 8db0dd47f5..49fa515c7f 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/last.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/last.md @@ -29,7 +29,7 @@ Get latest statistics for all nodes. | Permission name | |-----------------| -| [view_all_nodes_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_nodes_stats" >}}) | +| [view_all_nodes_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_nodes_stats) | ### Request {#get-all-request} @@ -58,7 +58,7 @@ GET /v1/nodes/stats/last?interval=1sec&stime=2015-10-14T06:29:43Z ### Response {#get-all-response} -Returns most recent [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all nodes. +Returns most recent [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for all nodes. #### Example JSON body @@ -109,7 +109,7 @@ Get the latest statistics of a node. | Permission name | |-----------------| -| [view_node_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_stats" >}}) | +| [view_node_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_node_stats) | ### Request {#get-request} @@ -145,7 +145,7 @@ GET /v1/nodes/stats/last/1?interval=1sec&stime=2015-10-13T09:01:54Z ### Response {#get-response} -Returns the most recent [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for the specified node. +Returns the most recent [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for the specified node. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/status.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/status.md index 19380cc0a3..d31dbf0a7b 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/status.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/status.md @@ -32,7 +32,7 @@ Gets the status of all nodes. Includes each node's hostname and role in the clus | Permission name | |-----------------| -| [view_node_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_info" >}}) | +| [view_node_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_node_info) | ### Request {#get-all-request} @@ -51,7 +51,7 @@ Gets the status of all nodes. Includes each node's hostname and role in the clus For each node in the cluster, returns a JSON object that contains each node's hostname, role, and other status details. -If a maintenance snapshot exists due to an in-progress or improperly stopped [node maintenance]({{}}) process, the response includes a `maintenance_snapshot` field. +If a maintenance snapshot exists due to an in-progress or improperly stopped [node maintenance](/content/operate/rs/7.4/clusters/maintenance-mode.md) process, the response includes a `maintenance_snapshot` field. #### Example JSON body @@ -111,7 +111,7 @@ Gets the status of a node. Includes the node's hostname and role in the cluster: | Permission name | |-----------------| -| [view_node_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_info" >}}) | +| [view_node_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_node_info) | ### Request {#get-request} @@ -139,7 +139,7 @@ Gets the status of a node. Includes the node's hostname and role in the cluster: Returns a JSON object that contains the node's hostname, role, and other status details. -If a maintenance snapshot exists due to an in-progress or improperly stopped [node maintenance]({{}}) process, the response includes a `maintenance_snapshot` field. +If a maintenance snapshot exists due to an in-progress or improperly stopped [node maintenance](/content/operate/rs/7.4/clusters/maintenance-mode.md) process, the response includes a `maintenance_snapshot` field. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/ocsp/_index.md b/content/operate/rs/7.4/references/rest-api/requests/ocsp/_index.md index af43603569..ccc17beb60 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/ocsp/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/ocsp/_index.md @@ -28,7 +28,7 @@ Gets the cluster's OCSP configuration. | Permission name | |-----------------| -| [view_ocsp_config]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_ocsp_config" >}}) | +| [view_ocsp_config](/content/operate/rs/7.4/references/rest-api/permissions.md#view_ocsp_config) | ### Request {#get-request} @@ -46,7 +46,7 @@ Gets the cluster's OCSP configuration. ### Response {#get-response} -Returns an [OCSP configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ocsp" >}}). +Returns an [OCSP configuration object](/content/operate/rs/7.4/references/rest-api/objects/ocsp.md). #### Example JSON body @@ -86,7 +86,7 @@ Updates the cluster's OCSP configuration. | Permission name | |-----------------| -| [config_ocsp]({{< relref "/operate/rs/7.4/references/rest-api/permissions#config_ocsp" >}}) | +| [config_ocsp](/content/operate/rs/7.4/references/rest-api/permissions.md#config_ocsp) | ### Request {#put-request} @@ -115,11 +115,11 @@ Updates the cluster's OCSP configuration. #### Request body -Include an [OCSP configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ocsp" >}}) with updated fields in the request body. +Include an [OCSP configuration object](/content/operate/rs/7.4/references/rest-api/objects/ocsp.md) with updated fields in the request body. ### Response {#put-response} -Returns the updated [OCSP configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ocsp" >}}). +Returns the updated [OCSP configuration object](/content/operate/rs/7.4/references/rest-api/objects/ocsp.md). ### Error codes {#put-error-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/ocsp/status.md b/content/operate/rs/7.4/references/rest-api/requests/ocsp/status.md index bced0c20b0..895f1cc99b 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/ocsp/status.md +++ b/content/operate/rs/7.4/references/rest-api/requests/ocsp/status.md @@ -26,7 +26,7 @@ Gets the latest cached status of the proxy certificate’s OCSP response. | Permission name | |-----------------| -| [view_ocsp_status]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_ocsp_status" >}}) | +| [view_ocsp_status](/content/operate/rs/7.4/references/rest-api/permissions.md#view_ocsp_status) | ### Request {#get-request} @@ -44,7 +44,7 @@ Gets the latest cached status of the proxy certificate’s OCSP response. ### Response {#get-response} -Returns an [OCSP status object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ocsp_status" >}}). +Returns an [OCSP status object](/content/operate/rs/7.4/references/rest-api/objects/ocsp_status.md). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/ocsp/test.md b/content/operate/rs/7.4/references/rest-api/requests/ocsp/test.md index bc02b970be..352a1c0307 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/ocsp/test.md +++ b/content/operate/rs/7.4/references/rest-api/requests/ocsp/test.md @@ -26,7 +26,7 @@ Queries the OCSP server for the proxy certificate’s latest status and returns | Permission name | |-----------------| -| [test_ocsp_status]({{< relref "/operate/rs/7.4/references/rest-api/permissions#test_ocsp_status" >}}) | +| [test_ocsp_status](/content/operate/rs/7.4/references/rest-api/permissions.md#test_ocsp_status) | ### Request {#post-request} @@ -43,7 +43,7 @@ Queries the OCSP server for the proxy certificate’s latest status and returns ### Response {#post-response} -Returns an [OCSP status object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ocsp_status" >}}). +Returns an [OCSP status object](/content/operate/rs/7.4/references/rest-api/objects/ocsp_status.md). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/proxies/_index.md b/content/operate/rs/7.4/references/rest-api/requests/proxies/_index.md index 65345d9ac5..8b44deb3b4 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/proxies/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/proxies/_index.md @@ -32,7 +32,7 @@ Get all the proxies in the cluster. | Permission name | Roles | |-----------------|-------| -| [view_all_proxies_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_proxies_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_all_proxies_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_proxies_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-all-request} @@ -51,7 +51,7 @@ GET /v1/proxies ### Response {#get-all-response} -Returns a JSON array of [proxy objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/proxy" >}}). +Returns a JSON array of [proxy objects](/content/operate/rs/7.4/references/rest-api/objects/proxy.md). #### Example JSON body @@ -103,7 +103,7 @@ Get a single proxy's info. | Permission name | Roles | |-----------------|-------| -| [view_proxy_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_proxy_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_proxy_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_proxy_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} @@ -128,7 +128,7 @@ GET /v1/proxies/1 ### Response {#get-response} -Returns a [proxy object]({{< relref "/operate/rs/7.4/references/rest-api/objects/proxy" >}}). +Returns a [proxy object](/content/operate/rs/7.4/references/rest-api/objects/proxy.md). #### Example JSON body @@ -178,7 +178,7 @@ However, if `allow_restart` is `false`, such changes only take effect after the | Permission name | Roles | |-----------------|-------| -| [update_proxy]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_proxy" >}}) | admin | +| [update_proxy](/content/operate/rs/7.4/references/rest-api/permissions.md#update_proxy) | admin | ### Request {#put-request} @@ -215,7 +215,7 @@ PUT /v1/proxies/1 #### Request body -Include a JSON object in the request body. The JSON object can contain the boolean field `allow_restart` and a [proxy object]({{< relref "/operate/rs/7.4/references/rest-api/objects/proxy" >}}) with updated fields. +Include a JSON object in the request body. The JSON object can contain the boolean field `allow_restart` and a [proxy object](/content/operate/rs/7.4/references/rest-api/objects/proxy.md) with updated fields. ### Response {#put-response} @@ -247,7 +247,7 @@ However, if `allow_restart` is `false`, such changes only take effect after the | Permission name | Roles | |-----------------|-------| -| [update_proxy]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_proxy" >}}) | admin | +| [update_proxy](/content/operate/rs/7.4/references/rest-api/permissions.md#update_proxy) | admin | ### Request {#put-all-request} @@ -279,7 +279,7 @@ PUT /v1/proxies #### Request body -Include a JSON object in the request body. The JSON object can contain the boolean field `allow_restart` and a [proxy object]({{< relref "/operate/rs/7.4/references/rest-api/objects/proxy" >}}) with updated fields. +Include a JSON object in the request body. The JSON object can contain the boolean field `allow_restart` and a [proxy object](/content/operate/rs/7.4/references/rest-api/objects/proxy.md) with updated fields. ### Response {#put-all-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/redis_acls/_index.md b/content/operate/rs/7.4/references/rest-api/requests/redis_acls/_index.md index 950039210f..e79c6c8c2b 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/redis_acls/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/redis_acls/_index.md @@ -33,7 +33,7 @@ Get all Redis ACL objects. | Permission name | Roles | |-----------------|-------| -| [view_all_redis_acls_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_redis_acls_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_all_redis_acls_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_redis_acls_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-all-request} @@ -52,7 +52,7 @@ GET /v1/redis_acls ### Response {#get-all-response} -Returns a JSON array of [Redis ACL objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/redis_acl" >}}). +Returns a JSON array of [Redis ACL objects](/content/operate/rs/7.4/references/rest-api/objects/redis_acl.md). #### Example JSON body @@ -100,7 +100,7 @@ Get a single Redis ACL object. | Permission name | Roles | |-----------------|-------| -| [view_redis_acl_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_redis_acl_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_redis_acl_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_redis_acl_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} @@ -126,7 +126,7 @@ GET /v1/redis_acls/1 ### Response {#get-response} -Returns a [Redis ACL object]({{< relref "/operate/rs/7.4/references/rest-api/objects/redis_acl" >}}). +Returns a [Redis ACL object](/content/operate/rs/7.4/references/rest-api/objects/redis_acl.md). #### Example JSON body @@ -159,7 +159,7 @@ Update an existing Redis ACL object. | Permission name | Roles | |-----------------|-------| -| [update_redis_acl]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_redis_acl" >}}) | admin | +| [update_redis_acl](/content/operate/rs/7.4/references/rest-api/permissions.md#update_redis_acl) | admin | ### Request {#put-request} @@ -187,11 +187,11 @@ PUT /v1/redis_acls/17 #### Request body -Include a [Redis ACL object]({{< relref "/operate/rs/7.4/references/rest-api/objects/redis_acl" >}}) with updated fields in the request body. +Include a [Redis ACL object](/content/operate/rs/7.4/references/rest-api/objects/redis_acl.md) with updated fields in the request body. ### Response {#put-response} -Returns the updated [Redis ACL object]({{< relref "/operate/rs/7.4/references/rest-api/objects/redis_acl" >}}). +Returns the updated [Redis ACL object](/content/operate/rs/7.4/references/rest-api/objects/redis_acl.md). #### Example JSON body @@ -233,7 +233,7 @@ Create a new Redis ACL object. | Permission name | Roles | |-----------------|-------| -| [create_redis_acl]({{< relref "/operate/rs/7.4/references/rest-api/permissions#create_redis_acl" >}}) | admin | +| [create_redis_acl](/content/operate/rs/7.4/references/rest-api/permissions.md#create_redis_acl) | admin | ### Request {#post-request} @@ -262,11 +262,11 @@ POST /v1/redis_acls #### Request body -Include a [Redis ACL object]({{< relref "/operate/rs/7.4/references/rest-api/objects/redis_acl" >}}) in the request body. +Include a [Redis ACL object](/content/operate/rs/7.4/references/rest-api/objects/redis_acl.md) in the request body. ### Response {#post-response} -Returns the newly created [Redis ACL object]({{< relref "/operate/rs/7.4/references/rest-api/objects/redis_acl" >}}). +Returns the newly created [Redis ACL object](/content/operate/rs/7.4/references/rest-api/objects/redis_acl.md). #### Example JSON body @@ -344,7 +344,7 @@ Delete a Redis ACL object. | Permission name | Roles | |-----------------|-------| -| [delete_redis_acl]({{< relref "/operate/rs/7.4/references/rest-api/permissions#delete_redis_acl" >}}) | admin | +| [delete_redis_acl](/content/operate/rs/7.4/references/rest-api/permissions.md#delete_redis_acl) | admin | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/roles/_index.md b/content/operate/rs/7.4/references/rest-api/requests/roles/_index.md index 541d47e5b4..81c2ce01a7 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/roles/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/roles/_index.md @@ -33,7 +33,7 @@ Get all roles' details. | Permission name | Roles | |-----------------|-------| -| [view_all_roles_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_roles_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_all_roles_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_roles_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-all-request} @@ -52,7 +52,7 @@ GET /v1/roles ### Response {#get-all-response} -Returns a JSON array of [role objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/role" >}}). +Returns a JSON array of [role objects](/content/operate/rs/7.4/references/rest-api/objects/role.md). #### Example JSON body @@ -115,7 +115,7 @@ Get the details of a single role. | Permission name | Roles | |-----------------|-------| -| [view_role_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_role_info" >}}) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | +| [view_role_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_role_info) | admin
    cluster_member
    cluster_viewer
    db_member
    db_viewer | ### Request {#get-request} @@ -142,7 +142,7 @@ GET /v1/roles/1 ### Response {#get-response} -Returns a [role object]({{< relref "/operate/rs/7.4/references/rest-api/objects/role" >}}). +Returns a [role object](/content/operate/rs/7.4/references/rest-api/objects/role.md). #### Example JSON body @@ -175,7 +175,7 @@ Update an existing role's details. | Permission name | Roles | |-----------------|-------| -| [update_role]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_role" >}}) | admin | +| [update_role](/content/operate/rs/7.4/references/rest-api/permissions.md#update_role) | admin | ### Request {#put-request} @@ -203,11 +203,11 @@ PUT /v1/roles/17 #### Body -Include a [role object]({{< relref "/operate/rs/7.4/references/rest-api/objects/role" >}}) with updated fields in the request body. +Include a [role object](/content/operate/rs/7.4/references/rest-api/objects/role.md) with updated fields in the request body. ### Response {#put-response} -Returns a [role object]({{< relref "/operate/rs/7.4/references/rest-api/objects/role" >}}) with the updated fields. +Returns a [role object](/content/operate/rs/7.4/references/rest-api/objects/role.md) with the updated fields. #### Example JSON body @@ -250,7 +250,7 @@ Create a new role. | Permission name | Roles | |-----------------|-------| -| [create_role]({{< relref "/operate/rs/7.4/references/rest-api/permissions#create_role" >}}) | admin | +| [create_role](/content/operate/rs/7.4/references/rest-api/permissions.md#create_role) | admin | ### Request {#post-request} @@ -279,11 +279,11 @@ POST /v1/roles #### Body -Include a [role object]({{< relref "/operate/rs/7.4/references/rest-api/objects/role" >}}) in the request body. +Include a [role object](/content/operate/rs/7.4/references/rest-api/objects/role.md) in the request body. ### Response {#post-response} -Returns the newly created [role object]({{< relref "/operate/rs/7.4/references/rest-api/objects/role" >}}). +Returns the newly created [role object](/content/operate/rs/7.4/references/rest-api/objects/role.md). #### Example JSON body @@ -360,7 +360,7 @@ Delete a role object. | Permission name | Roles | |-----------------|-------| -| [delete_role]({{< relref "/operate/rs/7.4/references/rest-api/permissions#delete_role" >}}) | admin | +| [delete_role](/content/operate/rs/7.4/references/rest-api/permissions.md#delete_role) | admin | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/shards/_index.md b/content/operate/rs/7.4/references/rest-api/requests/shards/_index.md index 0bd26a7aeb..5fe5d22563 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/shards/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/shards/_index.md @@ -45,7 +45,7 @@ Get information about all shards in the cluster. ### Response {#get-all-response} -Returns a JSON array of [shard objects]({{}}). +Returns a JSON array of [shard objects](/content/operate/rs/7.4/references/rest-api/objects/shard/_index.md). #### Example JSON body @@ -115,7 +115,7 @@ Gets information about a single shard. ### Response {#get-response} -Returns a [shard object]({{}}). +Returns a [shard object](/content/operate/rs/7.4/references/rest-api/objects/shard/_index.md). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/shards/actions/_index.md b/content/operate/rs/7.4/references/rest-api/requests/shards/actions/_index.md index face5f54a4..67815b245e 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/shards/actions/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/shards/actions/_index.md @@ -17,5 +17,5 @@ url: '/operate/rs/7.4/references/rest-api/requests/shards/actions/' | Method | Path | Description | |--------|------|-------------| -| [POST]({{}}) | `/v1/shards/actions/migrate` | Migrate multiple shards | -| [POST]({{}}) | `/v1/shards/{uid}/actions/migrate` | Migrate a specific shard | +| [POST](/content/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate.md#post-multi-shards) | `/v1/shards/actions/migrate` | Migrate multiple shards | +| [POST](/content/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate.md#post-shard) | `/v1/shards/{uid}/actions/migrate` | Migrate a specific shard | diff --git a/content/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate.md b/content/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate.md index 70b0ce26ac..1cfd781648 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate.md +++ b/content/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate.md @@ -23,13 +23,13 @@ url: '/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate/' Migrates the list of given shard UIDs to the node specified by `target_node_uid`. The shards can be from multiple databases. This request is asynchronous. -For more information about shard migration use cases and considerations, see [Migrate database shards]({{}}). +For more information about shard migration use cases and considerations, see [Migrate database shards](/content/operate/rs/7.4/databases/migrate-shards.md). #### Required permissions | Permission name | Roles | |-----------------|-------| -| [migrate_shard]({{< relref "/operate/rs/7.4/references/rest-api/permissions#migrate_shard" >}}) | admin
    cluster_member
    db_member | +| [migrate_shard](/content/operate/rs/7.4/references/rest-api/permissions.md#migrate_shard) | admin
    cluster_member
    db_member | ### Request {#post-multi-request} @@ -71,7 +71,7 @@ The request body is a JSON object that can contain the following fields: ### Response {#post-multi-response} -Returns a JSON object with an `action_uid`. You can track the action's progress with a [`GET /v1/actions/`]({{}}) request. +Returns a JSON object with an `action_uid`. You can track the action's progress with a [`GET /v1/actions/`](/content/operate/rs/7.4/references/rest-api/requests/actions/_index.md#get-action) request. #### Example JSON body @@ -98,13 +98,13 @@ Returns a JSON object with an `action_uid`. You can track the action's progress Migrates the shard with the given `shard_uid` to the node specified by `target_node_uid`. If the shard is already on the target node, nothing happens. This request is asynchronous. -For more information about shard migration use cases and considerations, see [Migrate database shards]({{}}). +For more information about shard migration use cases and considerations, see [Migrate database shards](/content/operate/rs/7.4/databases/migrate-shards.md). #### Required permissions | Permission name | Roles | |-----------------|-------| -| [migrate_shard]({{< relref "/operate/rs/7.4/references/rest-api/permissions#migrate_shard" >}}) | admin
    cluster_member
    db_member | +| [migrate_shard](/content/operate/rs/7.4/references/rest-api/permissions.md#migrate_shard) | admin
    cluster_member
    db_member | ### Request {#post-request} @@ -150,7 +150,7 @@ The request body is a JSON object that can contain the following fields: ### Response {#post-response} -Returns a JSON object with an `action_uid`. You can track the action's progress with a [`GET /v1/actions/`]({{}}) request. +Returns a JSON object with an `action_uid`. You can track the action's progress with a [`GET /v1/actions/`](/content/operate/rs/7.4/references/rest-api/requests/actions/_index.md#get-action) request. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/shards/stats/_index.md b/content/operate/rs/7.4/references/rest-api/requests/shards/stats/_index.md index b38ee2eb29..797c2fd9ad 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/shards/stats/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/shards/stats/_index.md @@ -29,7 +29,7 @@ Get statistics for all shards. | Permission name | |-----------------| -| [view_all_shard_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_shard_stats" >}}) | +| [view_all_shard_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_shard_stats) | ### Request {#get-all-request} @@ -54,11 +54,11 @@ Get statistics for all shards. | interval | string | Time interval for which we want stats: 1sec/10sec/5min/15min/1hour/12hour/1week (optional) | | stime | ISO_8601 | Start time from which we want the stats. Should comply with the [ISO_8601](https://en.wikipedia.org/wiki/ISO_8601) format (optional) | | etime | ISO_8601 | End time after which we don't want the stats. Should comply with the [ISO_8601](https://en.wikipedia.org/wiki/ISO_8601) format (optional) | -| metrics | list | Comma-separated list of [metric names]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics/shard-metrics" >}}) for which we want statistics (default is all) (optional) | +| metrics | list | Comma-separated list of [metric names](/content/operate/rs/7.4/references/rest-api/objects/statistics/shard-metrics.md) for which we want statistics (default is all) (optional) | ### Response {#get-all-response} -Returns a JSON array of [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all shards. +Returns a JSON array of [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for all shards. #### Example JSON body @@ -147,7 +147,7 @@ Get statistics for a specific shard. | Permission name | |-----------------| -| [view_shard_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_shard_stats" >}}) | +| [view_shard_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_shard_stats) | ### Request {#get-request} @@ -181,7 +181,7 @@ Get statistics for a specific shard. ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for the specified shard. +Returns [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for the specified shard. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/shards/stats/last.md b/content/operate/rs/7.4/references/rest-api/requests/shards/stats/last.md index ccb50306fb..1d7ab7db9b 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/shards/stats/last.md +++ b/content/operate/rs/7.4/references/rest-api/requests/shards/stats/last.md @@ -28,7 +28,7 @@ Get most recent statistics for all shards. | Permission name | |-----------------| -| [view_all_shard_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_shard_stats" >}}) | +| [view_all_shard_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_shard_stats) | ### Request {#get-all-request} @@ -55,7 +55,7 @@ Get most recent statistics for all shards. ### Response {#get-all-response} -Returns most recent [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all shards. +Returns most recent [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for all shards. #### Example JSON body @@ -116,7 +116,7 @@ Get most recent statistics for a specific shard. | Permission name | |-----------------| -| [view_shard_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_shard_stats" >}}) | +| [view_shard_stats](/content/operate/rs/7.4/references/rest-api/permissions.md#view_shard_stats) | ### Request {#get-request} @@ -150,7 +150,7 @@ Get most recent statistics for a specific shard. ### Response {#get-response} -Returns the most recent [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for the specified shard. +Returns the most recent [statistics](/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md) for the specified shard. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/suffix/_index.md b/content/operate/rs/7.4/references/rest-api/requests/suffix/_index.md index 65da8f65e9..091b2fcf78 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/suffix/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/suffix/_index.md @@ -46,7 +46,7 @@ Get a single DNS suffix. ### Response {#get-response} -Returns a [suffix object]({{< relref "/operate/rs/7.4/references/rest-api/objects/suffix" >}}). +Returns a [suffix object](/content/operate/rs/7.4/references/rest-api/objects/suffix.md). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/suffixes/_index.md b/content/operate/rs/7.4/references/rest-api/requests/suffixes/_index.md index dace7689f2..0f681c0962 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/suffixes/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/suffixes/_index.md @@ -39,7 +39,7 @@ Get all DNS suffixes in the cluster. ### Response {#get-all-response} -The response body contains a JSON array with all suffixes, represented as [suffix objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/suffix" >}}). +The response body contains a JSON array with all suffixes, represented as [suffix objects](/content/operate/rs/7.4/references/rest-api/objects/suffix.md). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/users/_index.md b/content/operate/rs/7.4/references/rest-api/requests/users/_index.md index 43f30a8644..c6e8aa9cb0 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/users/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/users/_index.md @@ -33,7 +33,7 @@ Get a list of all users. | Permission name | Roles | |-----------------|-------| -| [view_all_users_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_users_info" >}}) | admin | +| [view_all_users_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_all_users_info) | admin | ### Request {#get-all-request} @@ -52,7 +52,7 @@ GET /v1/users ### Response {#get-all-response} -Returns a JSON array of [user objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/user" >}}). +Returns a JSON array of [user objects](/content/operate/rs/7.4/references/rest-api/objects/user.md). #### Example JSON body @@ -100,7 +100,7 @@ Get a single user's details. | Permission name | Roles | |-----------------|-------| -| [view_user_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_user_info" >}}) | admin | +| [view_user_info](/content/operate/rs/7.4/references/rest-api/permissions.md#view_user_info) | admin | ### Request {#get-request} @@ -125,7 +125,7 @@ GET /v1/users/1 ### Response {#get-response} -Returns a [user object]({{< relref "/operate/rs/7.4/references/rest-api/objects/user" >}}) that contains the details for the specified user ID. +Returns a [user object](/content/operate/rs/7.4/references/rest-api/objects/user.md) that contains the details for the specified user ID. #### Example JSON body @@ -163,7 +163,7 @@ Update an existing user's configuration. | Permission name | Roles | |-----------------|-------| -| [update_user]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_user" >}}) | admin | +| [update_user](/content/operate/rs/7.4/references/rest-api/permissions.md#update_user) | admin | Any user can change their own name, password, or alert preferences. @@ -201,11 +201,11 @@ PUT /v1/users/1 #### Request body -Include a [user object]({{< relref "/operate/rs/7.4/references/rest-api/objects/user" >}}) with updated fields in the request body. +Include a [user object](/content/operate/rs/7.4/references/rest-api/objects/user.md) with updated fields in the request body. ### Response {#put-response} -Returns the updated [user object]({{< relref "/operate/rs/7.4/references/rest-api/objects/user" >}}). +Returns the updated [user object](/content/operate/rs/7.4/references/rest-api/objects/user.md). #### Example JSON body @@ -222,9 +222,8 @@ Returns the updated [user object]({{< relref "/operate/rs/7.4/references/rest-ap } ``` -{{}} -For [RBAC-enabled clusters]({{< relref "/operate/rs/7.4/security/access-control" >}}), the returned user details include `role_uids` instead of `role`. -{{}} +> [!NOTE] +> For [RBAC-enabled clusters](/content/operate/rs/7.4/security/access-control/_index.md), the returned user details include `role_uids` instead of `role`. ### Error codes {#put-error-codes} @@ -258,7 +257,7 @@ Create a new user. | Permission name | Roles | |-----------------|-------| -| [create_new_user]({{< relref "/operate/rs/7.4/references/rest-api/permissions#create_new_user" >}}) | admin | +| [create_new_user](/content/operate/rs/7.4/references/rest-api/permissions.md#create_new_user) | admin | ### Request {#post-request} @@ -277,11 +276,10 @@ POST /v1/users #### Body -Include a single [user object]({{< relref "/operate/rs/7.4/references/rest-api/objects/user" >}}) in the request body. The user object must have an email, password, and role. +Include a single [user object](/content/operate/rs/7.4/references/rest-api/objects/user.md) in the request body. The user object must have an email, password, and role. -{{}} -For [RBAC-enabled clusters]({{< relref "/operate/rs/7.4/security/access-control" >}}), use `role_uids` instead of `role` in the request body. -{{}} +> [!NOTE] +> For [RBAC-enabled clusters](/content/operate/rs/7.4/security/access-control/_index.md), use `role_uids` instead of `role` in the request body. `email_alerts` can be configured either as: @@ -305,7 +303,7 @@ For [RBAC-enabled clusters]({{< relref "/operate/rs/7.4/security/access-control" ### Response {#post-response} -Returns the newly created [user object]({{< relref "/operate/rs/7.4/references/rest-api/objects/user" >}}). +Returns the newly created [user object](/content/operate/rs/7.4/references/rest-api/objects/user.md). #### Example JSON body @@ -406,7 +404,7 @@ Delete a user. | Permission name | Roles | |-----------------|-------| -| [delete_user]({{< relref "/operate/rs/7.4/references/rest-api/permissions#delete_user" >}}) | admin | +| [delete_user](/content/operate/rs/7.4/references/rest-api/permissions.md#delete_user) | admin | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/users/authorize.md b/content/operate/rs/7.4/references/rest-api/requests/users/authorize.md index 216992e33b..5b8a40f01e 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/users/authorize.md +++ b/content/operate/rs/7.4/references/rest-api/requests/users/authorize.md @@ -45,7 +45,7 @@ Generate a JSON Web Token (JWT) for a user to use as authorization to access the #### Request body -Include a [JWT authorize object]({{< relref "/operate/rs/7.4/references/rest-api/objects/jwt_authorize" >}}) with a valid username and password in the request body. +Include a [JWT authorize object](/content/operate/rs/7.4/references/rest-api/objects/jwt_authorize.md) with a valid username and password in the request body. ### Response {#post-response} diff --git a/content/operate/rs/7.4/references/upgrade-paths.md b/content/operate/rs/7.4/references/upgrade-paths.md index af2d6c9c9e..e555c2e415 100644 --- a/content/operate/rs/7.4/references/upgrade-paths.md +++ b/content/operate/rs/7.4/references/upgrade-paths.md @@ -14,6 +14,6 @@ url: '/operate/rs/7.4/references/upgrade-paths/' {{}} -For detailed upgrade instructions, see [Upgrade a Redis Enterprise Software cluster]({{}}). +For detailed upgrade instructions, see [Upgrade a Redis Enterprise Software cluster](/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-cluster.md). -See the [Redis Enterprise Software product lifecycle]({{}}) for more information about release numbers and the end-of-life schedule. +See the [Redis Enterprise Software product lifecycle](/content/operate/rs/7.4/installing-upgrading/product-lifecycle.md) for more information about release numbers and the end-of-life schedule. From e46f70eec655c8d9edd78b0449f10da75c96be25 Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Wed, 23 Sep 2026 14:10:55 +0100 Subject: [PATCH 2/4] DOC-7104: Fix and convert the missing-paren relref in redis-cli/_index.md The unit-10 subagent correctly left this pre-existing malformed relref (missing its closing paren) unconverted rather than guessing at a fix, per the migration script's by-design behavior. Fixing it here so this unit doesn't leave one relref shortcode behind in an otherwise fully converted file, matching the pattern already applied in units 1 and 2. Co-Authored-By: Claude Sonnet 5 --- .../operate/rs/7.4/references/cli-utilities/redis-cli/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md b/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md index dd77cf0b2f..80755225cb 100644 --- a/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md +++ b/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md @@ -150,4 +150,4 @@ See [Scanning for big keys](/content/develop/tools/cli.md#scanning-for-big-keys) ## More info - [Redis CLI documentation](/content/develop/tools/cli.md) -- [Redis commands reference]({{< relref "/commands/" >}} +- [Redis commands reference](/commands/) From 8e929b1cbd030cce25a88a86035ce5233e4dc952 Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Thu, 24 Sep 2026 10:41:22 +0100 Subject: [PATCH 3/4] DOC-7104: Canonical /commands links, real filenames in relative refs (same fix as #4093 review) Same defect pattern found and fixed on PR #4093 (7.22/references) after human review: 7 bare /commands?group= links in compatibility/commands/ missing the /content/ prefix, and 10 source-relative relrefs in rest-api/requests/{bdbs/actions,debuginfo}/_index.md pointing at a directory/file with no extension (works via Hugo's render-link.html GetPage resolution, confirmed byte-identical rendered href before/after, but not a working link when the same markdown renders in GitHub's PR view or VS Code). This version snapshot is a near-identical copy of 7.22's rest-api tree, so the same instances recur in the same two files. Co-Authored-By: Claude Sonnet 5 --- .../7.4/references/compatibility/commands/cluster.md | 2 +- .../references/compatibility/commands/connection.md | 2 +- .../7.4/references/compatibility/commands/generic.md | 2 +- .../7.4/references/compatibility/commands/pub-sub.md | 2 +- .../references/compatibility/commands/scripting.md | 2 +- .../7.4/references/compatibility/commands/server.md | 2 +- .../compatibility/commands/transactions.md | 2 +- .../rest-api/requests/bdbs/actions/_index.md | 12 ++++++------ .../references/rest-api/requests/debuginfo/_index.md | 8 ++++---- 9 files changed, 17 insertions(+), 17 deletions(-) diff --git a/content/operate/rs/7.4/references/compatibility/commands/cluster.md b/content/operate/rs/7.4/references/compatibility/commands/cluster.md index 6d26f0d664..52be0fd9d4 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/cluster.md +++ b/content/operate/rs/7.4/references/compatibility/commands/cluster.md @@ -14,7 +14,7 @@ url: '/operate/rs/7.4/references/compatibility/commands/cluster/' [Clustering in Redis Enterprise Software](/content/operate/rs/7.4/databases/durability-ha/clustering.md) and [Redis Cloud](/content/operate/rc/databases/configuration/clustering.md) differs from the [Redis Open Source cluster](/content/operate/oss_and_stack/management/scaling.md) and works with all standard Redis clients. -Redis Enterprise blocks most [cluster commands](/commands?group=cluster). If you try to use a blocked cluster command, it returns an error. +Redis Enterprise blocks most [cluster commands](/content/commands?group=cluster). If you try to use a blocked cluster command, it returns an error. | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| diff --git a/content/operate/rs/7.4/references/compatibility/commands/connection.md b/content/operate/rs/7.4/references/compatibility/commands/connection.md index 73337998a7..6704892f10 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/connection.md +++ b/content/operate/rs/7.4/references/compatibility/commands/connection.md @@ -12,7 +12,7 @@ weight: 10 url: '/operate/rs/7.4/references/compatibility/commands/connection/' --- -The following tables show which Redis Open Source [connection management commands](/commands?group=connection) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. +The following tables show which Redis Open Source [connection management commands](/content/commands?group=connection) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. | Command | Redis
    Enterprise | Redis
    Cloud | Notes | diff --git a/content/operate/rs/7.4/references/compatibility/commands/generic.md b/content/operate/rs/7.4/references/compatibility/commands/generic.md index 76705d7228..6e3155b383 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/generic.md +++ b/content/operate/rs/7.4/references/compatibility/commands/generic.md @@ -12,7 +12,7 @@ weight: 10 url: '/operate/rs/7.4/references/compatibility/commands/generic/' --- -The following table shows which Redis Open Source [key (generic) commands](/commands?group=generic) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. +The following table shows which Redis Open Source [key (generic) commands](/content/commands?group=generic) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| diff --git a/content/operate/rs/7.4/references/compatibility/commands/pub-sub.md b/content/operate/rs/7.4/references/compatibility/commands/pub-sub.md index ff8c76c941..91a231a8b3 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/pub-sub.md +++ b/content/operate/rs/7.4/references/compatibility/commands/pub-sub.md @@ -12,7 +12,7 @@ weight: 10 url: '/operate/rs/7.4/references/compatibility/commands/pub-sub/' --- -The following table shows which Redis Open Source [pub/sub commands](/commands?group=pubsub) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. +The following table shows which Redis Open Source [pub/sub commands](/content/commands?group=pubsub) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| diff --git a/content/operate/rs/7.4/references/compatibility/commands/scripting.md b/content/operate/rs/7.4/references/compatibility/commands/scripting.md index 47b2aa3029..9cef1b6fd8 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/scripting.md +++ b/content/operate/rs/7.4/references/compatibility/commands/scripting.md @@ -12,7 +12,7 @@ weight: 10 url: '/operate/rs/7.4/references/compatibility/commands/scripting/' --- -The following table shows which Redis Open Source [scripting and function commands](/commands?group=scripting) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. +The following table shows which Redis Open Source [scripting and function commands](/content/commands?group=scripting) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. ## Function commands diff --git a/content/operate/rs/7.4/references/compatibility/commands/server.md b/content/operate/rs/7.4/references/compatibility/commands/server.md index f8919a5622..ff40fdf123 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/server.md +++ b/content/operate/rs/7.4/references/compatibility/commands/server.md @@ -13,7 +13,7 @@ weight: 10 url: '/operate/rs/7.4/references/compatibility/commands/server/' --- -The following tables show which Redis Open Source [server management commands](/commands?group=server) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. +The following tables show which Redis Open Source [server management commands](/content/commands?group=server) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. ## Access control commands diff --git a/content/operate/rs/7.4/references/compatibility/commands/transactions.md b/content/operate/rs/7.4/references/compatibility/commands/transactions.md index a86becb725..a46c0263a3 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/transactions.md +++ b/content/operate/rs/7.4/references/compatibility/commands/transactions.md @@ -12,7 +12,7 @@ weight: 10 url: '/operate/rs/7.4/references/compatibility/commands/transactions/' --- -The following table shows which Redis Open Source [transaction commands](/commands?group=transactions) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. +The following table shows which Redis Open Source [transaction commands](/content/commands?group=transactions) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. | Command | Redis
    Enterprise | Redis
    Cloud | Notes | |:--------|:----------------------|:-----------------|:------| diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/_index.md index e5849103cb..1f25c0ab90 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/_index.md @@ -17,27 +17,27 @@ url: '/operate/rs/7.4/references/rest-api/requests/bdbs/actions/' | Method | Path | Description | |--------|------|-------------| -| [PUT](./backup_reset_status#put-bdbs-actions-backup-reset-status) | `/v1/bdbs/{uid}/actions/backup_reset_status` | Reset database backup status | +| [PUT](./backup_reset_status.md#put-bdbs-actions-backup-reset-status) | `/v1/bdbs/{uid}/actions/backup_reset_status` | Reset database backup status | ## Export | Method | Path | Description | |--------|------|-------------| -| [PUT](./export_reset_status#put-bdbs-actions-export-reset-status) | `/v1/bdbs/{uid}/actions/export_reset_status` | Reset database export status | -| [POST](./export#post-bdbs-actions-export) | `/v1/bdbs/{uid}/actions/export` | Initiate database export | +| [PUT](./export_reset_status.md#put-bdbs-actions-export-reset-status) | `/v1/bdbs/{uid}/actions/export_reset_status` | Reset database export status | +| [POST](./export.md#post-bdbs-actions-export) | `/v1/bdbs/{uid}/actions/export` | Initiate database export | ## Import | Method | Path | Description | |--------|------|-------------| -| [PUT](./import_reset_status#put-bdbs-actions-import-reset-status) | `/v1/bdbs/{uid}/actions/import_reset_status` | Reset database import status | -| [POST](./import#post-bdbs-actions-import) | `/v1/bdbs/{uid}/actions/import` | Initiate manual dataset import | +| [PUT](./import_reset_status.md#put-bdbs-actions-import-reset-status) | `/v1/bdbs/{uid}/actions/import_reset_status` | Reset database import status | +| [POST](./import.md#post-bdbs-actions-import) | `/v1/bdbs/{uid}/actions/import` | Initiate manual dataset import | ## Optimize shards placement | Method | Path | Description | |--------|------|-------------| -| [GET](./optimize_shards_placement#get-bdbs-actions-optimize-shards-placement) | `/v1/bdbs/{uid}/actions/optimize_shards_placement` | Get optimized shards placement for a database | +| [GET](./optimize_shards_placement.md#get-bdbs-actions-optimize-shards-placement) | `/v1/bdbs/{uid}/actions/optimize_shards_placement` | Get optimized shards placement for a database | ## Recover diff --git a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/_index.md b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/_index.md index 642d1e25e7..c5e9409ae1 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/_index.md @@ -22,12 +22,12 @@ Downloads a support package, which includes logs and information about the clust | Method | Path | Description | |--------|------|-------------| -| [GET](./all#get-all-debuginfo) | `/v1/debuginfo/all` | Gets debug info for all nodes | -| [GET](./all/bdb#get-all-debuginfo-bdb) | `/v1/debuginfo/all/bdb/{bdb_uid}` | Gets debug info for a database from all nodes | +| [GET](./all/_index.md#get-all-debuginfo) | `/v1/debuginfo/all` | Gets debug info for all nodes | +| [GET](./all/bdb.md#get-all-debuginfo-bdb) | `/v1/debuginfo/all/bdb/{bdb_uid}` | Gets debug info for a database from all nodes | ## Get debug info for the current node | Method | Path | Description | |--------|------|-------------| -| [GET](./node#get-debuginfo-node) | `/v1/debuginfo/node` | Gets debug info for the current node | -| [GET](./node/bdb#get-debuginfo-node-bdb) | `/v1/debuginfo/node/bdb/{bdb_uid}` | Gets debug info for a database from the current node | +| [GET](./node/_index.md#get-debuginfo-node) | `/v1/debuginfo/node` | Gets debug info for the current node | +| [GET](./node/bdb.md#get-debuginfo-node-bdb) | `/v1/debuginfo/node/bdb/{bdb_uid}` | Gets debug info for a database from the current node | From aaf1b784ff0e53896420c220ba6a88f931a2e8be Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Thu, 24 Sep 2026 11:03:17 +0100 Subject: [PATCH 4/4] DOC-7104: Fix bare /commands links in redis-cli/_index.md (review) Co-Authored-By: Claude Sonnet 5 --- .../rs/7.4/references/cli-utilities/redis-cli/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md b/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md index 80755225cb..cb094480b6 100644 --- a/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md +++ b/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md @@ -14,7 +14,7 @@ weight: $weight url: '/operate/rs/7.4/references/cli-utilities/redis-cli/' --- -The `redis-cli` command-line utility lets you interact with a Redis database. With `redis-cli`, you can run [Redis commands](/commands) directly from the command-line terminal or with [interactive mode](#interactive-mode). +The `redis-cli` command-line utility lets you interact with a Redis database. With `redis-cli`, you can run [Redis commands](/content/commands) directly from the command-line terminal or with [interactive mode](#interactive-mode). If you want to run Redis commands without `redis-cli`, you can [connect to a database with Redis Insight](/content/develop/tools/insight/_index.md) and use the built-in [CLI](/content/develop/tools/insight/_index.md) prompt instead. @@ -150,4 +150,4 @@ See [Scanning for big keys](/content/develop/tools/cli.md#scanning-for-big-keys) ## More info - [Redis CLI documentation](/content/develop/tools/cli.md) -- [Redis commands reference](/commands/) +- [Redis commands reference](/content/commands)