IBM HTTP Server help: SNMP

SNMP

The SNMP module is an extension with which the status of the Apache HTTP Server can be retrieved via the Simple Network Management Protocol (SNMP). SNMP is a well-known management framework for the Internet allowing hardware (such as routers, bridges and modems) and software (such as operating systems, network layers and applications) to provide status via a Management Information Base (MIB). The MIB represents a collection of managed objects of remote devices that are accessible via SNMP-agents. Managers can query an agent for the values of objects managed by the agent.

The IBM HTTP Server supports the following MIBs:

MIB Description
SNMPv2-MIB A mandatory MIB for every SNMP agent. The MIB was defined by the SNMPv2 Working Group.
WWW-MIB A MIB defined for the management of WWW Services. The MIB is defined within the SYSAPPL MIB working group of the IETF.
APACHE-MIB A specific MIB for the Apache HTTP Server.

To enable SNMP, modify the IBM HTTP Server configuration file (httpd.conf) using the following SNMP directives:

To enable SNMP access for apScoreBoardGroup MIB's, add or modify the the following directives:

LoadModule directive for SNMP

You must have the SNMP Module loaded through the LoadModule directive in order to Enable SNMP.

For Windows NT:
Syntax:LoadModule snmp_agt_module modules/IBMModuleSNMP.dll

For unix:
Syntax:LoadModule snmp_agt_module libexec/mod_snmp.so

The corresponding AddModule is: AddModule mod_snmp.c

SNMPenable

Syntax:SNMPenable

The absence of SNMPenable is to cause SNMP to be disabled.

<SNMP>

Syntax:<SNMP number>...</SNMP>
Module: snmp_agt_module

The number sets the network port on which the SNMP agent listens. Number is a number from 0 to 65635; some port numbers (especially below 1024) are reserved for particular protocols. See /etc/services for a list of some defined ports; the standard port for the SNMP protocol is 161.

Port 161 is one of Unix's special ports. All ports numbered below 1024 are reserved for system use, i.e. regular (non-root) users cannot make use of them; instead they can only use higher port numbers. To use port 161, you must start the server from the root account.

If you cannot use port 161, choose any other unused port. Non-root users will have to choose a port number higher than 1023, such as 8000.

Example:

See also SNMPcommunity, sysDescr, sysContact and sysLocation.

SNMPcommunity

Syntax: SNMPcommunity string
Default: community public
Module: snmp_agt_module

The community is used to define communities with which the SNMP agent is accessible. In SNMP version 1 and version 2C the community is used for 'security'. Only valid communities have access to the information from the SNMP agent.

The most common known community is 'public'. A lot of people use this, but is not required. If there is no community given, the default community will be used. The string length of Community Name maybe at most 64 characters.

SECURITY: If you do not want the information from the SNMP agent available for others you must use well-known names or words from the dictionary.

Example:

sysDescr

Syntax: sysDescr string
Default:compiled in default reflecting the various version/protocol flags and other details.
Module: snmp_agt_module

The sysDescr directive is used to define the system description of the host on which the SNMP agent (thus server) is running that is used for the sysDescr object instance of SNMPv2-MIB (also known as part of MIB-II).

The definition says:

Example:

See also sysContact and sysLocation.

sysContact

Syntax: sysContact string
Module: snmp_agt_module

The sysContact directive is used to define the contact address for the system that is used for the sysContact object instance of SNMPv2-MIB (also known as part of MIB-II).

The definition says:

Example:

See also sysDescr, and sysLocation.

sysLocation

Syntax: sysLocation string
Module: snmp_agt_module

The sysLocation directive is used to define the location of the host on which the SNMP agent (thus the server) is running and is used for the sysLocation object instance of the SNMPv2-MIB (also known as part of MIB-II).

The definition says:

Example:

See also sysDescr and sysContact.

LoadModule directive for Status Module

You must have the Status Module loaded through the LoadModule directive for apScoreBoardGroup MIB's.

For Windows NT:
Syntax:LoadModule status_module modules/ApacheModuleStatus.dll

For unix:
Syntax:LoadModule status_module libexec/mod_status.so

The corresponding AddModule is: AddModule mod_status.c

ExtendedStatus

Syntax:<ExtendedStatus On>
Module: mod_status

The absence of ExtendedStatus will prevent any sucessful request for apScoreBoardGroup data.

<LocationMatch server-status>

Syntax:<LocationMatch server-status>...</LocationMatch>
Module: mod_status

Example: