Update plugin documentation
This commit is contained in:
dbildhauer committed
1 parent
11ce8a4615
commit
f3e3ff0282
3 files changed
+111
-446
No files matched your search
+40
-99
@@ -1,161 +1,102 @@
|
||||
# Checkmk OS Info
|
||||
# 🖥️ Checkmk OS Info
|
||||
|
||||
MKP-Erweiterung für **Checkmk Community 2.5.x**, die auf überwachten Hosts einen eigenen Service **„Betriebssystem“** bereitstellt.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Funktionen
|
||||
MKP-Erweiterung für **Checkmk Community 2.5.x**, die pro überwachten Host einen Service **„Betriebssystem“** bereitstellt.
|
||||
|
||||
Der Service zeigt unter anderem:
|
||||
⬅️ [Zurück zur Plugin-Übersicht](../README.md)
|
||||
|
||||
## ✨ Funktionen
|
||||
|
||||
- Betriebssystem bzw. Linux-Distribution
|
||||
- Betriebssystem-Version / Windows-Build
|
||||
- Architektur
|
||||
- Kernel-Version
|
||||
- Architektur und Kernel-Version
|
||||
- OS-ID und Version-ID
|
||||
- 🐧 Linux · 🪟 Windows · 🍎 macOS
|
||||
|
||||
Unterstützt werden Linux, Windows und grundsätzlich auch macOS.
|
||||
## 📥 Installation des MKP
|
||||
|
||||
## Repository-Struktur
|
||||
|
||||
```text
|
||||
checkmk-os-info/
|
||||
├── src/
|
||||
│ ├── agents/
|
||||
│ │ ├── plugins/
|
||||
│ │ │ └── os_info
|
||||
│ │ └── windows/
|
||||
│ │ └── plugins/
|
||||
│ │ └── os_info.ps1
|
||||
│ └── cmk_addons_plugins/
|
||||
│ └── os_info/
|
||||
│ ├── agent_based/
|
||||
│ │ └── os_info.py
|
||||
│ └── checkman/
|
||||
│ └── os_info
|
||||
├── dist/
|
||||
│ └── os_info-1.0.0.mkp
|
||||
├── CHANGELOG.md
|
||||
├── LICENSE
|
||||
└── README.md
|
||||
```
|
||||
|
||||
## Installation des MKP
|
||||
|
||||
Das fertige Paket befindet sich unter:
|
||||
|
||||
```text
|
||||
dist/os_info-1.0.0.mkp
|
||||
```
|
||||
|
||||
Auf den Checkmk-Server kopieren und als Site-Benutzer installieren:
|
||||
Paket: `dist/os_info-1.0.0.mkp`
|
||||
|
||||
```bash
|
||||
mkp add /tmp/os_info-1.0.0.mkp
|
||||
mkp enable os_info 1.0.0
|
||||
cmk -R
|
||||
```
|
||||
|
||||
Kontrolle:
|
||||
|
||||
```bash
|
||||
mkp list
|
||||
```
|
||||
|
||||
Der Eintrag `os_info` sollte als `Enabled (active on this site)` erscheinen.
|
||||
## 🐧 Agent-Plug-in für Linux / macOS
|
||||
|
||||
## Agent-Plug-in für Linux/macOS
|
||||
|
||||
Nach Aktivierung des MKP liegt das Plug-in im lokalen Site-Verzeichnis:
|
||||
Nach Aktivierung:
|
||||
|
||||
```text
|
||||
~/local/share/check_mk/agents/plugins/os_info
|
||||
```
|
||||
|
||||
Auf den Zielhost kopieren:
|
||||
|
||||
```bash
|
||||
scp ~/local/share/check_mk/agents/plugins/os_info \
|
||||
root@HOST:/usr/lib/check_mk_agent/plugins/os_info
|
||||
```
|
||||
|
||||
Danach auf dem Zielhost:
|
||||
Auf den Zielhost kopieren und testen:
|
||||
|
||||
```bash
|
||||
scp ~/local/share/check_mk/agents/plugins/os_info root@HOST:/usr/lib/check_mk_agent/plugins/os_info
|
||||
chmod 755 /usr/lib/check_mk_agent/plugins/os_info
|
||||
/usr/lib/check_mk_agent/plugins/os_info
|
||||
```
|
||||
|
||||
Die Ausgabe muss mit folgender Sektion beginnen:
|
||||
Die Ausgabe muss mit `<<<os_info:sep(9)>>>` beginnen.
|
||||
|
||||
```text
|
||||
<<<os_info:sep(9)>>>
|
||||
```
|
||||
## 🪟 Agent-Plug-in für Windows
|
||||
|
||||
## Agent-Plug-in für Windows
|
||||
|
||||
Nach Aktivierung liegt die PowerShell-Datei auf dem Checkmk-Server unter:
|
||||
Quelldatei:
|
||||
|
||||
```text
|
||||
~/local/share/check_mk/agents/windows/plugins/os_info.ps1
|
||||
```
|
||||
|
||||
Auf dem Windows-Host nach folgendem Verzeichnis kopieren:
|
||||
Ziel:
|
||||
|
||||
```text
|
||||
C:\ProgramData\checkmk\agent\plugins\os_info.ps1
|
||||
```
|
||||
|
||||
## Service Discovery
|
||||
|
||||
Auf dem Checkmk-Server zunächst prüfen, ob die Agent-Sektion ankommt:
|
||||
## 🔎 Service Discovery
|
||||
|
||||
```bash
|
||||
cmk -d HOSTNAME | grep -A2 '^<<<os_info'
|
||||
```
|
||||
|
||||
Danach die Service-Erkennung ausführen:
|
||||
|
||||
```bash
|
||||
cmk -vI HOSTNAME
|
||||
cmk -R
|
||||
```
|
||||
|
||||
Anschließend erscheint beim Host der Service:
|
||||
Anschließend erscheint der Service **Betriebssystem**.
|
||||
|
||||
```text
|
||||
Betriebssystem
|
||||
```
|
||||
|
||||
## Fehlersuche
|
||||
|
||||
Installierte Dateien des MKP suchen:
|
||||
## 🧰 Fehlersuche
|
||||
|
||||
```bash
|
||||
find ~/local -type f -name 'os_info*'
|
||||
```
|
||||
|
||||
Status des Pakets:
|
||||
|
||||
```bash
|
||||
mkp list
|
||||
```
|
||||
|
||||
Agent-Ausgabe kontrollieren:
|
||||
|
||||
```bash
|
||||
cmk -d HOSTNAME | grep -A2 '^<<<os_info'
|
||||
```
|
||||
|
||||
## Kompatibilität
|
||||
## 📂 Repository-Struktur
|
||||
|
||||
Entwickelt für:
|
||||
```text
|
||||
os-info/
|
||||
├── src/
|
||||
│ ├── agents/
|
||||
│ └── cmk_addons_plugins/os_info/
|
||||
├── dist/
|
||||
│ └── os_info-1.0.0.mkp
|
||||
├── CHANGELOG.md
|
||||
├── PROJECT.md
|
||||
├── LICENSE
|
||||
└── README.md
|
||||
```
|
||||
|
||||
- Checkmk Community 2.5.x
|
||||
- Check API V2
|
||||
- Linux-Agent
|
||||
- Windows-Agent
|
||||
## 🛠️ Kompatibilität
|
||||
|
||||
Aktuelle Paketversion: **1.0.0**
|
||||
Checkmk Community 2.5.x · Check API V2 · Linux-Agent · Windows-Agent · macOS grundsätzlich unterstützt
|
||||
|
||||
## Lizenz
|
||||
## ⚖️ Lizenz
|
||||
|
||||
GPL-2.0
|
||||
Reference in new issue
Block a user