Looking at the SNMP protocol, associated directives and MIB support: IBM HTTP Server
System Administration IBM HTTP Server documentation

Looking at the Simple Network Management Protocol, associated directives and Management Information Base support

This section provides information about the Simple Network Management Protocol (SNMP) module, including Management Information Base (MIB) support, the importance of the LoadModule directive, and other directive specifics with associated notes Notes:. Links to related information appear at the end of this section.

The SNMP module represents an extension with which you can retrieve the status of the IBM HTTP Server, retrieved through SNMP. SNMP provides a well-known management framework for the Internet, allowing hardware and software to provide status through a management information base (MIB). The MIB represents a collection of managed objects of remote devices accessible through SNMP agents. Managers can query an agent for the values of objects managed by the agent.

Supporting Management Information Bases

The IBM HTTP Server supports the following MIBs:

MIB Description
SNMPV2-MIB A mandatory MIB for every SNMP agent. The SNMPV2 working group defines the MIB.
WWW-MIB A MIB defined for the management of WWW Services. Define the MIB within the SYSAPPL MIB working group of the Internet Engineering Task Force (IETF).
APACHE-MIB A specific MIB for the Apache HTTP Server.

Enabling Simple Network Management Protocol

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 following directives:

Loading the LoadModule directive for Simple Network Management Protocol

You must have the SNMP module loaded through the LoadModule directive to enable SNMP.
Pertains to UNIX users

On the UNIX platform: LoadModule snmp_agt_module libexec/mod_snmp.so
Pertains to Windows NT users Pertains to Windows 2000 users

On Windows NT and Windows 2000 operating systems: LoadModule snmp_agt_module modules/IBMModuleSNMP.dll
The corresponding AddModule follows: AddModule mod_snmp.c

ExtendedStatus

You must have the ExtendedStatus directive set to On for apScoreBoardGroup MIBs. The correct syntax follows: ExtendedStatus On

Loading the LoadModule directive for Status module

You must have the Status module loaded through the LoadModule directive for apScoreBoardGroup MIBs.
Pertains to UNIX users

On the UNIX platform:
Syntax: LoadModule status_module libexec/mod_status.so

Pertains to Windows NT users Pertains to Windows 2000 users

On the Windows NT and Windows 2000 operating systems:
Syntax: LoadModule status_module modules/ApacheModuleStatus.dll

The corresponding AddModule follows: AddModule mod_status.c

<Location server-status>

Syntax: <Location server-status>...</LocationMatch> For example: 

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

Using Simple Network Management Protocol directives

Specific information for each SNMP directive follows:

SNMPenable

  • Description: Enables SNMP in the Web server.
  • Default: On when this directive is present.
  • Module: snmp_agt_module
  • Multiple instances in the configuration file: No
  • Scope: Global
  • Syntax: SNMPenable
  • Values: None

Note: The absence of SNMPenable causes the disabling of SNMP.

<SNMP>

  • Description: Specifies SNMP begin bracket and port.
  • Default: None
  • Module: snmp_agt_module
  • Multiple instances in the configuration file: No
  • Scope: SNMP
  • Syntax: <SNMP number>...</SNMP>
    where: The number sets the network port on which the SNMP agent listens.
  • Values: Number represents a number from 0 to 65635. Particular protocols reserve certain port numbers, especially those below 1024. See /etc/services for a list of defined ports; Port 161 represents the standard port for the SNMP protocol.

    Port 161 represents a special UNIX port. To use port 161, you must start the server from the root account.

    If you cannot use port 161, choose any other unused port. Nonroot users have to choose a port number higher than 1023, such as 8000. For 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

  • Description: Defines communities to access the SNMP agent.
  • Default: Community public
  • Module: snmp_agt_module
  • Multiple instances in the configuration file: No
  • Scope: SNMP
  • Syntax: SNMPcommunity string
  • Values: In SNMP Version 1 and Version 2C, use the community for security. Only valid communities have access to the information from the SNMP agent.

    Public represents the most commonly known community. Use a Community Name with a string length of less than or equal to 64 characters.

    Note: 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. For example: 

    SNMPcommunity public

sysDescr

  • Description: Defines the system description of the host on which the SNMP agent, or server runs.
  • Default: Compiled in default reflecting the various version and protocol flags and other details.
  • Module: snmp_agt_module
  • Multiple instances in a configuration file: No
  • Scope: SNMP
  • Syntax: sysDescr string

    Use this description for the sysDescr object instance of SNMPv2-MIB, also known as part of MIB-II.

  • Values: The definition says:

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

    For example: sysDescr IHS HTTP/1.1 with SNMP

    • See also sysContact and sysLocation.

sysContact

  • Description: Defines the system contact address used for the sysContact object instance of SNMPv2-MIB, also known as part of MIB-II.
  • Default: None
  • Module: snmp_agt_module
  • Multiple instances in the configuration file: No
  • Scope: SNMP
  • Syntax: sysContact string
  • Values: 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."

    For example: sysContact Admins@email.address

    See also sysDescr, and sysLocation.

sysLocation

  • Definition: Defines the location of the host on which the SNMP agent, or server runs. Use this directive for the sysLocation object instance of the SNMPv2-MIB, also known as part of MIB-II.
  • Default: None
  • Module: snmp_agt_module
  • Multiple instances in the configuration file: No
  • Scope: SNMP
  • Syntax: sysLocation string
  • Values: The definition says:

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

    For example: sysLocation Bottom Floor of building, room 44

    See also sysDescr and sysContact.

</SNMP>

  • Definition: Specifies SNMP end bracket
  • Default: None
  • Module: snmp_agt_module
  • Multiple instances in the configuration file: No
  • Scope: Global
  • Syntax: </SNMP> 
    <SNMP 80>
SNMPcommunity public
sysContact Admin@email.address
sysLocation you-place.your-country.your-earth
</SNMP>
  • Values: None

    See also sysDescr, sysContact and sysLocation.

 
Finding related information
     (Back to the top)