Unterabschnitte

Das Nut-Paket

Die Einleitung

NUT ist ein Client/Server-Framework zur Ansteuerung und Verwaltung einer USV (unterbrechungsfreie Stromversorgung, englisch: UPS). Unterstützt werden über 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:

Die Voraussetzungen

Um die Funktion `Show UPS key data as chart' auf einem nut-Server über das Menü aufrufen zu können wird ein installiertes gnuplot-Paket benötigt.

Die Installation

Das Nut-Paket wird über das Setup-Menü installiert. Wird eine ältere Paketversion vorgefunden, so wird diese deinstalliert bevor die neuen Programmdateien installiert werden.

Das Menü im Setup-Programm

Das Menü im Setup-Programm ist wie folgt aufgebaut:

Die Menüpunkte dürften selbsterklärend sein, da sie keinerlei weitere Eingaben erwarten. Aus diesem Grund wird auf deren Funktion nicht weiter eingegangen.

Die Änderung der Konfiguration

Die Konfiguration kann über den Menüpunkt 'Edit configuration' geändert werden. Standardmäßig wird der Editor aufgerufen, der in der Environment-Konfiguration über die Variable 'EDITOR' festgelegt wurde. Nachdem der Editor beendet wurde wird abgefragt, ob die Konfiguration aktiviert werden soll. Wird dies bestätigt, werden über ein Skript die Anpassungen umgehend wirksam gemacht.

Die Konfigurationsdatei

In der Konfigurationsdatei, die über das Menü zugänglich 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.

Gültige 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 dürfen nicht gleichzeitig aktiviert werden!


Gültige 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 dürfen nicht gleichzeitig aktiviert werden!


Gültige 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 können individuelle Anmeldedaten für den Monitorzugriff über die Parameter NUT_CLIENT_UPSMON_UPSNAME, NUT_CLIENT_UPSMON_USER und NUT_CLIENT_UPSMON_PASS definiert werden.

Gültige 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 können individuelle Anmeldedaten für den Monitorzugriff über die Parameter NUT_CLIENT_UPSMON_UPSNAME, NUT_CLIENT_UPSMON_USER und NUT_CLIENT_UPSMON_PASS definiert werden.

Gültige Werte: yes, no

Standardeinstellung: NUT_CLIENT_UPSMON_QNAP_CLIENT='no'

NUT_CLIENT_UPSMON_UPSNAME

Über diesen Parameter wird der Name der USV angegeben, zu welcher sich dieser USV-Klient verbinden soll.

Gültige Werte: beliebiger Name in Kleinbuchstaben

Beispiel: NUT_CLIENT_UPSMON_UPSNAME='ups'

NUT_CLIENT_UPSMON_USER

Über diesen Parameter wird der Benutzername festgelegt, welcher zur Authentifizierung gegenüber einem NUT-Server verwendet werden soll.

Gültige Werte: Benutzername

Standardeinstellung: NUT_CLIENT_UPSMON_USER='monuser'

NUT_CLIENT_UPSMON_PASS

Über diesen Parameter wird das Kennwort festgelegt, welches zur Authentifizierung gegenüber einem NUT-Server verwendet werden soll.

Gültige Werte: Kennwort

Standardeinstellung: NUT_CLIENT_UPSMON_USER='pass'

NUT_CLIENT_UPSMON_SERVER_IP

Über diesen Parameter wird die IP-Adresse des NUT-Servers festgelegt, als dessen Klient dieses NUT-Dienst arbeiten soll.

Gültige Werte: IP-Adresse

Standardeinstellung: NUT_CLIENT_UPSMON_SERVER_IP=''

Die Server-Einstellungen

NUT_SERVER_UPSMON_ADMIN_USER

Über diesen Parameter wird der Name des Administrators festgelegt, welcher erweitere USV-Abfragen durchführen oder USV-Einstellungen verändern darf.

Gültige Werte: Benutzername

Standardeinstellung: NUT_SERVER_UPSMON_ADMIN_USER='admin'

NUT_SERVER_UPSMON_ADMIN_PASS

Über diesen Parameter wird das Kennwort des Administrators festgelegt, welcher erweitere USV-Abfragen durchführen oder USV-Einstellungen verändern darf.

Gültige Werte: Kennwort

Standardeinstellung: NUT_SERVER_UPSMON_ADMIN_PASS='geheim'

NUT_SERVER_UPSMON_ADMIN_EMAIL

Optionaler Parameter: Über diesen Parameter kann eine vom Standard abweichende E-Mail-Adresse für 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.

Gültige Werte: E-Mail-Adresse

Beispiel: NUT_SERVER_UPSMON_ADMIN_EMAIL='tommy@domain.de'

NUT_SERVER_N

Über diesen Parameter wird die Anzahl der einzurichtenden NUT-Serverdienste angegeben.

Gültige 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.

Gültige 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.

Gültige Werte: beliebiger Text

Beispiel: NUT_SERVER_1_COMMENT='Meine erste USV'

NUT_SERVER_x_UPSNAME

Optionaler Parameter: Über 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 erhält in diesem Fall den Namen `ups', die zweite USV erhält den Namen `ups-2', die dritte den Namen `ups-3' usw..

Gültige Werte: beliebiger Name in Kleinbuchstaben

Beispiel: NUT_SERVER_1_UPSNAME='ups'

NUT_SERVER_x_DRIVER

Über diesen Parameter wird der zu verwendende USV-Treiber eingestellt, welcher zur Kommunikation mit der installierten USV verwendet werden soll.

Hinweis
Alle verfügbaren Treiber befinden sich im Verzeichnis /usr/lib/ups/driver


Gültige Werte: gültiger Treiber

Standardeinstellung: NUT_SERVER_1_DRIVER='apcsmart'

NUT_SERVER_x_PORT

Über diesen Parameter legt man die zu verwendende serielle oder USB-Schnittstelle fest, über 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 üblicherweise den angegebenen Port, sodass hier als Wert `auto' eingetragen werden sollte.

Gültige Werte: serielle oder USB-Schnittstelle oder `auto'

Beispiel: NUT_SERVER_1_PORT='/dev/ttyS0'

NUT_SERVER_x_CABLE

Optionaler Parameter: Über diesen kann man bei Bedarf, und wenn dies vom verwendeten USV-Treiber unterstützt wird, den verwendeten Kabeltyp angeben, welcher zur Verbindung mit der USV verwendet wurde.

Gültige Werte: gültiger Kabeltyp

Beispiel: NUT_SERVER_x_CABLE='940_0024C'

NUT_SERVER_x_DELAY

Optionaler Parameter: Über 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 übermässig lange hängen bleibt, weil ein z.B. ein Treiber oder eine USV defekt sind.

Hinweis
Standardmäßig beträgt die Wartezeit 45s


Gültige Werte: Zahl

Beispiel: NUT_SERVER_1_DELAY='45'

NUT_SERVER_x_ORDER

Optionaler Parameter: Wenn mehrere USV an einem Server angeschlossen sind, kann über 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' gewählt, so wird diese USV von der Abschaltsequenz ausgeschlossen.

Hinweis
Standardmäßig wird der Wert `0' gesetzt


Gültige Werte: 'exclude' oder Zahl

Beispiel: NUT_SERVER_1_ORDER='0'

NUT_SERVER_x_SERIAL

Optionaler Parameter: Wenn mehrere USV über z.B. USB-Anschlüsse an einem Server angeschlossen wurden, kann über diesen Parameter die Seriennummer der USV festgelegt werden um eine eindeutige Zuordnung zur Konfiguration sicher zu stellen.

Gültige Werte: Seriennummer einer USV

Beispiel: NUT_SERVER_1_SERIAL='3B0816X76344'

NUT_SERVER_x_UPSMON_SYNO_CLIENT

Über diesen Parameter wird festgelegt, ob Synology NAS Klienten sich mit diesem NUT-Server verbinden und dessen Statusmeldungen auslesen dürfen.

Gültige Werte: yes, no

Standardeinstellung: NUT_SERVER_1_UPSMON_SYNO_CLIENT='no'

NUT_SERVER_x_UPSMON_SYNO_CLIENT_IP

Über 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.

Gültige Werte: IP-Adresse

Beipspiel: NUT_SERVER_1_UPSMON_SYNO_CLIENT_IP='192.168.6.10'

NUT_SERVER_x_UPSMON_QNAP_CLIENT

Über diesen Parameter wird festgelegt, ob QNAP NAS Klienten sich mit diesem NUT-Server verbinden und dessen Statusmeldungen auslesen dürfen.

Gültige Werte: yes, no

Standardeinstellung: NUT_SERVER_1_UPSMON_QNAP_CLIENT='no'

NUT_SERVER_x_UPSMON_QNAP_CLIENT_IP

Über 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.

Gültige Werte: IP-Adresse

Beipspiel: NUT_SERVER_1_UPSMON_QNAP_CLIENT_IP='192.168.6.10'

NUT_SERVER_x_UPSMON_CLIENT_N

Über diesen Parameter wird die Anzahl der einzurichtenden Klienten angegeben, welche berechtigt werden sollen sich mit diesem NUT-Server zu verbinden und dessen Statusmeldungen auslesen dürfen.

Gültige 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.

Gültige Werte: yes, no

Standardeinstellung: NUT_SERVER_1_UPSMON_CLIENT_1_ACTIVE='no'

NUT_SERVER_x_UPSMON_CLIENT_y_USER

Über diesen Parameter wird der Benutzername festgelegt, welcher zur Authentifizierung des Klienten gegenüber dem NUT-Server verwendet werden soll.

Gültige Werte: Benutzername

Standardeinstellung: NUT_SERVER_1_UPSMON_CLIENT_1_USER='monuser'

NUT_SERVER_x_UPSMON_CLIENT_x_PASS

Über diesen Parameter wird das Kennwort festgelegt, welcher zur Authentifizierung des Klienten gegenüber dem NUT-Server verwendet werden soll.

Gültige Werte: Kennwort

Standardeinstellung: NUT_SERVER_1_UPSMON_CLIENT_1_PASS='pass'

NUT_SERVER_x_UPSMON_CLIENT_y_IP

Über diesen Parameter wird die IP-Adresse des NUT-Klienten festgelegt, welche berechtigt werden sollen sich mit diesem NUT-Server zu verbinden.

Gültige Werte: IP-Adresse

Beispiel: NUT_SERVER_x_UPSMON_CLIENT_y_IP='192.168.6.10'

NUT_SERVER_LISTEN_ADDRESSES

Optionaler Parameter: Über diesen Parameter wird die IP-Adresse bzw. werden die IP-Adressen festgelegt, auf welchen der NUT-Server Verbindungsanfragen entgegen nehmen soll.

Hinweis
Standardmäßig wird die IP-Adresse 127.0.0.1 verwendet


Gültige 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-Weboberfläche aktiviert, der Wert `no' deaktiviert sie.

Gültige Werte: yes, no

Standardeinstellung: NUT_SERVER_WEBGUI='no'

NUT_SERVER_WEBGUI_DOCUMENT_ROOT

Optionaler Parameter: Über 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.

Gültige 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 über 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 über ein USB-Kabel angesprochen. Falls mehr als eine USV über die USB-Schnittstelle angeschlossen wird, muss über den optionalen Parameter NUT_SERVER_1_SERIAL zusätzlich 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 über ein USB-Kabel angesprochen.

Beispiel:

NUT_SERVER_1_DRIVER='nutdrv_qx'
NUT_SERVER_1_PORT='auto'
NUT_SERVER_1_CABLE=''

eis 2017-05-03