Das Nut-Paket Die Einleitung NUT ist ein Client/Server-Framework zur Ansteuerung und Verwaltung einer USV (unterbrechungsfreie Stromversorgung, englisch: UPS). Unterstuetzt werden ueber 100 verschiedene Hersteller und Modelle. Einige Programmkomponenten arbeiten als Systemdienst (Daemon), d.h. diese werden automatisch beim Einschalten des Rechners gestartet. Die Funktionen Das Nut-Paket besteht aus folgenden Komponenten: * Network UPS Tools (NUT) - Programmdateien fuer die USV-Ansteuerung. ([1]http://www.networkupstools.org/) Die Voraussetzungen Um die Funktion `Show UPS key data as chart' auf einem nut-Server ueber das Menue aufrufen zu koennen wird ein installiertes gnuplot-Paket benoetigt. Die Installation Das Nut-Paket wird ueber das Setup-Menue installiert. Wird eine aeltere Paketversion vorgefunden, so wird diese deinstalliert bevor die neuen Programmdateien installiert werden. Das Menue im Setup-Programm Das Menue im Setup-Programm ist wie folgt aufgebaut: * View documentation: Anzeigen der Dokumentation * Edit configuration: Bearbeiten der Konfiguration * Advanced configuration file handling: Konfigurationen verwalten * Show status: Status des NUT-Servers anzeigen * Stop service: NUT-Server stoppen * Start service: NUT-Server starten * View log file: Logmeldungen anzeigen * Show UPS status: USV-Status anzeigen * Show UPS key data as chart * Simulate power failure * Return: Untermenue verlassen Die Menuepunkte duerften selbsterklaerend sein, da sie keinerlei weitere Eingaben erwarten. Aus diesem Grund wird auf deren Funktion nicht weiter eingegangen. Die Aenderung der Konfiguration Die Konfiguration kann ueber den Menuepunkt 'Edit configuration' geaendert werden. Standardmaessig wird der Editor aufgerufen, der in der Environment-Konfiguration ueber die Variable 'EDITOR' festgelegt wurde. Nachdem der Editor beendet wurde wird abgefragt, ob die Konfiguration aktiviert werden soll. Wird dies bestaetigt, werden ueber ein Skript die Anpassungen umgehend wirksam gemacht. Die Konfigurationsdatei In der Konfigurationsdatei, die ueber das Menue zugaenglich ist, sind folgende Parameter vorhanden; wer sie von Hand editieren will findet sie unter /etc/config.d/nut. Die Parameter Die Starteinstellungen START_NUT Um das Nut-Paket zu aktivieren muss dieser Parameter auf den Wert `yes' gesetzt werden, um es zu deaktivieren muss der Wert auf `no' gesetzt werde. Gueltige Werte: yes, no Standardeinstellung: START_NUT='no' NUT_CLIENT_MODE Um den Klientenmodus zu aktivieren muss dieser Parameter auf den Wert `yes' gesetzt werden, um ihn zu deaktivieren muss der Wert auf `no' gesetzt werde. Hinweis NUT_CLIENT_MODE und NUT_SERVER_MODE duerfen nicht gleichzeitig aktiviert werden! Gueltige Werte: yes, no Standardeinstellung: NUT_CLIENT_MODE='no' NUT_SERVER_MODE Um den Servermodus zu aktivieren muss dieser Parameter auf den Wert `yes' gesetzt werden, um ihn zu deaktivieren muss der Wert auf `no' gesetzt werde. Hinweis NUT_CLIENT_MODE und NUT_SERVER_MODE duerfen nicht gleichzeitig aktiviert werden! Gueltige Werte: yes, no Standardeinstellung: NUT_SERVER_MODE='no' Die Klienteneinstellungen NUT_CLIENT_UPSMON_SYNO_CLIENT Falls dieses Paket als Klient eines Synology NAS arbeiten soll, muss dieser Parameter auf den Wert `yes' gesetzt werden, falls nicht, so koennen individuelle Anmeldedaten fuer den Monitorzugriff ueber die Parameter [2], [3]NUT_CLIENT_UPSMON_USER und [4]NUT_CLIENT_UPSMON_PASS definiert werden. Gueltige Werte: yes, no Standardeinstellung: NUT_CLIENT_UPSMON_SYNO_CLIENT='no' NUT_CLIENT_UPSMON_QNAP_CLIENT Falls dieses Paket als Klient eines QNAP NAS arbeiten soll, muss dieser Parameter auf den Wert `yes' gesetzt werden, falls nicht, so koennen individuelle Anmeldedaten fuer den Monitorzugriff ueber die Parameter [5], [6]NUT_CLIENT_UPSMON_USER und [7]NUT_CLIENT_UPSMON_PASS definiert werden. Gueltige Werte: yes, no Standardeinstellung: NUT_CLIENT_UPSMON_QNAP_CLIENT='no' NUT_CLIENT_UPSMON_UPSNAME Ueber diesen Parameter wird der Name der USV angegeben, zu welcher sich dieser USV-Klient verbinden soll. Gueltige Werte: beliebiger Name in Kleinbuchstaben Beispiel: NUT_CLIENT_UPSMON_UPSNAME='ups' NUT_CLIENT_UPSMON_USER Ueber diesen Parameter wird der Benutzername festgelegt, welcher zur Authentifizierung gegenueber einem NUT-Server verwendet werden soll. Gueltige Werte: Benutzername Standardeinstellung: NUT_CLIENT_UPSMON_USER='monuser' NUT_CLIENT_UPSMON_PASS Ueber diesen Parameter wird das Kennwort festgelegt, welches zur Authentifizierung gegenueber einem NUT-Server verwendet werden soll. Gueltige Werte: Kennwort Standardeinstellung: NUT_CLIENT_UPSMON_USER='pass' NUT_CLIENT_UPSMON_SERVER_IP Ueber diesen Parameter wird die IP-Adresse des NUT-Servers festgelegt, als dessen Klient dieses NUT-Dienst arbeiten soll. Gueltige Werte: IP-Adresse Standardeinstellung: NUT_CLIENT_UPSMON_SERVER_IP='' Die Server-Einstellungen NUT_SERVER_UPSMON_ADMIN_USER Ueber diesen Parameter wird der Name des Administrators festgelegt, welcher erweitere USV-Abfragen durchfuehren oder USV-Einstellungen veraendern darf. Gueltige Werte: Benutzername Standardeinstellung: NUT_SERVER_UPSMON_ADMIN_USER='admin' NUT_SERVER_UPSMON_ADMIN_PASS Ueber diesen Parameter wird das Kennwort des Administrators festgelegt, welcher erweitere USV-Abfragen durchfuehren oder USV-Einstellungen veraendern darf. Gueltige Werte: Kennwort Standardeinstellung: NUT_SERVER_UPSMON_ADMIN_PASS='geheim' NUT_SERVER_UPSMON_ADMIN_EMAIL Optionaler Parameter: Ueber diesen Parameter kann eine vom Standard abweichende E-Mail-Adresse fuer den Versand von Status- und Alarmmeldungen des USV-Monitors festgelegt werden. Wird dieser Parameter nicht gesetzt, so werden alle Meldungen an die E-Mail-Adresse des root-Anwenders geschickt. Gueltige Werte: E-Mail-Adresse Beispiel: NUT_SERVER_UPSMON_ADMIN_EMAIL='tommy@domain.de' NUT_SERVER_N Ueber diesen Parameter wird die Anzahl der einzurichtenden NUT-Serverdienste angegeben. Gueltige Werte: Zahl Standardeinstellung: NUT_SERVER_N='1' NUT_SERVER_x_ACTIVE Wird dieser Parameter auf den Wert `yes' gesetzt, so wird der Datensatz aktiviert, der Wert `no' deaktiviert ihn. Gueltige Werte: yes, no Standardeinstellung: NUT_SERVER_1_ACTIVE='no' NUT_SERVER_x_COMMENT Dies ist ein Kommentarfeld, welches einzig der Beschreibung des NUT-Serverdienstes dient. Gueltige Werte: beliebiger Text Beispiel: NUT_SERVER_1_COMMENT='Meine erste USV' NUT_SERVER_x_UPSNAME Optionaler Parameter: Ueber diesen Parameter kann auf Wunsch ein individueller USV-Name festgelegt werden. Falls dieser Parameter nicht gesetzt wird, wird der USV-Name automatisch gesetzt. Die erste USV erhaelt in diesem Fall den Namen `ups', die zweite USV erhaelt den Namen `ups-2', die dritte den Namen `ups-3' usw.. Gueltige Werte: beliebiger Name in Kleinbuchstaben Beispiel: NUT_SERVER_1_UPSNAME='ups' NUT_SERVER_x_DRIVER Ueber diesen Parameter wird der zu verwendende USV-Treiber eingestellt, welcher zur Kommunikation mit der installierten USV verwendet werden soll. Hinweis Alle verfuegbaren Treiber befinden sich im Verzeichnis /usr/lib/ups/driver Gueltige Werte: gueltiger Treiber Standardeinstellung: NUT_SERVER_1_DRIVER='apcsmart' NUT_SERVER_x_PORT Ueber diesen Parameter legt man die zu verwendende serielle oder USB-Schnittstelle fest, ueber welche der konfigurierte USV-Treiber mit der USV kommunizieren kann. Die USB-Treiber `usbhid-ups', `bcmxcp_usb', `tripplite_usb', `blazer_usb' und `richcomm_usb' ignorieren ueblicherweise den angegebenen Port, sodass hier als Wert `auto' eingetragen werden sollte. Gueltige Werte: serielle oder USB-Schnittstelle oder `auto' Beispiel: NUT_SERVER_1_PORT='/dev/ttyS0' NUT_SERVER_x_CABLE Optionaler Parameter: Ueber diesen kann man bei Bedarf, und wenn dies vom verwendeten USV-Treiber unterstuetzt wird, den verwendeten Kabeltyp angeben, welcher zur Verbindung mit der USV verwendet wurde. Gueltige Werte: gueltiger Kabeltyp Beispiel: NUT_SERVER_x_CABLE='940_0024C' NUT_SERVER_x_DELAY Optionaler Parameter: Ueber diesen Parameter kann festgelegt werden, wie lange beim Treiberstart gewartet werden soll bis ein Treiber geladen wurde. Durch Setzen des Parameter kann verhindert werden, dass ein Server beim Systemstart uebermaessig lange haengen bleibt, weil ein z.B. ein Treiber oder eine USV defekt sind. Hinweis Standardmaessig betraegt die Wartezeit 45s Gueltige Werte: Zahl Beispiel: NUT_SERVER_1_DELAY='45' NUT_SERVER_x_ORDER Optionaler Parameter: Wenn mehrere USV an einem Server angeschlossen sind, kann ueber diesen Parameter festgelegt werden, in welcher Reihenfolge diese abgeschaltet werden sollen. Dabei werden erst alle USV mit der Kennzeichnung `0', dann `1', `2' usw. abgeschaltet. Wird `exclude' gewaehlt, so wird diese USV von der Abschaltsequenz ausgeschlossen. Hinweis Standardmaessig wird der Wert `0' gesetzt Gueltige Werte: 'exclude' oder Zahl Beispiel: NUT_SERVER_1_ORDER='0' NUT_SERVER_x_SERIAL Optionaler Parameter: Wenn mehrere USV ueber z.B. USB-Anschluesse an einem Server angeschlossen wurden, kann ueber diesen Parameter die Seriennummer der USV festgelegt werden um eine eindeutige Zuordnung zur Konfiguration sicher zu stellen. Gueltige Werte: Seriennummer einer USV Beispiel: NUT_SERVER_1_SERIAL='3B0816X76344' NUT_SERVER_x_UPSMON_SYNO_CLIENT Ueber diesen Parameter wird festgelegt, ob Synology NAS Klienten sich mit diesem NUT-Server verbinden und dessen Statusmeldungen auslesen duerfen. Gueltige Werte: yes, no Standardeinstellung: NUT_SERVER_1_UPSMON_SYNO_CLIENT='no' NUT_SERVER_x_UPSMON_SYNO_CLIENT_IP Ueber diesen Parameter wird die IP-Adresse bzw. werden die IP-Adressen der Synology NAS-Klienten festgelegt, welche berechtigt werden sollen sich mit diesem NUT-Server zu verbinden. Gueltige Werte: IP-Adresse Beipspiel: NUT_SERVER_1_UPSMON_SYNO_CLIENT_IP='192.168.6.10' NUT_SERVER_x_UPSMON_QNAP_CLIENT Ueber diesen Parameter wird festgelegt, ob QNAP NAS Klienten sich mit diesem NUT-Server verbinden und dessen Statusmeldungen auslesen duerfen. Gueltige Werte: yes, no Standardeinstellung: NUT_SERVER_1_UPSMON_QNAP_CLIENT='no' NUT_SERVER_x_UPSMON_QNAP_CLIENT_IP Ueber diesen Parameter wird die IP-Adresse bzw. werden die IP-Adressen der QNAP NAS-Klienten festgelegt, welche berechtigt werden sollen sich mit diesem NUT-Server zu verbinden. Gueltige Werte: IP-Adresse Beipspiel: NUT_SERVER_1_UPSMON_QNAP_CLIENT_IP='192.168.6.10' NUT_SERVER_x_UPSMON_CLIENT_N Ueber diesen Parameter wird die Anzahl der einzurichtenden Klienten angegeben, welche berechtigt werden sollen sich mit diesem NUT-Server zu verbinden und dessen Statusmeldungen auslesen duerfen. Gueltige Werte: Zahl Standardeinstellung: NUT_SERVER_1_UPSMON_CLIENT_N='0' NUT_SERVER_x_UPSMON_CLIENT_y_ACTIVE Wird dieser Parameter auf den Wert `yes' gesetzt, so wird der Datensatz aktiviert, der Wert `no' deaktiviert ihn. Gueltige Werte: yes, no Standardeinstellung: NUT_SERVER_1_UPSMON_CLIENT_1_ACTIVE='no' NUT_SERVER_x_UPSMON_CLIENT_y_USER Ueber diesen Parameter wird der Benutzername festgelegt, welcher zur Authentifizierung des Klienten gegenueber dem NUT-Server verwendet werden soll. Gueltige Werte: Benutzername Standardeinstellung: NUT_SERVER_1_UPSMON_CLIENT_1_USER='monuser' NUT_SERVER_x_UPSMON_CLIENT_x_PASS Ueber diesen Parameter wird das Kennwort festgelegt, welcher zur Authentifizierung des Klienten gegenueber dem NUT-Server verwendet werden soll. Gueltige Werte: Kennwort Standardeinstellung: NUT_SERVER_1_UPSMON_CLIENT_1_PASS='pass' NUT_SERVER_x_UPSMON_CLIENT_y_IP Ueber diesen Parameter wird die IP-Adresse des NUT-Klienten festgelegt, welche berechtigt werden sollen sich mit diesem NUT-Server zu verbinden. Gueltige Werte: IP-Adresse Beispiel: NUT_SERVER_x_UPSMON_CLIENT_y_IP='192.168.6.10' NUT_SERVER_LISTEN_ADDRESSES Optionaler Parameter: Ueber diesen Parameter wird die IP-Adresse bzw. werden die IP-Adressen festgelegt, auf welchen der NUT-Server Verbindungsanfragen entgegen nehmen soll. Hinweis Standardmaessig wird die IP-Adresse 127.0.0.1 verwendet Gueltige Werte: IP-Adresse bzw. Adressen Beispiel: NUT_SERVER_LISTEN_ADDRESSES='192.168.6.10' Die Web-GUI-Einstellungen NUT_SERVER_WEBGUI Wird dieser Parameter auf den Wert `yes' gesetzt, so wird die NUT-Weboberflaeche aktiviert, der Wert `no' deaktiviert sie. Gueltige Werte: yes, no Standardeinstellung: NUT_SERVER_WEBGUI='no' NUT_SERVER_WEBGUI_DOCUMENT_ROOT Optionaler Parameter: Ueber diesen Parameter kann ein vom Standard abweichendes Dokumentenstammverzeichnis festgelegt werden. Wird dieser Parameter nicht gesetzt, so wird der folgende Verzeichnispfad verwendet: /var/www/htdocs/nut. Gueltige Werte: absolute Pfadangabe Beispiel: NUT_SERVER_WEBGUI_DOCUMENT_ROOT='/var/www/htdocs/nut' Verschiedenes Getestet USV-Anbindungen APC Smart-UPS 1000/1500 Diese USV wird ueber ein serielles Kabel angesprochen, dessen Typ bei der Konfiguration angegeben werden muss: Beispiel: NUT_SERVER_1_DRIVER='apcsmart' NUT_SERVER_1_PORT='/dev/ttyS0' NUT_SERVER_1_CABLE='940_0024C' APC Back-UPS BR800 Diese USV wird ueber ein USB-Kabel angesprochen. Falls mehr als eine USV ueber die USB-Schnittstelle angeschlossen wird, muss ueber den optionalen Parameter NUT_SERVER_1_SERIAL zusaetzlich noch die Seriennummer der USV mitgegeben werden. Beispiel: NUT_SERVER_1_DRIVER='usbhid-ups' NUT_SERVER_1_PORT='/dev/ttyUSB0' NUT_SERVER_1_CABLE='' NUT_SERVER_1_SERIAL='valid-serial-number' BlueWalker PowerWalker VI 1000 LCD Diese USV wird ueber ein USB-Kabel angesprochen. Beispiel: NUT_SERVER_1_DRIVER='nutdrv_qx' NUT_SERVER_1_PORT='auto' NUT_SERVER_1_CABLE='' __________________________________________________________________ Juergen Edner 2015-10-11