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-07 15:15:43 -05:00
parent 40a7e41213 25ecc6f813
commit 54b70be0fa
1 changed files with 87 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
api/classes/lifepreserver.rst
View File

@@ -1,6 +1,91 @@
.. _lifepreserver:
lifepreserver
=============
*************
Some intro text here...
The lifepreserver class is used to manage and retrieve information about scheduled snapshots and replication.
Every lifepreserver class request contains the following parameters:
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| **Parameter** | **Value** | **Description** |
| | | |
+=================================+===============+======================================================================================================================+
| id | | any unique value for the request; examples include a hash, checksum, or uuid |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| name | sysadm | |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| namespace | lifepreserver | |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| action | | supported actions include listcron |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
The rest of this section provides examples of the available *actions* for each type of request, along with their responses.
.. _List Schedules:
List Schedules
==============
The "listcron" action retrieves the information for each scheduled snapshot. For each schedule, it lists the name of the ZFS pool, the number of snapshots to keep, and the time that the
snapshot is taken.
**REST Request**
.. code-block:: json
PUT /sysadm/lifepreserver
{
"action" : "listcron"
}
**REST Response**
.. code-block:: json
{
"args": {
"listcron": {
"tank1": {
"keep": "3",
"schedule": "daily@18"
}
}
}
}
**WebSocket Request**
.. code-block:: json
{
"args" : {
"action" : "listcron"
},
"name" : "lifepreserver",
"namespace" : "sysadm",
"id" : "fooid"
}
**WebSocket Response**
.. code-block:: json
{
"args": {
"listcron": {
"tank1": {
"keep": "3",
"schedule": "daily@18"
}
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}