Doc mountbe action.

2026-01-27 10:20:26 +00:00 · 2016-02-11 12:47:38 -05:00
parent cfb7537d78
commit f351f85f74
1 changed files with 101 additions and 1 deletions
--- 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"
 }