github-personal/sysadm
1
0
Fork 0
mirror of https://github.com/outbackdingo/sysadm.git synced 2026-01-27 10:20:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc pkg_lock and pkg_unlock actions.

Browse Source
This commit is contained in:
dlavigne
2016-03-28 12:51:22 -04:00
parent 6e046d5782
commit f72f2db240
1 changed files with 101 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

102
api/classes/pkg.rst
View File

@@ -21,7 +21,7 @@ Every pkg class request contains the following parameters:
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| action | | supported actions include "pkg_info", "pkg_search", "list_categories", "list_repos", "pkg_audit", "pkg_upgrade", |
| | | "pkg_check_upgrade", "pkg_update" |
| | | "pkg_check_upgrade", "pkg_update", "pkg_lock", "pkg_unlock |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
@@ -741,4 +741,104 @@ If you include "force" = "true", it forces :command:`pkg` to completely resync a
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: pkg_lock, pkg_unlock, pkg
.. _Lock/Unlock Packages:
Lock/Unlock Packages
====================
The "pkg_lock" action locks the specified "pkg_origins" so that it will be skipped during a package upgrade and remain at its current version. When using "pkg_origins", specify either a
single package origin string or an array of package origins.
The "pkg_unlock" action unlocks the previously locked "pkg_origins" so that it is no longer skipped during a package upgrade.
Both actions return any information as a dispatcher event. Refer to the :ref:`Dispatcher Subsystem` for instructions on how to subscribe to and query dispatcher events.
**REST Request**
.. code-block:: json
PUT /sysadm/pkg
{
"pkg_origins" : [
"misc/pcbsd-base"
],
"action" : "pkg_lock"
}
**WebSocket Request**
.. code-block:: json
{
"namespace" : "sysadm",
"id" : "fooid",
"name" : "pkg",
"args" : {
"pkg_origins" : [
"misc/pcbsd-base"
],
"action" : "pkg_lock"
}
}
**Response**
.. code-block:: json
{
"args": {
"pkg_lock": {
"proc_cmd": "pkg lock -y misc/pcbsd-base",
"proc_id": "sysadm_pkg_lock-{352f7f66-d036-4c16-8978-67950957bf22}",
"status": "pending"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
**REST Request**
.. code-block:: json
PUT /sysadm/pkg
{
"action" : "pkg_unlock",
"pkg_origins" : "misc/pcbsd-base"
}
**WebSocket Request**
.. code-block:: json
{
"id" : "fooid",
"args" : {
"action" : "pkg_unlock",
"pkg_origins" : "misc/pcbsd-base"
},
"name" : "pkg",
"namespace" : "sysadm"
}
**Response**
.. code-block:: json
{
"args": {
"pkg_unlock": {
"proc_cmd": "pkg unlock -y misc/pcbsd-base",
"proc_id": "sysadm_pkg_unlock-{d1771b41-c1ca-480a-a3ce-42d4eddbfae8}",
"status": "pending"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}