Doc createsnap action.

This commit is contained in:
dlavigne
2016-04-21 13:37:59 -04:00
parent e4db11a0f7
commit 25eac09ce9

View File

@@ -20,7 +20,7 @@ Every lifepreserver class request contains the following parameters:
| namespace | sysadm | |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| action | | supported actions include "listcron", "cronsnap", "cronscrub", "listsnap", "revertsnap", "removesnap", |
| action | | supported actions include "listcron", "cronsnap", "cronscrub", "createsnap", "listsnap", "revertsnap", "removesnap", |
| | | "addreplication", "removereplication", "listreplication", "runreplication", "initreplication", "settings", and |
| | | "savesettings" |
| | | |
@@ -255,6 +255,60 @@ The "cronscrub" action is used to schedule a ZFS scrub. This action supports the
"name": "response",
"namespace": "sysadm"
}
.. index:: createsnap, Life Preserver
.. _Create a Snapshot:
Create a Snapshot
=================
The "createsnap" action creates a one-time snapshot of the specified dataset.
**REST Request**
.. code-block:: json
PUT /sysadm/lifepreserver
{
"snap" : "mytestsnap",
"dataset" : "tank",
"comment" : "Testing",
"action" : "createsnap"
}
**WebSocket Request**
.. code-block:: json
{
"args" : {
"comment" : "Testing",
"dataset" : "tank",
"action" : "createsnap",
"snap" : "mytestsnap"
},
"name" : "lifepreserver",
"namespace" : "sysadm",
"id" : "fooid"
}
**Response**
.. code-block:: json
{
"args": {
"createsnap": {
"comment": "Testing",
"dataset": "tank",
"snap": "mytestsnap"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: listsnap, Life Preserver