mirror of
https://github.com/outbackdingo/sysadm.git
synced 2026-01-27 10:20:26 +00:00
146 lines
4.8 KiB
ReStructuredText
146 lines
4.8 KiB
ReStructuredText
.. _update:
|
|
|
|
update
|
|
******
|
|
|
|
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", "listbranches" |
|
|
| | | |
|
|
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
|
|
|
|
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"
|
|
}
|
|
|
|
.. index:: listbranches, update
|
|
|
|
.. _List Branches:
|
|
|
|
List Branches
|
|
=============
|
|
|
|
The "listbranches" action retrieves the list of available branches (operating system versions). The currently installed version will be listed as "active".
|
|
|
|
**REST Request**
|
|
|
|
.. code-block:: json
|
|
|
|
PUT /sysadm/update
|
|
{
|
|
"action" : "listbranches"
|
|
}
|
|
|
|
**REST Response**
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"args": {
|
|
"listbranches": {
|
|
"10.2-RELEASE": "active",
|
|
"11.0-CURRENTJAN2016": "available"
|
|
}
|
|
}
|
|
}
|
|
|
|
**WebSocket Request**
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"args" : {
|
|
"action" : "listbranches"
|
|
},
|
|
"namespace" : "sysadm",
|
|
"name" : "update",
|
|
"id" : "fooid"
|
|
}
|
|
|
|
**WebSocket Response**
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"args": {
|
|
"listbranches": {
|
|
"10.2-RELEASE": "active",
|
|
"11.0-CURRENTJAN2016": "available"
|
|
}
|
|
},
|
|
"id": "fooid",
|
|
"name": "response",
|
|
"namespace": "sysadm"
|
|
} |