Skip to content

VOLUME.ADMIN REPLICATION

Starts or stops volume replication on a standby node.

VOLUME.ADMIN REPLICATION <operation> <volume-name>
ParameterTypeDescription
operationstringOne of START or STOP (case-insensitive)
volume-namestringVolume identifier (e.g. bucket-shard-0). Use VOLUME.ADMIN LIST to discover names

Operations:

OperationDescription
STARTStarts replication. Resumes processing if it was previously stopped.
STOPStops replication and prevents automatic restart until explicitly started again.

Simple string OK on success. OK means the request was accepted.

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).

ConditionMessage
Missing or extra parametersERR invalid number of parameters
Invalid volume name formatERR invalid volume name: <name>
No route found for the volumeERR No route found for <volume-name>
Current node is not a standby for the volumeERR This node is not a standby for <volume-name>
Invalid operation (not START or STOP)ERR unknown subcommand: '<operation>'

Start replication on a standby node:

127.0.0.1:3320> VOLUME.ADMIN REPLICATION START bucket-shard-1
OK

Stop replication on a standby node:

127.0.0.1:3320> VOLUME.ADMIN REPLICATION STOP bucket-shard-1
OK

Node 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-1

Missing parameters:

127.0.0.1:3320> VOLUME.ADMIN REPLICATION
(error) ERR invalid number of parameters