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

Document cronscrub action.

Browse Source
This commit is contained in:
dlavigne
2016-01-12 13:17:24 -05:00
parent f659ce2fb1
commit bb88295d44
1 changed files with 81 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
api/classes/lifepreserver.rst
View File

@@ -14,13 +14,13 @@ Every lifepreserver class request contains the following parameters:
| id | | any unique value for the request; examples include a hash, checksum, or uuid |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| name | sysadm | |
| name | lifepreserver | |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| namespace | lifepreserver | |
| namespace | sysadm | |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| action | | supported actions include "listcron", "listsnap", "cronsnap", and "settings" |
| action | | supported actions include "listcron", "listsnap", "cronsnap", "cronscrub", and "settings" |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
@@ -170,10 +170,10 @@ The "listsnap" action retrieves the list of saved snapshots.
"namespace": "sysadm"
}
.. _Create a Schedule:
.. _Create a Snapshot Schedule:
Create a Schedule
=================
Create a Snapshot Schedule
==========================
The "cronsnap" action is used to create snapshot schedules for Life Preserver. This action supports the following parameters:
@@ -187,7 +187,7 @@ The "cronsnap" action is used to create snapshot schedules for Life Preserver. T
| keep | specify the number of snapshots to keep |
| | |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------+
| frequency | specify when to take the snapshots; possible values are "none", "daily@XX" (where XX is the number of the hour), |
| frequency | specify when to take the snapshots; possible values are "daily@XX" (where XX is the number of the hour), |
| | "hourly", "30min", "10min", "5min" or "none" (disables snapshots) |
| | |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------+
@@ -252,6 +252,80 @@ The "cronsnap" action is used to create snapshot schedules for Life Preserver. T
"namespace": "sysadm"
}
.. _Create a Scrub Schedule:
Create a Scrub Schedule
==========================
The "cronscrub" action is used to schedule a ZFS scrub. This action supports the following parameters:
+---------------------------------+----------------------------------------------------------------------------------------------------------------------+
| **Parameter** | **Description** |
| | |
+=================================+======================================================================================================================+
| pool | name of ZFS pool to scrub |
| | |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------+
| frequency | specify when to perform the scrub; possible values are "daily@XX", "weekly@YY@XX", and monthly@ZZ@XX, where "XX" is |
| | the hour, "YY" is the day of week, "ZZ" is the day of month, and "none" disables scrubs |
| | |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------+
**REST Request**
.. code-block:: json
PUT /sysadm/lifepreserver
{
"action" : "cronscrub",
"pool" : "tank",
"frequency" : "daily@22"
}
**REST Response**
.. code-block:: json
{
"args": {
"cronscrub": {
"frequency": "daily@22",
"pool": "tank"
}
}
}
**WebSocket Request**
.. code-block:: json
{
"args" : {
"action" : "cronscrub",
"pool" : "tank",
"frequency" : "daily@22"
},
"namespace" : "sysadm",
"name" : "lifepreserver",
"id" : "fooid"
}
**WebSocket Response**
.. code-block:: json
{
"args": {
"cronscrub": {
"frequency": "daily@22",
"pool": "tank"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. _View Settings:
View Settings