Archives/opensense-docs
2
0
Fork 0
mirror of https://github.com/opnsense/docs synced 2024-10-30 21:20:20 +00:00
Code Issues Projects Releases Wiki Activity

manual: add common cron job information; closes #450

Browse Source
This commit is contained in:
Franco Fichtner 2023-02-10 10:36:12 +01:00
parent c44d97b664
commit 3679ae3697
1 changed files with 67 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
source/manual/settingsmenu.rst
View File

@ -112,6 +112,73 @@ share the same syntax:
- Specifying multiple values is possible using the comma: ``1,4,9``
- Ranges can be specified using a dash: ``4-9``
Available cron jobs are registered in the backend to prevent command injection and privilege escalation. These can be found under
`Command` and may allow an additional `Parameter`. Restart and reload actions are self-explanatory. They take no parameters are
will restart (usually slower stop and start of a process) or reload (usually a faster SIGHUP) the respective service. The availability
of restart and reload is subject to their respective services as not all software will support a reload for implementational reasons.
The most common core commands are as follows:
+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Command in GUI | Command in shell | Supported parameters | Background information |
+==============================================================================================================================================================+
| Update and reload firewall aliases | configctl filter refresh_aliases | No parameters | Updates IP aliases for DNS entries and MAC |
| | | | addresses as well as URL tables. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Firmware update check | configctl firmware poll | No parameters | Refresh current update status from firmware |
| | | | mirror for e.g. remote status check via |
| | | | API. Note this utilizes a skew interval of |
| | | | 25 minutes. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Firmware changelog update | configctl firmware changelog cron | No parameters | Refresh current changelog status from |
| | | | authoritative firmware location to preview |
| | | | changelogs for new versions. Note this |
| | | | utilizes a skew interval of 25 minutes and |
| | | | is also performed by the firmware update |
| | | | check. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Automatic firmware update | configctl firmware auto-update | No parameters | Perform a minor update if applicable. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Update and reload intrusion detection rules | configctl ids update | No parameters | Fetches remote rules and reloads the IDS |
| | | | instance to make use of newly fetched rules.|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Periodic interface reset | configctl interface reconfigure | identifier: Internal | Cycle through an interface reset that |
| | [identifier] | name of the interface | removes all connectivity and reactivates |
| | | as shown in assignments | it cleanly. |
| | | or overview page, e.g. | |
| | | "lan", "wan", "optX". | |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Download and reload external proxy ACLs | configctl proxy fetchacls | No parameters | Fetch and activate the external ACL files |
| | | | for configured blocklists. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Remote backup | configctl system remote backup | No parameters | Trigger the remote backup at the specified |
| | | | time as opposed to its nightly default. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Issue a reboot | configctl system reboot | No parameters | Perform a reboot at the specified time. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| HA update and reconfigure backup | configctl system ha_reconfigure_backup | No parameters | Synchronize the configuration to the backup |
| | | | firewall and restart its services to apply |
| | | | the changes. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Update Unbound DNSBLs | configctl unbound dnsbl | No parameters | Update the the DNS blocklists and apply the |
| | | | changes to Unbound. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ZFS pool trim | configctl zfs trim [pool] | pool: ZFS pool name to | Initiates an immediate on-demand TRIM |
| | | perform the action on | operation for all of the free space in a |
| | | | pool. This operation informs the underlying |
| | | | storage devices of all blocks in the pool |
| | | | which are no longer allocated and allows |
| | | | thinly provisioned devices to reclaim the |
| | | | space. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ZFS pool scrub | configctl zfs scrub [pool] | pool: ZFS pool name to | Begins a scrub or resumes a paused scrub. |
| | | perform the action on | The scrub examines all data in the specified|
| | | | pools to verify that it checksums correctly.|
| | | | For replicated (mirror, raidz, or draid) |
| | | | devices, ZFS automatically repairs any |
| | | | damage discovered during the scrub. |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
-------
General
-------