summaryrefslogtreecommitdiff
path: root/docs/appendix
diff options
context:
space:
mode:
Diffstat (limited to 'docs/appendix')
-rw-r--r--docs/appendix/cmd-index.rst14
-rw-r--r--docs/appendix/http-api.rst24
-rw-r--r--docs/appendix/vyos-on-baremetal.rst42
3 files changed, 53 insertions, 27 deletions
diff --git a/docs/appendix/cmd-index.rst b/docs/appendix/cmd-index.rst
index fa4143ad..71b556cb 100644
--- a/docs/appendix/cmd-index.rst
+++ b/docs/appendix/cmd-index.rst
@@ -4,6 +4,12 @@
Command Reference
#################
+Configuration Commands
+======================
+
+.. _cfg_cmd_list:
+
+.. cfgcmdlist::
Operational Commands
====================
@@ -11,11 +17,3 @@ Operational Commands
.. _op_cmd_list:
.. opcmdlist::
-
-
-Configuration Commands
-======================
-
-.. _cfg_cmd_list:
-
-.. cfgcmdlist::
diff --git a/docs/appendix/http-api.rst b/docs/appendix/http-api.rst
index 86d8b394..49f2dbd9 100644
--- a/docs/appendix/http-api.rst
+++ b/docs/appendix/http-api.rst
@@ -99,8 +99,30 @@ If you don't specify the file when saving, it saves to ``/config/config.boot``.
# curl -k -X POST -F key=MY-HTTP-API-PLAINTEXT-KEY -Fdata='{"op": "save", "file": "/config/config.boot"}' https://192.168.122.127/config-file
+Image management requests
+-------------------------
+
+One may ``add`` or ``delete`` a system image using the endpoint ``/image``. Here are the respective examples:
+
+``add`` from ``url``. Here we use the URL of the latest rolling release:
+
+.. code-block:: none
+
+ # curl -k -X POST -F data='{"op": "add", "url": "https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso"}' -F key=MY-HTTP-API-PLAINTEXT-KEY https://192.168.122.127/image
+
+``delete`` by image ``name``. For example:
+
+.. code-block:: none
+
+ # curl -k -X POST -F data='{"op": "delete", "name": "1.3-rolling-202006070117"}' -F key=MY-HTTP-API-PLAINTEXT-KEY https://192.168.122.127/image
+
+To list the available system images by name, one may use the operational mode request ``show`` discussed in the next section; in this setting it would be:
+
+.. code-block:: none
+
+ # curl -k -X POST -F data='{"op": "show", "path": ["system", "image"]}' -F key=MY-HTTP-API-PLAINTEXT-KEY https://192.168.122.127/show
-Operational mode commands
+Operational mode requests
-------------------------
It is possible to run ``show`` and ``generate`` commands:
diff --git a/docs/appendix/vyos-on-baremetal.rst b/docs/appendix/vyos-on-baremetal.rst
index 1481156f..0116ddc1 100644
--- a/docs/appendix/vyos-on-baremetal.rst
+++ b/docs/appendix/vyos-on-baremetal.rst
@@ -214,45 +214,51 @@ Pictures
Rack Mount
^^^^^^^^^^
-.. figure:: /_static/images/apu4c4_rack_1.jpg
+.. figure:: /_static/images/apu4_rack_1.jpg
:scale: 25 %
- :alt: APU4C4 rack closed
+ :alt: APU4 rack closed
-.. figure:: /_static/images/apu4c4_rack_2.jpg
+.. figure:: /_static/images/apu4_rack_2.jpg
:scale: 25 %
- :alt: APU4C4 rack front
+ :alt: APU4 rack front
-.. figure:: /_static/images/apu4c4_rack_3.jpg
+.. figure:: /_static/images/apu4_rack_3.jpg
:scale: 25 %
- :alt: APU4C4 rack module #1
+ :alt: APU4 rack module #1
-.. figure:: /_static/images/apu4c4_rack_4.jpg
+.. figure:: /_static/images/apu4_rack_4.jpg
:scale: 25 %
- :alt: APU4C4 rack module #2
+ :alt: APU4 rack module #2
-.. figure:: /_static/images/apu4c4_rack_5.jpg
+.. figure:: /_static/images/apu4_rack_5.jpg
:scale: 25 %
- :alt: APU4C4 rack module #3 with PSU
+ :alt: APU4 rack module #3 with PSU
+VyOS custom print
+"""""""""""""""""
+
+.. figure:: /_static/images/apu4_rack_vyos_print.jpg
+ :scale: 25 %
+ :alt: APU4 custom VyOS powder coat
Desktop / Bench Top
^^^^^^^^^^^^^^^^^^^
-.. figure:: /_static/images/apu4c4_desk_1.jpg
+.. figure:: /_static/images/apu4_desk_1.jpg
:scale: 25 %
- :alt: APU4C4 desktop closed
+ :alt: APU4 desktop closed
-.. figure:: /_static/images/apu4c4_desk_2.jpg
+.. figure:: /_static/images/apu4_desk_2.jpg
:scale: 25 %
- :alt: APU4C4 desktop closed
+ :alt: APU4 desktop closed
-.. figure:: /_static/images/apu4c4_desk_3.jpg
+.. figure:: /_static/images/apu4_desk_3.jpg
:scale: 25 %
- :alt: APU4C4 desktop back
+ :alt: APU4 desktop back
-.. figure:: /_static/images/apu4c4_desk_4.jpg
+.. figure:: /_static/images/apu4_desk_4.jpg
:scale: 25 %
- :alt: APU4C4 desktop back
+ :alt: APU4 desktop back
.. _Rufus: https://rufus.ie/