SnmpMgrGetTrap, fonction (mgmtapi.h)

Article
08/24/2023

[SNMP est disponible pour une utilisation dans les systèmes d’exploitation spécifiés dans la section Configuration requise. Il sera peut-être modifié ou indisponible dans les versions ultérieures. Utilisez plutôt Windows Remote Management, qui est l’implémentation Microsoft de WS-Man.]

La fonction SnmpMgrGetTrap retourne les données d’interruption en suspens que l’appelant n’a pas reçues si la réception d’interruption est activée. Cette fonction est un élément de l’API de gestion SNMP.

En plus des informations retournées par cette fonction, la fonction SnmpMgrGetTrapEx retourne l’adresse de la source de transport et la chaîne de communauté de l’interruption.

Syntaxe

BOOL SNMP_FUNC_TYPE SnmpMgrGetTrap(
  [out] AsnObjectIdentifier *enterprise,
  [out] AsnNetworkAddress   *IPAddress,
  [out] AsnInteger          *genericTrap,
  [out] AsnInteger          *specificTrap,
  [out] AsnTimeticks        *timeStamp,
  [out] RFC1157VarBindList  *variableBindings
);

Paramètres

[out] enterprise

Pointeur vers une structure AsnObjectIdentifier pour recevoir l’entreprise qui a généré l’interruption SNMP.

[out] IPAddress

Pointeur vers une variable pour recevoir l’adresse de l’agent qui a généré l’interruption SNMP.

[out] genericTrap

Pointeur vers une variable pour recevoir un indicateur de l’interruption générique. Ce paramètre peut prendre les valeurs suivantes.

Valeur	Signification
SNMP_GENERICTRAP_COLDSTART	L’agent initialise des entités de protocole en mode managé. Il peut modifier des objets dans sa vue.
SNMP_GENERICTRAP_WARMSTART	L’agent se réinitialise, mais il ne modifie pas les objets dans sa vue.
SNMP_GENERICTRAP_LINKDOWN	Une interface attachée est passée de l’état « up » à l’état « down ». La première variable de la liste des liaisons de variables identifie l’interface.
SNMP_GENERICTRAP_LINKUP	Une interface attachée est passée de l’état « down » à l’état « up ». La première variable de la liste des liaisons de variables identifie l’interface.
SNMP_GENERICTRAP_AUTHFAILURE	Une entité SNMP a envoyé un message SNMP, mais elle a faussement prétendu appartenir à une communauté connue.
SNMP_GENERICTRAP_EGPNEIGHLOSS	Un homologue EGP est passé à l’état « down ». La première variable de la liste des liaisons de variables identifie l’adresse IP de l’homologue EGP.
SNMP_GENERICTRAP_ENTERSPECIFIC	Un événement extraordinaire s’est produit et il est identifié dans le paramètre specificTrap avec une valeur spécifique à l’entreprise.

[out] specificTrap

Pointeur vers une variable pour recevoir une indication de l’interruption spécifique générée.

[out] timeStamp

Pointeur vers une variable pour recevoir l’horodatage.

[out] variableBindings

Pointeur vers une structure SnmpVarBindList pour recevoir la liste des liaisons de variables.

Valeur retournée

Si la fonction retourne une interruption, la valeur de retour est TRUE. Le code de l’erreur peut être récupéré en appelant SnmpGetLastError immédiatement après l’appel.

Vous devez appeler la fonction SnmpMgrGetTrap à plusieurs reprises jusqu’à ce qu’elle retourne FALSE (zéro). La fonction peut également retourner les codes d’erreur suivants.

Code de retour	Description
SNMP_MGMTAPI_TRAP_ERRORS	Indique que des erreurs ont été rencontrées ; les pièges ne sont pas accessibles.
SNMP_MGMTAPI_NOTRAPS	Indique qu’aucun piège n’est disponible.
SNMP_MEM_ALLOC_ERROR	Indique une erreur d’allocation de mémoire.

Remarques

L’application doit toujours appeler la fonction SnmpMgrTrapListen avant d’appeler la fonction SnmpMgrGetTrap . Cela est dû au fait que le handle d’événement pointé par le paramètre phTrapAvailable de la fonction SnmpMgrTrapListen permet l’acquisition pilotée par les événements des interruptions SNMP. L’API de gestion SNMP signale l’événement d’une application lorsque le service d’interruption SNMP remet une interruption.

L’application peut également interroger la fonction SnmpMgrGetTrap à la recherche d’interruptions à intervalles réguliers. Dans ce cas, l’application doit appeler snmpMgrGetTrap à plusieurs reprises jusqu’à ce que la fonction retourne zéro.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	mgmtapi.h
Bibliothèque	Mgmtapi.lib
DLL	Mgmtapi.dll

Voir aussi

AsnObjectIdentifier

Fonctions SNMP

Vue d’ensemble du protocole SNMP (Simple Network Management Protocol)

SnmpMgrTrapListen

SnmpVarBindList

Partager via