From dd0bf124fbe5e92e15b6ee5ef768269648861dec Mon Sep 17 00:00:00 2001 From: dlavigne Date: Tue, 9 Feb 2016 13:13:08 -0500 Subject: [PATCH] Doc createbe action. --- api/classes/beadm.rst | 54 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 53 insertions(+), 1 deletion(-) diff --git a/api/classes/beadm.rst b/api/classes/beadm.rst index 7e770f9..0e11983 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" | +| action | | supported actions include "listbes", "renamebe", "activatebe", "createbe" | | | | | +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ @@ -186,4 +186,56 @@ The "activatebe" action activates the specified boot environment (target) so tha "id": "fooid", "name": "response", "namespace": "sysadm" + } + +.. index:: createbe, beadm + +.. _Create Boot Environment: + +Create Boot Environment +======================= + +The "create" action creates a new boot environment. Specify the name of the boot environment as the "newbe". If you wish to create a new boot environment which is a clone of an existing +boot environment, also include "clonefrom" to specify which boot environment to clone. + +**REST Request** + +.. code-block:: json + + PUT /sysadm/beadm + { + "action" : "createbe", + "newbe" : "red", + "clonefrom" : "green" + } + +**WebSocket Request** + +.. code-block:: json + + { + "id" : "fooid", + "args" : { + "newbe" : "red", + "clonefrom" : "green", + "action" : "createbe" + }, + "namespace" : "sysadm", + "name" : "beadm" + } + +**Response** + +.. code-block:: json + + { + "args": { + "createbe": { + "clonefrom": "green", + "newbe": "red" + } + }, + "id": "fooid", + "name": "response", + "namespace": "sysadm" } \ No newline at end of file