This is an universal type allowing to carry multiple other unspecified types. For example text string, date and time, physical address (MAC), array, etc. Unfortunately the data of this type do not carry the information regarding the type of contained data. In order to decypher the content it is necessary to know the MIB database.
Tip: In the Pm.TransformValue method, the support for "HexaString" is implemented.
In the driver, the content can be specified by additional information added (see the ItemId description). There are the following subtypes (in SNMP these are called "Composed syntax"):
|TCP/UDP port number||161 (standard port number for SNMP protocol)|
|Ethernet transfer type||UDP|
|SNMP Agent Receive Buffer Size||Maximum length of requested message (in bytes) that can be sent by the driver into the SNMP agent. Based on this value, the variables from one PmaCommGroup object are separated into the communication messages. |
The default value is 512.
|Version||SNMP protocol version number. |
For access in the script this entry is identified as: "snmpVer".
SNMP v1 - Basic version of the SNMP protocol. This is not secured against "tapping".
SNMP v3 - SNMP protocol version with authorization and encryption.
|Protocol parameters for SNMP version 1:|
|ReadOnly community name||Community string is a text parameter that defines so-called SNMP community where both the sender and receiver are members. This is used for implementing a simple security mechanism based on communities. |
For "ReadOnly" access the "public" community string is often used.
For access in the script this entry is identified as: "commRO".
|ReadWrite community name||See previous description of "ReadOnly community name". |
For "ReadWrite" access the "private" community string is often used.
For access in the script this entry is identified as: "commRW".
|Protocol parameters for SNMP version 3:|
With authorization, no encryption
With authorization, with encryption
|User name||Defined in SNMP agent. This name specifies the access level to the system. |
For access in the script this entry is identified as: "usrName".
|Password||Text string used for authorization with the SNMP server. Minimum length is 8 characters. |
For access in the script this entry is identified as: "psw".
|Privacy key||Text string to be used for encryption of transmitted data. Minimum length is 8 characters. |
This configurator is visible only if the security level with encryption is set.
For access in the script this entry is identified as: "privKey". If not set, then it is SNMP without encryption.
The variables in the PmaCommGroup object (or even better the variables in the PmaData object with ExtComm data extension) can be of arbitrary number, type and order. The driver uses optimalised internal communication messages for reading the data from the device.
All variables are read (if the "Data refresh enabled" configurator is checked). When writing to the variable, only the single value is sent (if the "Auto send when writing to item" configurator is checked).
ItemId is the text identifier of the item that is used for addressing the value in the device. The ItemID configurator tells the driver how to receive or send the item value. The text can be written manually, or it can be assembled in the window opened by the button to the right of the configurator. Macro expression can be used for input (it is evaluated after starting the application).
The identifier is often represented just by the OID address. These addresses can be found either in MIB database or by using the SNMP Walk type message - see further. It is possible to enter only the OID addresses that represent values with supported data types.
Optionally it is possible to use the semicolon character and then the subtype - this is used only for the OctetString type parameter - see Supported data types.
|Definite part of OID||The starting address of OID, that will be repeatedly used in multiple ItemId of the variables. If this starting address is defined, then only the second portion of the address can be entered in the ItemId of these variables.|
|0 = NoError||No errors occurred.|
|1 = TooBig||The size of the response would be too large to transport.|
|2 = NoSuchName||The name of a requested object was not found.|
|3 = BadValue||The requested SNMP operation tried to change a variable but it specified either a syntax or value error.|
|4 = ReadOnly||The requested SNMP operation tried to change a variable that was not allowed to change, according to the community profile of the variable.|
|5 = GenErr||An error other than one of those listed here occurred during the requested SNMP operation.|
|6 = NoAccess||The specified SNMP variable is not accessible.|
|7 = WrongType||Value is of type that is inconsistent with the type required for the variable.|
|8 = WrongLength||Value has a length that is inconsistent with the length required for the variable.|
|9 = WrongEncoding||Value contains an Abstract Syntax Notation One (ASN.1) encoding that is inconsistent with the ASN.1 tag of the field.|
|10 = WrongValue||Value cannot be assigned to the variable.|
|11 = NoCreation||Variable doesn't exist, and the agent cannot create it.|
|12 = InconsistentValue||Value is inconsistent with values of other managed objects.|
|13 = ResourceUnavailable||Assigning the value to the variable requires allocation of resources that are currently unavailable.|
|14 = CommitFailed||An attempt to set a particular variable failed.|
|15 = UndoFailed||An attempt to set a particular variable as part of a group of variables failed, and the attempt to then undo the setting of other variables was not successful.|
|16 = AuthorizationError||An authorization error occurred.|
|17 = NotWritable||The variable cannot be written or created.|
|18 = InconsistentName||variable doesn't exist. The agent cannot create it because the named object instance is inconsistent with the values of other managed objects.|