{
  "schema_version": 2,
  "id": "operate/rs/references/cli-utilities/rladmin/node/snapshot",
  "title": "rladmin node snapshot",
  "url": "https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/node/snapshot/",
  "summary": "Manages snapshots of the configuration of a node's shards and endpoints.",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2026-09-24T10:14:21+01:00",
  "page_type": "content",
  "content_hash": "99e82f26fd4ae063d9a54a045093641375ae30e881615211beb92141145b9f79",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "Manages snapshots of the configuration of a node's shards and endpoints.\n\nYou can create node snapshots and use them to restore the node's shards and endpoints to a configuration from a previous point in time. If you restore a node from a snapshot (for example, after an event such as failover or maintenance), the node's shards have the same placement and roles as when the snapshot was created."
    },
    {
      "id": "node-snapshot-create",
      "title": "`node snapshot create`",
      "role": "content",
      "text": "Creates a snapshot of a node's current configuration, including the placement of shards and endpoints on the node and the shards' roles.\n\n[code example]"
    },
    {
      "id": "parameters",
      "title": "Parameters",
      "role": "parameters",
      "text": "| Parameter             | Type/Value                     | Description                                                                               |\n|-----------------------|--------------------------------|-------------------------------------------------------------------------------------------|\n| node                  | integer                        | Creates a snapshot of the specified node                    |\n| name                  | string                         | Name of the created snapshot                                |"
    },
    {
      "id": "returns",
      "title": "Returns",
      "role": "returns",
      "text": "Returns `Done` if the snapshot was created successfully. Otherwise, returns an error."
    },
    {
      "id": "example",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    },
    {
      "id": "node-snapshot-delete",
      "title": "`node snapshot delete`",
      "role": "content",
      "text": "Deletes an existing snapshot of a node.\n\n[code example]\n\n> [!NOTE]\n> You cannot use this command to delete a snapshot created by maintenance mode. As of Redis Software version 7.4.2, only the latest maintenance mode snapshot is kept."
    },
    {
      "id": "parameters-1",
      "title": "Parameters",
      "role": "parameters",
      "text": "| Parameter             | Type/Value                     | Description                                                                               |\n|-----------------------|--------------------------------|-------------------------------------------------------------------------------------------|\n| node                  | integer                        | Deletes a snapshot of the specified node                    |\n| name                  | string                         | Deletes the specified snapshot                                |"
    },
    {
      "id": "returns-1",
      "title": "Returns",
      "role": "returns",
      "text": "Returns `Done` if the snapshot was deleted successfully. Otherwise, returns an error."
    },
    {
      "id": "example-1",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    },
    {
      "id": "node-snapshot-list",
      "title": "`node snapshot list`",
      "role": "content",
      "text": "Displays a list of created snapshots for the specified node.\n\n[code example]"
    },
    {
      "id": "parameters-2",
      "title": "Parameters",
      "role": "parameters",
      "text": "| Parameter             | Type/Value                     | Description                                                                               |\n|-----------------------|--------------------------------|-------------------------------------------------------------------------------------------|\n| node                  | integer                        | Displays snapshots of the specified node                    |"
    },
    {
      "id": "returns-2",
      "title": "Returns",
      "role": "returns",
      "text": "Returns a list of snapshots of the specified node."
    },
    {
      "id": "example-2",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    },
    {
      "id": "node-snapshot-restore",
      "title": "`node snapshot restore`",
      "role": "content",
      "text": "Restores a node's shards and endpoints as close to the stored snapshot as possible.\n\n[code example]"
    },
    {
      "id": "parameters-3",
      "title": "Parameters",
      "role": "parameters",
      "text": "| Parameter             | Type/Value                     | Description                                                                               |\n|-----------------------|--------------------------------|-------------------------------------------------------------------------------------------|\n| node                  | integer                        | Restore the specified node from a snapshot.                    |\n| restore              | string                           | Name of the snapshot used to restore the node.              |"
    },
    {
      "id": "returns-3",
      "title": "Returns",
      "role": "returns",
      "text": "Returns `Snapshot restore completed successfully` if the actions needed to restore the snapshot completed successfully. Otherwise, it returns an error."
    },
    {
      "id": "example-3",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    }
  ],
  "examples": [
    {
      "id": "node-snapshot-create-ex0",
      "language": "sh",
      "code": "rladmin node <ID> snapshot create <name>",
      "section_id": "node-snapshot-create"
    },
    {
      "id": "example-ex0",
      "language": "sh",
      "code": "$ rladmin node 1 snapshot create snap1\nCreating node snapshot 'snap1' for node:1\nDone.",
      "section_id": "example"
    },
    {
      "id": "node-snapshot-delete-ex0",
      "language": "sh",
      "code": "rladmin node <ID> snapshot delete <name>",
      "section_id": "node-snapshot-delete"
    },
    {
      "id": "example-1-ex0",
      "language": "sh",
      "code": "$ rladmin node 1 snapshot delete snap1\nDeleting node snapshot 'snap1' for node:1\nDone.",
      "section_id": "example-1"
    },
    {
      "id": "node-snapshot-list-ex0",
      "language": " sh",
      "code": "rladmin node <ID> snapshot list",
      "section_id": "node-snapshot-list"
    },
    {
      "id": "example-2-ex0",
      "language": "sh",
      "code": "$ rladmin node 2 snapshot list\nName                                               Node    Time\nsnap2                                              2       2022-05-12T19:27:51Z",
      "section_id": "example-2"
    },
    {
      "id": "node-snapshot-restore-ex0",
      "language": "sh",
      "code": "rladmin node <ID> snapshot restore <name>",
      "section_id": "node-snapshot-restore"
    },
    {
      "id": "example-3-ex0",
      "language": "sh",
      "code": "$ rladmin node 2 snapshot restore snap2\nReading node snapshot 'snap2' for node:2\nPlanning restore\nPlanned actions:\n* migrate redis:15 to node:2\n* failover redis:14\n* migrate redis:17 to node:2\n* failover redis:16\n* migrate redis:19 to node:2\n* failover redis:18\n* migrate redis:21 to node:2\n* failover redis:20\nProceed?[Y]es/[N]o? Y\n2022-05-12T19:43:31.486613 Scheduling 8 actions\n[2022-05-12T19:43:31.521422 Actions Status: 8 waiting ]\n* [migrate redis:21 to node:2] waiting => executing\n* [migrate redis:19 to node:2] waiting => executing\n* [migrate redis:17 to node:2] waiting => executing\n* [migrate redis:15 to node:2] waiting => executing\n[2022-05-12T19:43:32.586084 Actions Status: 4 executing | 4 waiting ]\n* [migrate redis:21 to node:2] executing => finished\n* [migrate redis:19 to node:2] executing => finished\n* [migrate redis:17 to node:2] executing => finished\n* [migrate redis:15 to node:2] executing => finished\n* [failover redis:20] waiting => executing\n* [failover redis:18] waiting => executing\n* [failover redis:16] waiting => executing\n* [failover redis:14] waiting => executing\n[2022-05-12T19:43:33.719496 Actions Status: 4 finished | 4 executing ]\n* [failover redis:20] executing => finished\n* [failover redis:18] executing => finished\n* [failover redis:16] executing => finished\n* [failover redis:14] executing => finished\nSnapshot restore completed successfully.",
      "section_id": "example-3"
    }
  ]
}