CLUSTER RESET

Syntax text Syntax diagram API methods

CLUSTER RESET [HARD | SOFT]

Client:

No method signature available for this client.

clusterReset() → String  // OK

clusterReset(
    resetType: ClusterResetType
) → String  // OK

clusterReset(
    hard: boolean  // Hard reset if true, soft reset if false
) → String  // OK

clusterReset(
    hard: boolean  // Hard reset if true, soft reset if false
) → RedisFuture<String>  // OK

clusterReset(
    hard: boolean  // Hard reset if true, soft reset if false
) → Mono<String>  // OK

ClusterResetSoft(
    ctx: context.Context
) → *StatusCmd

ClusterResetHard(
    ctx: context.Context
) → *StatusCmd

Available since:: Redis Open Source 3.0.0
Time complexity:: O(N) where N is the number of known nodes. The command may execute a FLUSHALL as a side effect.
ACL categories:: @admin, @slow, @dangerous,
Compatibility:: Redis Software and Redis Cloud compatibility

Use CLUSTER RESET to reset a Redis Cluster node. Specify SOFT or HARD to choose the reset type.

Before you reset a primary node, remove all keys from it, for example with FLUSHALL. Redis does not reset primary nodes that contain keys.

Effects on the node:

All the other nodes in the cluster are forgotten.
All the assigned / open slots are reset, so the slots-to-nodes mapping is totally cleared.
If the node is a replica its dataset is flushed, transforming the node to an empty master.
HARD reset only: a new Node ID is generated.
HARD reset only: currentEpoch and configEpoch variables are set to 0.
The new configuration is persisted on disk in the node cluster configuration file.

This command is mainly useful to reprovision a Redis Cluster node in order to be used in the context of a new, different cluster. The command is also extensively used by the Redis Cluster testing framework in order to reset the state of the cluster every time a new test unit is executed.

If no reset type is specified, the default is soft.

Optional arguments

HARD | SOFT

SOFT (the default) resets the node but keeps its node ID; HARD also assigns a new node ID and clears additional state.

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
❌ Standard ❌ Active-Active	❌ Standard ❌ Active-Active

Return information

RESP2 RESP3

Simple string reply: OK if the command was successful. Otherwise an error is returned.