|
<< Click to Display Table of Contents >>
Tag Reference |
The next parameters are used for Tags:
•Device: Name of an Agent registered on the SNMP Device Config tab
•Item: Identifier of an object or OID. This parameter can also have the next formats:
•"ReadCommunity:OID": Information about a specific community for reading
•"TableOID[Row]": When using a block pointing to an OID identifier of a table, users can specify with brackets a specific row from this table to return when reading, discarding other rows found
•"WalkTable:TableOID": Instruction to retrieve all cells from an SNMP table to a single Tag
•EnterpriseOID.<suffix> = When used with Trap messages, there are four possible suffixes to extract specific metadata from the received Trap:
▪EnterpriseOID.Source: Returns the IP address of the agent that sent the Trap
▪EnterpriseOID.Generic: Returns the Generic-Trap code (generic SNMP v1 trap type: 0–6)
▪EnterpriseOID.Specific: Returns the Specific-Trap code (vendor-defined specific trap type)
▪EnterpriseOID.Timestamp: Returns the timestamp (sysUpTime) in seconds at the moment the Trap was generated
•N1: If this parameter is different from 0 (zero), this indicates that a Tag is only updated using a trap message, it does not perform a communication by polling using the scan rate defined in this Tag
•N2: Allows indicating one of the communities declared in the Read Community option of a device, using an index starting from 0 (zero) for reading. For example, when declaring in a device the communities "A;B;C" and configuring in a Tag the N2 parameter equal to 2 (two), then the "C" community is used in this Tag. This parameter is only used for reading, and the community for writing is defined in the Write Community option
Available options for Tag parameters
ParamDevice |
ParamItem |
Operation |
Description |
|---|---|---|---|
Name of an Agent, such as "router-001" |
OID, such as 1.3.6.1.2.1.37.1.2.1.1.1.0 |
Reading and writing |
Any Tag read according to the configured scan. If the N1 parameter is different from 0 (zero), this Tag is only updated when receiving a trap message with the indicated variable. The OID identifier ending with ".0" represents a scalar variable. The OID identifier specified with an index between brackets corresponds to a column of a table, with the index between brackets representing a row. In this case, a search is performed in all OIDs lexicographically found on that table's column, returning the result the same way of the WalkTable option described next |
Same as previous |
Community:OID |
Read-only |
Indicate the name of a community to be used in this reading, such as "public:1.3.6.1.2.1.37.1.1.0" |
Same as previous |
TableOID |
Read-only |
The Tag Browser window offers Table-type objects from the SNMP protocol as Block Tags, in which each Element corresponds to a column from a table. The Item parameter is configured with the OID identifier of that table. When performing a reading of a Block Tag, this Driver searches and returns all rows found on that table. Users can handle the content of each row, with the value of each one of the respective columns, using this Block Tag's OnRead event. Therefore, if this table contains 5 (five) rows, this Block Tag's OnRead event is triggered 5 (five) times |
Same as previous |
TableOID[Row] |
Read-only |
Similar to the previous item, when adding to the Item parameter of a Block Tag linked to a table an index between brackets, this reading returns only the selected row, if it exists on that table |
Same as previous |
WalkTable:OID |
Read-only |
This instruction indicates that this Driver must scan all OID identifiers lexicographically found starting with the initial OID identifier informed in the Item parameter, by using SNMP's GetNextRequest command. The result is returned in a Tag as a String composed by a sequence of "OID = value" combinations separated by semicolons, such as "1.3.6.1.2.1.37.1.2.1.33.1 = 1260; 1.3.6.1.2.1.37.1.2.1.33.2 = 'Fast Ethernet Switch'" |
Same as previous |
EnterpriseOID.Source |
Read-only |
Exclusive use with Traps (N1 ≠ 0) Returns the IP address of the agent that sent the Trap message. The EnterpriseOID refers to the organization/manufacturer identifier configured on the device. This suffix extracts metadata from the received Trap, not the variable value itself. |
Same as previous |
EnterpriseOID.Generic |
Read-only |
Exclusive use with Traps (N1 ≠ 0) Returns the SNMP v1 Generic-Trap code. Possible values: 0 = coldStart 1 = warmStart 2 = linkDown 3 = linkUp 4 = authenticationFailure 5 = egpNeighborLoss 6 = enterpriseSpecific |
Same as previous |
EnterpriseOID.Specific |
Read-only |
Exclusive use with Traps (N1 ≠ 0) Returns the manufacturer-defined Specific-Trap code. This value identifies equipment-specific event types when Generic-Trap = 6 (enterpriseSpecific). |
Same as previous |
EnterpriseOID.Timestamp |
Read-only |
Exclusive use with Traps (N1 ≠ 0) Returns the timestamp (sysUpTime) in seconds from the moment the Trap event was generated by the agent. It represents the elapsed time since the last device reboot. |
Same as previous |
ServerStatus |
Read-only |
Returns the internal status of the connection with an Agent. Possible values are 0: No communication or 1: Communicating normally |
Any name, which cannot be an empty String |
UpdateConfig |
Write-only |
Recreates all connections with each device, using the current definition of parameters, which can be changed by writing an array of parameters and values. For more information, please check topic Updating Parameters At Run Time |