github-personal/sysadm
1
0
Fork 0
mirror of https://github.com/outbackdingo/sysadm.git synced 2026-01-27 10:20:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:pcbsd/sysadm

Browse Source
This commit is contained in:
Ken Moore
2016-01-13 13:17:18 -05:00
parent d93b0a5ba7 9f2dfc91a9
commit 2020eb2e64
1 changed files with 109 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
api/classes/lifepreserver.rst
View File

@@ -21,7 +21,7 @@ Every lifepreserver class request contains the following parameters:
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| action | | supported actions include "listcron", "cronsnap", "cronscrub", "listsnap", "revertsnap", "removesnap", |
| | | "settings", and "savesettings" |
| | | "addreplication", "settings", and "savesettings" |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
@@ -456,6 +456,114 @@ The "removesnap" action is used to remove a ZFS snapshot from the specified data
"namespace": "sysadm"
}
.. _Add Replication:
Add Replication
===============
The "addreplication" action is used to create a replication task in Life Preserver. This action supports the following parameters:
+---------------------------------+----------------------------------------------------------------------------------------------------------------------+
| **Parameter** | **Description** |
| | |
+=================================+======================================================================================================================+
| host | remote hostname or IP address |
| | |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------+
| port | SSH port number on remote system |
| | |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------+
| user | user must exist on remote system |
| | |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------+
| password | the password for *user* on remote system |
| | |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------+
| dataset | name of local dataset to replicate |
| | |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------+
| remotedataset | path to dataset on remote system |
| | |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------+
| frequency | when to replicate; supported times are "XX" (hour), "sync" (as snapshot is created, not recommended for frequent |
| | snapshots), "hour" (hourly), "30min" (every 30 minutes), "10min" (every 10 minutes), or "manual" (only when |
| | requested by user) |
| | |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------+
**REST Request**
.. code-block:: json
PUT /sysadm/lifepreserver
{
"action" : "addreplication",
"password" : "mypass",
"dataset" : "tank1",
"remotedataset" : "tank/backups",
"user" : "backupuser",
"frequency" : "22",
"port" : "22",
"host" : "192.168.0.10"
}
**REST Response**
.. code-block:: json
{
"args": {
"addreplication": {
"frequency": "22",
"host": "192.168.0.10",
"ldataset": "tank1",
"port": "22",
"rdataset": "tank/backups",
"user": "backupuser"
}
}
}
**WebSocket Request**
.. code-block:: json
{
"namespace" : "sysadm",
"name" : "lifepreserver",
"args" : {
"action" : "addreplication",
"user" : "backupuser",
"dataset" : "tank1",
"frequency" : "22",
"port" : "22",
"password" : "mypass",
"host" : "192.168.0.10",
"remotedataset" : "tank/backups"
},
"id" : "fooid"
}
**WebSocket Response**
.. code-block:: json
{
"args": {
"addreplication": {
"frequency": "22",
"host": "192.168.0.10",
"ldataset": "tank1",
"port": "22",
"rdataset": "tank/backups",
"user": "backupuser"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. _View Settings: