CUPS 1.7 Documentation

List of CUPS 1.7 Documents

snmpbackend(8)

snmpbackend(8)

Name

snmpbackend - cups snmp backend

Synopsis

/usr/libexec/cups/backend/snmp ip-address-or-hostname
lpinfo -v --include-schemes snmp

Description

The CUPS SNMP backend provides legacy discovery and identification of network printers using SNMPv1. When used for discovery through the scheduler, the backend will list all printers that respond to a broadcast SNMPv1 query with the "public" community name. Additional queries are then sent to printers that respond in order to determine the correct device URI, make and model, and other information needed for printing.

In the first form, the SNMP backend is run directly by the user to look up the device URI and other information when you have an IP address or hostname. This can be used for programs that need to configure print queues where the user has supplied an address but nothing else.

In the second form, the SNMP backend is run indirectly using the lpinfo(8) command. The output provides all printers detected via SNMP on the configured broadcast addresses. Note: no broadcast addresses are configured by default.

Configuration

The SNMP backend reads the /private/etc/cups/snmp.conf configuration file, if present, to set the default broadcast address, community name, and logging level. Each line consists of a directive followed by whitespace and any values associated with the directive:
Address @IF(name)
Address @LOCAL
Address ip-address-or-hostname
Specifies a (broadcast) address for discovery. "@LOCAL" adds all of the IPv4 and IPv6 broadcast addresses for active, non-point-to-point network interfaces, while "@IF(name)" adds the IPv4 and IPv6 broadcast addresses associated with the named interface. There is no default address.
Community name
Specifies the community name to use. Only a single community name may be specified. The default community name is "public".
DebugLevel number
Specifies the logging level from 0 (none) to 3 (everything). Typically only used for debugging (thus the name). The default debug level is 0. The CUPS_DEBUG_LEVEL environment variable can be used to override the default value.
DeviceURI "regular expression" device-uri [... device-uri]
Specifies one or more device URIs that should be used for a given make and model string. The regular expression is used to match the detected make and model, and the device URI strings must be of the form "scheme://%s[:port]/[path]", where "%s" represents the detected address or hostname. There are no default device URI matching rules.
HostNameLookups on
HostNameLookups off
Specifies whether the backend tries to do a reverse lookup of the detected printer's address. The default is off.
MaxRunTime seconds
Specifies the maximum amount of time the backend will wait for a response. The default is 120 seconds (2 minutes). The CUPS_MAX_RUN_TIME environment variable can be used to override the default value.

See Also

backend(7), cupsd(8), cupsd.conf(5), filter(7), lpinfo(8),
http://localhost:631/help

Copyright

Copyright 2007-2012 by Apple Inc.