# snmp.conf

The /etc/cups/snmp.conf file contains several directives that determine how the SNMP printer discovery backend behaves. Each directive is listed on a line by itself followed by its value. Comments are introduced using the number sign ("#") character at the beginning of a line.

The SNMP backend uses the SNMPv1 protocol to discover network printers, collecting information from the Host MIB along with intelligent port probes to determine the correct device URI and make and model for each printer. Future versions of CUPS will likely support the new Port Monitor MIB as well.

## Address

### Examples

    Address @LOCAL
    Address @IF(name)
    Address 255.255.255.255
    Address 192.168.2.255

### Description

The `Address` directive specifies a broadcast address to use when discovering printers. Multiple `Address` lines can be provided to scan different subnets.

The default address is @LOCAL, which broadcasts to all LANs.

## Community

### Examples

    Community public
    Community easysw
    Community BigCorp

### Description

The `Community` directive specifies a community name to use when discovering printers. Multiple `Community` lines can be provided to scan different SNMP communities.

The default community is "public".

## DebugLevel

### Examples

    DebugLevel 0
    DebugLevel 1
    DebugLevel 2
    DebugLevel 3

### Description

The `DebugLevel` directive specifies the debugging level to use when searching for network printers. Level 0 produces no debugging information. Level 1 produces basic debugging information. Level 2 adds printing of the SNMP messages. Level 3 adds a hex dump of the network data.

The default setting is 0.

## DeviceURI

### Examples

    DeviceURI "HP.*JetDirect.*" socket://%s:9100 socket://%s:9101 socket://%s:9102
    DeviceURI "HP.*" socket://%s
    DeviceURI "Acme.*Laser.*" lpd://%s/print
    DeviceURI "Xerox.*"

### Description

The `DeviceURI` directive specifies a regular expression (enclosed in double quotes) that is matched against the SNMP device description OID returned by a printer. If the description matches the regular expression, each device URI that follows the regular expression is listed by the backend, with any occurrences of `%s` replaced by the device's hostname or IP address. If no URIs are listed, the device is ignored.

The `DeviceURI` directives are processed serially in the order specified in the snmp.conf file until a match is found.

## HostNameLookups

### Examples

    HostNameLookups on
    HostNameLookups off

### Description

The `HostNameLookups` directive specifies whether printer addresses are converted to hostnames or left as numeric IP addresses.

The default setting is off.

## MaxRunTime

### Examples

    MaxRunTime 10
    MaxRunTime 300

### Description

The `MaxRunTime` directive specifies the maxium number of seconds that the SNMP backend will spend looking for printer devices on the network.

The default setting is 10.