This help document describes how to discover, configure, and use TCP/IP network printers with CUPS.
Every network printer or print server has a unique Internet Protocol (IP) address associated with it. This address is either configured manually or set using an automatic network protocol such as the Boot Protocol (BOOTP), Dynamic Host Control Protocol (DHCP), Reverse Address Resolution Protocol (RARP), or ZeroConf.
You can normally find the IP address of a printer on the printer's control panel or by printing the configuration or status page. The Simple Network Management Protocol (SNMP) can also be used to get the IP address remotely.
When you first install a network printer or print server on your LAN, you need to set the Internet Protocol ("IP") address. Most higher-end "workgroup" printers allow you to set the address through the printer control panel. However, if you have many printers you will want to assign the addresses remotely - this makes administration a bit easier and avoids assigning duplicate addresses accidentally.
To setup your printer or print server for remote address assignment, you'll need the Ethernet Media Access Control ("MAC") address, also sometimes called a node address, and the IP address you want to use for the device. The Ethernet MAC address can often be found on the printer test page or bottom of the print server.
The DHCP protocol is the usual way of setting the IP address of a printer on a managed network. Using the standard dhcpd(8) program supplied with UNIX you simply need to add a line to the /etc/dhcpd.conf file:
host hostname {
hardware ethernet mac-address;
fixed-address ip-address;
}
Make sure that the hostname you use is also listed in the /etc/hosts file or is registered with your DNS server.
The BOOTP protocol is used when you need to provide additional information such as the location of a configuration file to the network interface. Using the standard bootpd(8) program supplied with UNIX you simply need to add a line to the /etc/bootptab file:
myprinter:ha=080069001234:ip=192.0.2.2:t144=myprinter.boot
The myprinter.boot file resides in the /usr/local/boot directory by default. If you do not need to provide a boot file you may leave the last part of the line blank.
Note: Some versions of UNIX do not enable the BOOTP service by default. The /etc/inetd.conf or /etc/xinetd.d/bootp file usually contains a line for the BOOTP service that can be uncommented if needed.
To test that the IP address has been successfully assigned and that the printer is properly connected to your LAN, type:
ping ip-address
If the connection is working properly you will see something like:
ping myprinter PING myprinter (192.0.2.2): 56 data bytes 64 bytes from 192.0.2.2: icmp_seq=0 ttl=15 time=5 ms 64 bytes from 192.0.2.2: icmp_seq=1 ttl=15 time=3 ms 64 bytes from 192.0.2.2: icmp_seq=2 ttl=15 time=3 ms 64 bytes from 192.0.2.2: icmp_seq=3 ttl=15 time=3 ms
If not, verify that the printer or print server is connected to the LAN, it is powered on, the LAN cabling is good, and the IP address is set correctly. You can usually see the current IP address and network status by printing a configuration or test page on the device.
CUPS supports most network printers using one of three TCP/IP-based protocols. Printer discovery is currently accomplished using the SNMP protocol, however future versions of CUPS will also include support for multicast DNS service discovery as well.
The AppSocket protocol (sometimes also called the JetDirect protocol, owing to its origins with the HP JetDirect network interfaces) is the simplest, fastest, and generally the most reliable network protocol used for printers. AppSocket printing normally happens over port 9100 and uses the socket URI scheme:
socket://ip-address-or-hostname socket://ip-address-or-hostname/?option=value socket://ip-address-or-hostname/?option=value&option=value socket://ip-address-or-hostname:port-number socket://ip-address-or-hostname:port-number/?option=value socket://ip-address-or-hostname:port-number/?option=value&option=value
The "contimeout" option controls the number of seconds that the backend will wait to obtain a connection to the printer. The default is 1 week.
The "snmp" option controls whether the socket backend queries for supply and page count information via SNMP.
The "waiteof" option controls whether the socket backend waits for the printer to complete the printing of the job. The default is to wait.
IPP is the only protocol that CUPS supports natively and is supported by most network printers and print servers. IPP printing normally happens over port 631 and uses the http (Windows), ipp, and ipps URI schemes:
http://ip-address-or-hostname:port-number/resource http://ip-address-or-hostname:port-number/resource?option=value http://ip-address-or-hostname:port-number/resource?option=value&option=value ipp://ip-address-or-hostname/resource ipp://ip-address-or-hostname/resource?option=value ipp://ip-address-or-hostname/resource?option=value&option=value ipp://ip-address-or-hostname:port-number/resource ipp://ip-address-or-hostname:port-number/resource?option=value ipp://ip-address-or-hostname:port-number/resource?option=value&option=value ipps://ip-address-or-hostname/resource ipps://ip-address-or-hostname/resource?option=value ipps://ip-address-or-hostname/resource?option=value&option=value ipps://ip-address-or-hostname:port-number/resource ipps://ip-address-or-hostname:port-number/resource?option=value ipps://ip-address-or-hostname:port-number/resource?option=value&option=value
The ipp backend supports many options, which are summarized in Table 2.
| Option | Description |
|---|---|
| encryption=always | Specifies that the connection to the IPP server should be encrypted using SSL. |
| encryption=ifrequested | Specifies that the connection to the IPP server should only be encrypted if the server requests it. |
| encryption=never | Specifies that the connection to the IPP server should not be encrypted. |
| encryption=required | Specifies that the connection to the IPP server should be encrypted using TLS. |
| snmp=false | Specifies that SNMP supply and page count queries should not be performed. |
| version=1.0 | Specifies that version 1.0 of the IPP protocol should be used instead of the default version 2.0. |
| version=1.1 | Specifies that version 1.1 of the IPP protocol should be used instead of the default version 2.0. |
| version=2.1 | Specifies that version 2.1 of the IPP protocol should be used instead of the default version 2.0. |
| waitjob=false | Specifies that the IPP backend should not wait for the job to complete. |
| waitprinter=false | Specifies that the IPP backend should not wait for the printer to become idle before sending the print job. |
LPD is the original network printing protocol and is supported by many network printers. Due to limitations in the LPD protocol, we do not recommend using it if the printer or server supports one of the other protocols. LPD printing normally happens over port 515 and uses the lpd URI scheme:
lpd://ip-address-or-hostname/queue lpd://username@ip-address-or-hostname/queue lpd://ip-address-or-hostname/queue?option=value lpd://username@ip-address-or-hostname/queue?option=value lpd://ip-address-or-hostname/queue?option=value&option=value lpd://username@ip-address-or-hostname/queue?option=value&option=value
Table 3 summarizes the options supported by the lpd backend.
| Option | Description |
|---|---|
| banner=on | Specifies that a banner page should be printed by the server. |
| contimeout=seconds | Specifies the number of seconds to wait for the connection to the server to complete. |
| format=c | Specifies that the print data is a CIF file. |
| format=d | Specifies that the print data is a DVI file. |
| format=f | Specifies that the print data is a plain text file. |
| format=g | Specifies that the print data is a Berkeley plot file. |
| format=l | Specifies that the print data is a raw (preformatted) print file. |
| format=n | Specifies that the print data is a ditroff file. |
| format=o | Specifies that the print data is a PostScript file. |
| format=p | Specifies that the print data is a plain text file that should be "pretty" printed with a header and footer. |
| format=r | Specifies that the print data is a FORTRAN carriage control file. |
| format=t | Specifies that the print data is a troff Graphic Systems C/A/T phototypesetter file. |
| format=v | Specifies that the print data is a Sun raster file. |
| order=data,control | Specifies that the print data files should be sent before the control file. |
| reserve=none | Specifies that the backend should not reserve a source port. |
| reserve=rfc1179 | Specifies that the backend should reserve a source port from 721 to 731 as required by RFC 1179. |
| sanitize_title=no | Specifies that the job title string should not be restricted to ASCII alphanumeric and space characters. |
| sanitize_title=yes | Specifies that the job title string should be restricted to ASCII alphanumeric and space characters. |
| snmp=false | Specifies that SNMP supply and page count queries should not be performed. |
| timeout=seconds | Specifies the number of seconds to wait for LPD commands to complete. |
Once you have set the IP address you can access the printer or print server using the ipp, lpd, or socket backends. Table 1 shows a list of common network interfaces and printer servers and the settings you should use with CUPS:
| Model/Manufacturer | Device URI(s) |
|---|---|
| Apple LaserWriter | lpd://address/PASSTHRU |
| Axis w/o IPP Axis OfficeBasic (see directions) |
socket://address:9100 socket://address:9101 socket://address:9102 |
| Axis w/IPP | ipp://address/LPT1 ipp://address/LPT2 ipp://address/COM1 |
| Castelle LANpressTM | lpd://address/pr1 lpd://address/pr2 lpd://address/pr3 |
| DPI NETPrint | lpd://address/pr1 lpd://address/pr2 lpd://address/pr3 |
| DLink DP-301P+ | socket://address |
| EFI® Fiery® RIP | lpd://address/print |
| EPSON® Multiprotocol Ethernet Interface Board | socket://address |
| Extended System ExtendNET | lpd://address/pr1 lpd://address/pr2 lpd://address/pr3 |
| Hewlett Packard JetDirect | socket://address:9100 socket://address:9101 socket://address:9102 |
| Intel® NetportExpress XL, PRO/100 | lpd://address/LPT1_PASSTHRU lpd://address/LPT2_PASSTHRU lpd://address/COM1_PASSTHRU |
| LexmarkTM MarkNet | lpd://address/ps |
| Linksys EtherFast® (see directions) |
socket://address:4010 socket://address:4020 socket://address:4030 |
| Linksys PSUS4 | lpd://address/lp |
| Kodak® | lpd://address/ps |
| Netgear WGPS606 | lpd://address/L1 lpd://address/L2 |
| QMS® CrownNetTM | lpd://address/ps |
| Tektronix® PhaserShareTM | socket://address:9100 |
| XEROX® 4512 NIC | lpd://address/PORT1 |
| XEROX® XNIC | lpd://address/PASSTHRU |
| XEROX® (most others) | socket://address:5503 |
Whenever you view the administration web page or a list of supported device URIs, the snmp backend can probe the local network(s) using Simple Network Management Protocol (SNMP) v1 broadcasts. Printers that respond to these broadcasts are then interrogated for the make, model, and supported protocols, yielding a device URI that can be used to add the printer.
That said, the SNMP requests sometimes expose problems in vendor implementations. If you are experiencing long delays in loading the CUPS web interface administration page, or if you don't see your printer listed, the following instructions will help you to diagnose those problems and/or provide important feedback to the CUPS developers so that we can correct problems and improve the SNMP backend in future releases.
If you don't use "public" as your community name, edit or create (as needed) a text file called /etc/cups/snmp.conf and put the following line in it:
Community your community name
The SNMP backend will not be able to find any printers on your network if SNMP v1 or broadcasting are not supported on your network.
The SNMP backend supports a debugging mode that is activated by running it from a shell prompt. If you are using Bash (/bin/bash), Bourne shell (/bin/sh), Korn shell (/bin/ksh), or Z shell (/bin/zsh), you can run the following command to get a verbose log of the SNMP backend:
CUPS_DEBUG_LEVEL=2 /usr/lib/cups/backend/snmp 2>&1 | tee snmp.log
For C shell (/bin/csh) and TCsh (/bin/tcsh), use the following command instead:
(setenv CUPS_DEBUG_LEVEL 2; /usr/lib/cups/backend/snmp) |& tee snmp.log
On macOS you'll find the SNMP backend in /usr/libexec/cups/backend instead:
CUPS_DEBUG_LEVEL=2 /usr/libexec/cups/backend/snmp 2>&1 | tee snmp.log
The output will look something like this:
1 INFO: Using default SNMP Address @LOCAL
2 INFO: Using default SNMP Community public
3 DEBUG: Scanning for devices in "public" via "@LOCAL"...
4 DEBUG: 0.000 Sending 46 bytes to 192.168.2.255...
5 DEBUG: SEQUENCE 44 bytes
6 DEBUG: INTEGER 1 bytes 0
7 DEBUG: OCTET STRING 6 bytes "public"
8 DEBUG: Get-Request-PDU 31 bytes
9 DEBUG: INTEGER 4 bytes 1149539174
10 DEBUG: INTEGER 1 bytes 0
11 DEBUG: INTEGER 1 bytes 0
12 DEBUG: SEQUENCE 17 bytes
13 DEBUG: SEQUENCE 15 bytes
14 DEBUG: OID 11 bytes .1.3.6.1.2.1.25.3.2.1.2.1
15 DEBUG: NULL VALUE 0 bytes
16 DEBUG: 0.001 Received 55 bytes from 192.168.2.229...
17 DEBUG: community="public"
18 DEBUG: request-id=1149539174
19 DEBUG: error-status=0
20 DEBUG: SEQUENCE 53 bytes
21 DEBUG: INTEGER 1 bytes 0
22 DEBUG: OCTET STRING 6 bytes "public"
23 DEBUG: Get-Response-PDU 40 bytes
24 DEBUG: INTEGER 4 bytes 1149539174
25 DEBUG: INTEGER 1 bytes 0
26 DEBUG: INTEGER 1 bytes 0
27 DEBUG: SEQUENCE 26 bytes
28 DEBUG: SEQUENCE 24 bytes
29 DEBUG: OID 11 bytes .1.3.6.1.2.1.25.3.2.1.2.1
30 DEBUG: OID 9 bytes .1.3.6.1.2.1.25.3.1.5
31 DEBUG: add_cache(addr=0xbfffe170, addrname="192.168.2.229",
uri="(null)", id="(null)", make_and_model="(null)")
32 DEBUG: 0.002 Sending 46 bytes to 192.168.2.229...
33 DEBUG: SEQUENCE 44 bytes
34 DEBUG: INTEGER 1 bytes 0
35 DEBUG: OCTET STRING 6 bytes "public"
36 DEBUG: Get-Request-PDU 31 bytes
37 DEBUG: INTEGER 4 bytes 1149539175
38 DEBUG: INTEGER 1 bytes 0
39 DEBUG: INTEGER 1 bytes 0
40 DEBUG: SEQUENCE 17 bytes
41 DEBUG: SEQUENCE 15 bytes
42 DEBUG: OID 11 bytes .1.3.6.1.2.1.25.3.2.1.3.1
43 DEBUG: NULL VALUE 0 bytes
44 DEBUG: 0.003 Received 69 bytes from 192.168.2.229...
45 DEBUG: community="public"
46 DEBUG: request-id=1149539175
47 DEBUG: error-status=0
48 DEBUG: SEQUENCE 67 bytes
49 DEBUG: INTEGER 1 bytes 0
50 DEBUG: OCTET STRING 6 bytes "public"
51 DEBUG: Get-Response-PDU 54 bytes
52 DEBUG: INTEGER 4 bytes 1149539175
53 DEBUG: INTEGER 1 bytes 0
54 DEBUG: INTEGER 1 bytes 0
55 DEBUG: SEQUENCE 40 bytes
56 DEBUG: SEQUENCE 38 bytes
57 DEBUG: OID 11 bytes .1.3.6.1.2.1.25.3.2.1.3.1
58 DEBUG: OCTET STRING 23 bytes "HP LaserJet 4000
Series"
59 DEBUG: 1.001 Probing 192.168.2.229...
60 DEBUG: 1.001 Trying socket://192.168.2.229:9100...
61 DEBUG: 192.168.2.229 supports AppSocket!
62 DEBUG: 1.002 Scan complete!
63 network socket://192.168.2.229 "HP LaserJet 4000 Series"
"HP LaserJet 4000 Series 192.168.2.229" ""
The first two lines are just informational and let you know that the default community name and address are being used. Lines 3-15 contain the initial SNMP query for the device type OID (.1.3.6.1.2.1.25.3.2.1.2.1) from the Host MIB.
Lines 16-31 show the response we got from an HP LaserJet 4000 network printer. At this point we discover that it is a printer device and then send another SNMP query (lines 32-43) for the device description OID (.1.3.6.1.2.1.25.3.2.1.3.1) from the Host MIB as well.
Lines 44-58 show the response to the device description query, which tells us that this is an HP LaserJet 4000 Series printer.
On line 59 we start our active connection probe and discover that this print server supports the AppSocket (JetDirect) protocol on port 9100.
Finally, line 63 shows the device information line for the print server that is sent to CUPS.
snmpwalk -Cc -v 1 -c public ip-address | tee snmpwalk.log
where "ip-address" is the IP address of the printer or print server. You should see a lot of values stream by - the ones you want to see are:
HOST-RESOURCES-MIB::hrDeviceType.1 = OID: HOST-RESOURCES-TYPES::hrDevicePrinter HOST-RESOURCES-MIB::hrDeviceDescr.1 = STRING: HP LaserJet 4000 Series
The hrDeviceType line should show hrDevicePrinter; if not, then your printer or print server doesn't identify itself as a printer. The hrDeviceDescr line should provide a human-readable string for the make and model of the printer, although in some cases you'll just see something less useful like "Axis OfficeBASIC Parallel Print Server".
Once you have collected the snmpwalk output, you should go to the CUPS Bugs & Features page to submit a feature request to support your printer or print server. Be sure to attach those two log files you created - they will help us to identify the SNMP values we need to look for.
The Axis print servers can be configured using BOOTP or DHCP. However, on models that do not provide IPP support an additional step must be performed to configure the TCP/IP portion of the print server for use with CUPS.
Each print server contains a configuration file named config that contains a list of network parameters used by the server. To modify this file you must first download it from the print server using the ftp(1) program:
ftp ip-address Connected to ip-address. 220 Axis NPS ### FTP Printer Server V#.## MON DD YEAR ready. ftp> user root 331 User name ok, need password Password: pass (this is not echoed) 230 User logged in ftp> get config local: config remote: config 200 PORT command successful. 150 Opening data connection for config (192,0,2,2), (mode ascii). 226 Transfer complete. ##### bytes received in #.## seconds (##### Kbytes/s) ftp> quit 221 Goodbye.
Next, edit the file with your favorite text editor and locate the lines beginning with:
RTN_OPT. : YES RTEL_PR1. : 0 RTEL_PR2. : 0 RTEL_PR3. : 0 RTEL_PR4. : 0 RTEL_PR5. : 0 RTEL_PR6. : 0 RTEL_PR7. : 0 RTEL_PR8. : 0
Change the RTN_OPT line to read:
RTN_OPT. : NO
This disables the Reverse TELNET protocol and enables the standard TELNET protocol on the print server. Next, assign a port number for each parallel and serial port on the server as follows:
RTEL_PR1. : 9100 RTEL_PR2. : 9101 RTEL_PR3. : 9102 RTEL_PR4. : 9103 RTEL_PR5. : 9104 RTEL_PR6. : 9105 RTEL_PR7. : 9106 RTEL_PR8. : 9107
This essentially makes the Axis print server look like a Hewlett Packard JetDirect EX print server. Save the file and then upload the new config file using the ftp command:
ftp ip-address Connected to ip-address. 220 Axis NPS ### FTP Printer Server V#.## MON DD YEAR ready. ftp> user root 331 User name ok, need password Password: pass (this is not echoed) 230 User logged in ftp> put config CONFIG local: config remote: CONFIG 200 PORT command successful. 150 Opening data connection for config (192,0,2,2), (mode ascii). 226 Transfer complete. ##### bytes received in #.## seconds (##### Kbytes/s) ftp> get hardreset local: hardreset remote: hardreset 200 PORT command successful. 421 Axis NPS ### hard reset, closing connection. ftp> quit 221 Goodbye.
Your Axis print server is now ready for use!
The Linksys print servers can be configured using BOOTP or DHCP. Like older Axis print servers, an additional step must be performed to configure the TCP/IP portion of the print server for use with CUPS.
Each print server contains a configuration file named CONFIG that contains a list of network parameters used by the server. To modify this file you must first download it from the print server using the ftp(1) program:
ftp -n ip-address Connected to ip-address. 220 Print Server Ready. Remote system type is Print. ftp> get CONFIG local: CONFIG remote: CONFIG 200 Command OK. 150 Open ASCII Mode Connection. WARNING! 68 bare linefeeds received in ASCII mode File may not have transferred correctly. 226 Transfer complete. ##### bytes received in #.## seconds (##### Kbytes/s) ftp> quit 221 Goodbye.
Next, edit the file with your favorite text editor and locate the lines beginning with:
0100 L1_PROUT:P1 0120 L2_PROUT:P1 0140 L3_PROUT:P1
Change the port number for each parallel and serial port on the server as follows:
0100 L1_PROUT:P1 0120 L2_PROUT:P2 0140 L3_PROUT:P3
This maps each virtual printer with a physical port. Save the file and then upload the new CONFIG file using the ftp command:
ftp -n ip-address Connected to ip-address. 220 Print Server Ready. Remote system type is Print. ftp> put CONFIG local: CONFIG remote: CONFIG 200 Command OK. 150 Open ASCII Mode Connection. 226 Transfer complete. ##### bytes received in #.## seconds (##### Kbytes/s) ftp> quit 221 Goodbye.
Your Linksys print server is now ready for use!