doc/html/ref/ping-command.html

   1 <!-- Copyright (C) 2003 Red Hat, Inc.                                -->
   2 <!-- This material may be distributed only subject to the terms      -->
   3 <!-- and conditions set forth in the Open Publication License, v1.0  -->
   4 <!-- or later (the latest version is presently available at          -->
   5 <!-- http://www.opencontent.org/openpub/).                           -->
   6 <!-- Distribution of the work or derivative of the work in any       -->
   7 <!-- standard (paper) book form is prohibited unless prior           -->
   8 <!-- permission is obtained from the copyright holder.               -->
   9 <HTML
  10 ><HEAD
  11 ><TITLE
  12 >ping</TITLE
  13 ><meta name="MSSmartTagsPreventParsing" content="TRUE">
  14 <META
  15 NAME="GENERATOR"
  16 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
  17 "><LINK
  18 REL="HOME"
  19 TITLE="eCos Reference Manual"
  20 HREF="ecos-ref.html"><LINK
  21 REL="UP"
  22 TITLE="Common Commands"
  23 HREF="common-commands.html"><LINK
  24 REL="PREVIOUS"
  25 TITLE="mfill"
  26 HREF="mfill-command.html"><LINK
  27 REL="NEXT"
  28 TITLE="reset"
  29 HREF="reset-command.html"></HEAD
  30 ><BODY
  31 CLASS="REFENTRY"
  32 BGCOLOR="#FFFFFF"
  33 TEXT="#000000"
  34 LINK="#0000FF"
  35 VLINK="#840084"
  36 ALINK="#0000FF"
  37 ><DIV
  38 CLASS="NAVHEADER"
  39 ><TABLE
  40 SUMMARY="Header navigation table"
  41 WIDTH="100%"
  42 BORDER="0"
  43 CELLPADDING="0"
  44 CELLSPACING="0"
  45 ><TR
  46 ><TH
  47 COLSPAN="3"
  48 ALIGN="center"
  49 >eCos Reference Manual</TH
  50 ></TR
  51 ><TR
  52 ><TD
  53 WIDTH="10%"
  54 ALIGN="left"
  55 VALIGN="bottom"
  56 ><A
  57 HREF="mfill-command.html"
  58 ACCESSKEY="P"
  59 >Prev</A
  60 ></TD
  61 ><TD
  62 WIDTH="80%"
  63 ALIGN="center"
  64 VALIGN="bottom"
  65 ></TD
  66 ><TD
  67 WIDTH="10%"
  68 ALIGN="right"
  69 VALIGN="bottom"
  70 ><A
  71 HREF="reset-command.html"
  72 ACCESSKEY="N"
  73 >Next</A
  74 ></TD
  75 ></TR
  76 ></TABLE
  77 ><HR
  78 ALIGN="LEFT"
  79 WIDTH="100%"></DIV
  80 ><H1
  81 ><A
  82 NAME="PING-COMMAND">ping</H1
  83 ><DIV
  84 CLASS="REFNAMEDIV"
  85 ><A
  86 NAME="AEN3744"
  87 ></A
  88 ><H2
  89 >Name</H2
  90 >ping&nbsp;--&nbsp;Verify network connectivity</DIV
  91 ><DIV
  92 CLASS="REFSYNOPSISDIV"
  93 ><A
  94 NAME="AEN3747"><H2
  95 >Synopsis</H2
  96 ><P
  97 ><B
  98 CLASS="COMMAND"
  99 >ping</B
 100 >  [-v ] [-i <TT
 101 CLASS="REPLACEABLE"
 102 ><I
 103 > local_IP_address</I
 104 ></TT
 105 >] [-l <TT
 106 CLASS="REPLACEABLE"
 107 ><I
 108 > length</I
 109 ></TT
 110 >] [-n <TT
 111 CLASS="REPLACEABLE"
 112 ><I
 113 > count</I
 114 ></TT
 115 >] [-t <TT
 116 CLASS="REPLACEABLE"
 117 ><I
 118 > timeout</I
 119 ></TT
 120 >] [-r <TT
 121 CLASS="REPLACEABLE"
 122 ><I
 123 > rate</I
 124 ></TT
 125 >] {-h <TT
 126 CLASS="REPLACEABLE"
 127 ><I
 128 > server_IP_address</I
 129 ></TT
 130 >}</P
 131 ></DIV
 132 ><DIV
 133 CLASS="REFSECT1"
 134 ><A
 135 NAME="AEN3763"
 136 ></A
 137 ><H2
 138 >Arguments</H2
 139 ><DIV
 140 CLASS="INFORMALTABLE"
 141 ><A
 142 NAME="AEN3765"><P
 143 ></P
 144 ><TABLE
 145 BORDER="1"
 146 CLASS="CALSTABLE"
 147 ><THEAD
 148 ><TR
 149 ><TH
 150 WIDTH="25%"
 151 ALIGN="LEFT"
 152 VALIGN="TOP"
 153 >Name</TH
 154 ><TH
 155 WIDTH="25%"
 156 ALIGN="LEFT"
 157 VALIGN="TOP"
 158 >Type</TH
 159 ><TH
 160 WIDTH="25%"
 161 ALIGN="LEFT"
 162 VALIGN="TOP"
 163 >Description</TH
 164 ><TH
 165 WIDTH="25%"
 166 ALIGN="LEFT"
 167 VALIGN="TOP"
 168 >Default</TH
 169 ></TR
 170 ></THEAD
 171 ><TBODY
 172 ><TR
 173 ><TD
 174 WIDTH="25%"
 175 ALIGN="LEFT"
 176 VALIGN="TOP"
 177 >-v</TD
 178 ><TD
 179 WIDTH="25%"
 180 ALIGN="LEFT"
 181 VALIGN="TOP"
 182 >Boolean</TD
 183 ><TD
 184 WIDTH="25%"
 185 ALIGN="LEFT"
 186 VALIGN="TOP"
 187 >Be verbose, displaying information about each packet sent.</TD
 188 ><TD
 189 WIDTH="25%"
 190 ALIGN="LEFT"
 191 VALIGN="TOP"
 192 ><SPAN
 193 CLASS="emphasis"
 194 ><I
 195 CLASS="EMPHASIS"
 196 >quiet</I
 197 ></SPAN
 198 ></TD
 199 ></TR
 200 ><TR
 201 ><TD
 202 WIDTH="25%"
 203 ALIGN="LEFT"
 204 VALIGN="TOP"
 205 >-n <TT
 206 CLASS="REPLACEABLE"
 207 ><I
 208 >local_IP_address</I
 209 ></TT
 210 ></TD
 211 ><TD
 212 WIDTH="25%"
 213 ALIGN="LEFT"
 214 VALIGN="TOP"
 215 >Number</TD
 216 ><TD
 217 WIDTH="25%"
 218 ALIGN="LEFT"
 219 VALIGN="TOP"
 220 >Controls the number of packets to be sent.</TD
 221 ><TD
 222 WIDTH="25%"
 223 ALIGN="LEFT"
 224 VALIGN="TOP"
 225 >10</TD
 226 ></TR
 227 ><TR
 228 ><TD
 229 WIDTH="25%"
 230 ALIGN="LEFT"
 231 VALIGN="TOP"
 232 >-i <TT
 233 CLASS="REPLACEABLE"
 234 ><I
 235 >local_IP_address</I
 236 ></TT
 237 ></TD
 238 ><TD
 239 WIDTH="25%"
 240 ALIGN="LEFT"
 241 VALIGN="TOP"
 242 >Numeric IP or DNS name</TD
 243 ><TD
 244 WIDTH="25%"
 245 ALIGN="LEFT"
 246 VALIGN="TOP"
 247 >The IP address RedBoot should use.</TD
 248 ><TD
 249 WIDTH="25%"
 250 ALIGN="LEFT"
 251 VALIGN="TOP"
 252 >Value set by <B
 253 CLASS="COMMAND"
 254 >ip_address</B
 255 ></TD
 256 ></TR
 257 ><TR
 258 ><TD
 259 WIDTH="25%"
 260 ALIGN="LEFT"
 261 VALIGN="TOP"
 262 >-h <TT
 263 CLASS="REPLACEABLE"
 264 ><I
 265 >server_IP_address</I
 266 ></TT
 267 ></TD
 268 ><TD
 269 WIDTH="25%"
 270 ALIGN="LEFT"
 271 VALIGN="TOP"
 272 >Numeric IP or DNS name</TD
 273 ><TD
 274 WIDTH="25%"
 275 ALIGN="LEFT"
 276 VALIGN="TOP"
 277 >The IP address of the host to contact.</TD
 278 ><TD
 279 WIDTH="25%"
 280 ALIGN="LEFT"
 281 VALIGN="TOP"
 282 ><SPAN
 283 CLASS="emphasis"
 284 ><I
 285 CLASS="EMPHASIS"
 286 >none</I
 287 ></SPAN
 288 ></TD
 289 ></TR
 290 ><TR
 291 ><TD
 292 WIDTH="25%"
 293 ALIGN="LEFT"
 294 VALIGN="TOP"
 295 >-l <TT
 296 CLASS="REPLACEABLE"
 297 ><I
 298 >length</I
 299 ></TT
 300 ></TD
 301 ><TD
 302 WIDTH="25%"
 303 ALIGN="LEFT"
 304 VALIGN="TOP"
 305 >Number</TD
 306 ><TD
 307 WIDTH="25%"
 308 ALIGN="LEFT"
 309 VALIGN="TOP"
 310 >The length of the ICMP data payload.</TD
 311 ><TD
 312 WIDTH="25%"
 313 ALIGN="LEFT"
 314 VALIGN="TOP"
 315 >64</TD
 316 ></TR
 317 ><TR
 318 ><TD
 319 WIDTH="25%"
 320 ALIGN="LEFT"
 321 VALIGN="TOP"
 322 >-r <TT
 323 CLASS="REPLACEABLE"
 324 ><I
 325 >length</I
 326 ></TT
 327 ></TD
 328 ><TD
 329 WIDTH="25%"
 330 ALIGN="LEFT"
 331 VALIGN="TOP"
 332 >Number</TD
 333 ><TD
 334 WIDTH="25%"
 335 ALIGN="LEFT"
 336 VALIGN="TOP"
 337 >How fast to deliver packets, i.e. time between successive sends.
 338 A value of 0 sends packets as quickly as possible.</TD
 339 ><TD
 340 WIDTH="25%"
 341 ALIGN="LEFT"
 342 VALIGN="TOP"
 343 >1000ms (1 second)</TD
 344 ></TR
 345 ><TR
 346 ><TD
 347 WIDTH="25%"
 348 ALIGN="LEFT"
 349 VALIGN="TOP"
 350 >-t <TT
 351 CLASS="REPLACEABLE"
 352 ><I
 353 >length</I
 354 ></TT
 355 ></TD
 356 ><TD
 357 WIDTH="25%"
 358 ALIGN="LEFT"
 359 VALIGN="TOP"
 360 >Number</TD
 361 ><TD
 362 WIDTH="25%"
 363 ALIGN="LEFT"
 364 VALIGN="TOP"
 365 >How long to wait for the round-trip to complete, specified in milliseconds.</TD
 366 ><TD
 367 WIDTH="25%"
 368 ALIGN="LEFT"
 369 VALIGN="TOP"
 370 >1000ms (1 second)</TD
 371 ></TR
 372 ></TBODY
 373 ></TABLE
 374 ><P
 375 ></P
 376 ></DIV
 377 ></DIV
 378 ><DIV
 379 CLASS="REFSECT1"
 380 ><A
 381 NAME="AEN3822"
 382 ></A
 383 ><H2
 384 >Description</H2
 385 ><P
 386 >The <B
 387 CLASS="COMMAND"
 388 >ping</B
 389 > command checks the connectivity of the local network by sending
 390 special (ICMP) packets to a specific host. These packets should be automatically
 391 returned by that host. The command will indicate how many of these round-trips
 392 were successfully completed.
 393       </P
 394 ></DIV
 395 ><DIV
 396 CLASS="REFSECT1"
 397 ><A
 398 NAME="AEN3826"
 399 ></A
 400 ><H2
 401 >Examples</H2
 402 ><P
 403 >Test connectivity to host 192.168.1.101.
 404 <TABLE
 405 BORDER="5"
 406 BGCOLOR="#E0E0F0"
 407 WIDTH="70%"
 408 ><TR
 409 ><TD
 410 ><PRE
 411 CLASS="SCREEN"
 412 >RedBoot&#62; <TT
 413 CLASS="USERINPUT"
 414 ><B
 415 >ping -h 192.168.1.101</B
 416 ></TT
 417 >
 418 Network PING - from 192.168.1.31 to 192.168.1.101
 419 PING - received 10 of 10 expected</PRE
 420 ></TD
 421 ></TR
 422 ></TABLE
 423 > </P
 424 ><P
 425 >Test connectivity to host 192.168.1.101, with verbose reporting.
 426 <TABLE
 427 BORDER="5"
 428 BGCOLOR="#E0E0F0"
 429 WIDTH="70%"
 430 ><TR
 431 ><TD
 432 ><PRE
 433 CLASS="SCREEN"
 434 >RedBoot&#62; <TT
 435 CLASS="USERINPUT"
 436 ><B
 437 >ping -h 192.168.1.101 -v -n 4</B
 438 ></TT
 439 >
 440 Network PING - from 192.168.1.31 to 192.168.1.101
 441  seq: 1, time: 1 (ticks)
 442  seq: 2, time: 1 (ticks)
 443  seq: 3, time: 1 (ticks)
 444  seq: 4, time: 1 (ticks)
 445 PING - received 10 of 10 expected</PRE
 446 ></TD
 447 ></TR
 448 ></TABLE
 449 > </P
 450 ><P
 451 ><TABLE
 452 BORDER="5"
 453 BGCOLOR="#E0E0F0"
 454 WIDTH="70%"
 455 ><TR
 456 ><TD
 457 ><PRE
 458 CLASS="SCREEN"
 459 >Test connectivity to a non-existent host (192.168.1.109).
 460 RedBoot&#62; <TT
 461 CLASS="USERINPUT"
 462 ><B
 463 >ping -h 192.168.1.109 -v -n 4</B
 464 ></TT
 465 >
 466 PING: Cannot reach server '192.168.1.109' (192.168.1.109)</PRE
 467 ></TD
 468 ></TR
 469 ></TABLE
 470 >
 471       </P
 472 ></DIV
 473 ><DIV
 474 CLASS="NAVFOOTER"
 475 ><HR
 476 ALIGN="LEFT"
 477 WIDTH="100%"><TABLE
 478 SUMMARY="Footer navigation table"
 479 WIDTH="100%"
 480 BORDER="0"
 481 CELLPADDING="0"
 482 CELLSPACING="0"
 483 ><TR
 484 ><TD
 485 WIDTH="33%"
 486 ALIGN="left"
 487 VALIGN="top"
 488 ><A
 489 HREF="mfill-command.html"
 490 ACCESSKEY="P"
 491 >Prev</A
 492 ></TD
 493 ><TD
 494 WIDTH="34%"
 495 ALIGN="center"
 496 VALIGN="top"
 497 ><A
 498 HREF="ecos-ref.html"
 499 ACCESSKEY="H"
 500 >Home</A
 501 ></TD
 502 ><TD
 503 WIDTH="33%"
 504 ALIGN="right"
 505 VALIGN="top"
 506 ><A
 507 HREF="reset-command.html"
 508 ACCESSKEY="N"
 509 >Next</A
 510 ></TD
 511 ></TR
 512 ><TR
 513 ><TD
 514 WIDTH="33%"
 515 ALIGN="left"
 516 VALIGN="top"
 517 >mfill</TD
 518 ><TD
 519 WIDTH="34%"
 520 ALIGN="center"
 521 VALIGN="top"
 522 ><A
 523 HREF="common-commands.html"
 524 ACCESSKEY="U"
 525 >Up</A
 526 ></TD
 527 ><TD
 528 WIDTH="33%"
 529 ALIGN="right"
 530 VALIGN="top"
 531 >reset</TD
 532 ></TR
 533 ></TABLE
 534 ></DIV
 535 ></BODY
 536 ></HTML
 537 >