coqos_info.1.html 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  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. coqos_info.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='coqos_add.1.html' title=' coqos_add.1 '>PREV</a>]
  17. [<a href='toolkit.html' title=' Index '>HOME</a>]
  18. [<a href='coqos_man.1.html' title=' coqos_man.1 '>NEXT</a>]
  19. </div>
  20. <pre>
  21. coqos_info(1) Qualcomm Atheros Open Powerline Toolkit coqos_info(1)
  22. NAME
  23. coqos_info - CoQoS Stream Utility
  24. SYNOPSIS
  25. coqos_info [options] type [cid] [limit] [device]
  26. DESCRIPTION
  27. This page is under construction.
  28. None.
  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. -e Redirects stderr messages to stdout. By convention progress messages and error messages are printed on stderr
  33. while primary program output is printed on stdout. This option prints all output on stdout in cases where this is
  34. desired.
  35. -i interface
  36. Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
  37. this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
  38. network connection; however, if environment string &quot;PLC&quot; is defined then it takes precedence over the default
  39. interface. This option then takes precedence over either default.
  40. -q Suppresses status messages on stderr.
  41. -r Display relative memory offsets on output. This option is the default.
  42. -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
  43. -?,--help
  44. Displays program help information on stderr. This option takes precedence over all other options on the command
  45. line except version information.
  46. -!,--version
  47. Displays program version information on stderr. This option takes precedence over all other options on the com‐
  48. mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
  49. ARGUMENTS
  50. type The request type. Valid types are &quot;STA&quot;, &quot;CID&quot;, &quot;RSVD&quot;, &quot;VIC&quot;, &quot;BW&quot;, and &quot;BW&quot;. Individual request types are
  51. described below.
  52. device The MAC address of some powerline device. More than one address may be specified on the command line. If more
  53. than one address is specified then operations are performed on each device in turn. The default address is
  54. &quot;local&quot;. See DEVICES for more information.
  55. TYPES
  56. STA Station. Request information on all active connections for this station.
  57. CID number
  58. Connection identifier. If present, it must be followed by a valid connection identifier. Connection identifiers
  59. are assigned when the connection is added using program coqos_add. The connection identifier is two bytes where
  60. byte 0 is the LLID-F and byte 1 is the OrigTEI.
  61. RSVD Reserved. Sets REQ_TYPE = 2 in the mme.
  62. VIC Vicinity. Provide all active connections in the vicinity.
  63. BW number
  64. Bandwidth. set station to provide info when the limit is exceeded. BW must be followed by a number. This number
  65. is in units of 10kbps. BWC cancels all previous requests.
  66. DEVICES
  67. Ethernet MAC addresses are expressed as six hexadecimal octets optionally separated by colon. For example, the Qualcomm
  68. Atheros Local Management Address (LMA) of &quot;00b052000001&quot; may also be entered as &quot;00:b0:52:00:00:01&quot; or &quot;00b052:000001&quot;.
  69. Addresses are case insensitive and quotes are optional. In addition, some special addresses may be entered by name
  70. rather than number where names are case sensitive.
  71. all A synonym for the &quot;broadcast&quot; address, described next.
  72. broadcast
  73. A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
  74. will respond to this address.
  75. local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
  76. Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
  77. the far end of a powerline connection. A foreign device is any device not manufactured by Atheros. See the Qual‐
  78. comm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
  79. DISCLAIMER
  80. Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
  81. USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
  82. structure and content in future firmware releases without any obligation to notify or compensate users of this program.
  83. EXAMPLES
  84. This command requests connection from the station
  85. # coqos_info STA 00:B0:52:BA:BE:01
  86. This command set the station to provide notification if the bandwidth used exceeds 20mbps
  87. # coqos_info BW 2000 00:B0:52:BA:BE:01
  88. SEE ALSO
  89. coqos_add(1), coqos_rel(1), coqos_man(1), coqos_mod(1)
  90. CREDITS
  91. Bill Wike &lt;bill.wike@qca.qualcomm.com&gt;
  92. Nathaniel Houghton &lt;nhoughto@qca.qualcomm.com&gt;
  93. Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
  94. open-plc-utils-0.0.3 Mar 2014 coqos_info(1)
  95. </pre>
  96. <div class='footerlink'>
  97. [<a href='coqos_add.1.html' title=' coqos_add.1 '>PREV</a>]
  98. [<a href='toolkit.html' title=' Index '>HOME</a>]
  99. [<a href='coqos_man.1.html' title=' coqos_man.1 '>NEXT</a>]
  100. </div>
  101. </body>
  102. </html>