]> git.ipfire.org Git - thirdparty/cups.git/blame - doc/help/network.html
Merge changes from CUPS 1.7svn-r10643
[thirdparty/cups.git] / doc / help / network.html
CommitLineData
ef416fc2 1<HTML>
2<!-- SECTION: Getting Started -->
3<HEAD>
4 <TITLE>Using Network Printers</TITLE>
178cb736 5 <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css">
ef416fc2 6</HEAD>
7<BODY>
8
178cb736
MS
9<H1 CLASS="title">Using Network Printers</H1>
10
b86bc4cf 11<P>This help document describes how to discover, configure, and use TCP/IP network printers with CUPS.</P>
ef416fc2 12
b86bc4cf 13<H2 CLASS="title"><A NAME="ADDRESS">Getting the IP Address</A></H2>
14
15<P>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 <A HREF="#BOOTP">Boot Protocol (BOOTP)</A>, <A HREF="#DHCP">Dynamic Host Control Protocol (DHCP)</A>, Reverse Address Resolution Protocol (RARP), or ZeroConf.</P>
16
17<P>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 <A HREF="#SNMP">Simple Network Management Protocol (SNMP)</A> can also be used to get the IP address remotely, which happens automatically when you visit the CUPS administration web page or choose an available CUPS device when adding a printer.</P>
18
19
20<H2 CLASS="title"><A NAME="CONFIG">Configuring the IP Address</A></H2>
21
22<P>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.</P>
23
24<P>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.</P>
25
26<H3><A NAME="DHCP">Configuring the IP Address Using DHCP</A></H3>
27
28<P>The DHCP protocol is the usual way of setting the IP address of a printer on a managed network. Using the standard <TT>dhcpd(8)</TT> program supplied with UNIX you simply need to add a line to the <VAR>/etc/dhcpd.conf</VAR> file:</P>
29
30<PRE CLASS="command">
31host <I>hostname</I> {
32 hardware ethernet <I>mac-address</I>;
33 fixed-address <I>ip-address</I>;
34}
35</PRE>
36
37<P>Make sure that the hostname you use is also listed in the <VAR>/etc/hosts</VAR> file or is registered with your DNS server.</P>
38
39<H3><A NAME="BOOTP">Configuring the IP Address Using BOOTP</A></H3>
40
3dd9c340 41<P>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 <TT>bootpd(8)</TT> program supplied with UNIX you simply need to add a line to the <VAR>/etc/bootptab</VAR> file:</P>
b86bc4cf 42
43<PRE CLASS="command">
44myprinter:ha=080069001234:ip=192.0.2.2:<VAR>t144=myprinter.boot</VAR>
45</PRE>
46
47<P>The <VAR>myprinter.boot</VAR> file resides in the <VAR>/usr/local/boot</VAR> directory by default. If you do not need to provide a boot file you may leave the last part of the line blank.</P>
48
49<BLOCKQUOTE><B>Note:</B> Some versions of UNIX do not enable the BOOTP service by default. The <VAR>/etc/inetd.conf</VAR> or <VAR>/etc/xinetd.d/bootp</VAR> file usually contains a line for the BOOTP service that can be uncommented if needed.</BLOCKQUOTE>
50
51
52<H2 CLASS="title"><A NAME="VERIFY">Verifying the Printer Connection</A></H2>
53
54<P>To test that the IP address has been successfully assigned and
55that the printer is properly connected to your LAN, type:</P>
56
57<PRE CLASS="command">
58<KBD>ping ip-address</KBD>
59</PRE>
60
61<P>If the connection is working properly you will see something
62like:</P>
63
64<PRE CLASS="command">
65<KBD>ping myprinter</KBD>
66PING myprinter (192.0.2.2): 56 data bytes
6764 bytes from 192.0.2.2: icmp_seq=0 ttl=15 time=5 ms
6864 bytes from 192.0.2.2: icmp_seq=1 ttl=15 time=3 ms
6964 bytes from 192.0.2.2: icmp_seq=2 ttl=15 time=3 ms
7064 bytes from 192.0.2.2: icmp_seq=3 ttl=15 time=3 ms
71</PRE>
72
73<P>If not, verify that the printer or print server is connected
74to the LAN, it is powered on, the LAN cabling is good, and the IP
75address is set correctly. You can usually see the current IP
76address and network status by printing a configuration or test
77page on the device.</P>
78
79
80<H2 CLASS="title"><A NAME="PROTOCOLS">Network Protocols Supported by CUPS</H2>
81
82<P>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.</P>
83
84<H3><A NAME="SOCKET">AppSocket Protocol</A></H3>
85
86<P>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 <tt>socket</tt> URI scheme:</P>
87
88<PRE>
89socket://<i>ip-address-or-hostname</i>
5a9febac
MS
90socket://<i>ip-address-or-hostname</i>/?option=value
91socket://<i>ip-address-or-hostname</i>/?option=value&option=value
b86bc4cf 92socket://<i>ip-address-or-hostname</i>:<i>port-number</i>
5a9febac
MS
93socket://<i>ip-address-or-hostname</i>:<i>port-number</i>/?option=value
94socket://<i>ip-address-or-hostname</i>:<i>port-number</i>/?option=value&option=value
b86bc4cf 95</PRE>
96
5a9febac
MS
97<P>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.</P>
98
99<P>The "snmp" option controls whether the <tt>socket</tt> backend queries for supply and page count information via SNMP.</P>
100
b86bc4cf 101<P>The "waiteof" option controls whether the <tt>socket</tt> backend waits for the printer to complete the printing of the job. The default is to wait.</P>
102
103<H3><A NAME="IPP">Internet Printing Protocol (IPP)</A></H3>
104
5a9febac 105<P>IPP is the only protocol that CUPS supports natively and is supported by some network printers and print servers. However, since many printers do not implement IPP properly, only use IPP when the vendor actually documents official support for it. IPP printing normally happens over port 631 and uses the <tt>http</tt>, <tt>ipp</tt>, and <tt>ipps</tt> URI schemes:</P>
b86bc4cf 106
107<PRE>
108http://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>
109http://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value</i>
110http://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value&option=value</i>
111ipp://<i>ip-address-or-hostname</i>/<i>resource</i>
112ipp://<i>ip-address-or-hostname</i>/<i>resource</i>?<i>option=value</i>
113ipp://<i>ip-address-or-hostname</i>/<i>resource</i>?<i>option=value&option=value</i>
114ipp://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>
115ipp://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value</i>
116ipp://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value&option=value</i>
5a9febac
MS
117ipps://<i>ip-address-or-hostname</i>/<i>resource</i>
118ipps://<i>ip-address-or-hostname</i>/<i>resource</i>?<i>option=value</i>
119ipps://<i>ip-address-or-hostname</i>/<i>resource</i>?<i>option=value&option=value</i>
120ipps://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>
121ipps://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value</i>
122ipps://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value&option=value</i>
b86bc4cf 123</PRE>
124
125<P>The <tt>ipp</tt> backend supports many options, which are summarized in <A HREF="#TABLE2">Table 2</A>.</P>
126
127<DIV CLASS="table"><TABLE SUMMARY="IPP URI Options">
128<CAPTION>Table 2: <A NAME="TABLE2">IPP URI Options</A></CAPTION>
129<THEAD>
130<TR>
131 <TH>Option</TH>
132 <TH>Description</TH>
133</TR>
134</THEAD>
135<TBODY>
136<TR>
137 <TD><TT>compression=gzip</TT></TD>
138 <TD>Specifies that print data should be compressed before sending.</TD>
139</TR>
140<TR>
141 <TD><TT>encryption=always</TT></TD>
142 <TD>Specifies that the connection to the IPP server should be encrypted using SSL.</TD>
143</TR>
144<TR>
145 <TD><TT>encryption=ifrequested</TT></TD>
146 <TD>Specifies that the connection to the IPP server should only be encrypted if the server requests it.</TD>
147</TR>
148<TR>
149 <TD><TT>encryption=never</TT></TD>
150 <TD>Specifies that the connection to the IPP server should not be encrypted.</TD>
151</TR>
152<TR>
153 <TD><TT>encryption=required</TT></TD>
154 <TD>Specifies that the connection to the IPP server should be encrypted using TLS.</TD>
155</TR>
5a9febac
MS
156<TR>
157 <TD><TT>snmp=false</TT></TD>
158 <TD>Specifies that SNMP supply and page count queries should not be performed.</TD>
159</TR>
b86bc4cf 160<TR>
161 <TD><TT>version=1.0</TT></TD>
5a9febac 162 <TD>Specifies that version 1.0 of the IPP protocol should be used instead of the default version 2.0.</TD>
b86bc4cf 163</TR>
c168a833 164<TR>
5a9febac
MS
165 <TD><TT>version=1.1</TT></TD>
166 <TD>Specifies that version 1.1 of the IPP protocol should be used instead of the default version 2.0.</TD>
c168a833
MS
167</TR>
168<TR>
169 <TD><TT>version=2.1</TT></TD>
5a9febac 170 <TD>Specifies that version 2.1 of the IPP protocol should be used instead of the default version 2.0.</TD>
c168a833 171</TR>
b86bc4cf 172<TR>
173 <TD><TT>waitjob=false</TT></TD>
174 <TD>Specifies that the IPP backend should not wait for the job to complete.</TD>
175</TR>
176<TR>
177 <TD><TT>waitprinter=false</TT></TD>
178 <TD>Specifies that the IPP backend should not wait for the printer to become idle before sending the print job.</TD>
179</TR>
180</TBODY>
181</TABLE></DIV>
182
183<H3><A NAME="LPD">Line Printer Daemon (LPD) Protocol</A></H3>
184
185<P>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 <tt>lpd</tt> URI scheme:</P>
186
187<PRE>
188lpd://<i>ip-address-or-hostname</i>/<i>queue</i>
c168a833 189lpd://<i>username@ip-address-or-hostname</i>/<i>queue</i>
b86bc4cf 190lpd://<i>ip-address-or-hostname</i>/<i>queue</i>?<i>option=value</i>
c168a833 191lpd://<i>username@ip-address-or-hostname</i>/<i>queue</i>?<i>option=value</i>
b86bc4cf 192lpd://<i>ip-address-or-hostname</i>/<i>queue</i>?<i>option=value&option=value</i>
c168a833 193lpd://<i>username@ip-address-or-hostname</i>/<i>queue</i>?<i>option=value&option=value</i>
b86bc4cf 194</PRE>
195
196<P><A HREF="#TABLE3">Table 3</A> summarizes the options supported by the <tt>lpd</tt> backend.</P>
197
198<DIV CLASS="table"><TABLE SUMMARY="LPD URI Options">
199<CAPTION>Table 3: <A NAME="TABLE3">LPD URI Options</A></CAPTION>
200<THEAD>
201<TR>
202 <TH>Option</TH>
203 <TH>Description</TH>
204</TR>
205</THEAD>
206<TBODY>
207<TR>
208 <TD><TT>banner=on</TT></TD>
209 <TD>Specifies that a banner page should be printed by the server.</TD>
210</TR>
211<TR>
212 <TD><TT>contimeout=<I>seconds</I></TT></TD>
213 <TD>Specifies the number of seconds to wait for the connection to the server to complete.</TD>
214</TR>
215<TR>
216 <TD><TT>format=c</TT></TD>
217 <TD>Specifies that the print data is a CIF file.</TD>
218</TR>
219<TR>
220 <TD><TT>format=d</TT></TD>
221 <TD>Specifies that the print data is a DVI file.</TD>
222</TR>
223<TR>
224 <TD><TT>format=f</TT></TD>
225 <TD>Specifies that the print data is a plain text file.</TD>
226</TR>
227<TR>
228 <TD><TT>format=g</TT></TD>
229 <TD>Specifies that the print data is a Berkeley plot file.</TD>
230</TR>
231<TR>
232 <TD><TT>format=l</TT></TD>
233 <TD>Specifies that the print data is a raw (preformatted) print file.</TD>
234</TR>
235<TR>
236 <TD><TT>format=n</TT></TD>
237 <TD>Specifies that the print data is a ditroff file.</TD>
238</TR>
239<TR>
240 <TD><TT>format=o</TT></TD>
241 <TD>Specifies that the print data is a PostScript file.</TD>
242</TR>
243<TR>
244 <TD><TT>format=p</TT></TD>
245 <TD>Specifies that the print data is a plain text file that should be "pretty" printed with a header and footer.</TD>
246</TR>
247<TR>
248 <TD><TT>format=r</TT></TD>
249 <TD>Specifies that the print data is a FORTRAN carriage control file.</TD>
250</TR>
251<TR>
252 <TD><TT>format=t</TT></TD>
253 <TD>Specifies that the print data is a troff Graphic Systems C/A/T phototypesetter file.</TD>
254</TR>
255<TR>
256 <TD><TT>format=v</TT></TD>
257 <TD>Specifies that the print data is a Sun raster file.</TD>
258</TR>
259<TR>
260 <TD><TT>order=data,control</TT></TD>
261 <TD>Specifies that the print data files should be sent before the control file.</TD>
262</TR>
263<TR>
264 <TD><TT>reserve=none</TT></TD>
265 <TD>Specifies that the backend should not reserve a source port.</TD>
266</TR>
267<TR>
268 <TD><TT>reserve=rfc1179</TT></TD>
269 <TD>Specifies that the backend should reserve a source port from 721 to 731 as required by RFC 1179.</TD>
270</TR>
271<TR>
272 <TD><TT>sanitize_title=no</TT></TD>
273 <TD>Specifies that the job title string should not be restricted to ASCII characters.</TD>
274</TR>
275<TR>
276 <TD><TT>sanitize_title=yes</TT></TD>
277 <TD>Specifies that the job title string should be restricted to ASCII characters.</TD>
278</TR>
5a9febac
MS
279<TR>
280 <TD><TT>snmp=false</TT></TD>
281 <TD>Specifies that SNMP supply and page count queries should not be performed.</TD>
282</TR>
b86bc4cf 283<TR>
284 <TD><TT>timeout=<I>seconds</I></TT></TD>
285 <TD>Specifies the number of seconds to wait for LPD commands to complete.</TD>
286</TR>
287</TBODY>
288</TABLE></DIV>
289
290
291<H3><A NAME="URI">Common Network Printer URIs</A></H3>
292
293<P>Once you have set the IP address you can access the printer or print server using the <TT>ipp</TT>, <TT>lpd</TT>, or <TT>socket</TT> backends. <A HREF="#TABLE1">Table 1</A> shows a list of common network interfaces and printer servers and the settings you should use with CUPS:</P>
ef416fc2 294
480ef0fe 295<DIV CLASS="table"><TABLE SUMMARY="Common Device URIs">
b86bc4cf 296<CAPTION>Table 1: <A NAME="TABLE1">Common Device URIs</A></CAPTION>
480ef0fe 297<THEAD>
298<TR>
ef416fc2 299 <TH>Model/Manufacturer</TH>
300 <TH>Device URI(s)</TH>
301</TR>
480ef0fe 302</THEAD>
303<TBODY>
304<TR>
ef416fc2 305 <TD>Apple LaserWriter</TD>
306 <TD>lpd://<I>address</I>/PASSTHRU</TD>
307</TR>
480ef0fe 308<TR>
ef416fc2 309 <TD>Axis w/o IPP<BR>
310 Axis OfficeBasic<BR>
311 <A HREF="#AXIS">(see directions)</A></TD>
312 <TD>socket://<I>address</I>:9100<BR>
313 socket://<I>address</I>:9101<BR>
314 socket://<I>address</I>:9102</TD>
315</TR>
480ef0fe 316<TR>
ef416fc2 317 <TD>Axis w/IPP</TD>
318 <TD>ipp://<I>address</I>/LPT1<BR>
319 ipp://<I>address</I>/LPT2<BR>
320 ipp://<I>address</I>/COM1</TD>
321</TR>
480ef0fe 322<TR>
ef416fc2 323 <TD>Castelle LANpress<SUP>TM</SUP></TD>
324 <TD>lpd://<I>address</I>/pr1<BR>
325 lpd://<I>address</I>/pr2<BR>
326 lpd://<I>address</I>/pr3</TD>
327</TR>
480ef0fe 328<TR>
ef416fc2 329 <TD>DPI NETPrint</TD>
330 <TD>lpd://<I>address</I>/pr1<BR>
331 lpd://<I>address</I>/pr2<BR>
332 lpd://<I>address</I>/pr3</TD>
333</TR>
480ef0fe 334<TR>
ef416fc2 335 <TD>DLink DP-301P+</TD>
336 <TD>socket://<I>address</I></TD>
337</TR>
480ef0fe 338<TR>
ef416fc2 339 <TD>EFI&reg; Fiery&reg; RIP</TD>
340 <TD>lpd://<I>address</I>/print</TD>
341</TR>
480ef0fe 342<TR>
ef416fc2 343 <TD>EPSON&reg; Multiprotocol Ethernet Interface Board</TD>
344 <TD>socket://<I>address</I></TD>
345</TR>
480ef0fe 346<TR>
ef416fc2 347 <TD>Extended System ExtendNET</TD>
348 <TD>lpd://<I>address</I>/pr1<BR>
349 lpd://<I>address</I>/pr2<BR>
350 lpd://<I>address</I>/pr3</TD>
351</TR>
480ef0fe 352<TR>
2fb76298 353 <TD>Hewlett Packard JetDirect</TD>
ef416fc2 354 <TD>socket://<I>address</I>:9100<BR>
355 socket://<I>address</I>:9101<BR>
356 socket://<I>address</I>:9102</TD>
357</TR>
480ef0fe 358<TR>
e1d6a774 359 <TD>Intel&reg; NetportExpress XL, PRO/100</TD>
ef416fc2 360 <TD>lpd://<I>address</I>/LPT1_PASSTHRU<BR>
361 lpd://<I>address</I>/LPT2_PASSTHRU<BR>
362 lpd://<I>address</I>/COM1_PASSTHRU</TD>
363</TR>
480ef0fe 364<TR>
ef416fc2 365 <TD>Lexmark<SUP>TM</SUP> MarkNet</TD>
366 <TD>lpd://<I>address</I>/ps</TD>
367</TR>
480ef0fe 368<TR>
ef416fc2 369 <TD>Linksys EtherFast&reg;<BR>
370 <A HREF="#LINKSYS">(see directions)</A></TD>
371 <TD>socket://<I>address</I>:4010<BR>
372 socket://<I>address</I>:4020<BR>
373 socket://<I>address</I>:4030</TD>
374</TR>
480ef0fe 375<TR>
ef416fc2 376 <TD>Linksys PSUS4</TD>
377 <TD>lpd://<I>address</I>/lp</TD>
378</TR>
480ef0fe 379<TR>
ef416fc2 380 <TD>Kodak&reg;</TD>
381 <TD>lpd://<I>address</I>/ps</TD>
382</TR>
4b3f67ff
MS
383<TR>
384 <TD>Netgear WGPS606</TD>
385 <TD>lpd://<I>address</I>/L1<BR>
386 lpd://<I>address</I>/L2</TD>
387</TR>
480ef0fe 388<TR>
ef416fc2 389 <TD>QMS&reg; CrownNet<SUP>TM</SUP></TD>
390 <TD>lpd://<I>address</I>/ps</TD>
391</TR>
480ef0fe 392<TR>
ef416fc2 393 <TD>Tektronix&reg; PhaserShare<SUP>TM</SUP></TD>
394 <TD>socket://<I>address</I>:9100</TD>
395</TR>
480ef0fe 396<TR>
ef416fc2 397 <TD>XEROX&reg; 4512 NIC</TD>
398 <TD>lpd://<I>address</I>/PORT1</TD>
399</TR>
480ef0fe 400<TR>
ef416fc2 401 <TD>XEROX&reg; XNIC</TD>
402 <TD>lpd://<I>address</I>/PASSTHRU</TD>
403</TR>
480ef0fe 404<TR>
ef416fc2 405 <TD>XEROX&reg; (most others)</TD>
406 <TD>socket://<I>address</I>:5503</TD>
407</TR>
480ef0fe 408</TBODY>
ef416fc2 409</TABLE></DIV>
410
ef416fc2 411
b86bc4cf 412<H2 CLASS="title"><A NAME="SNMP">Troubleshooting SNMP Discovery Problems</A></H2>
413
f3c17241 414<P>Whenever you view the administration web page or a list of supported device URIs, the <tt>snmp</tt> 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.</P>
b86bc4cf 415
f3c17241 416<P>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.</P>
b86bc4cf 417
418<H3>Quick Fixes</H3>
419
f3c17241 420<P>If you don't use "public" as your community name, edit or create (as needed) a text file called <VAR>/etc/cups/snmp.conf</VAR> and put the following line in it:</P>
ef416fc2 421
422<PRE CLASS="command">
b86bc4cf 423Community <I>your community name</I>
ef416fc2 424</PRE>
425
f3c17241 426<P>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.</P>
ef416fc2 427
b86bc4cf 428<H3>Basic Debugging</H3>
ef416fc2 429
b86bc4cf 430<P>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:</P>
ef416fc2 431
432<PRE CLASS="command">
b86bc4cf 433CUPS_DEBUG_LEVEL=2 /usr/lib/cups/backend/snmp 2>&amp;1 | tee snmp.log
ef416fc2 434</PRE>
435
b86bc4cf 436<P>For C shell (/bin/csh) and TCsh (/bin/tcsh), use the following command instead:</P>
ef416fc2 437
438<PRE CLASS="command">
b86bc4cf 439(setenv CUPS_DEBUG_LEVEL 2; /usr/lib/cups/backend/snmp) |& tee snmp.log
ef416fc2 440</PRE>
441
b86bc4cf 442<P>On MacOS X you'll find the SNMP backend in /usr/libexec/cups/backend instead:</P>
ef416fc2 443
444<PRE CLASS="command">
b86bc4cf 445CUPS_DEBUG_LEVEL=2 /usr/libexec/cups/backend/snmp 2>&amp;1 | tee snmp.log
ef416fc2 446</PRE>
447
b86bc4cf 448<P>The output will look something like this:</P>
449
450<PRE STYLE="margin-left: 36pt">
451 1 INFO: Using default SNMP Address @LOCAL
452 2 INFO: Using default SNMP Community public
453 3 DEBUG: Scanning for devices in "public" via "@LOCAL"...
454 4 DEBUG: 0.000 Sending 46 bytes to 192.168.2.255...
455 5 DEBUG: SEQUENCE 44 bytes
456 6 DEBUG: INTEGER 1 bytes 0
457 7 DEBUG: OCTET STRING 6 bytes "public"
458 8 DEBUG: Get-Request-PDU 31 bytes
459 9 DEBUG: INTEGER 4 bytes 1149539174
46010 DEBUG: INTEGER 1 bytes 0
46111 DEBUG: INTEGER 1 bytes 0
46212 DEBUG: SEQUENCE 17 bytes
46313 DEBUG: SEQUENCE 15 bytes
46414 DEBUG: OID 11 bytes .1.3.6.1.2.1.25.3.2.1.2.1
46515 DEBUG: NULL VALUE 0 bytes
46616 DEBUG: 0.001 Received 55 bytes from 192.168.2.229...
46717 DEBUG: community="public"
46818 DEBUG: request-id=1149539174
46919 DEBUG: error-status=0
47020 DEBUG: SEQUENCE 53 bytes
47121 DEBUG: INTEGER 1 bytes 0
47222 DEBUG: OCTET STRING 6 bytes "public"
47323 DEBUG: Get-Response-PDU 40 bytes
47424 DEBUG: INTEGER 4 bytes 1149539174
47525 DEBUG: INTEGER 1 bytes 0
47626 DEBUG: INTEGER 1 bytes 0
47727 DEBUG: SEQUENCE 26 bytes
47828 DEBUG: SEQUENCE 24 bytes
47929 DEBUG: OID 11 bytes .1.3.6.1.2.1.25.3.2.1.2.1
48030 DEBUG: OID 9 bytes .1.3.6.1.2.1.25.3.1.5
48131 DEBUG: add_cache(addr=0xbfffe170, addrname="192.168.2.229",
482 uri="(null)", id="(null)", make_and_model="(null)")
48332 DEBUG: 0.002 Sending 46 bytes to 192.168.2.229...
48433 DEBUG: SEQUENCE 44 bytes
48534 DEBUG: INTEGER 1 bytes 0
48635 DEBUG: OCTET STRING 6 bytes "public"
48736 DEBUG: Get-Request-PDU 31 bytes
48837 DEBUG: INTEGER 4 bytes 1149539175
48938 DEBUG: INTEGER 1 bytes 0
49039 DEBUG: INTEGER 1 bytes 0
49140 DEBUG: SEQUENCE 17 bytes
49241 DEBUG: SEQUENCE 15 bytes
49342 DEBUG: OID 11 bytes .1.3.6.1.2.1.25.3.2.1.3.1
49443 DEBUG: NULL VALUE 0 bytes
49544 DEBUG: 0.003 Received 69 bytes from 192.168.2.229...
49645 DEBUG: community="public"
49746 DEBUG: request-id=1149539175
49847 DEBUG: error-status=0
49948 DEBUG: SEQUENCE 67 bytes
50049 DEBUG: INTEGER 1 bytes 0
50150 DEBUG: OCTET STRING 6 bytes "public"
50251 DEBUG: Get-Response-PDU 54 bytes
50352 DEBUG: INTEGER 4 bytes 1149539175
50453 DEBUG: INTEGER 1 bytes 0
50554 DEBUG: INTEGER 1 bytes 0
50655 DEBUG: SEQUENCE 40 bytes
50756 DEBUG: SEQUENCE 38 bytes
50857 DEBUG: OID 11 bytes .1.3.6.1.2.1.25.3.2.1.3.1
50958 DEBUG: OCTET STRING 23 bytes "HP LaserJet 4000
510 Series"
51159 DEBUG: 1.001 Probing 192.168.2.229...
51260 DEBUG: 1.001 Trying socket://192.168.2.229:9100...
51361 DEBUG: 192.168.2.229 supports AppSocket!
51462 DEBUG: 1.002 Scan complete!
51563 network socket://192.168.2.229 "HP LaserJet 4000 Series"
516 "HP LaserJet 4000 Series 192.168.2.229" ""
ef416fc2 517</PRE>
518
b86bc4cf 519<H3>Dissecting the Output</H3>
ef416fc2 520
b86bc4cf 521<P>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.</P>
ef416fc2 522
b86bc4cf 523<P>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.</P>
ef416fc2 524
b86bc4cf 525<P>Lines 44-58 show the response to the device description query, which tells us that this is an HP LaserJet 4000 Series printer.</P>
ef416fc2 526
b86bc4cf 527<P>On line 59 we start our active connection probe and discover that this print server supports the AppSocket (JetDirect) protocol on port 9100.</P>
ef416fc2 528
b86bc4cf 529<P>Finally, line 63 shows the device information line for the print server that is sent to CUPS.</P>
ef416fc2 530
b86bc4cf 531<H3>Reporting Problems</H3>
ef416fc2 532
b86bc4cf 533If you don't see your printer listed, or the wrong information is listed, then you need to gather more information on the printer. The easiest way to do this is to run the snmpwalk command:
ef416fc2 534
535<PRE CLASS="command">
b86bc4cf 536snmpwalk -Cc -v 1 -c public <I>ip-address</I> | tee snmpwalk.log
ef416fc2 537</PRE>
538
b86bc4cf 539<P>where "ip-address" is the IP address of the printer or print server. You should see a <em>lot</em> of values stream by - the ones you want to see are:</P>
ef416fc2 540
b86bc4cf 541<PRE STYLE="margin-left: 36pt">
542HOST-RESOURCES-MIB::hrDeviceType.1 = OID: HOST-RESOURCES-TYPES::hrDevicePrinter
543HOST-RESOURCES-MIB::hrDeviceDescr.1 = STRING: HP LaserJet 4000 Series
ef416fc2 544</PRE>
545
b86bc4cf 546<P>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".</P>
547
548<P>Once you have collected the snmpwalk output, you should go to the <A HREF="http://www.cups.org/str.php">CUPS Bugs &amp; Features page</A> 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.</P>
549
550
551<H2 CLASS="title"><A NAME="SERVERS">Configuring Print Servers</A></H2>
ef416fc2 552
b86bc4cf 553<H3><A NAME="AXIS">Configuring Axis Print Servers</A></H3>
ef416fc2 554
b86bc4cf 555<P>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.</P>
ef416fc2 556
b86bc4cf 557<P>Each print server contains a configuration file named <VAR>config</VAR> 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 <TT>ftp(1)</TT> program:</P>
ef416fc2 558
559<PRE CLASS="command">
560<KBD>ftp ip-address</KBD>
561Connected to ip-address.
562220 Axis NPS ### FTP Printer Server V#.## MON DD YEAR ready.
563ftp> <KBD>user root</KBD>
564331 User name ok, need password
565Password: <KBD>pass</KBD> <I>(this is not echoed)</I>
566230 User logged in
567ftp> <KBD>get config</KBD>
568local: config remote: config
569200 PORT command successful.
570150 Opening data connection for config (192,0,2,2),
571(mode ascii).
572226 Transfer complete.
573##### bytes received in #.## seconds (##### Kbytes/s)
574ftp> <KBD>quit</KBD>
575221 Goodbye.
576</PRE>
577
b86bc4cf 578<P>Next, edit the file with your favorite text editor and locate the lines beginning with:</P>
ef416fc2 579
580<PRE CLASS="command">
581RTN_OPT. : YES
582RTEL_PR1. : 0
583RTEL_PR2. : 0
584RTEL_PR3. : 0
585RTEL_PR4. : 0
586RTEL_PR5. : 0
587RTEL_PR6. : 0
588RTEL_PR7. : 0
589RTEL_PR8. : 0
590</PRE>
591
b86bc4cf 592<P>Change the <TT>RTN_OPT</TT> line to read:</P>
ef416fc2 593
594<PRE CLASS="command">
595RTN_OPT. : <KBD>NO</KBD>
596</PRE>
597
b86bc4cf 598<P>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:</P>
ef416fc2 599
600<PRE CLASS="command">
601RTEL_PR1. : <KBD>9100</KBD>
602RTEL_PR2. : <KBD>9101</KBD>
603RTEL_PR3. : <KBD>9102</KBD>
604RTEL_PR4. : <KBD>9103</KBD>
605RTEL_PR5. : <KBD>9104</KBD>
606RTEL_PR6. : <KBD>9105</KBD>
607RTEL_PR7. : <KBD>9106</KBD>
608RTEL_PR8. : <KBD>9107</KBD>
609</PRE>
610
b86bc4cf 611<P>This essentially makes the Axis print server look like a Hewlett Packard JetDirect EX print server. Save the file and then upload the new <VAR>config</VAR> file using the <TT>ftp</TT> command:</P>
ef416fc2 612
613<PRE CLASS="command">
614<KBD>ftp ip-address</KBD>
615Connected to ip-address.
616220 Axis NPS ### FTP Printer Server V#.## MON DD YEAR ready.
617ftp> <KBD>user root</KBD>
618331 User name ok, need password
619Password: <KBD>pass</KBD> <I>(this is not echoed)</I>
620230 User logged in
621ftp> <KBD>put config CONFIG</KBD>
622local: config remote: CONFIG
623200 PORT command successful.
624150 Opening data connection for config (192,0,2,2), (mode ascii).
625226 Transfer complete.
626##### bytes received in #.## seconds (##### Kbytes/s)
627ftp> <KBD>get hardreset</KBD>
628local: hardreset remote: hardreset
629200 PORT command successful.
630421 Axis NPS ### hard reset, closing connection.
631ftp> <KBD>quit</KBD>
632221 Goodbye.
633</PRE>
634
635<P>Your Axis print server is now ready for use!</P>
636
b86bc4cf 637<H3><A NAME="LINKSYS">Configuring Linksys Print Servers</A></H3>
ef416fc2 638
b86bc4cf 639<P>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.</P>
ef416fc2 640
b86bc4cf 641<P>Each print server contains a configuration file named <VAR>CONFIG</VAR> 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 <TT>ftp(1)</TT> program:</P>
ef416fc2 642
643<PRE CLASS="command">
644<KBD>ftp -n ip-address</KBD>
645Connected to ip-address.
646220 Print Server Ready.
647Remote system type is Print.
648ftp> <KBD>get CONFIG</KBD>
649local: CONFIG remote: CONFIG
650200 Command OK.
651150 Open ASCII Mode Connection.
652WARNING! 68 bare linefeeds received in ASCII mode
653File may not have transferred correctly.
654226 Transfer complete.
655##### bytes received in #.## seconds (##### Kbytes/s)
656ftp> <KBD>quit</KBD>
657221 Goodbye.
658</PRE>
659
b86bc4cf 660<P>Next, edit the file with your favorite text editor and locate the lines beginning with:</P>
ef416fc2 661
662<PRE CLASS="command">
6630100 L1_PROUT:P1
6640120 L2_PROUT:P1
6650140 L3_PROUT:P1
666</PRE>
667
b86bc4cf 668<P>Change the port number for each parallel and serial port on the server as follows:</P>
ef416fc2 669
670<PRE CLASS="command">
6710100 L1_PROUT:<KBD>P1</KBD>
6720120 L2_PROUT:<KBD>P2</KBD>
6730140 L3_PROUT:<KBD>P3</KBD>
674</PRE>
675
b86bc4cf 676<P>This maps each virtual printer with a physical port. Save the file and then upload the new <VAR>CONFIG</VAR> file using the <TT>ftp</TT> command:</P>
ef416fc2 677
678<PRE CLASS="command">
679<KBD>ftp -n ip-address</KBD>
680Connected to ip-address.
681220 Print Server Ready.
682Remote system type is Print.
683ftp> <KBD>put CONFIG</KBD>
684local: CONFIG remote: CONFIG
685200 Command OK.
686150 Open ASCII Mode Connection.
687226 Transfer complete.
688##### bytes received in #.## seconds (##### Kbytes/s)
689ftp> <KBD>quit</KBD>
690221 Goodbye.
691</PRE>
692
693<P>Your Linksys print server is now ready for use!</P>
694
ef416fc2 695</BODY>
696</HTML>