[snmpdrv]

Settings for the SNMP manager

[snmpdrv] agentAliveTimeout

Type
unsigned int
Default
40 [sec]
The interval for cyclic connection monitoring (connection to the agents) is set via this entry.

[snmpdrv] agentConnectOID

Type
string
Default
1.3.6.1.2.1.1.1.0 (system.sysDescr)
The connection to the SNMP agent is monitored via this entry. This entry is valid for all agents that are queried by a driver. If this timeout elapses (specification in seconds)without receiving a message from the agent, a bit in the agent datapoint is set. When the next message is received the bit is deleted. Each received message resets the timer.

[snmpdrv] agentConnectTimeout

Type
int
Default
60
The connection to the SNMP agent is monitored via this entry. This entry is valid for all agents that are queried by a driver. If this timeout elapses (specification in seconds)without receiving a message from the agent, a bit in the agent datapoint is set. When the next message is received the bit is deleted. Each received message resets the timer.

[snmpdrv] agentDPName

Type
string
Default
SNMPAgent
This entry specifies the middle part of the datapoint name for the SNMP agent DPs. Each name is composed of _driverNumber_agentDPName_agentNumber. The datapoints are of the internal type "_SNMPAgent".

[snmpdrv] agentDPTemplate

Type
string
Default
_SNMPAgent
In order to initialize all datapoint elements a template datapoint is queried when starting a driver. The elements of this datapoint are available for all datapoints. If an element of this template datapoint is missing, the element is not available on any agent datapoints! A template datapoint can, of course, be a normal datapoint (that is used anyway). In this case the value is set to the complete datapoint name e.g. "_1_SNMPAgent_5".

[snmpdrv] allowAgentPort162

Type
bool
Default
0
Range
0|1
For trap-only connections the TCP port 162 is handled in a special way. To switch off this special behavior and use this port for normal SNMP connections set the config entry allowAgentPort162 to 1. Note Setting this config entry to 1 is only allowed if the SNMP driver does not use trap-only connections.

[snmpdrv] arrayQueryErrorHandlingMode

Type
bool
Default
0
Bool flag for defining if the driver should write the result array requests despite single errors. For substituting the error values the config entries starting with "arrayQueryErrorValue*" are used.

[snmpdrv] arrayQueryErrorValueInteger32

Type
int
Default
2147483647
Substitution value for integer32 transformation in case of an erroneous OID.

[snmpdrv] arrayQueryErrorValueIPadress

Type
string
Default
255.255.255.255
Substitution value for IP address transformation in case of an erroneous OID. The value must be defined in dot-decimal notation, consisting of four decimal numbers, each ranging from 0 to 255, separated by dots, e.g., "172.16.254.1".

[snmpdrv] arrayQueryErrorValueMACadress

Type
string
Default
FF:FF:FF:FF:FF:FF
Substitution value for MAC address transformation in case of an erroneous OID. The value must be defined in six groups of two hexadecimal digits, separated by colons, e.g. "74:2B:62:86:A5:CA".

[snmpdrv] arrayQueryErrorValueOctet

Type
string
Default
FFFFFFFF
Substitution value for octet transformation in case of an erroneous OID. Since the SNMP data type OCTET STRING is used to process byte arrays, the error value must be defined in hexadecimal representation as string. If the error value should be displayed as text, for example also the value "3C3C4552524F523E3E00" can be used, which represents the null-terminated text "<<ERROR>>".

[snmpdrv] arrayQueryErrorValueOID

Type
string
Default
1.0.4294967295
Substitution value for objectID transformation in case of an erroneous OID. Due to the Basic Encoding Rules, the first subidentifier must be 0, 1 or 2. The second subidentifier must be between 0 and 39 if the first subidentifier is 0 or 1. Otherwise, the only further restrictions imposed by SNMP are that there is a limit of 128 subidentifiers in an OID value, and that each subidentifier is restricted to the range 0..4294967295.

[snmpdrv] arrayQueryErrorValueUnsigned32

Type
uint
Default
4294967295
Substitution value for unsigned32 transformation in case of an erroneous OID.

[snmpdrv] arrayQueryErrorValueUnsigned64

Type
uint64
Default
18446744073709551615
Substitution value for unsigned64 transformation in case of an erroneous OID.

[snmpdrv] arrayQueryErrorValueVisibleString

Type
string
Default
<<ERROR>>
Substitution value for visible string transformation in case of an erroneous OID.

[snmpdrv] commandUserByte

Type
uint
Default
0
Range
0, 1-4
Defines if and which user byte is set for a corresponding writing result. The selected byte information is written to the first byte of the DPE Status.WriteResponse. 0 => The user byte is not set 1-4 => The corresponding user byte is set with the values of the writing results.

[snmpdrv] ctrlDPName

Type
string
Default
SNMPManager
This string specifies which string is used as a part of the manager Control datapoint. Operating states of the driver are shown via this datapoint. The name of the datapoint also contains the number of the driver. _driverNumber_ctrlDPName

[snmpdrv] delayBetweenAgents

Type
int
Default
0
Range
>=0
Defines the time interval between the queries to the grouped agents in milliseconds. The default value 0 means that the queries within a poll group are sorted and also executed in this ordered. If a value >=0 is set, the changed agents will be grouped and queried after the defined time interval. If an agent is not accessible, it may happen that the other agents can not be queried. If a request to an agent answers with a timeout, all requests of this agent will be deleted (if the option "set to invalid" is enabled, the deleted requests will be set to invalid). This is only done when the config entry "delayBetweenAgents" is set. In the next poll cycle the driver will again attempt to establish a connection to this.

[snmpdrv] doGQOnStart

Type
string
Default
Yes
Range
Yes|No
This parameter specifies that all parameterized SNMP objects are queried when the driver is started. (Default) This option can cause a selective overload of the network since all parameterized objects are queried. If a general query should not be executed set the entry to "No". In order to avoid a too high network load when doGQOnStart = "Yes" is used, it is also possible to execute general queries on single agents via the internal datapoint _Driver<Nr>.GQ:_original.._value. Thus, enter the number of the agent on _Driver<Nr>.GQ:_original.._value.

[snmpdrv] enableTraps

Type
string
Default
Yes
Range
Yes|No
If the SNMP manager should receive traps, this entry should be set to "Yes". If you do not want to receive traps, set the entry to "No". The received traps are shown in the manager datapoint.

[snmpdrv] enableTrapsFromStandbyAgent

Type
bool
Default
0
Range
0|1
Traps are only received from the current agent by default. If traps are received from the standby agent, the traps are discarded. If the traps should not be discarded, set the config entry "enableTrapsFromStandbyAgent = 1".

[snmpdrv] ignoreGQTrapErrors

Type
string
Default
No
Range
Yes|No
If a general query is performed OIDs, which exist only as traps and no as OID objects, and those are spontaneous addresses, this config entry prevents that invalid bit is set to the specific DPE.

[snmpdrv] mapInvalidData

Type
string
Default
Yes
Range
Yes|No
If this config entry is set to 'Yes', the invalid bit is set for DPEs with an input address when the connection to the corresponding SNMP agent is lost or if the read OID does not exist in the agent.

[snmpdrv] maxAgents

Type
uint
Default
255
Range
>=0
Number of the possible configurable SNMP Agents. Per default the limitation is 255 SNMP Agents.

[snmpdrv] maxNumOfVbsInBulkQuery

Type
uint
Default
1000
Range
>=0
Usually a device returns a "endOfMIBView" at the last SNMP address (OID) of a bulk query  which will cancel the query.  If this may not be the case for some reason, the driver will restart at the beginning of the list and is stuck in an infinite loop. In order to avoid this, the query will be canceled when the first already received result is repeated. For additional security measures, a limited number of results can be set with this config entry. When the given number is hit, the query will be canceled.

[snmpdrv] maxTrapsBufferSize

Type
uint
Default
30000
Range
>=0
Defines the buffer size to buffer traps which could not be sent due to an overload (limited with maxTrapsPerSecond).

[snmpdrv] maxTrapsPerSecond

Type
uint
Default
50
Range
>= 0
Defines the maximum number of traps, which are sent per second. If the value was set to <=0 a warning will be written to the log. In case of an overload, the traps are buffered. The buffer size is defined in the config entry maxTrapsBufferSize.

[snmpdrv] numberOfAgentsWithDelay

Type
uint
Default
1
Range
0 - 500
If  "delayBetweenAgents" is set to >=0 several agents can communicate at the same time. This config entry defines the number of the agents.

[snmpdrv] onlyActivePolls

Type
string
Default
No
Range
Yes|No
If onlyActivePolls is set to "Yes", only the active driver polls in a redundant system. "No" means that both drivers poll the agent.

[snmpdrv] reportHomelessTraps

Type
int
Default
0
Range
0..2
Defines if the information for homeless traps shall be written to the internal data point (see Trap.HomelessTrap). 0 => Information will be written to the LogViewer. 1 => Information will be written to the LogViewer and to the internal data point. 2 => Information will be written to the LogViewer and to the internal data point but only if at least one payload OID could not be matched to a peripheral address.

[snmpdrv] setTimeoutOnV3USMerrors

Type
string
Default
no
If setTimeoutOnV3USMerrors = "yes" and a state timeout was set for an SNMPv3 agent, USM error have an impact on the state of the timeout. "yes" - in case of a USM error, the DPE Status.Timeout will be set to TRUE. "no" - the DPE Status.Timeout will never be set to TRUE in case of a USM error.

[snmpdrv] snmpDir

Type
string
Default
/<Projektverzeichnis>/data
For SNMPv3 the SNMP entity needs a boot counter. This is located in the "snmpv3_boot_counter" file. Per default the Pmon writes this file into the /data directory from the project directory. If the user has no write access at this directory, so another directory can be set via this config entry.

[snmpdrv] trapPayloadOctetStringHex

Type
bool
Default
0
Range
0|1
With this entry set to 1, trap payload data of type octet string are written as HEX-string to the internal DPE _SNMPManager.Trap.PayloadValue. This allows also the handling of octet strings containing non-printable characters.

[snmpdrv] trapReceptionPort

Type
int
Default
162
You can set the trap port for the SNMP driver. Port numbers < 1024 cannot be used under Linux.

[snmpdrv] useExtendedEngineID

Type
string
Default
N
Range
Y|N
Defines whether the internal EngineID of the SNMP agent will be extended with the regarding host and port information.

[snmpdrv] v3agentDPTemplate

Type
string
Default
_SNMPV3Entity
In order to initialize all datapoint elements a template datapoint is queried at the start of the driver. Its leaves are then available for all datapoints. If an element of this template datapoint is missing, it is not available on the registered agent datapoints! As template datapoint also a "normal" datapoint that is used anyway can be used. In this case the value is set to the complete DP name e.g. _1_SNMPV3Entity_5.

[snmpdrv] v3entityDPName

Type
string
Default
SNMPV3Entity

[snmpdrv] writeToStandbyAgent

Type
bool
Default
0
Range
0|1
The WinCC OA SNMP driver sends the write request only to the active agent. If the driver also should write to the standby agent, you can set the config entry "writeToStandbyAgent = 1".