From e747ad1300164af927c5be3bc7933dd4956f2e23 Mon Sep 17 00:00:00 2001 From: Ad Schellevis Date: Fri, 7 Jul 2023 12:05:15 +0200 Subject: [PATCH] manually update firmware page, closes https://github.com/opnsense/core/issues/6655 --- source/development/api/core/firmware.rst | 51 ++++++++++++++---------- 1 file changed, 30 insertions(+), 21 deletions(-) diff --git a/source/development/api/core/firmware.rst b/source/development/api/core/firmware.rst index bc2bc9a6..26d96117 100644 --- a/source/development/api/core/firmware.rst +++ b/source/development/api/core/firmware.rst @@ -2,24 +2,32 @@ Firmware ~~~~~~~~ OPNsense has several API calls to get and set the firmware configuration: + + .. csv-table:: :header: "Method", "Module", "Controller", "Command", "Parameters" :widths: 4, 15, 15, 30, 40 - "``POST``","Core","Firmware","poweroff","" - "``POST``","Core","Firmware","reboot","" - "``GET``","Core","Firmware","running","" - "``GET``","Core","Firmware","getFirmwareConfig","" - "``GET``","Core","Firmware","getFirmwareOptions","" - "``POST``","Core","Firmware","setFirmwareConfig","" - "``GET``","Core","Firmware","info","" - "``GET``","Core","Firmware","status","" - "``POST``","Core","Firmware","status","" - "``POST``","Core","Firmware","audit","" - "``POST``","Core","Firmware","update","" - "``POST``","Core","Firmware","upgrade","" - "``GET``","Core","Firmware","upgradestatus","" - "``POST``","Core","Firmware","changelog","$version" + "``POST``","core","firmware","audit","" + "``POST``","core","firmware","changelog","$version" + "``POST``","core","firmware","check","" + "``POST``","core","firmware","connection","" + "``GET``","core","firmware","get","" + "``GET``","core","firmware","getOptions","" + "``POST``","core","firmware","health","" + "``GET``","core","firmware","info","" + "``POST``","core","firmware","log","$clear" + "``POST``","core","firmware","poweroff","" + "``POST``","core","firmware","reboot","" + "``POST``","core","firmware","resyncPlugins","" + "``GET``","core","firmware","running","" + "``POST``","core","firmware","set","" + "``POST``","core","firmware","set","" + "``POST``","core","firmware","status","" + "``POST``","core","firmware","syncPlugins","" + "``POST``","core","firmware","update","" + "``POST``","core","firmware","upgrade","" + "``GET``","core","firmware","upgradestatus","" Examples: @@ -44,13 +52,14 @@ You can manage the packages and plugins in OPNsense, using these API calls: :header: "Method", "Module", "Controller", "Command", "Parameters" :widths: 4, 15, 15, 30, 40 - "``POST``","Core","Firmware","install","$pkg_name" - "``POST``","Core","Firmware","reinstall","$pkg_name" - "``POST``","Core","Firmware","remove","$pkg_name" - "``POST``","Core","Firmware","lock","$pkg_name" - "``POST``","Core","Firmware","unlock","$pkg_name" - "``POST``","Core","Firmware","details","$pkg_name" - "``POST``","Core","Firmware","license","$pkg_name" + "``POST``","core","firmware","details","$package" + "``POST``","core","firmware","reinstall","$pkg_name" + "``POST``","core","firmware","remove","$pkg_name" + "``POST``","core","firmware","unlock","$pkg_name" + "``POST``","core","firmware","install","$pkg_name" + "``POST``","core","firmware","license","$package" + "``POST``","core","firmware","lock","$pkg_name" + Examples: