SNMP MIB support: IBM HTTP Server
System Administration IBM HTTP Server documentation

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.

MIB Support

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 MIBs, 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 causes the disabling of SNMP.

<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 a special UNIX port. All ports numbered below 1024 are reserved for system use. Regular (non-root) users 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:

    <SNMP 80>
    SNMPcommunity public
    sysContact Admins@email.address
    sysLocation your-place.your-country.your-earth.your-universe
    </SNMP>

See also SNMPcommunity, sysDescr, sysContact and sysLocation.

SNMPcommunity

Default: Community public
Module: snmp_agt_module
Syntax: SNMPcommunity string

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 commonly known community is 'public'. If there is no community given, the default community is used. The string length of Community Name cannot be greater than 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:

    SNMPcommunity public

sysDescr

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

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

The definition says:

    "A textual description of the entity. This value should include the full name and version identification of the system's hardware type, software operating-system, and networking software."

Example:

    sysDescr IHS HTTP/1.1 with SNMP

See also sysContact and sysLocation.

sysContact

Module: snmp_agt_module

Syntax: sysContact string

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

The definition says:

    "The textual identification of the contact person for this managed node, together with information on how to contact this person. If no contact information is known, the value is the zero-length string."

Example:

    sysContact Admins@email.address

See also sysDescr, and sysLocation.

sysLocation

Module: snmp_agt_module

Syntax: sysLocation string

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

The definition says:

    "The physical location of this node (e.g., `telephone closet, 3rd floor'). If the location is unknown, the value is the zero-length string."

Example:

    sysLocation Bottom Floor of building, room 44

See also sysDescr and sysContact.

LoadModule directive for Status Module

You must have the Status Module loaded through the LoadModule directive for apScoreBoardGroup MIBs.

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

Module: mod_status
Syntax:<ExtendedStatus On>

The absence of ExtendedStatus prevents any successful request for apScoreBoardGroup data.

<LocationMatch server-status>

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

Example:

    <LocationMatch server-status>
    SetHandler server-status
    </LocationMatch>

Related information...

     (Back to Top)