Skip to content
Snippets Groups Projects
Commit 6ebf6ee9 authored by Hahn Axel (hahn)'s avatar Hahn Axel (hahn)
Browse files

Merge branch 'update-docs' into 'master'

Update docs

See merge request !266
parents 01944140 a81a1268
No related branches found
No related tags found
2 merge requests!266Update docs,!265showhelp: replace _self
......@@ -4,8 +4,8 @@
**check_client_backup** is a plugin to show the backup status of IML Backup.
📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/iml-backup/>
📜 License: GNU GPL 3.0
📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/iml-backup/>\
📜 License: GNU GPL 3.0\
📖 Docs: see docs folder or online <https://os-docs.iml.unibe.ch/iml-backup/>
## Requirements
......
......@@ -3,20 +3,60 @@
## Introduction
Show status of all Cronjobs using Axels Cronwrapper
https://github.com/axelhahn/cronwrapper
The last run of each job is verified to these conditions:
📄 Source: <https://github.com/axelhahn/cronwrapper>\
📜 License: GNU GPL 3.0\
📖 Docs: see docs folder or online <https://www.axel-hahn.de/docs/cronwrapper/>
Pre conditions:
* The cronwrapper must be installed
* Your cronjob(s) must be changed to use the wrapper, eg.\
`*/60 * * * * /opt/cronwrappre.sh 60 <YOUR_COMMAND>`
`check_cronstatus` executes the cronstatus.sh in the cronwrapper installation directory and will parse its output.
In the cronstatus the last run of each job will be verified with these conditions:
* exitcode was 0
* last run is younger than given TTL
As output you get a summary of all checks followed by more detailed status per job.
## Syntax
`$ check_cronstatus [-h] [SCRIPT]`
`$ check_cronstatus [-h]`
or
`$ check_cronstatus [SCRIPT]`
### Parameters
```text
______________________________________________________________________
CHECK_CRONSTATUS
v2.4
(c) Institute for Medical Education - University of Bern
Licence: GNU GPL 3
https://os-docs.iml.unibe.ch/icinga-checks/Checks/check_cronstatus.html
______________________________________________________________________
Show status of all Cronjobs using Axels Cronwrapper
https://github.com/axelhahn/cronwrapper
The last run of each job is verified to these conditions:
- exitcode was 0
- last run is younger than given TTL
SYNTAX:
check_cronstatus [-h] [SCRIPT]
OPTIONS:
-h or --help show this help.
......@@ -25,6 +65,7 @@ PARAMETERS:
SCRIPT optional: custom status script
default: /opt/cronwrapper/cronstatus.sh
```
## Examples
......@@ -34,3 +75,4 @@ PARAMETERS:
`check_cronstatus /usr/share/cronwrapper/cronstatus.sh`
The Check of cronjobs with custom loction.
The parameter must reference cronstatus.sh with its full path
\ No newline at end of file
......@@ -573,7 +573,7 @@ function ph.execIfReady(){
ph.showImlHelpHeader(){
local _html;
_html=$(basename $0)
_html=${_self//\-/_}.html
_html=${_html//\-/_}.html
cat <<EOF
______________________________________________________________________
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment