SNMP Management | X4Documentation

Der Adapter verwaltet Geräte in einem IP-Netzwerk über das Simple Network Management Protocol (SNMP) in Version 1, 2c oder 3 (mit automatisch gewählter Sicherheitsebene). Der Adapter fordert einzelne oder mehrere Management-Datensätze (MIB-Objekte) von Agenten an, setzt Werte von Management-Datensätzen und versendet Trap-Nachrichten an Agenten.

Dieser Adapter erwartet ein Input-XML-Dokument mit einer spezifischen Struktur, die MIB-Objekt-IDs und SNMP-Parameter enthält, und gibt ein XML-Dokument aus.

Wenn der Agent bei der Überwachung des Systems einen Fehler erkennt, kann er diesen mit Hilfe eines Trap-Paketes unaufgefordert an den SNMP Management Adapter melden. Diese Pakete werden nicht vom Adapter bestätigt. Der Agent kann damit nicht feststellen, ob der Trap beim Adapter angekommen ist.

Eigenschaften (Properties)

Operation

Bestimmt, welche Operation der Adapter durchführt

Mögliche Werte:

GET: Einzelnen Management-Datensatz (MIB-Objekt) anfordern. Der Agent antwortet mit einem Response-Paket, das entweder die angeforderten Daten oder eine Fehlermeldung enthält.
GETNEXT: Nachfolgenden Management-Datensatz (MIB-Objekt) anfordern (um Tabellen zu durchlaufen)
GETBULK: Mehrere Management-Datensätze (MIB-Objekte) gleichzeitig anfordern
SET: Einen oder mehrere Management-Datensätze (MIB-Objekte) eines Geräts verändern oder Aktionen auszulösen. Der Agent bestätigt die Übernahme der Werte mit einem Response-Paket.
SENDTRAP: Trap-Nachricht zu einem Ereignis unaufgefordert an den Manager per UDP von Port 161 senden

Parameter

Adapter	Hauptklasse des Adapters (nicht verändern!) Mögliche Werte: `de.softproject.integration.adapter. snmp.SnmpAdapter`: Hauptklasse (Standard)
host	IP-Adresse oder Host-Name der Netzwerk-Management-Station (NMS) Mögliche Werte: Beliebige gültige Zeichenkette (z.B. `127.0.0.1`)
port	UDP-Portnummer (nur für SNMP in Version 2c und 3 änderbar) Mögliche Werte: `161`: Standard-Port, auf dem SNMP-Agenten horchen für die Operationen `GET`, `GETNEXT`, `GETBULK` und `SET` (Standard) `162`: Port, auf dem die Netzwerk-Management-Station standardmäßig horcht (für die Operation `SENDTRAP`)
version	Verwendete SNMP-Version Mögliche Werte: `version1`: Version 1 verwenden `version2c`: Version 2c verwenden `version3`: Version 3 verwenden
timeout	Zeitbeschränkung für den Verbindungsaufbau in Millisekunden Mögliche Werte: Beliebige ganze Zahl `3`: Zeitbeschränkung von 3 ms (Standard)
retries	Anzahl der Wiederholung von Verbindungsversuchen, falls die Verbindung nicht direkt aufgebaut werden kann Mögliche Werte: Beliebige ganze Zahl `0`: Kein zusätzlicher Verbindungsversuch (Standard)
walk	Sämtliche Anfragen im Input-XML-Dokument mit der Walk -Operation ausführen, bis alle Instanzen im OID-Teilbaum abgefragt wurden (wenn die Eigenschaft Operation auf `GETNEXT` oder `GETBULK` gesetzt ist) Mögliche Werte: `true`: `GETNEXT`- und `GETBULK`-Anfragen mit der SNMP Walk-Operation ausführen `false`: Keine `Walk`-Operation ausführen, wenn nicht anders im Input-XML-Dokument definiert (Standard)
contextEngineId	SNMP-Entity, die die Anfrage ausführen soll (wenn Parameter `version` auf `version3` gesetzt ist) Mögliche Werte: Beliebige Zeichenkette
community	Name der Community der SNMP-Agenten (wenn der Parameter version auf `version1` oder `version2c` gesetzt ist) Mögliche Werte: Beliebige Zeichenkette (z. B. `public`)
securityname	Sicherheitsnamen zur Authentifizierung von Nachrichten über SNMP Version 3 (wenn Parameter `version` auf `version3` gesetzt ist) Mögliche Werte: Beliebige Zeichenkette
authenticationprotocol	Verwendetes Verfahren zur Authentifizierung einer Nachricht über SNMP Version 3 (wenn Parameter `version` auf `version3` gesetzt ist) Mögliche Werte: `MD5`: MD5-Prüfsumme erstellen `SHA`: Secure Hash-Code erstellen
authenticationpass	Passwort zur Authentifizierung über SNMP Version 3 auf Sicherheitsebene authNoPriv (wenn Parameter `version` auf `version3` gesetzt ist) Mögliche Werte: Beliebige Zeichenkette mit mindestens 8 Zeichen Länge
privacyprotocol	Verschlüsselungs-Algorithmus für Nachrichten mit SNMP Version 3 (wenn Parameter `version` auf `version3` gesetzt ist) Mögliche Werte: `DES`: Data Encryption Standard -Algorithmus verwenden `AES`: Advanced Encryption Standard -Algorithmus verwenden `AES192`: Advanced Encryption Standard -Algorithmus mit 192 Bit Schlüssellänge verwenden `AES256`: Advanced Encryption Standard -Algorithmus 256 Bit Schlüssellänge verwenden
privacypass	Passwort für die Verschlüsselung von Nachrichten mit SNMP Version 3 auf Sicherheitsebene `authPriv` (wenn Parameter `version` auf `version3` gesetzt ist) Mögliche Werte: Beliebige Zeichenkette

Statuswerte

`1`	Die Operation wurde erfolgreich ausgeführt.
`-1`	Die Operation ist aufgrund eines technischen Fehlers fehlgeschlagen.

Input

Dieser Adapter erwartet eine adapterspezifische Input-XML-Struktur, wobei jedes Element <pdu/> für ein Netzwerkgerät steht.

<root>
    <pdu oid="MIB-Objekt-ID" timeout="Zeitbeschränkung in ms" 
         retries="Anzahl zusätzlicher Verbindungsversuche" />
</root>

Output

Dieser Adapter gibt ein UTF-8-kodiertes XML-Dokument mit folgender Struktur aus.

<root>
    <pdu oid="MIB-Objekt-ID">
        <![CDATA[ Ausgegeben Daten des MIB-Objekts ]]>
    </pdu>
</root>