Doc runreplication task.

This commit is contained in:
dlavigne
2016-01-15 15:06:06 -05:00
parent 4f14d76418
commit 9af179294b

View File

@@ -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