NAME

snmpsetup − Select which Simple Network Management Protocol (SNMP) agent to run and perform initial set up of the POLYCENTER Common Agent

SYNOPSIS

/usr/sbin/snmpsetup

DESCRIPTION

DEC OSF/1 provides two implementations of the SNMP agent, as follows:

       •The default SNMP agent is provided by the snmpd daemon. 

       •The POLYCENTER Common Agent is contained in the optional subset OSFCOMAGENT300. 

You can run only one SNMP agent on your system.  The default SNMP agent is started at boot time, unless you have installed and set up the POLYCENTER Common Agent. 

You configure the snmpd daemon by editing the /etc/snmpd.conf file.  (For more information on configuring the snmpd daemon, see the snmpd reference page.) 

To use the POLYCENTER Common Agent, you must install the OSFCOMAGENT300 subset and configure the Common Agent using the snmpsetup script.  The snmpsetup command is only available if you have installed the OSFCOMAGENT300 subset. 

The snmpsetup command invokes an interactive script that you can use to configure the POLYCENTER Common Agent, or to start the snmpd daemon.  You can run the snmpsetup command while in multiuser mode, but you must be logged in as root or superuser. 

The snmpsetup script first displays the current configuration information and prompts you to select an agent.  If you select the default snmpd agent, the script prompts you to start SNMP, then exits. 

If you select the POLYCENTER Common Agent, the script prompts you for configuration information and starts the POLYCENTER Common Agent. 

Note

You must run the POLYCENTER Common Agent to use the POLYCENTER Common Agent Developer’s Toolkit.

Configuring the POLYCENTER Common Agent

Before you invoke the snmpsetup command, you must know the Internet Protocol (IP) address of each Network Management Station (NMS) that you want to have monitor or manage your system. 

The snmpsetup script prompts you for each item, usually providing a default value which you select by pressing Return without entering a value.  Enter each value in the format specified.  Spaces between words are permitted only when entering the name of the system administrator and the system location.  Enter all IP addresses in dot notation (for example, 1.2.3.4). 

The following configuration files are affected by the snmpsetup script:

/etc/eca/snmp_pe.conf

/etc/eca/internet_mom.conf

The contents of the configuration files are overwritten upon successful completion of the snmpsetup script without regard to their original contents.  The original files are renamed to <filename>.sav. 

Changes made to the configuration files only take effect after the Common Agent has been stopped and restarted. 

Digital recommends that you use the snmpsetup script for only the initial setup of the configuration files.  Use a text editor to add to or modify the configuration files if you want to preserve existing entries. 

The SNMP Configuration File

The snmp_pe.conf  file contains information used by the SNMP protocol engine component of the POLYCENTER Common Agent.  It defines which communities are permitted access to the agent system, and which communities should receive SNMP traps that are generated by the agent.  In addition, to disable the sending of authenticationFailure traps you can specify the no_auth_trap directive in the snmp_pe.conf file. 

The directives specified in the snmp_pe.conf file are not order-dependent.  The following is a sample of the initial version of this file:

#
# snmp_pe.conf
# SNMP Network Management Agent Configuration File
# for POLYCENTER Common Agent
#
community       PUBLIC   0.0.0.0      readonly

The following list describes each file directive:

community name IP-address community-type
The community directive describes an SNMP community for the agent. 

nameA string that describes the name of the community. 

IP-address
The dot-notation Internet Protocol (IP) address for a  Network Management Station (NMS). If you specify 0.0.0.0 in the IP-address field, the snmp_pe process honors requests from any having the name community. 

community-type
The community-type parameter can be one of the following:

readonly
Permits monitoring of variables.

readwrite
Permits both monitoring and setting of variables.

writeonly
Permits setting of variables.

noneDoes not permit access to any variables. 

trap name IP-address
The trap directive describes an SNMP community to which traps are sent. 

nameA string that describes the name of the trap community. 

IP-address
The dot-notation Internet Protocol (IP) address of the NMS to receive traps generated by the Common Agent.

no_auth_traps
The no_auth_traps directive specifies that no
authenticationFailure traps are to be sent to any of the trap communities. 

If this directive is not specified, the snmp_pe process issues authenticationFailure traps to all trap communities. 

Internet MOM Configuration File

The internet_mom.conf configuration file contains the values for the variables sysLocation and sysContact MIB-II System Group.  The initial values for sysLocation and sysContact are Unknown  The file also contains the default value for the Link Polling Interval used by the Common Agent to check the operational status of each TCP/IP network interface for generating the linkUp and linkDown traps (see Common Agent Trap Support).  The initial value of the polling interval is 60 seconds. 

The values in this file are order-dependent and are required.  The initial version of this file is as follows:

#
# This is the configuration file for the TCP/IP MOM.
# A "#" in the first line indicates a comment.
# A line should not be greater than 1023 characters.
# The first line should contain information about the
# location of the system.
# The second line should contain information about the
# contact person for the system.
# The third line should contain the default Link Polling
# Interval value used internally by the Internet MOM (in seconds).
#
Unknown
Unknown
60

Common Agent Components

The basic run-time components of the Common Agent consist of the mold process, the internet_mom process, the fddi_mom process, the trn_mom process, and the snmp_pe process:

       •The mold process provides the registration facility that relates managed object classes to the Managed Object Module (MOMs) that support the classes, and also acts as a MOM lookup service for the Common Agent components. 

       •The fddi_mom process is the MOM component of the POLYCENTER Common Agent that provides access to the FDDI MIB managed objects as defined by FDDI Management Information Base (RFC 1285). 

       •The trn_mom process is the MOM component of the POLYCENTER Common Agent that provides access to the managed objects as defined by IEEE Token 802.5 Ring MIB (RFC 1231). 

       •The internet_mom process is the MOM component of the POLYCENTER Common Agent that provides access to the Internet MIB-II objects specified by Management Information Base for Network Management of TCP/IP-based Internets: MIB II (RFC 1213). 

       •The snmp_pe process is the SNMP protocol engine component that handles incoming SNMP management requests (on SNMP port 161) and sends SNMP management responses.  When the snmp_pe daemon process receives an SNMP message from a Network Management System (NMS), the snmp_pe process performs SNMP operations on the message and returns a valid response to the NMS. 

Common Agent Extensibility

The POLYCENTER Common Agent is extensible; using the optional Developer’s Toolkit layered product, you can add Managed Object Modules for managing objects other than those managed by the internet_mom process, the fddi_mom process, and the trn_mom process. 

The Developer’s Toolkit consists primarily of the momgen utility, template source files, and example MOMs.  The momgen utility produces ANSI C source code modules that you can customize for your particular application.  See the POLYCENTER Managed Object Module Developer’s Guide and the momgen(8) reference page (both supplied with the Common Agent Developer’s Toolkit) for information on how to generate your own MOM. 

The Common Agent may be reconfigured to support additional MOMs and their defined MIBs by performing these steps as superuser:

     1.Stop the Common Agent by executing the following command:

# /sbin/init.d/common_agent stop

     2.Copy the MOM executable to the /usr/sbin directory and set the protection mode to 755. 

     3.Modify the /sbin/init.d/common_agent startup and shutdown script by updating the variable USER_MOMS to include the MOM executable path name. 

     4.Update the Management Information Repository (MIR) with the new MIB. For example:

# cp /usr/var/opt/ECO110/mir.dat /usr/var/opt/ECO110/mir.dat1
# mirc -b/usr/var/opt/ECO110/mir.dat1 \
-o/usr/var/opt/ECO110/mir.dat <new-mib>
# chmod 644 /usr/var/opt/ECO110/mir.dat

     5.Restart the common agent, as follows:

# /sbin/init.d/common_agent start

     6.Load the MIB in the databases of the NMSs that will be used to manage the object. 

Common Agent Trap Support

The Common Agent supports the following types of traps:

       •coldStart

       •warmStart

       •authenticationFailure

       •linkUp

       •linkDown

       •enterpriseSpecific

The snmp_pe process sends traps to all communities identified with the trap directive in the snmp_pe.conf configuration file (see the FILES section).  Enterprise-specific traps are posted to the snmp_pe process by the momgen-generated MOMs, and the linkUp and
linkDown generic traps are posted to the snmp_pe process by the internet_mom process.  The snmp_pe process distributes the traps to all trap listeners. 

A coldStart trap is generated when the snmp_pe process is originally started after the initial installation of the operating system, once for each subsequent reboot of the system, and possibly once for each subsequent upgrade of the operating system. 

A warmStart trap is generated whenever the snmp_pe process is restarted, except for the reasons stated above for coldStart conditions. 

An authenticationFailure trap is generated by the snmp_pe process when an attempt to use a community fails.  An attempt will fail when an unauthorized client tries to use snmp_pe, or if the requested community is used in a way that the community type does not allow. 

By default, the snmp_pe process generates
authenticationFailure traps as long as one or more trap communities are specified using the trap directive in the snmp_pe.conf configuration file.  If the following directive is specified in the snmp_pe.conf file, authenticationFailure traps are not generated:

no_auth_traps

A linkUp or linkDown trap is generated by the internet_mom process for each TCP/IP interface on the resident system whenever the internet_mom process is restarted, and whenever the link-up or link-down condition is detected by the internet_mom process.  You can configure the Link Trap Polling Interval (see the Internet MOM Configuration File section). 

Common Agent Process Startup Order

A script to automatically stop or start the Common Agent processes is provided with the Common Agent.  The syntax of the script is as follows: /sbin/init.d/common_agent {start|stop} Digital recommends that you use the common_agent script to start and stop the Common Agent processes whenever necessary.  New entries should be added to stop and start new MOMs, or existing entries should be removed for MOMs that are no longer used.  When starting the Common Agent processes, you must always start the mold process first. 

Some of the variables in the IP routing table and the EGP group are obtained from the gated daemon, if it is running on the system.  If the gated daemon is not running prior to starting the Common Agent processes, the default values are used for these variables. 

RESTRICTIONS

The egpNeighborLoss trap is not supported. 

EXAMPLES

The following is an example of an snmp_pe.conf file:

#
# snmp_pe.conf
# SNMP Network Management Agent Configuration File
# POLYCENTER Common Agent
#
#
#  Describe who can use your SNMP process by
#  defining "communities".    USAGE:
#
#  community <name> <IP address> <community-type>
#
#  This is limited-use community; a finite number of
#  hosts can use it.  This community can only be queried.
#
community org1129.40.11.200   readonly
community org1129.40.11.201   readonly
#
#  This is a wide-open, general-use community.  Specifying
#  0.0.0.0 means that any address can use this community only
#  to monitor variables.
#
community public 0.0.0.0 readonly
#
#  This is the management community.  Variables can be set
#  as well as monitored.  It is a wide-open community as well.
#
community manage 0.0.0.0 readwrite
#
#  These are trap community definitions.  Traps are sent to these
#  addresses all from the same community name.
#
trap   trap1   129.40.11.200
trap   trap1   129.40.11.201

In this example, note the following:

       •The org1 Community can be monitored by either 129.40.11.200 or 129.40.11.201. 

       •The public Community can be monitored by any Network Management Station. 

       •The manage Community can be monitored and managed by any Network Management Station. 

       •When a trap is generated, it is sent to the trap1 community at 129.40.11.200 and 129.40.11.201. 

       •In this example the no_auth_traps directive was not specified, meaning that all trap communities receive
authenticationFailure traps. 

FILES

/etc/eca/snmp_pe.conf
The POLYCENTER Common Agent SNMP protocol engine configuration file.

/etc/eca/internet_mom.conf
The POLYCENTER Common Agent Internet MOM configuration file.

/sbin/init.d/common_agent
The POLYCENTER Common Agent startup and shutdown script.

RELATED INFORMATION

Commands: mirc(8), momgen(8), mtu(8)

Daemons: fddi_mom(8), gated(8), internet_mom(8), mold(8), snmpd(8), snmp_pe(8), trn_mom(8)

Network Configuration

Management Information Base for Network Management of TCP/IP-based Internets: MIB II (RFC 1213)

A Simple Network Management Protocol (RFC 1157)

POLYCENTER Common Agent Managed Object Module Developer’s Guide

POLYCENTER Common Agent Managed Object Module Developer’s Reference