version 1.1.2.1, 2006/02/10 16:11:46
|
version 1.11, 2008/12/16 18:56:44
|
|
|
//%2006//////////////////////////////////////////////////////////////////////// |
//%LICENSE//////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
// Licensed to The Open Group (TOG) under one or more contributor license |
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. |
// agreements. Refer to the OpenPegasusNOTICE.txt file distributed with |
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.; |
// this work for additional information regarding copyright ownership. |
// IBM Corp.; EMC Corporation, The Open Group. |
// Each contributor licenses this file to you under the OpenPegasus Open |
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; |
// Source License; you may not use this file except in compliance with the |
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
// License. |
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
// |
// EMC Corporation; VERITAS Software Corporation; The Open Group. |
// Permission is hereby granted, free of charge, to any person obtaining a |
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
// copy of this software and associated documentation files (the "Software"), |
// EMC Corporation; Symantec Corporation; The Open Group. |
// to deal in the Software without restriction, including without limitation |
// |
// the rights to use, copy, modify, merge, publish, distribute, sublicense, |
// Permission is hereby granted, free of charge, to any person obtaining a copy |
// and/or sell copies of the Software, and to permit persons to whom the |
// of this software and associated documentation files (the "Software"), to |
// Software is furnished to do so, subject to the following conditions: |
// deal in the Software without restriction, including without limitation the |
// |
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
// The above copyright notice and this permission notice shall be included |
// sell copies of the Software, and to permit persons to whom the Software is |
// in all copies or substantial portions of the Software. |
// furnished to do so, subject to the following conditions: |
// |
// |
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN |
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED |
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT |
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR |
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN |
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
|
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
|
// | // |
//============================================================================== |
////////////////////////////////////////////////////////////////////////// |
// |
|
// Author: Yi Zhou, Hewlett-Packard Company (yi.zhou@hp.com) |
|
// |
|
// Modified By: |
|
// | // |
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
|
|
| |
#include <net-snmp/net-snmp-config.h> | #include <net-snmp/net-snmp-config.h> |
#include <net-snmp/net-snmp-includes.h> | #include <net-snmp/net-snmp-includes.h> |
|
#include <net-snmp/config_api.h> |
|
#include <Pegasus/Common/Mutex.h> |
#include "snmpDeliverTrap.h" | #include "snmpDeliverTrap.h" |
| |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
|
|
static const char _MSG_SESSION_OPEN_FAILED [] = | static const char _MSG_SESSION_OPEN_FAILED [] = |
"Snmp Indication Handler failed to open the SNMP session: "; | "Snmp Indication Handler failed to open the SNMP session: "; |
static const char _MSG_SESSION_OPEN_FAILED_KEY [] = | static const char _MSG_SESSION_OPEN_FAILED_KEY [] = |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp._MSG_SESSION_OPEN_FAILED"; |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp." |
|
"_MSG_SESSION_OPEN_FAILED"; |
| |
static const char _MSG_GET_SESSION_POINT_FAILED [] = | static const char _MSG_GET_SESSION_POINT_FAILED [] = |
"Snmp Indication Handler failed to get the SNMP session pointer: "; | "Snmp Indication Handler failed to get the SNMP session pointer: "; |
static const char _MSG_GET_SESSION_POINTER_FAILED_KEY [] = | static const char _MSG_GET_SESSION_POINTER_FAILED_KEY [] = |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp._MSG_GET_SESSION_POINT_FAILED"; |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp." |
|
"_MSG_GET_SESSION_POINT_FAILED"; |
| |
static const char _MSG_PDU_CREATE_FAILED [] = | static const char _MSG_PDU_CREATE_FAILED [] = |
"Snmp Indication Handler failed to create the SNMP PDU."; | "Snmp Indication Handler failed to create the SNMP PDU."; |
static const char _MSG_PDU_CREATE_FAILED_KEY [] = | static const char _MSG_PDU_CREATE_FAILED_KEY [] = |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp._MSG_PDU_CREATE_FAILED"; |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp." |
|
"_MSG_PDU_CREATE_FAILED"; |
| |
static const char _MSG_VERSION_NOT_SUPPORTED [] = | static const char _MSG_VERSION_NOT_SUPPORTED [] = |
"SNMPv1 Trap and SNMPv2C Trap are the only supported SNMPVersion values."; | "SNMPv1 Trap and SNMPv2C Trap are the only supported SNMPVersion values."; |
static const char _MSG_VERSION_NOT_SUPPORTED_KEY [] = | static const char _MSG_VERSION_NOT_SUPPORTED_KEY [] = |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp._MSG_VERSION_NOT_SUPPORTED"; |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp." |
|
"_MSG_VERSION_NOT_SUPPORTED"; |
| |
static const char _MSG_SESSION_SEND_FAILED [] = | static const char _MSG_SESSION_SEND_FAILED [] = |
"Snmp Indication Handler failed to send the trap: "; | "Snmp Indication Handler failed to send the trap: "; |
static const char _MSG_SESSION_SEND_FAILED_KEY [] = | static const char _MSG_SESSION_SEND_FAILED_KEY [] = |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp._MSG_SESSION_SEND_FAILED"; |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp." |
|
"_MSG_SESSION_SEND_FAILED"; |
| |
static const char _MSG_PACK_TRAP_INFO_INTO_PDU_FAILED [] = | static const char _MSG_PACK_TRAP_INFO_INTO_PDU_FAILED [] = |
"Snmp Indication Handler failed to pack trap information into the SNMP PDU: \"$0\"."; |
"Snmp Indication Handler failed to pack trap information into the " |
|
"SNMP PDU: \"$0\"."; |
static const char _MSG_PACK_TRAP_INFO_INTO_PDU_FAILED_KEY [] = | static const char _MSG_PACK_TRAP_INFO_INTO_PDU_FAILED_KEY [] = |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp._MSG_PACK_TRAP_INFO_INTO_PDU_FAILED"; |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp." |
|
"_MSG_PACK_TRAP_INFO_INTO_PDU_FAILED"; |
| |
static const char _MSG_ADD_SYSUPTIME_TO_PDU_FAILED [] = | static const char _MSG_ADD_SYSUPTIME_TO_PDU_FAILED [] = |
"Snmp Indication Handler failed to add sysUpTime to the SNMP PDU: \"$0\"."; | "Snmp Indication Handler failed to add sysUpTime to the SNMP PDU: \"$0\"."; |
static const char _MSG_ADD_SYSUPTIME_TO_PDU_FAILED_KEY [] = | static const char _MSG_ADD_SYSUPTIME_TO_PDU_FAILED_KEY [] = |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp._MSG_ADD_SYSUPTIME_TO_PDU_FAILED"; |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp." |
|
"_MSG_ADD_SYSUPTIME_TO_PDU_FAILED"; |
| |
static const char _MSG_ADD_SNMP_TRAP_TO_PDU_FAILED [] = | static const char _MSG_ADD_SNMP_TRAP_TO_PDU_FAILED [] = |
"Snmp Indication Handler failed to add SNMP Trap to the SNMP PDU: \"$0\"."; | "Snmp Indication Handler failed to add SNMP Trap to the SNMP PDU: \"$0\"."; |
static const char _MSG_ADD_SNMP_TRAP_TO_PDU_FAILED_KEY [] = | static const char _MSG_ADD_SNMP_TRAP_TO_PDU_FAILED_KEY [] = |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp._MSG_ADD_SNMP_TRAP_TO_PDU_FAILED"; |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp." |
|
"_MSG_ADD_SNMP_TRAP_TO_PDU_FAILED"; |
| |
static const char _MSG_PACK_CIM_PROPERTY_TO_PDU_FAILED [] = | static const char _MSG_PACK_CIM_PROPERTY_TO_PDU_FAILED [] = |
"Snmp Indication Handler failed to pack a CIM Property into the SNMP PDU: \"$0\"."; |
"Snmp Indication Handler failed to pack a CIM Property into the " |
|
"SNMP PDU: \"$0\"."; |
static const char _MSG_PACK_CIM_PROPERTY_TO_PDU_FAILED_KEY [] = | static const char _MSG_PACK_CIM_PROPERTY_TO_PDU_FAILED_KEY [] = |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp._MSG_PACK_CIM_PROPERTY_TO_PDU_FAILED"; |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp." |
|
"_MSG_PACK_CIM_PROPERTY_TO_PDU_FAILED"; |
| |
static const char _MSG_READ_OBJID_FAILED [] = | static const char _MSG_READ_OBJID_FAILED [] = |
"Snmp Indication Handler failed to convert trapOid \"$0\" from a " | "Snmp Indication Handler failed to convert trapOid \"$0\" from a " |
"numeric form to a list of subidentifiers."; | "numeric form to a list of subidentifiers."; |
static const char _MSG_READ_OBJID_FAILED_KEY [] = | static const char _MSG_READ_OBJID_FAILED_KEY [] = |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp._MSG_READ_OBJID_FAILED"; |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp." |
|
"_MSG_READ_OBJID_FAILED"; |
| |
static const char _MSG_PARSE_CIM_PROPERTY_OID_FAILED [] = | static const char _MSG_PARSE_CIM_PROPERTY_OID_FAILED [] = |
"Snmp Indication Handler failed to convert a CIM property OID \"$0\" from " | "Snmp Indication Handler failed to convert a CIM property OID \"$0\" from " |
"a numeric form to a list of subidentifiers."; | "a numeric form to a list of subidentifiers."; |
static const char _MSG_PARSE_CIM_PROPERTY_OID_FAILED_KEY [] = | static const char _MSG_PARSE_CIM_PROPERTY_OID_FAILED_KEY [] = |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp.__MSG_PARSE_CIM_PROPERTY_OID_FAILED"; |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp." |
|
"__MSG_PARSE_CIM_PROPERTY_OID_FAILED"; |
| |
static const char _MSG_READ_ENTOID_FAILED [] = | static const char _MSG_READ_ENTOID_FAILED [] = |
"Snmp Indication Handler failed to convert SNMPV1 enterprise OID \"$0\" " | "Snmp Indication Handler failed to convert SNMPV1 enterprise OID \"$0\" " |
"from a numeric form to a list of subidentifiers."; | "from a numeric form to a list of subidentifiers."; |
static const char _MSG_READ_ENTOID_FAILED_KEY [] = | static const char _MSG_READ_ENTOID_FAILED_KEY [] = |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp._MSG_READ_ENTOID_FAILED"; |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp." |
|
"_MSG_READ_ENTOID_FAILED"; |
| |
static const char _MSG_UNSUPPORTED_SNMP_DATA_TYPE [] = | static const char _MSG_UNSUPPORTED_SNMP_DATA_TYPE [] = |
"Type \"$0\" is an unsupported SNMP Data Type for the CIM property."; | "Type \"$0\" is an unsupported SNMP Data Type for the CIM property."; |
static const char _MSG_UNSUPPORTED_SNMP_DATA_TYPE_KEY [] = | static const char _MSG_UNSUPPORTED_SNMP_DATA_TYPE_KEY [] = |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp._MSG_UNSUPPORTED_SNMP_DATA_TYPE"; |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp." |
|
"_MSG_UNSUPPORTED_SNMP_DATA_TYPE"; |
| |
static const char _MSG_ADD_VAR_TO_PDU_FAILED [] = | static const char _MSG_ADD_VAR_TO_PDU_FAILED [] = |
"Snmp Indication Handler failed to add a CIM property \"$0\" to the SNMP PDU: \"$1\"."; |
"Snmp Indication Handler failed to add a CIM property \"$0\" to the " |
|
"SNMP PDU: \"$1\"."; |
static const char _MSG_ADD_VAR_TO_PDU_FAILED_KEY [] = | static const char _MSG_ADD_VAR_TO_PDU_FAILED_KEY [] = |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp._MSG_ADD_VAR_TO_PDU_FAILED"; |
"Handler.snmpIndicationHandler.snmpDeliverTrap_netsnmp." |
|
"_MSG_ADD_VAR_TO_PDU_FAILED"; |
| |
class snmpDeliverTrap_netsnmp : public snmpDeliverTrap | class snmpDeliverTrap_netsnmp : public snmpDeliverTrap |
{ | { |
public: | public: |
| |
|
void initialize(); |
|
|
|
void terminate(); |
|
|
void deliverTrap( | void deliverTrap( |
const String& trapOid, | const String& trapOid, |
const String& securityName, | const String& securityName, |
|
|
| |
private: | private: |
| |
|
// Mutex is needed before a session is created. Sessions created |
|
// using the Single API do not interact with other SNMP sessions. |
|
Mutex _sessionInitMutex; |
|
|
/** | /** |
Creates a SNMP session. | Creates a SNMP session. |
| |
@param targetHost the target system of a hostname or an IPv4 | @param targetHost the target system of a hostname or an IPv4 |
address |
address or an IPv6 address to receive a trap |
to receive a trap |
@param targetHostFormat the format of the targetHost |
@param portNumber the port number to receive a trap | @param portNumber the port number to receive a trap |
@param securityName the human readable community name | @param securityName the human readable community name |
@param snmpSession the SNMP session |
|
@param sessionHandle an opaque pointer of the SNMP session | @param sessionHandle an opaque pointer of the SNMP session |
@param sessionPtr the SNMP session pointer to its associated | @param sessionPtr the SNMP session pointer to its associated |
struct snmp_session | struct snmp_session |
|
|
*/ | */ |
|
void _createSession( |
void _createSession(const String & targetHost, |
const String& targetHost, |
|
Uint16 targetHostFormat, |
Uint32 portNumber, | Uint32 portNumber, |
const String & securityName, | const String & securityName, |
struct snmp_session & snmpSession, |
|
void *&sessionHandle, | void *&sessionHandle, |
struct snmp_session *&sessionPtr); | struct snmp_session *&sessionPtr); |
| |
|
|
@param trapOid the trap OID | @param trapOid the trap OID |
@param sessionPtr the SNMP session pointer | @param sessionPtr the SNMP session pointer |
@param snmpPdu the SNMP PDU | @param snmpPdu the SNMP PDU |
|
|
*/ | */ |
|
void _createPdu( |
void _createPdu(Uint16 snmpVersion, |
Uint16 snmpVersion, |
const String& trapOid, | const String& trapOid, |
struct snmp_session *&sessionPtr, | struct snmp_session *&sessionPtr, |
struct snmp_pdu *& snmpPdu); | struct snmp_pdu *& snmpPdu); |
|
|
@param trapOid the trap OID | @param trapOid the trap OID |
@param snmpPdu the SNMP PDU | @param snmpPdu the SNMP PDU |
*/ | */ |
void _packTrapInfoIntoPdu(const String & trapOid, |
void _packTrapInfoIntoPdu( |
|
const String& trapOid, |
snmp_pdu * snmpPdu); | snmp_pdu * snmpPdu); |
| |
/** | /** |
|
|
@param vbValues the array of CIM property values | @param vbValues the array of CIM property values |
@param snmpPdu the SNMP PDU | @param snmpPdu the SNMP PDU |
*/ | */ |
void _packOidsIntoPdu(const Array<String>& vbOids, |
void _packOidsIntoPdu( |
|
const Array<String>& vbOids, |
const Array<String>& vbTypes, | const Array<String>& vbTypes, |
const Array<String>& vbValues, | const Array<String>& vbValues, |
snmp_pdu * snmpPdu); | snmp_pdu * snmpPdu); |
| |
enum SNMPVersion {_SNMPv1_TRAP = 2, _SNMPv2C_TRAP = 3, |
enum SNMPVersion |
_SNMPv2C_INFORM = 4, _SNMPv3_TRAP = 5, _SNMPv3_INFORM = 6}; |
{ |
|
_SNMPv1_TRAP = 2, |
|
_SNMPv2C_TRAP = 3, |
|
_SNMPv2C_INFORM = 4, |
|
_SNMPv3_TRAP = 5, |
|
_SNMPv3_INFORM = 6 |
|
}; |
| |
|
/** |
|
Values for the TargetHostFormat property of the |
|
PG_IndicationHandlerSNMPMapper class. |
|
*/ |
|
enum TargetHostFormat |
|
{ |
|
_OTHER = 1, |
|
_HOST_NAME = 2, |
|
_IPV4_ADDRESS = 3, |
|
_IPV6_ADDRESS = 4 |
|
}; |
}; | }; |
| |
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |