From f351f85f741126dcaa6ea04542d80d33fe3bd500 Mon Sep 17 00:00:00 2001 From: dlavigne Date: Thu, 11 Feb 2016 12:47:38 -0500 Subject: [PATCH] Doc mountbe action. --- api/classes/beadm.rst | 102 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 101 insertions(+), 1 deletion(-) diff --git a/api/classes/beadm.rst b/api/classes/beadm.rst index 8424ea3..9518ce7 100644 --- a/api/classes/beadm.rst +++ b/api/classes/beadm.rst @@ -20,7 +20,7 @@ Every beadm class request contains the following parameters: | namespace | sysadm | | | | | | +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ -| action | | supported actions include "listbes", "renamebe", "activatebe", "createbe" | +| action | | supported actions include "listbes", "renamebe", "activatebe", "createbe", "destroybe", and "mountbe" | | | | | +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ @@ -238,4 +238,104 @@ To specify another, inactive boot environment, also include "clonefrom" to speci "id": "fooid", "name": "response", "namespace": "sysadm" + } + +.. index:: destroybe, beadm + +.. _Destroy a Boot Environment: + +Destroy a Boot Environment +========================== + +The "destroybe" action destroys the specified "target" boot environment and forcefully unmounts it. + + +**REST Request** + +.. code-block:: json + + PUT /sysadm/beadm + { + "target" : "red", + "action" : "destroybe" + } + +**WebSocket Request** + +.. code-block:: json + + { + "id" : "fooid", + "args" : { + "action" : "destroybe", + "target" : "red" + }, + "name" : "beadm", + "namespace" : "sysadm" + } + +**Response** + +.. code-block:: json + + { + "args": { + "destroybe": { + "target": "red" + } + }, + "id": "fooid", + "name": "response", + "namespace": "sysadm" + } + +.. index:: mountbe, beadm + +.. _Mount a Boot Environment: + +Mount a Boot Environment +======================== + +The "mountbe" action mounts the specified boot environment. Use the optional "mountpoint" argument to specify the mount point. + +**REST Request** + +.. code-block:: json + + PUT /sysadm/beadm + { + "mountpoint" : "/tmp/mounteddir/", + "action" : "mountbe", + "be" : "green" + } + +**WebSocket Request** + +.. code-block:: json + + { + "id" : "fooid", + "namespace" : "sysadm", + "name" : "beadm", + "args" : { + "mountpoint" : "/tmp/mounteddir/", + "be" : "green", + "action" : "mountbe" + } + } + +**Response** + +.. code-block:: json + + { + "args": { + "mountbe": { + "be": "green", + "mountpoint": "" + } + }, + "id": "fooid", + "name": "response", + "namespace": "sysadm" } \ No newline at end of file