int6kstat.1.html 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  1. <?xml version='1.0' encoding='iso-8859-1'?>
  2. <!doctype html public '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
  3. <html xmlns='http://www.w3c.org/1999/xhtml' lang='en-us'>
  4. <head>
  5. <title>
  6. int6kstat.1
  7. </title>
  8. <meta http-equiv='content-type' content='text/html;iso-8859-1'/>
  9. <meta name='generator' content='motley-tools 1.9.4 13:40:33 Feb 18 2015'/>
  10. <meta name='author' content='cmaier@cmassoc.net'/>
  11. <meta name='robots' content='noindex,nofollow'/>
  12. <link href='toolkit.css' rel='stylesheet' type='text/css'/>
  13. </head>
  14. <body>
  15. <div class='headerlink'>
  16. [<a href='int6krule.1.html' title=' int6krule.1 '>PREV</a>]
  17. [<a href='toolkit.html' title=' Index '>HOME</a>]
  18. [<a href='int6ktest.1.html' title=' int6ktest.1 '>NEXT</a>]
  19. </div>
  20. <pre>
  21. int6kstat(1) Qualcomm Atheros Open Powerline Toolkit int6kstat(1)
  22. NAME
  23. int6kstat - Qualcomm Atheros INT6x00 Link Statistics
  24. SYNOPSIS
  25. int6kstat [options] [device] [device] [...]
  26. DESCRIPTION
  27. The Atheros Device Statistics Utility polls a device and prints network and link statistics in various formats suitable
  28. for use by other programs. This is a work in progress so usr feedback is encouraged.
  29. This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
  30. instructions.
  31. OPTIONS
  32. -C Clear device link statistics using VS_LNK_STATS. Statistics are read and cleared then displayed. The statistics
  33. that are read and displayed depend on options -d, -p and -s but all link statistics are cleared.
  34. -d direction
  35. Return statistics for the specified direction using VS_LNK_STATS. Direction can be 0=tx, 1=rx, 2=both or &quot;rx&quot;,
  36. &quot;tx&quot; or &quot;both&quot;.
  37. -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
  38. program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
  39. -i Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
  40. this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
  41. network connection; however, if environment string &quot;PLC&quot; is defined then it takes precedence over the default
  42. interface. This option then takes precedence over either default.
  43. -l count
  44. Define the number of times that the command will be repeated for each device specified. Normally, you will repeat
  45. operations on one device only.
  46. -m Displays network membership information, as seen by one device, using VS_NW_INFO. Use option -t for complete net‐
  47. work topology seen by the local host.
  48. -p peernode
  49. Ethernet hardware address of the peer node for VS_LNK_STATS. This option is required for all Link ID values
  50. except 0xFC. The default is 00:00:00:00:00:00.
  51. -q Enter quiet mode. Progress messages are suppressed.
  52. -s linkid
  53. The Link ID for VS_LNK_STATS. Link ID values range from 0 through 255 but not all values are accepted by the
  54. device firmware. Values may be expressed in decimal, binary prefixed with &quot;0b&quot; or hexadecimal prefixed by &quot;0x&quot;.
  55. Many valid values can be expressed by name. Valid values are listed and explained under LINKID. The default Link
  56. ID is 0xFC.
  57. -t Display network topology using VS_SW_VER and VS_NW_INFO messages. This option is similar to option -m but pro‐
  58. vides complete network topology plus device hardware and firmware version. Topology is always relative to the
  59. local host, or local hosts if present. Powerline devices that appear on the command line are not used for this
  60. operation. PHY rates displaye by this option may saturate at 255 mbps.
  61. -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
  62. -w seconds
  63. Defines the number of seconds to wait before repeating command line options. This option has no effect unless
  64. option -l is also specified with a non-zero value.
  65. -?, --help
  66. Print program help summary on stdout. This option takes precedence over other options on the command line.
  67. -!, --version
  68. Print program version information on stdout. This option takes precedence over other options on the command line.
  69. Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
  70. the Linux Toolkit you are using.
  71. ARGUMENTS
  72. device The MAC address of some powerline device. More than one address may be specified. If more than one address is
  73. specified then operations are performed on each device in turn. The default address is local. See DEVICES for
  74. information about symbolic device addresses.
  75. LINKID
  76. 0x00,CSMA-CAP0
  77. Display CSMA statistics for CAP0 traffic using a single peer node. The peer node MAC address must be specified
  78. using option -p.
  79. 0x01,CSMA-CAP1
  80. Display CSMA statistics for CAP1 traffic using a single peer node. The peer node MAC address must be specified
  81. using option -p.
  82. 0x02,CSMA-CAP2
  83. Display CSMA statistics for CAP2 traffic using a single peer node. The peer node MAC address must be specified
  84. using option -p.
  85. 0x03,CSMA-CAP3
  86. Display CSMA statistics for CAP3 traffic using a single peer node. The peer node MAC address must be specified
  87. using option -p.
  88. 0xF8,CSMA-PEER
  89. Display CSMA statistics for all traffic using a single peer node. The peer node MAC address must be specified
  90. using option -p.
  91. 0xFC,CSMA-ALL
  92. Display CSMA statistics for all traffic with all peer nodes. A peer node MAC address is not needed and will be
  93. ignored if provided. This value is the default for option -s.
  94. DEVICES
  95. Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
  96. decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
  97. &quot;00b052000001&quot;, &quot;00:b0:52:00:00:01&quot; and &quot;00b052:000001&quot; are valid and equivalent.
  98. The following MAC addresses are special and may be entered by name instead of number.
  99. all Same as &quot;broadcast&quot;.
  100. broadcast
  101. A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
  102. recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
  103. A foreign device is any device not manufactured by Atheros.
  104. local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
  105. Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
  106. the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
  107. REFERENCES
  108. See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
  109. DISCLAIMER
  110. Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
  111. Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
  112. sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
  113. gram.
  114. EXAMPLES
  115. None.
  116. SEE ALSO
  117. plc(1), int6krate(1), int6krule(1), int6ktone(1)
  118. CREDITS
  119. Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
  120. open-plc-utils-0.0.3 Mar 2014 int6kstat(1)
  121. </pre>
  122. <div class='footerlink'>
  123. [<a href='int6krule.1.html' title=' int6krule.1 '>PREV</a>]
  124. [<a href='toolkit.html' title=' Index '>HOME</a>]
  125. [<a href='int6ktest.1.html' title=' int6ktest.1 '>NEXT</a>]
  126. </div>
  127. </body>
  128. </html>