{
  "schema_version": 2,
  "id": "operate/rs/references/cli-utilities/rladmin/cluster/recover",
  "title": "rladmin cluster recover",
  "url": "https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/cluster/recover/",
  "summary": "Recovers a cluster from a backup file.",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2025-05-19T15:06:21-05:00",
  "page_type": "content",
  "content_hash": "d30a2d72cceaad6ce9f7095c7ebe6f5fca36b44f99ca71a767610510bba4b0e4",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "Recovers a cluster from a backup file. The default location of the configuration backup file is `/var/opt/redislabs/persist/ccs/ccs-redis.rdb`.\n\n[code example]"
    },
    {
      "id": "parameters",
      "title": "Parameters",
      "role": "parameters",
      "text": "| Parameter | Type/Value | Description |\n|-----------|------------|-------------|\n| addr | IP address | Sets a node's internal IP address. If not provided, the node sets the address automatically. (optional) |\n| ccs_persistent_path | filepath | Path to the location of CCS snapshots (default is the same as persistent_path) (optional) |\n| external_addr | IP address | Sets a node's external IP address. If not provided, the node sets the address automatically. (optional) |\n| ephemeral_path | filepath (default: /var/opt/redislabs) | Path to an ephemeral storage location (optional) |\n| filename | filepath | Backup file to use for recovery |\n| flash_enabled | | Enables flash storage (optional) |\n| flash_path | filepath (default: /var/opt/redislabs/flash) | Path to the flash storage location in case the node does not support CAPI (required if flash_enabled) |\n| node_uid | integer (default: 1) | Specifies which node will recover first and become master (optional) |\n| override_rack_id | | Changes to a new rack, specified by `rack_id` (optional) |\n| persistent_path | filepath | Path to the persistent storage location (optional) |\n| rack_id | string | Switches to the specified rack (optional) |\n| second_rack_id | string | The unique identifier of a second rack ID for two-dimensional rack awareness (optional) |"
    },
    {
      "id": "returns",
      "title": "Returns",
      "role": "returns",
      "text": "Returns `ok` if the cluster recovered successfully. Otherwise, it returns an error message."
    },
    {
      "id": "example",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    }
  ],
  "examples": [
    {
      "id": "overview-ex0",
      "language": "sh",
      "code": "rladmin cluster recover\n        filename <recovery filename>\n        [ ephemeral_path <path> ]\n        [ persistent_path <path> ]\n        [ ccs_persistent_path <path> ]\n        [ rack_id <ID> ]\n        [ second_rack_id <ID> ]\n        [ override_rack_id ]\n        [ node_uid <number> ]\n        [ flash_enabled ]\n        [ flash_path <path> ]\n        [ addr <IP address> ]\n        [ external_addr <IP address> ]",
      "section_id": "overview"
    },
    {
      "id": "example-ex0",
      "language": "sh",
      "code": "$ rladmin cluster recover filename /tmp/persist/ccs/ccs-redis.rdb node_uid 1 rack_id 5\nInitiating cluster recovery... ok",
      "section_id": "example"
    }
  ]
}