SnmpMgrGetTrapEx-Funktion (mgmtapi.h)

Artikel
08/24/2023

[SNMP ist für die Verwendung in den im Abschnitt Anforderungen angegebenen Betriebssystemen verfügbar. Es kann in nachfolgenden Versionen geändert oder entfernt werden. Verwenden Sie stattdessen die Windows-Remoteverwaltung, die Microsoft-Implementierung von WS-Man.]

Die SnmpMgrGetTrapEx-Funktion gibt ausstehende Trapdaten zurück, die der Aufrufer nicht empfangen hat, wenn der Trapempfang aktiviert ist. Zusätzlich zu den Informationen, die von der SnmpMgrGetTrap-Funktion zurückgegeben werden, gibt diese erweiterte Funktion die Adresse der Transportquelle und die Communityzeichenfolge der Trap zurück. Diese Funktion ist ein Element der SNMP-Verwaltungs-API.

Syntax

BOOL SNMP_FUNC_TYPE SnmpMgrGetTrapEx(
  [out] AsnObjectIdentifier *enterprise,
  [out] AsnNetworkAddress   *agentAddress,
  [out] AsnNetworkAddress   *sourceAddress,
  [out] AsnInteger          *genericTrap,
  [out] AsnInteger          *specificTrap,
  [out] AsnOctetString      *community,
  [out] AsnTimeticks        *timeStamp,
  [out] RFC1157VarBindList  *variableBindings
);

Parameter

[out] enterprise

Zeiger auf eine AsnObjectIdentifier-Struktur , um das Unternehmen zu empfangen, das den SNMP-Trap generiert hat.

[out] agentAddress

Zeiger auf eine Variable, um die Adresse des Agents zu empfangen, der die SNMP-Trap generiert hat; Diese Informationen werden von der SNMP-Protokolldateneinheit (PDU) abgerufen.

[out] sourceAddress

Zeiger auf eine Variable, um die Adresse des Agents zu empfangen, der die SNMP-Trap generiert hat; diese Informationen werden vom Netzwerktransport abgerufen.

[out] genericTrap

Zeiger auf eine Variable, um einen Indikator der generischen Trap zu empfangen. Dieser Parameter kann einen der folgenden Werte annehmen.

Wert	Bedeutung
SNMP_GENERICTRAP_COLDSTART	Der Agent initialisiert Protokollentitäten im verwalteten Modus. Es kann Objekte in seiner Ansicht ändern.
SNMP_GENERICTRAP_WARMSTART	Der Agent initialisiert sich selbst neu, ändert jedoch keine Objekte in seiner Ansicht.
SNMP_GENERICTRAP_LINKDOWN	Eine angefügte Schnittstelle hat sich vom Status "Oben" in "Unten" geändert. Die erste Variable in der Variablenbindungsliste identifiziert die Schnittstelle.
SNMP_GENERICTRAP_LINKUP	Eine angefügte Schnittstelle hat sich vom Abwärtszustand in den Up-Zustand geändert. Die erste Variable in der Variablenbindungsliste identifiziert die Schnittstelle.
SNMP_GENERICTRAP_AUTHFAILURE	Eine SNMP-Entität hat eine SNMP-Nachricht gesendet, aber sie hat fälschlicherweise behauptet, einer bekannten Community anzugehören.
SNMP_GENERICTRAP_EGPNEIGHLOSS	Ein EGP-Peer hat sich in den Down-Zustand geändert. Die erste Variable in der Variablenbindungsliste identifiziert die IP-Adresse des EGP-Peers.
SNMP_GENERICTRAP_ENTERSPECIFIC	Ein außergewöhnliches Ereignis ist aufgetreten. Sie wird im specificTrap-Parameter mit einem unternehmensspezifischen Wert identifiziert.

[out] specificTrap

Zeiger auf eine Variable, um einen Indikator für die generierte spezifische Trap zu empfangen.

[out] community

Zeiger auf eine AsnOctetString-Struktur , um die Communityzeichenfolge der generierten SNMP-Trap zu empfangen.

[out] timeStamp

Zeiger auf eine Variable, um den Zeitstempel zu erhalten.

[out] variableBindings

Zeiger auf eine SnmpVarBindList-Struktur , um die Variablenbindungsliste zu empfangen.

Rückgabewert

Wenn die Funktion eine Trap zurückgibt, ist der Rückgabewert ungleich null.

Sie sollten die SnmpMgrGetTrapEx-Funktion wiederholt aufrufen, bis sie null zurückgibt. Die Funktion gibt möglicherweise auch die folgenden Fehlercodes zurück.

Rückgabecode	Beschreibung
SNMP_MGMTAPI_TRAP_ERRORS	Gibt an, dass Fehler aufgetreten sind; Auf Traps kann nicht zugegriffen werden.
SNMP_MGMTAPI_NOTRAPS	Gibt an, dass keine Traps verfügbar sind.
SNMP_MEM_ALLOC_ERROR	Gibt einen Speicherbelegungsfehler an.

Hinweise

Die Anwendung muss immer die SnmpMgrTrapListen-Funktion aufrufen, bevor die SnmpMgrGetTrapEx-Funktion aufgerufen wird. Dies liegt daran, dass das Ereignishandle, auf das vom phTrapAvailable-Parameter der SnmpMgrTrapListen-Funktion verwiesen wird, die ereignisgesteuerte Erfassung von SNMP-Traps ermöglicht. Die SNMP-Verwaltungs-API signalisiert ein Anwendungsereignis, wenn der SNMP-Trap-Dienst eine Trap übermittelt.

Die Anwendung kann auch die SnmpMgrGetTrapEx-Funktion in regelmäßigen Abständen auf Traps abfragen. In diesem Fall sollte die Anwendung snmpMgrGetTrapEx wiederholt aufrufen, bis die Funktion null zurückgibt.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	mgmtapi.h
Bibliothek	Mgmtapi.lib
DLL	Mgmtapi.dll