diff --git a/api/classes/beadm.rst b/api/classes/beadm.rst index b280685..7e770f9 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" | +| action | | supported actions include "listbes", "renamebe", "activatebe" | | | | | +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ @@ -137,4 +137,53 @@ The "renamebe" action renames the specified boot environment. When using this ac "id": "fooid", "name": "response", "namespace": "sysadm" + } + +.. index:: activatebe, beadm + +.. _Activate Boot Environment: + +Activate Boot Environment +========================= + +The "activatebe" action activates the specified boot environment (target) so that it will be the default at next boot. + + +**REST Request** + +.. code-block:: json + + PUT /sysadm/beadm + { + "target" : "bootthingy", + "action" : "activatebe" + } + +**WebSocket Request** + +.. code-block:: json + + { + "name" : "beadm", + "args" : { + "action" : "activatebe", + "target" : "bootthingy" + }, + "namespace" : "sysadm", + "id" : "fooid" + } + +**Response** + +.. code-block:: json + + { + "args": { + "activatebe": { + "target": "bootthingy" + } + }, + "id": "fooid", + "name": "response", + "namespace": "sysadm" } \ No newline at end of file