Función SnmpMgrGetTrap (mgmtapi.h)

Artículo
02/29/2024

[SNMP está disponible para su uso en los sistemas operativos especificados en la sección Requisitos. En versiones posteriores podría modificarse o no estar disponible. En su lugar, use la administración remota de Windows, que es la implementación de Microsoft de WS-Man.]

La función SnmpMgrGetTrap devuelve datos de captura pendientes que el autor de la llamada no ha recibido si está habilitada la recepción de capturas. Esta función es un elemento de la API de administración de SNMP.

Además de la información devuelta por esta función, la función SnmpMgrGetTrapEx devuelve la dirección del origen de transporte y la cadena de comunidad de la captura.

Sintaxis

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

Parámetros

[out] enterprise

Puntero a una estructura AsnObjectIdentifier para recibir la empresa que generó la captura snmp.

[out] IPAddress

Puntero a una variable para recibir la dirección del agente que generó la captura snmp.

[out] genericTrap

Puntero a una variable para recibir un indicador de la captura genérica. Este parámetro puede ser uno de los valores siguientes.

Valor	Significado
SNMP_GENERICTRAP_COLDSTART	El agente está inicializando entidades de protocolo en el modo administrado. Puede modificar objetos en su vista.
SNMP_GENERICTRAP_WARMSTART	El agente se reinicializa, pero no modificará los objetos en su vista.
SNMP_GENERICTRAP_LINKDOWN	Una interfaz adjunta ha cambiado del estado "arriba" al estado "abajo". La primera variable de la lista de enlaces de variables identifica la interfaz .
SNMP_GENERICTRAP_LINKUP	Una interfaz adjunta ha cambiado del estado "abajo" al estado "arriba". La primera variable de la lista de enlaces de variables identifica la interfaz .
SNMP_GENERICTRAP_AUTHFAILURE	Una entidad SNMP ha enviado un mensaje SNMP, pero se ha reclamado falsamente que pertenezca a una comunidad conocida.
SNMP_GENERICTRAP_EGPNEIGHLOSS	Un par EGP ha cambiado al estado "inactivo". La primera variable de la lista de enlaces de variables identifica la dirección IP del par EGP.
SNMP_GENERICTRAP_ENTERSPECIFIC	Se ha producido un evento extraordinario y se identifica en el parámetro specificTrap con un valor específico de la empresa.

[out] specificTrap

Puntero a una variable para recibir una indicación de la captura específica generada.

[out] timeStamp

Puntero a una variable para recibir la marca de tiempo.

[out] variableBindings

Puntero a una estructura SnmpVarBindList para recibir la lista de enlaces de variables.

Valor devuelto

Si la función devuelve una captura, el valor devuelto es TRUE. El código del error se puede recuperar llamando a SnmpGetLastError inmediatamente después de la llamada.

Debe llamar a la función SnmpMgrGetTrap repetidamente hasta que devuelva FALSE (cero). La función también puede devolver los siguientes códigos de error.

Código devuelto	Descripción
SNMP_MGMTAPI_TRAP_ERRORS	Indica que se encontraron errores; Las trampas no son accesibles.
SNMP_MGMTAPI_NOTRAPS	Indica que no hay capturas disponibles.
SNMP_MEM_ALLOC_ERROR	Indica un error de asignación de memoria.

Comentarios

La aplicación siempre debe llamar a la función SnmpMgrTrapListen antes de llamar a la función SnmpMgrGetTrap . Esto se debe a que el controlador de eventos al que apunta el parámetro phTrapAvailable de la función SnmpMgrTrapListen habilita la adquisición controlada por eventos de capturas SNMP. Snmp Management API señala el evento de una aplicación cuando el servicio de captura snmp entrega una captura.

La aplicación también puede sondear la función SnmpMgrGetTrap para capturas a intervalos regulares. En este caso, la aplicación debe llamar repetidamente a SnmpMgrGetTrap hasta que la función devuelva cero.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	mgmtapi.h
Library	Mgmtapi.lib
Archivo DLL	Mgmtapi.dll