VOLUME.ADMIN REPLICATION
Starts or stops volume replication on a standby node.
Syntax
Section titled “Syntax”VOLUME.ADMIN REPLICATION <operation> <volume-name>Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
operation | string | One of START or STOP (case-insensitive) |
volume-name | string | Volume identifier (e.g. bucket-shard-0). Use VOLUME. to discover names |
Operations:
| Operation | Description |
|---|---|
START | Starts replication. Resumes processing if it was previously stopped. |
STOP | Stops replication and prevents automatic restart until explicitly started again. |
Return Value
Section titled “Return Value”Simple string OK on success. OK means the request was accepted.
Behavior
Section titled “Behavior”Both operations verify that the current node is listed as a standby in the route for the given volume.
START resumes replication processing. Replication normally starts automatically when a standby is assigned via routing, but if it was previously stopped (e.g. for maintenance), this command re-initiates it manually.
STOP gracefully shuts down replication and prevents automatic restart until explicitly started again.
This command must be run on the standby node. It is available on the management port (default 3320).
Errors
Section titled “Errors”| Condition | Message |
|---|---|
| Missing or extra parameters | ERR invalid number of parameters |
| Invalid volume name format | ERR invalid volume name: <name> |
| No route found for the volume | ERR No route found for <volume-name> |
| Current node is not a standby for the volume | ERR This node is not a standby for <volume-name> |
| Invalid operation (not START or STOP) | ERR unknown subcommand: '<operation>' |
Examples
Section titled “Examples”Start replication on a standby node:
127.0.0.1:3320> VOLUME.ADMIN REPLICATION START bucket-shard-1OKStop replication on a standby node:
127.0.0.1:3320> VOLUME.ADMIN REPLICATION STOP bucket-shard-1OKNode is not a standby:
127.0.0.1:3320> VOLUME.ADMIN REPLICATION START bucket-shard-1(error) ERR This node is not a standby for bucket-shard-1Missing parameters:
127.0.0.1:3320> VOLUME.ADMIN REPLICATION(error) ERR invalid number of parameters