mdustats.1.html 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  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. mdustats.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='mdiodump.1.html' title=' mdiodump.1 '>PREV</a>]
  17. [<a href='toolkit.html' title=' Index '>HOME</a>]
  18. [<a href='mme.1.html' title=' mme.1 '>NEXT</a>]
  19. </div>
  20. <pre>
  21. mdustats(1) Qualcomm Atheros Open Powerline Toolkit mdustats(1)
  22. NAME
  23. mdustats
  24. SYNOPSIS
  25. mdustats [options] [device] [device] [...]
  26. DESCRIPTION
  27. Collect and display MDU traffic statisitcs using the Qualcomm Atheros vendor specific VS_MDU_TRAFFIC_STATS message.
  28. This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
  29. instructions.
  30. OPTIONS
  31. -c command
  32. An integer indicating the type of statistics to be collected and reported. Permitted values are 0 through 255
  33. decimal but only 4 through 15 are valid at this time. This option is mandatory because the default value of 0 is
  34. invalid.
  35. 4 - retrieve traffic statistics on the slave side
  36. 5 - retrieve traffic statistics (master TX/RX) collected on the master side
  37. 6 - retrieve traffic statistics (slave TX/RX) collected on the master side
  38. 7 - retrieve traffic statistics (master/slave TX/RX) collected on the master side
  39. 8 - clear traffic statistics on the slave side
  40. 9 - clear traffic statistics (master TX/RX) colleted on the master side
  41. 10 - clear traffic statistics (slave TX/RX) collected on the master side
  42. 11 - clear traffic statistics (master/slave TX/RX) collected on the master side
  43. 12 - retrieve then clear traffic statistics collected on the slave side
  44. 13 - retrieve then clear traffic statistics (master TX/RX) collected on the master side
  45. 14 - retrieve then clear traffic statistics (slave TX/RX) collected on the master side
  46. 15 - retrieve then clear traffic statistics (master/slave TX/RX) collected on the master side
  47. -s session
  48. The session identifier used to associate request/confirm message pairs. Valid identifiers are 0 through 255. The
  49. default is 0.
  50. -t milliseconds
  51. Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
  52. response. The default is shown in brackets on the program menu.
  53. -u unit
  54. The slave unit number. This is the same as the slave Terminal Equipment Identifier or TEI. Valid unit numbers
  55. are 0 through 255. Unit 0 is the default. This option is ignored when option -c specified any of the &quot;slave
  56. side&quot; commands 4, 8 or 12.
  57. -v Print additional information on stdout.
  58. -x Cause the program to exit on the first error instead of continuing with remaining iterations, operations or
  59. devices. Normally, the program reports errors and moves on to the next operation, iteration or device depending
  60. on the command line.
  61. -?,--help
  62. Print program help summary on stdout. This option takes precedence over other options on the command line.
  63. -?,--version
  64. Print program version information on stdout. This option takes precedence over other options on the command line.
  65. Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
  66. the Linux Toolkit you are using.
  67. ARGUMENTS
  68. device The Ethernet hardware address of some powerline device. More than one address may be specified on the command
  69. line. If more than one address is specified then operations are performed on each device in turn. The default
  70. address is local. as explained in the DEVICES section.
  71. DEVICES
  72. Powerline devices use Ethernet hardware, or Media Access Control (MAC), addresses. Device addresses are expressed as 12
  73. hexadecimal digits (0123456789ABCDEFabcdef) in upper, lower or mixed case. Individual octets may be separated by colons,
  74. for clarity, but not all octets need to be seperated. For example, &quot;00b052000001&quot;, &quot;00:b0:52:00:00:01&quot; and
  75. &quot;00b052:000001&quot; are valid and equivalent.
  76. These symbolic addresses are recognized by this program and may be used instead of the actual address value.
  77. all Equivalent to &quot;broadcast&quot;, described next.
  78. broadcast
  79. A synonym for the standard Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or
  80. foreign will respond to this address.
  81. local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
  82. Atheros devices will recognize this address but remote and foreign devices will not. A remote device is any
  83. device at the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
  84. REFERENCES
  85. See the Qualcomm Atheros Powerline Firmware Technical Reference Manual for more information about MDU powerline configu‐
  86. ration and the VS_MDU_TRAFFIC_STATS message type.
  87. DISCLAIMER
  88. Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
  89. USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
  90. structure or content in future firmware releases without any obligation to notify or compensate users of this program.
  91. EXAMPLES
  92. The following example collects and displays MDU traffic statistics on the slave side of the local device because option
  93. -c is 4. The local device is implicit because no device is specified on the command line.
  94. # mdustats -c 4
  95. The next example collects and displays MDU traffic statistics for slave 2 on the master side of device 00:b0:52:9F:E0:14
  96. because option -c is 5 and option -s is 2. The master device is explicit in this example.
  97. # mdustats -c 5 -u 2 00b0529FE014
  98. SEE ALSO
  99. plc(1), int6kstat(1), sada(1)
  100. CREDITS
  101. Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
  102. open-plc-utils-0.0.3 Mar 2014 mdustats(1)
  103. </pre>
  104. <div class='footerlink'>
  105. [<a href='mdiodump.1.html' title=' mdiodump.1 '>PREV</a>]
  106. [<a href='toolkit.html' title=' Index '>HOME</a>]
  107. [<a href='mme.1.html' title=' mme.1 '>NEXT</a>]
  108. </div>
  109. </body>
  110. </html>