The following sections describe the configuration files accessed by the BEA SNMP Agent Integrator and the BEA SNMP agents:
At startup, the BEA SNMP Agent Integrator (
snmp_integrator) and the BEA SNMP agent (
tux_snmpd) read the absolute pathname specified by the
BEA_SM_BEAMGR_CONF environment variable to locate the
beamgr.conf configuration file on the host system. The BEA SNMP Agent Integrator and agents read certain configurations in the
BEA_SM_BEAMGR_CONF environment variable is not set, the BEA SNMP Agent Integrator and agents look for
beamgr.conf at the following default location:
If the BEA SNMP Agent Integrator and agents cannot find the
beamgr.conf file on the host system, they will print an error message and not start. The
beamgr.conf file is a mandatory configuration file.
beamgr.conf configuration file contains information used by the BEA SNMP Agent Integrator and the BEA SNMP agents. A configuration entry in the file consist of two or more blank or tab-separated fields:
If an entry is too long, you can use the backslash (\) character as a continuation character at the end of the line. There should be a newline character immediately following the \ character.
The following keywords have corresponding MIB objects:
Host name, port number, and community name necessary to send SNMP traps.
The name of the target destination machine for the trap notification. The default is the local host.
You can have multiple
TRAP_HOST entries in the configuration file if you need to send traps to multiple destinations.
TRAP_HOST entry is used by the BEA SNMP Agent Integrator and the SNMP agents to determine trap destinations when they generate SNMP trap notifications.
Contains a value that indicates whether the SNMP agent is permitted to generate authentication-failure traps. If the value is 1, the SNMP agent generates authentication-failure traps when an invalid request (according to the community profile) is received. If the value is not 1, no authentication-failure trap is generated.
The OID is a unique number assigned to each object in the MIB as an object identifier. OIDs fall into specific categories or classes. When the SNMP agent accesses a specific object, it traverses the OID tree in the MIB file to find the object. An OID identifies an object by specifying a unique path to the object from the root of the OID tree.
Sets the BEA SNMP Agent Integrator timeout in waiting for responses to requests. The default timeout is 30 seconds.You can set the BEA SNMP Agent Integrator timeout by adding an
INTEGRATOR_TIMEOUT entry as follows:
BEA_PEER MAX_WAIT 30
Sets the maximum number of times the BEA SNMP Agent Integrator permits requests to an SNMP peer or SMUX subagent to time out before disregarding any further requests for that agent or subagent. The default is 3.
Specifies the OIDs supported by an SNMP agent when it is running as a peer of the BEA SNMP Agent Integrator. For more information, see NON_SMUX_PEER Entry.
Specifies an BEA SNMP Agent Integrator polling rule. This allows threshold-checking to be offloaded from the network management system to the distributed integrator agents on managed nodes. For more information, see RULE_ACTION Entry.
Defines the BEA Tuxedo domain that an agent is to monitor. There must be one
TMAGENT entry for each Tuxedo SNMP agent on a managed node. The format of the entry is as follows:
logical_agent_name tuxdir tuxconfig_path
Monitoring of multiple domains is performed by running a separate Tuxedo agent for each domain being monitored. These agents must be run as SMUX subagents under the BEA SNMP Agent Integrator.
When there are multiple Tuxedo SNMP agents running as SMUX subagents on a managed node, the logical agent name must be used to modify the community in Set or Get requests. The community must be of the following form:
The community does not need to be qualified with the logical agent name when there is only one Tuxedo SNMP agent running on the managed node.
Defines a subset of BEA Tuxedo event notifications that are to be forwarded as SNMP trap notifications. By default, if no filter is provided, BEA SNMP Agent forwards all Tuxedo events as SNMP traps. The format of the entry is:
Note that the strings used for each of the parameters must not have blanks or white space.
A string that must be unique among all
TMEVENT_FILTER entries in the BEA SNMP Agent configuration file. The maximum length of the string is 16 characters.
Maps the event filter to a particular agent on that node. A logical agent name is a string up to 32 characters long. The logical agent name is the name given to the Windows service on a Windows system that starts the agent, or the name specified in the
-l option when starting the agent from the command line on a UNIX system.
A Tuxedo event name expression. This string can be a maximum of 255 characters long. For information about event name expressions, which are regular expressions, see reference page tpsubscribe(3c) in BEA Tuxedo ATMI C Function Reference.
This name must match a Tuxedo event name for that event to be forwarded as an SNMP trap. For a list of event names, see reference page EVENTS(5) in BEA Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
The default is
all events. If
NONE is used, no events are forwarded and the other parameters in the
TMEVENT_FILTER entry can be omitted. An entry of
NONE overrides all other event filter entries for the same logical agent name. For example:
An entry of
matches all events.
An entry of
matches all system events related to servers.
An event filter expression. This string can be a maximum of 255 characters long. Each Tuxedo event is accompanied by an FML buffer that contains pertinent information about the event. The buffer is evaluated with respect to this filter if the filter is present. If the buffer content is evaluated to
TRUE, the event is forwarded; otherwise the event is not forwarded. BEA SNMP Agent uses this filter as an argument for a call to
tpsubscribe(). For more information, see reference page tpsubscribe(3c) in BEA Tuxedo ATMI C Function Reference.
Can be either
inactive. If the status is
active, the filter is being used; otherwise the filter is not being used.
There is a MIB table that corresponds to the
TMEVENT_FILTER entries in the BEA SNMP Agent configuration file. These entries can be updated dynamically using an SNMP Set request. For more information, see the
beaEvtFilterTable object in in BEA Tuxedo SNMP Agent MIB Reference.
To configure the BEA SNMP Agent Integrator to access MIB objects through a peer SNMP agent (for example, a non-SMUX master agent or a non-SMUX peer agent), add the
NON_SMUX_PEER entry to the
beamgr.conf file in the following format:
The keyword for the entry.
Specifies the UDP port number on which the SNMP agent is listening. This value may be specified in either of the following forms:
when the SNMP agent is remote from the BEA SNMP Agent Integrator. If
Specifies the community to be used by the BEA SNMP Agent Integrator when the SNMP agent is polled. The special value * is used to specify that the BEA SNMP Agent Integrator should use the community supplied by the SNMP manager.
Specifies the OID of the root of the MIB tree that is supported by this SNMP agent.
Specifies whether this OID tree is being exported as read-only or as read-write. The default is
A positive number that specifies the priority at which the OID tree is being exported. The lower the number, the higher the priority. If there are multiple agents/subagents supporting the same MIB tree, the subagent with the highest priority is consulted. Multiple SNMP agents and SMUX subagents can register the same subtree; however, they must do so at different priorities.
If an SNMP agent tries to register a subtree at a priority that is already taken, the BEA SNMP Agent Integrator repeatedly increments the integer value (lowering the priority) until an unused priority is found. A special priority
-1, causes the selection of the highest available priority. When a request is made to register with priority
-1, registration is made at the highest available number below 20. If the priority field is missing, the MIB tree is exported at a
Specifies the time interval in seconds for which the BEA SNMP Agent Integrator waits for the replies from this SNMP agent for the particular MIB group. The default value is three seconds. This default can be changed by setting the
BEA_PEER_MAX_WAIT environment variable to a different value.
The access (
timeout fields are optional. However, you must specify access and
priority if you need to specify
timeout, and you must specify access if you need to specify
priority for a MIB tree.
You can list multiple OID nodes.
Note that a subtree registration hides the registrations by other SNMP agents/subagents of objects within the subtree. So, if an agent A registers subtree
.18.104.22.168.4.1.140 and another agent/subagent, B, registers subtree
.22.214.171.124.126.96.36.199, agent/subagent A is consulted for all the objects under the
Also, when the BEA SNMP Agent Integrator reads this entry, an SNMP agent should be running on the specified port. Otherwise, the BEA SNMP Agent Integrator disregards this entry. Also, if three consecutive requests to this SNMP agent time out, it is assumed that the SNMP agent specified by this entry is no longer alive and this entry is disregarded.
At any point, the command
reinit_agent snmp_integrator can be invoked to force the BEA SNMP Agent Integrator to re-read its configuration file.
The BEA SNMP Agent Integrator disallows/disregards any attempt to register above, at, or below the SNMP (
mib2.snmp) and SMUX subtrees of the MIB.
The following examples are provided to illustrate the use of the
The first entry tells the BEA SNMP Agent Integrator to look for an SNMP agent at port 2001. All the requests from BEA SNMP Agent Integrator to this SNMP agent use
snmp as the community. The agent supports the subtree
.188.8.131.52.2.1.1, and is available for read-only commands.
The second entry tells the BEA SNMP Agent Integrator to look for an SNMP agent at port 2002. All the requests from BEA SNMP Agent Integrator to this SNMP agent use
squid as the community. The agent supports the subtrees
.184.108.40.206.4.1.145. Since no access option is specified, both subtrees default to
The third entry specifies a non-SMUX agent at port 2008 with a community of *. The * tells the BEA SNMP Agent Integrator to pass along the same community information it receives from the SNMP manager. For example, if the SNMP manager sends the community
nevus, the BEA SNMP Agent Integrator sends
nevus along to the subagent. (Of course,
nevus must be a valid community for the BEA SNMP Agent Integrator in the first place.)
The fourth entry lists an agent at port 2005 with a community of *. The agent supports two subtrees:
.220.127.116.11.4.1.145. Since the first subtree lists no access information, access defaults to
rw. The second subtree specifically lists
rw. This means exactly the same thing; the
rw could have been left off with no effect.
rw is redundant, then why have it at all? Because each OID node can have three arguments: access (
timeout. If you specify any of these arguments, you must also specify all the arguments that come before it. For example, if you specify priority, you must also specify access. If you specify timeout, you must specify both access and priority.
rw, a priority of
-1, and a timeout of two seconds; the second has an access of
rw,a priority of
-1, and a timeout of ten seconds. Although
-1are the defaults for access and priority, these values must be stated explicitly in order to include a timeout value.
The timeout values are the maximum amount of time the BEA SNMP Agent Integrator waits for a response from the SNMP agent for a given object. In this case, two seconds for a response if the object falls under MIB tree
.18.104.22.168.2.1.1, and ten seconds for a response if the object falls under the
.22.214.171.124.2.1.2 MIB group. The default value is three seconds. This default value can be changed by setting the environment variable
.126.96.36.199.2.1.1.The agent at port 2009 has a higher priority (5 is a higher priority than 8), so that is the one the BEA SNMP Agent Integrator calls. Notice that this entry specifies
rwaccess. The other entry specifies
roaccess, but since it has a lower priority, it is completely ignored. As far as the BEA SNMP Agent Integrator is concerned, the only agent supporting
.188.8.131.52.2.1.1is at port 2009.
The default is
-1 if a priority is not specified. The BEA SNMP Agent Integrator reads through the file sequentially. When it comes to an object with a
-1 priority, it tries to assign it a priority of 20. If 20 has already been assigned to that MIB group (in another entry), it tries to assign 19. It keeps trying each successive lower number until it finds one that is not taken, or until it reaches 0, in which case an error message appears.
.184.108.40.206.2.1.1and the first entry is ignored. As before, the access is
rw, since the entry specifying
roaccess is ignored.
.220.127.116.11.2.1.11is a special case, called
mib2.snmp. This MIB group is always handled by the BEA SNMP Agent Integrator itself, and should not be exported by any agent or subagent. Any registration at, above, or below this MIB tree is not permitted. For example, none of the following entries is permitted:
|Note:||To continue an entry on another line, use a backslash. Make sure that there are no characters (other than the carriage return) immediately following the backslash.|
This entry is used by the SMUX subagents. Normally, these SMUX subagents register all the MIB groups they know about with the SMUX master agent. But you can limit the MIB groups exported by the SMUX subagents. To do so, you need to add an
OID_CLASS entry to
beamgr.conf in the following format:
The keyword for the entry.
Specifies the name of the SMUX subagent for which this entry is applicable.
Specifies the OID of the tree that is supported by this SMUX subagent.
Specifies whether this OID tree is being exported as read-only or as read-write. The default is rw.
A positive number that specifies the sequence in which the OID tree is being exported. The lower the number, the higher the priority. If there are multiple subagents supporting the same MIB tree, the subagent with the highest priority is consulted. If the priority field is missing, the MIB tree is exported at the highest available priority. This entry is mainly used to limit the OID subtrees being exported by the BEA SNMP Agent Integrator SMUX subagents. If this entry is not present, the SMUX subagent exports all the MIB groups it knows about.
Multiple OID nodes can be listed.
The BEA SNMP Agent Integrator can be configured to manage locally on the managed node and inform the SNMP manager selectively to reduce polling traffic generated by the SNMP manager. The user can define rules in terms of MIB objects available locally using a C-like "IF" syntax, and accordingly send SNMP traps or execute commands locally (or both). The MIB object can be the one supported by the BEA SNMP Agent Integrator itself or the one supported by one of its SNMP agents or SMUX subagents. For a discussion of
RULE_ACTION entries, with examples, see Using the BEA SNMP Agent Integrator for Polling.
The configuration is done in the
beamgr.conf file. Syntax of the entry looks like the following:
|Note:||The whole entry should appear on the same line, else the backslash (
A keyword to identify this entry.
A unique identifier for each
RULE_ACTION entry that is passed as a command-line argument to any commands specified as actions in the rule. This identifier can be a maximum of eight characters long.
The polling frequency (in seconds) at which the
snmp_integrator should check the condition.
Each left-hand side of a condition should have this keyword, which should be followed by the object identifier (within parentheses) of the MIB object. Each rule can contain a maximum of ten
An object identifier (OID). The OID must be specified only in numeric form and can be in one of the following formats:
.18.104.22.168.22.214.171.124.0. Note that the trailing zero in this example is the instance index.
Columnar objects are used to represent a column of a tabular MIB group. Columnar objects, accordingly, can have multiple instances. The last number in an OID is used to specify the particular instance. A specific number can be used to specify a particular instance or the asterisk (*) wildcard can be used to specify all instances. Zero is used as the instance index in the case of scalar objects (objects that can have only one instance). The asterisk wildcard is only used to represent all instances of a columnar object. For example:
|Note:||When you specify multiple OIDs in a complex rule, you should not combine an OID that specifies a particular instance with an OID that uses a wildcard in the same rule. Also, when you use multiple OIDs with wildcards in a single rule, all the OIDs should specify objects only within the same table.|
See the table titled Relations for Defining Conditions for a list of valid relational operators.
The RHS in a condition can be one of the following: number, string, IP address: number1.number2.number3.number4, or OID (as previously explained).
If RHS is an OID it must be enclosed in single quotes. Also, the type of value on RHS should correspond to the type of VALUE of the OID in LHS of the condition.
See the table in Use of Logical Operators in Conditions for a list of valid logical operators.
You can take two actions whenever there is a transition in the state of a rule from true (ERR) to false (OK) and false (OK) to true (ERR)—namely, execute a command and/or generate an SNMP trap. When generic OIDs (those that use an asterisk to specify all instances of a columnar object) are used to define a rule, the rule state transitions from the OK state to the ERR state if the threshold evaluates to true for any row in the table; and the rule state transitions from ERR to OK if the threshold evaluates to false for all rows in the MIB table. Initially, the rule states of all rules are set to OK when the BEA SNMP Agent Integrator starts up (or is re-initialized using the
reinit_agent command). Specify actions using the following keywords:
Indicates that an enterprise-specific SNMP trap with trapid of
number should be generated whenever there is a transition from false (OK) to true (ERR).
Indicates that an enterprise-specific SNMP trap with trapid of
number should be generated whenever there is a transition from true (ERR) to false (OK).
command should be executed whenever there is a transition from false (OK) to true (ERR).
command should be executed whenever there is a transition from true (ERR) to false (OK).
The configuration file can contain multiple domains defined by multiple
TMAGENTs. The instructions for setting up
RULE_ACTION are as follows:
TMAGENTentry defines the BEA Tuxedo domain that an agent monitors. There must be one
TMAGENTentry for a Tuxedo SNMP agent on a single managed node.
RULE_ACTIONentry is used to inform the SNMP manager of selective information gathered by the BEA SNMP Agent Integrator.
logical _agent_name, must be appended to
rule_nameif multiple Tuxedo SNMP agents are running on the same node and the rule uses any Tuxedo MIB objects.
beamgr.conf configuration file, which is mandatory, the
beamgr_snmpd.conf passwords file is an optional configuration file. Even if the BEA SNMP Agent Integrator and agents cannot find the
beamgr_snmpd.conf file on the host system, they will still run as long as they can find the
The BEA SNMP Agent Integrator and agents look for
beamgr_snmpd.conf at the following default location:
beamgr_snmpd.conf passwords file contains the SNMP community strings used as passwords in communication between agents and managers. On a UNIX system, the
beamgr_snmpd.conf passwords file is installed with access privileges for
root only. For password security, the read and write permissions for the
beamgr_snmpd.conf file should be set to permit access only by
A configuration entry in the
beamgr_snmpd.conf file consists of two or more blank or tab-separated fields:
Recognized values for
The string following this keyword specifies the read-write community for the agent. If this keyword is not present in the configuration file, the SNMP agent uses
iview as the read-write community. Entries with this keyword can be repeated more than one time to specify more than one read-write community.
The string following this keyword specifies the read-only community for the agent. If this keyword is not present in the configuration file, the SNMP agent uses
public as the read-only community. Entries with this keyword can be repeated more than one time to specify more than one read-only community.
The string following this keyword specifies the SMUX password. Any SMUX subagent that needs to register with the BEA SNMP Agent Integrator must specify this password. If this keyword is not present, the BEA SNMP Agent Integrator does not authenticate connection requests from SMUX subagents.
A SMUX subagent obtains the password at startup by reading the value specified by the
BEA_SMUX_PASSWD environment variable. If this variable is not set, the SMUX subagent does not specify a password when registering.
The possible values for this keyword are
NO being the default. If set to
YES, Set access for all SNMP agents is disabled.
If the BEA SNMP Agent Integrator and agents cannot find the
beamgr_snmpd.conf file on the host system, they will use the default values for