Module mod_snmp

This module is contained in the modules/snmp directory and is not compiled in by default. It provides an SNMP management extension for the Apache server via the SNMP framework. The SNMP agent implements the SNMPv2-MIB (RFC 1907), WWW-MIB (RFC 2594) and some extra Apache specific MIB-modules.

• SNMP
• SNMPbuckets
• SNMPcommunity
• sysDescr
• sysContact
• sysLocation

<SNMP> directive

Syntax:<SNMP number>...</SNMP>
Context: snmp config
Status: Extension
Module: mod_snmp

The number sets the network port on which the SNMP agent listens. The network port is a number from 0 to 65635; some port numbers (especially below 1024) are reserved for particular protocols. See also /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:

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

See also SNMPbuckets, SNMPcommunity, sysDescr, sysContact and sysLocation.

SNMPbuckets directive

Syntax: SNMP directory
Context: snmp config
Status: Extension
Module: mod_snmp

The SNMPbuckets directives specifies the directory where you want the buckets (used for the WWW_Docuement group) want to be stored. These bucket are storage for the GNU-DBM to provide document statistics in SNMP. For precise working and usage of the see the WWW-MIB.

Example:

SNMPbuckets logs

SNMPcommunity directive

Syntax: SNMPcommunity string
Default: community public
Context: snmp config
Status: Extension
Module: mod_snmp

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 of 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. At most 10 communities can be defined and the string length 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:

SNMPcommunity public

sysDescr directive

Syntax: sysDescr string
Default:a compiled in default reflecting the various version/protocol flags and other details.
Context: snmp config
Status: Extension
Module: mod_snmp

The sysDescr directive is used to define the system description of the host on which the SNMP agent (thus server) is running taht is used for the 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 Apache HTTP/1.1 with SNMP

See also sysContact and sysLocation.

sysContact directive

>Syntax: sysContact string
Context: snmp config
Status: Extension
Module: mod_snmp

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:

"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 directive

Syntax: sysLocation string
Context: snmp config
Status: Extension
Module: mod_snmp

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:

"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 bulding, room 44

See also sysDescr and sysContact.