From 9af179294b6d73bae8f84db2d69e45522cdc7b4d Mon Sep 17 00:00:00 2001 From: dlavigne Date: Fri, 15 Jan 2016 15:06:06 -0500 Subject: [PATCH] Doc runreplication task. --- api/classes/lifepreserver.rst | 65 ++++++++++++++++++++++++++++++++++- 1 file changed, 64 insertions(+), 1 deletion(-) diff --git a/api/classes/lifepreserver.rst b/api/classes/lifepreserver.rst index 4759546..63756d3 100644 --- a/api/classes/lifepreserver.rst +++ b/api/classes/lifepreserver.rst @@ -21,7 +21,8 @@ Every lifepreserver class request contains the following parameters: | | | | +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ | action | | supported actions include "listcron", "cronsnap", "cronscrub", "listsnap", "revertsnap", "removesnap", | -| | | "addreplication", "removereplication", "listreplication", "initreplication", "settings", and "savesettings" | +| | | "addreplication", "removereplication", "listreplication", "runreplication", "initreplication", "settings", and | +| | | "savesettings" | | | | | +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ @@ -712,6 +713,68 @@ dataset on the remote system to store the replicated data ("rdset"), and the nam "namespace": "sysadm" } +.. _Start Replication: + +Start Replication +================= + +The "runreplication" action can be used to manually replicate the specified dataset to the specified remote server. + +**REST Request** + +.. code-block:: json + + PUT /sysadm/lifepreserver + { + "host" : "10.0.10.100", + "dataset" : "mypool", + "action" : "runreplication" + } + +**REST Response** + +.. code-block:: json + + { + "args": { + "runreplication": { + "dataset": "mypool", + "host": "10.0.10.100" + } + } + } + +**WebSocket Request** + +.. code-block:: json + + { + "id" : "fooid", + "name" : "lifepreserver", + "args" : { + "host" : "10.0.10.100", + "dataset" : "mypool", + "action" : "runreplication" + }, + "namespace" : "sysadm" + } + +**WebSocket Response** + +.. code-block:: json + + { + "args": { + "runreplication": { + "dataset": "mypool", + "host": "10.0.10.100" + } + }, + "id": "fooid", + "name": "response", + "namespace": "sysadm" + } + .. _Initialize Replication: Initialize Replication