diff --git a/api/classes/lifepreserver.rst b/api/classes/lifepreserver.rst index 6963b2c..133a4d0 100644 --- a/api/classes/lifepreserver.rst +++ b/api/classes/lifepreserver.rst @@ -584,7 +584,7 @@ The "addreplication" action is used to create a replication task in Life Preserv .. _Remove Replication: Remove Replication -=============== +================== The "removereplication" action is used to delete an existing replication task. Note that this action only deletes the task--it does not remove any already replicated data from the remote system. diff --git a/api/classes/updates.rst b/api/classes/updates.rst index b3d0e3c..3e7dab5 100644 --- a/api/classes/updates.rst +++ b/api/classes/updates.rst @@ -1,6 +1,86 @@ -.. _updates: +.. _update: -updates -======= +update +****** -Some intro text here... +The update class is used to check for and manage system and software updates. + +Every update class request contains the following parameters: + ++---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ +| **Parameter** | **Value** | **Description** | +| | | | ++=================================+===============+======================================================================================================================+ +| id | | any unique value for the request; examples include a hash, checksum, or uuid | +| | | | ++---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ +| name | update | | +| | | | ++---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ +| namespace | sysadm | | +| | | | ++---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ +| action | | supported actions include "checkupdates" | +| | | | ++---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ + +The rest of this section provides examples of the available *actions* for each type of request, along with their responses. + +.. index:: checkupdates, update + +.. _Check for Updates: + +Check for Updates +================= + +The "checkupdates" action queries the update server to see if any updates are available. If an update is available, the response will indicate if it is a system security update, an +upgrade to a newer version of the operating system, a system patch, or an update to installed software packages. + +**REST Request** + +.. code-block:: json + + PUT /sysadm/update + { + "action" : "checkupdates" + } + +**REST Response** + +.. code-block:: json + + { + "args": { + "checkupdates": { + "status": "noupdates" + } + } + } + +**WebSocket Request** + +.. code-block:: json + + { + "name" : "update", + "args" : { + "action" : "checkupdates" + }, + "namespace" : "sysadm", + "id" : "fooid" + } + +**WebSocket Response** + +.. code-block:: json + + { + "args": { + "checkupdates": { + "status": "noupdates" + } + }, + "id": "fooid", + "name": "response", + "namespace": "sysadm" + } \ No newline at end of file