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

Fix all Sphinx build errors with API handbook

Browse Source 
- Fixed every sphinx build error for JSON parsing.
- For invalid JSON messages, replaced .. code-block:: JSON with the
  generic code block directive ::.
- Fixed multiple errors across various valid JSON code blocks.
- Fixed a few spacing errors with .. note:: entries.
This commit is contained in:
Mrt134
2016-08-04 15:01:15 -04:00
parent 26d114639a
commit fbc436db75
14 changed files with 142 additions and 207 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
api/classes/beadm.rst
View File

@@ -42,7 +42,7 @@ was created, its mount point, its nickname, and its size.
**REST Request**
.. code-block:: json
::
PUT /sysadm/beadm
{
@@ -104,7 +104,7 @@ environment as the "target".
**REST Request**
.. code-block:: json
::
PUT /sysadm/beadm
{
@@ -157,7 +157,7 @@ The "activatebe" action activates the specified boot environment
**REST Request**
.. code-block:: json
::
PUT /sysadm/beadm
{
@@ -208,7 +208,7 @@ also include "clonefrom" to specify which boot environment to clone from.
**REST Request**
.. code-block:: json
::
PUT /sysadm/beadm
{
@@ -261,7 +261,7 @@ and forcefully unmounts it.
**REST Request**
.. code-block:: json
::
PUT /sysadm/beadm
{
@@ -310,7 +310,7 @@ optional "mountpoint" argument to specify the mount point.
**REST Request**
.. code-block:: json
::
PUT /sysadm/beadm
{
@@ -362,7 +362,7 @@ even if it is in use.
**REST Request**
.. code-block:: json
::
PUT /sysadm/beadm
{

4
api/classes/dispatcher.rst
View File

@@ -41,7 +41,7 @@ within the dispatcher queues. Possible queues are "no_queue",
**REST Request**
.. code-block:: json
::
PUT /rpc/dispatcher
{
@@ -96,7 +96,7 @@ running jobs within the dispatcher system.
**REST Request**
.. code-block:: json
::
PUT /rpc/dispatcher
{

2
api/classes/fs.rst
View File

@@ -38,7 +38,7 @@ The "dirlist" action lists the contents of the specified directory.
**REST Request**
.. code-block:: json
::
PUT /sysadm/fs
{

58
api/classes/iocage.rst
View File

@@ -43,7 +43,7 @@ apply to all jails.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -326,7 +326,7 @@ thickjail).
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -409,7 +409,7 @@ Here is an example of specifying the property and the jail:
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -454,7 +454,7 @@ Here is an example of using *-r* and a specifed property:
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -505,7 +505,7 @@ jail, as both modes produce identical outputs:
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -674,7 +674,7 @@ name).
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -733,12 +733,12 @@ Start a Jail
The "startjail" action starts the specified jail.
.. note:: since a jail can only be started once, you will receive an
error if the jail is already running.
.. note:: A jail can be started only once. If the jail is already
running, an error message will be generated.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -802,12 +802,12 @@ Stop a Jail
The "stopjail" action stops the specified jail.
.. note:: since a jail can only be stopped once, you will receive an
error if the jail is not running.
.. note:: A jail can be only stopped once. If the jail has already
stopped, an error message will be generated.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -877,7 +877,7 @@ want to apply the changes without restarting the jail.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -931,7 +931,7 @@ has a different name than the jail it was cloned from.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -979,7 +979,7 @@ values and the props returned in the response is empty:
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -1034,7 +1034,7 @@ the "release" property specifies which template to use.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -1081,7 +1081,7 @@ for the list of available switches.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -1107,7 +1107,7 @@ for the list of available switches.
**Response**
.. code-block:: json
::
{
"args": {
@@ -1137,7 +1137,7 @@ jail is running.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -1190,7 +1190,7 @@ output from the command.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -1245,7 +1245,7 @@ all data stored in the jails.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -1293,7 +1293,7 @@ basejails still exist.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -1343,7 +1343,7 @@ The "cleantemplates" action destroys all existing jail templates.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -1365,7 +1365,7 @@ The "cleantemplates" action destroys all existing jail templates.
**Response**
.. code-block:: json
::
{
"args": {
@@ -1389,7 +1389,7 @@ The "cleanall" action destroys everything associated with iocage.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -1439,7 +1439,7 @@ These examples specify the pool to use:
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -1492,7 +1492,7 @@ These examples show responses when the pool is not specified:
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{
@@ -1528,7 +1528,7 @@ These examples show responses when the pool is not specified:
**WebSocket Response**
.. code-block:: json
::
{
"args": {
@@ -1559,7 +1559,7 @@ or activate the old pool again.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iocage
{

42
api/classes/iohyve.rst
View File

@@ -45,7 +45,7 @@ loaded into memory.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -115,7 +115,7 @@ with *http://*, *ftp://*, or *file://*.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -163,7 +163,7 @@ with *http://*, *ftp://*, or *file://*.
"name" : "dispatcher",
"id" : "none",
"args" : {
"event_system" : "sysadm"/"iohyve",
"event_system" : "sysadm/iohyve",
"state" : "finished",
"filename" : "<filename>",
"percent_done" : "<number>%",
@@ -190,7 +190,7 @@ The "listisos" action lists all the known ISO files which iohyve can use.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -237,7 +237,7 @@ Specify the existing name with "source" and the new name with "target".
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -289,7 +289,7 @@ Specify the ISO's name as the "target".
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -339,7 +339,7 @@ use.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -391,7 +391,7 @@ The "issetup" action queries if iohyve has been setup and returns either
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -438,7 +438,7 @@ and "size".
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -492,7 +492,7 @@ the system.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -543,7 +543,7 @@ The "start" action starts the specified VM.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -591,7 +591,7 @@ The "stop" action stops the specified VM.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -639,7 +639,7 @@ The "delete" action deletes the specified iohyve guest.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -687,7 +687,7 @@ The "adddisk" action adds and creates a disk for a VM.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -739,7 +739,7 @@ The "listdisks" action lists the disks connected to the specified VM.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -789,7 +789,7 @@ size.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -843,7 +843,7 @@ The "deletedisk" action removes the specified disk from the specified VM.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -869,7 +869,7 @@ The "deletedisk" action removes the specified disk from the specified VM.
**Response**
.. code-block:: json
::
{
"args": {
@@ -894,7 +894,7 @@ The "version" action displays the iohyve version.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -940,7 +940,7 @@ The "getprops" action lists the properties for the specified guest.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{
@@ -1005,7 +1005,7 @@ Use "getprops" to see the current properties and values for the guest.
**REST Request**
.. code-block:: json
::
PUT /sysadm/iohyve
{

28
api/classes/lifepreserver.rst
View File

@@ -45,7 +45,7 @@ the time that ZFS scrubs occur.
**REST Request**
.. code-block:: json
::
PUT /sysadm/lifepreserver
{
@@ -129,7 +129,7 @@ Preserver. This action supports the following parameters:
**REST Request**
.. code-block:: json
::
PUT /sysadm/lifepreserver
{
@@ -211,7 +211,7 @@ supports the following parameters:
**REST Request**
.. code-block:: json
::
PUT /sysadm/lifepreserver
{
@@ -276,7 +276,7 @@ dataset.
**REST Request**
.. code-block:: json
::
PUT /sysadm/lifepreserver
{
@@ -330,7 +330,7 @@ The "listsnap" action retrieves the list of saved snapshots.
**REST Request**
.. code-block:: json
::
PUT /sysadm/lifepreserver
{
@@ -419,7 +419,7 @@ taken.
**REST Request**
.. code-block:: json
::
PUT /sysadm/lifepreserver
{
@@ -484,7 +484,7 @@ specified dataset or pool.
**REST Request**
.. code-block:: json
::
PUT /sysadm/lifepreserver
{
@@ -577,7 +577,7 @@ Preserver. This action supports the following parameters:
**REST Request**
.. code-block:: json
::
PUT /sysadm/lifepreserver
{
@@ -674,7 +674,7 @@ This action supports the following parameters:
**REST Request**
.. code-block:: json
::
PUT /sysadm/lifepreserver
{
@@ -745,7 +745,7 @@ user account.
**REST Request**
.. code-block:: json
::
PUT /sysadm/lifepreserver
{
@@ -818,7 +818,7 @@ specified dataset to the specified remote server.
**REST Request**
.. code-block:: json
::
PUT /sysadm/lifepreserver
{
@@ -898,7 +898,7 @@ The "initreplication" action supports the following parameters:
**REST Request**
.. code-block:: json
::
PUT /sysadm/lifepreserver
{
@@ -970,7 +970,7 @@ available setting.
**REST Request**
.. code-block:: json
::
PUT /sysadm/lifepreserver
{
@@ -1054,7 +1054,7 @@ parameters:
**REST Request**
.. code-block:: json
::
PUT /sysadm/lifepreserver
{

11
api/classes/logs.rst
View File

@@ -73,10 +73,11 @@ And will return this format:
.. code-block:: json
"args" : {
"<log_file_type>" : {
"<date_time_stamp>" : <message>,
"<date_timo_stamp2>" : <message>
{
"args" : {
"<log_file_type>" : {
"<date_time_stamp>" : "<message>",
"<date_time_stamp2>" : "<message>"
}
}
}

2
api/classes/network.rst
View File

@@ -44,7 +44,7 @@ its current status.
**REST Request**
.. code-block:: json
::
PUT /sysadm/network
{

122
api/classes/pkg.rst
View File

@@ -52,7 +52,7 @@ relevant information. The following arguments are optional:
**REST Request**
.. code-block:: json
::
PUT /sysadm/pkg
{
@@ -82,7 +82,7 @@ relevant information. The following arguments are optional:
**Response**
.. code-block:: json
::
{
"args": {
@@ -98,24 +98,9 @@ relevant information. The following arguments are optional:
"x11-wm/fluxbox",
"x11/libXdamage",
"devel/qt5-linguist",
"x11/numlockx",
"devel/qt5-buildtools",
"multimedia/qt5-multimedia",
"graphics/qt5-svg",
"x11/xbrightness",
"x11/xorg",
"devel/desktop-file-utils",
"devel/qt5-concurrent",
"x11/libX11",
"net/qt5-network",
"x11-themes/fluxbox-tenr-styles-pack",
"x11-themes/kde4-icons-oxygen",
"devel/qt5-core",
"x11/xscreensaver",
"multimedia/gstreamer1-plugins-core",
"graphics/qt5-imageformats"
"x11/numlockx"
],
"desc": "Lumina-DE is a lightweight, BSD licensed desktop environment,\ndesigned specifically for use on FreeBSD\n\nWWW: http://lumina-desktop.org",
"desc": "Lumina-DE is a lightweight, BSD licensed desktop environment.",
"files": [
"/usr/local/share/licenses/lumina-0.8.8_2,1/catalog.mk",
"/usr/local/share/licenses/lumina-0.8.8_2,1/LICENSE",
@@ -130,48 +115,7 @@ relevant information. The following arguments are optional:
"/usr/local/bin/lumina-search",
"/usr/local/bin/lumina-xconfig",
"/usr/local/etc/luminaDesktop.conf.dist",
"/usr/local/include/LuminaOS.h",
"/usr/local/include/LuminaSingleApplication.h",
"/usr/local/include/LuminaThemes.h",
"/usr/local/include/LuminaUtils.h",
"/usr/local/include/LuminaX11.h",
"/usr/local/include/LuminaXDG.h",
"/usr/local/lib/libLuminaUtils.so",
"/usr/local/lib/libLuminaUtils.so.1",
"/usr/local/lib/libLuminaUtils.so.1.0",
"/usr/local/lib/libLuminaUtils.so.1.0.0",
"/usr/local/share/Lumina-DE/Login.ogg",
"/usr/local/share/Lumina-DE/Logout.ogg",
"/usr/local/share/Lumina-DE/colors/Black.qss.colors",
"/usr/local/share/Lumina-DE/colors/Blue-Light.qss.colors",
"/usr/local/share/Lumina-DE/colors/Grey-Dark.qss.colors",
"/usr/local/share/Lumina-DE/colors/Lumina-Glass.qss.colors",
"/usr/local/share/Lumina-DE/colors/Lumina-Gold.qss.colors",
"/usr/local/share/Lumina-DE/colors/Lumina-Green.qss.colors",
"/usr/local/share/Lumina-DE/colors/Lumina-Purple.qss.colors",
"/usr/local/share/Lumina-DE/colors/Lumina-Red.qss.colors",
"/usr/local/share/Lumina-DE/colors/PCBSD10-Default.qss.colors",
"/usr/local/share/Lumina-DE/colors/Solarized-Dark.qss.colors",
"/usr/local/share/Lumina-DE/colors/Solarized-Light.qss.colors",
"/usr/local/share/Lumina-DE/desktop-background.jpg",
"/usr/local/share/Lumina-DE/fluxbox-init-rc",
"/usr/local/share/Lumina-DE/fluxbox-keys",
"/usr/local/share/Lumina-DE/luminaDesktop.conf",
"/usr/local/share/Lumina-DE/quickplugins/quick-sample.qml",
"/usr/local/share/Lumina-DE/themes/Lumina-default.qss.template",
"/usr/local/share/Lumina-DE/themes/None.qss.template",
"/usr/local/share/applications/lumina-fm.desktop",
"/usr/local/share/applications/lumina-info.desktop",
"/usr/local/share/applications/lumina-screenshot.desktop",
"/usr/local/share/applications/lumina-search.desktop",
"/usr/local/share/applications/lumina-support.desktop",
"/usr/local/share/pixmaps/Insight-FileManager.png",
"/usr/local/share/pixmaps/Lumina-DE.png",
"/usr/local/share/wallpapers/Lumina-DE/Lumina_Wispy_gold.jpg",
"/usr/local/share/wallpapers/Lumina-DE/Lumina_Wispy_green.jpg",
"/usr/local/share/wallpapers/Lumina-DE/Lumina_Wispy_purple.jpg",
"/usr/local/share/wallpapers/Lumina-DE/Lumina_Wispy_red.jpg",
"/usr/local/share/xsessions/Lumina-DE.desktop"
"/usr/local/include/LuminaOS.h"
],
"flatsize": "12324767",
"icon": "\\\"http://www.pcbsd.org/appcafe/icons/x11_lumina.png\\\"",
@@ -183,7 +127,7 @@ relevant information. The following arguments are optional:
"locked": "0",
"maintainer": "kmoore@FreeBSD.org",
"manifestdigest": "2$0$4ypg5zrco9upyuioczmo3uwbtdd5yart7xuit6fx3gjrn1k979qb",
"message": "[{\"message\":\"The Lumina Desktop Environment has been installed!\\n\\nAn entry for for launching Lumina from a graphical login manager has already been added to the system, but if you with to start Lumina manually, you will need to do one of the following:\\n1) Put the line \\\"exec Lumina-DE\\\" at the end of your user's \\\"~/.xinitrc\\\" file before running startx\\n2) Wrap the Lumina binary call with an X initialization call: \\nExample: \\\"xinit ${PREFIX}/bin/Lumina-DE -- :0\\\"\\n\\nAlso note that the system-wide default settings for Lumina are contained in ${PREFIX}/etc/luminaDesktop.conf[.dist]. While it is possible to customize the desktop to the user's liking after logging in, you may want to adjust the default settings as necessary if there are multiple user accounts on this system.\"}]",
"message": "The Lumina Desktop Environment has been installed!",
"mtree_id": "",
"name": "lumina",
"options": {
@@ -205,19 +149,7 @@ relevant information. The following arguments are optional:
"libxcb-damage.so.0",
"libXdamage.so.1",
"libxcb-util.so.1",
"libGL.so.1",
"libQt5Core.so.5",
"libxcb-image.so.0",
"libxcb-icccm.so.4",
"libxcb-ewmh.so.2",
"libQt5Gui.so.5",
"libQt5Network.so.5",
"libQt5Widgets.so.5",
"libQt5Concurrent.so.5",
"libQt5Multimedia.so.5",
"libQt5MultimediaWidgets.so.5",
"libQt5Svg.so.5",
"libQt5X11Extras.so.5"
"libGL.so.1"
],
"time": "1458334158",
"version": "0.8.8_2,1",
@@ -248,7 +180,7 @@ match the given "search_term" (required). These parameters are optional:
**REST Request**
.. code-block:: json
::
PUT /sysadm/pkg
{
@@ -427,7 +359,7 @@ local repository.
**REST Request**
.. code-block:: json
::
PUT /sysadm/pkg
{
@@ -529,7 +461,7 @@ argument for the other pkg API actions.
**REST Request**
.. code-block:: json
::
PUT /sysadm/pkg
{
@@ -585,7 +517,7 @@ packages which are impacted by those vulnerabilities.
**REST Request**
.. code-block:: json
::
PUT /sysadm/pkg
{
@@ -631,7 +563,7 @@ packages which are impacted by those vulnerabilities.
"name" : "dispatcher",
"id" : "none",
"args" : {
"event_system" : "sysadm"/"pkg",
"event_system" : "sysadm/pkg",
"state" : "finished",
"pkg_log" : "<process log>",
"action" : "pkg_audit",
@@ -660,7 +592,7 @@ to and query dispatcher events.
**REST Request**
.. code-block:: json
::
PUT /sysadm/pkg
{
@@ -706,7 +638,7 @@ to and query dispatcher events.
"name" : "dispatcher",
"id" : "none",
"args" : {
"event_system" : "sysadm"/"pkg",
"event_system" : "sysadm/pkg",
"state" : "finished",
"pkg_log" : "<process log>",
"action" : "pkg_upgrade",
@@ -735,7 +667,7 @@ subscribe to and query dispatcher events.
**REST Request**
.. code-block:: json
::
PUT /sysadm/pkg
{
@@ -785,7 +717,7 @@ subscribe to and query dispatcher events.
"state" : "finished",
"pkg_log" : "<process log>",
"action" : "pkg_check_upgrade",
"updates_available" : "true" OR "false",
"updates_available" : "true/false",
"process_details" : {
"time_finished" : "<ISO 8601 time date string>",
"cmd_list" : ["<command 1>", "<command 2>"],
@@ -815,7 +747,7 @@ some time.
**REST Request**
.. code-block:: json
::
PUT /sysadm/pkg
{
@@ -863,7 +795,7 @@ some time.
"name" : "dispatcher",
"id" : "none",
"args" : {
"event_system" : "sysadm"/"pkg",
"event_system" : "sysadm/pkg",
"state" : "finished",
"pkg_log" : "<process log>",
"action" : "pkg_update",
@@ -899,7 +831,7 @@ query dispatcher events.
**REST Request**
.. code-block:: json
::
PUT /sysadm/pkg
{
@@ -951,7 +883,7 @@ query dispatcher events.
"name" : "dispatcher",
"id" : "none",
"args" : {
"event_system" : "sysadm"/"pkg",
"event_system" : "sysadm/pkg",
"state" : "finished",
"pkg_log" : "<process log>",
"action" : "pkg_lock",
@@ -968,7 +900,7 @@ query dispatcher events.
**REST Request**
.. code-block:: json
::
PUT /sysadm/pkg
{
@@ -1016,7 +948,7 @@ query dispatcher events.
"name" : "dispatcher",
"id" : "none",
"args" : {
"event_system" : "sysadm"/"pkg",
"event_system" : "sysadm/pkg",
"state" : "finished",
"pkg_log" : "<process log>",
"action" : "pkg_unlock",
@@ -1048,7 +980,7 @@ query dispatcher events.
**REST Request**
.. code-block:: json
::
PUT /sysadm/pkg
{
@@ -1098,7 +1030,7 @@ query dispatcher events.
"name" : "dispatcher",
"id" : "none",
"args" : {
"event_system" : "sysadm"/"pkg",
"event_system" : "sysadm/pkg",
"state" : "finished",
"pkg_log" : "<process log>",
"action" : "pkg_install",
@@ -1134,7 +1066,7 @@ and query dispatcher events.
**REST Request**
.. code-block:: json
::
PUT /sysadm/pkg
{
@@ -1184,7 +1116,7 @@ and query dispatcher events.
"name" : "dispatcher",
"id" : "none",
"args" : {
"event_system" : "sysadm"/"pkg",
"event_system" : "sysadm/pkg",
"state" : "finished",
"pkg_log" : "<process log>",
"action" : "pkg_remove",
@@ -1210,7 +1142,7 @@ The "pkg_autoremove" action prunes all orphaned packages on the system.
**REST Request**
.. code-block:: json
::
PUT /sysadm/pkg
{

24
api/classes/systemmanager.rst
View File

@@ -39,7 +39,7 @@ of active, cached, free, inactive, and total physical (wired) memory.
**REST Request**
.. code-block:: json
::
PUT /sysadm/systemmanager
{
@@ -105,7 +105,7 @@ The "cpupercentage" action returns the usage percentage of each CPU.
**REST Request**
.. code-block:: json
::
PUT /sysadm/systemmanager
{
@@ -187,7 +187,7 @@ The "cputemps" action returns the temperature of each CPU.
**REST Request**
.. code-block:: json
::
PUT /sysadm/systemmanager
{
@@ -254,7 +254,7 @@ listed by this action.
**REST Request**
.. code-block:: json
::
PUT /sysadm/systemmanager
{
@@ -337,7 +337,7 @@ QUIT, ABRT, KILL, ALRM, or TERM.
**REST Request**
.. code-block:: json
::
PUT /sysadm/systemmanager
{
@@ -406,7 +406,7 @@ estimated time left (in seconds).
**REST Request**
.. code-block:: json
::
PUT /sysadm/systemmanager
{
@@ -467,7 +467,7 @@ device name, filesystem, mount path, and device type.
**REST Request**
.. code-block:: json
::
PUT /sysadm/systemmanager
{
@@ -536,7 +536,7 @@ system's uptime.
**REST Request**
.. code-block:: json
::
PUT /sysadm/systemmanager
{
@@ -612,7 +612,7 @@ been truncated to just show a few.
**REST Request**
.. code-block:: json
::
PUT /sysadm/systemmanager
{
@@ -688,7 +688,7 @@ to the new value.
**REST Request**
.. code-block:: json
::
PUT /sysadm/systemmanager
{
@@ -754,7 +754,7 @@ The "halt" action shuts down the system.
**REST Request**
.. code-block:: json
::
PUT /sysadm/systemmanager
{
@@ -800,7 +800,7 @@ The "reboot" action reboots the system.
**REST Request**
.. code-block:: json
::
PUT /sysadm/systemmanager
{

8
api/classes/updates.rst
View File

@@ -43,7 +43,7 @@ installed software packages.
**REST Request**
.. code-block:: json
::
PUT /sysadm/update
{
@@ -103,7 +103,7 @@ listed as "active".
**REST Request**
.. code-block:: json
::
PUT /sysadm/update
{
@@ -180,7 +180,7 @@ targets are:
**REST Request**
.. code-block:: json
::
PUT /sysadm/update
{
@@ -242,7 +242,7 @@ targets are:
"name" : "dispatcher",
"id" : "none",
"args" : {
"event_system" : "sysadm"/"update",
"event_system" : "sysadm/update",
"state" : "finished",
"update_log" : "<update log>",
"process_details" : {

4
api/classes/zfs.rst
View File

@@ -45,7 +45,7 @@ total size. This action is the equivalent of running
**REST Request**
.. code-block:: json
::
PUT /sysadm/zfs
{
@@ -101,7 +101,7 @@ The "datasets" action lists the ZFS datasets on the specified pool.
**REST Request**
.. code-block:: json
::
PUT /sysadm/zfs
{

6
api/connection.rst
View File

@@ -652,7 +652,7 @@ access the user has. This subsystem is used only by the server.
**REST Request**
.. code-block:: json
::
PUT /rpc/query
{
@@ -714,7 +714,7 @@ types using this subsystem.
**REST Request**
.. code-block:: json
::
PUT /rpc/identify
{}
@@ -755,7 +755,7 @@ the MD5 checksums of all known SSL keys.
**REST Request**
.. code-block:: json
::
PUT /rpc/settings
{

24
api/events.rst
View File

@@ -58,12 +58,11 @@ Here is an example reply from the Life Preserver subsystem:
{
"namespace" : "events",
"name" : "life-preserver",
"name" : "life_preserver",
"id" : "<none>"
"args" : {
"message" : <message>,
"priority" : "<number> -
<category>",
"message" : "<message>",
"priority" : "<number>/<category>",
"class" : "[snapshot/replication]"
}
}
@@ -198,8 +197,8 @@ following:
"id" : "none",
"args" : {
"message" : "<text string>",
"priority" : "<number - warning level>",
"class" : "snapshot" OR "replication"
"priority" : "<number/warning level>",
"class" : "snapshot/replication"
}
}
@@ -223,6 +222,9 @@ following:
**Websocket Event Message**
This message will appear if the host name has changed and a priority
error has occurred.
.. code-block:: json
{
@@ -231,7 +233,7 @@ following:
"id" : "none",
"args" : {
"hostname" : "<name>",
"hostnamechanged" : "true", (only if host name changed)
"hostnamechanged" : "true",
"zpools" : {
"<poolname>" : {
"size" : "<107G>",
@@ -243,7 +245,7 @@ following:
"altroot" : "<->",
"capacity" : "<12%>",
"health" : "<online>",
"priority" : "<priority>" (if error)
"priority" : "<priority>"
}
}
}
@@ -271,6 +273,6 @@ server connects/disconnects or vice versa.
}
}
.. note:: available_connections are **all** the connections available at
the time, **not** a difference from a previous state. There may be both
new ID's in the list and ID's which are no longer listed.
.. note:: Available_connections are **all** the connections available at
the time, **not** a difference from a previous state. There may be
both new ID's in the list and ID's which are no longer listed.