OSS.SNMP.MIBS.LAG.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  1. <!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  4. <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
  5. <meta charset="utf-8">
  6. <title>OSS_SNMP » \OSS\SNMP\MIBS\LAG</title>
  7. <meta name="author" content="Mike van Riel">
  8. <meta name="description" content="">
  9. <link href="../css/template.css" rel="stylesheet" media="all">
  10. <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
  11. <link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
  12. <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
  13. <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
  14. </head>
  15. <body>
  16. <div class="navbar navbar-fixed-top">
  17. <div class="navbar-inner"><div class="container">
  18. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">OSS_SNMP</a><div class="nav-collapse"><ul class="nav">
  19. <li class="dropdown">
  20. <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
  21. API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
  22. <li><a>Namespaces</a></li>
  23. <li><a href="../namespaces/OSS.html"><i class="icon-th"></i> OSS</a></li>
  24. </ul>
  25. </li>
  26. <li class="dropdown" id="charts-menu">
  27. <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
  28. Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
  29. </li>
  30. <li class="dropdown" id="reports-menu">
  31. <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
  32. Reports <b class="caret"></b></a><ul class="dropdown-menu">
  33. <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
  34. <span class="label label-info">25</span></a></li>
  35. <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
  36. <ul></ul></a></li>
  37. <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
  38. <span class="label label-info">0</span></a></li>
  39. </ul>
  40. </li>
  41. </ul></div>
  42. </div></div>
  43. <div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
  44. </div>
  45. <div id="___" class="container">
  46. <noscript><div class="alert alert-warning">
  47. Javascript is disabled; several features are only available
  48. if Javascript is enabled.
  49. </div></noscript>
  50. <div class="row">
  51. <div class="span4">
  52. <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
  53. <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
  54. </div>
  55. <ul class="side-nav nav nav-list">
  56. <li class="nav-header">
  57. <i class="icon-custom icon-method"></i> Methods</li>
  58. <li class="method public "><a href="#findFailedLAGPorts" title="findFailedLAGPorts :: Utility function to identify configured but unattached LAG ports"><span class="description">Utility function to identify configured but unattached LAG ports</span><pre>findFailedLAGPorts()</pre></a></li>
  59. <li class="method public "><a href="#getLAGPorts" title="getLAGPorts :: Gets an associate array of LAG ports with the [id] =&gt; name of it's constituent ports"><span class="description">Gets an associate array of LAG ports with the [id] =&gt; name of it's constituent ports</span><pre>getLAGPorts()</pre></a></li>
  60. <li class="method public "><a href="#isAggregatePorts" title="isAggregatePorts :: Returns an associate array of port IDs with a boolean value to indicate if it's an aggregate port (true)
  61. or an individual port (false)."><span class="description">Returns an associate array of port IDs with a boolean value to indicate if it's an aggregate port (true)
  62. or an individual port (false).</span><pre>isAggregatePorts()</pre></a></li>
  63. <li class="method public "><a href="#portAttachedIds" title="portAttachedIds :: Returns an associate array of port IDs with the ID of the aggregate port that
  64. they are a member of (else 0 if not a LAG port)"><span class="description">Returns an associate array of port IDs with the ID of the aggregate port that
  65. they are a member of (else 0 if not a LAG port)</span><pre>portAttachedIds()</pre></a></li>
  66. <li class="nav-header">
  67. <i class="icon-custom icon-constant"></i> Constants</li>
  68. <li class="constant "><a href="#OID_LAG_AGGREGATE_OR_INDIVIDUAL" title="OID_LAG_AGGREGATE_OR_INDIVIDUAL :: "><span class="description">OID_LAG_AGGREGATE_OR_INDIVIDUAL</span><pre>OID_LAG_AGGREGATE_OR_INDIVIDUAL</pre></a></li>
  69. <li class="constant "><a href="#OID_LAG_PORT_ATTACHED_ID" title="OID_LAG_PORT_ATTACHED_ID :: "><span class="description">OID_LAG_PORT_ATTACHED_ID</span><pre>OID_LAG_PORT_ATTACHED_ID</pre></a></li>
  70. </ul>
  71. </div>
  72. <div class="span8">
  73. <a name="%5COSS%5CSNMP%5CMIBS%5CLAG" id="\OSS\SNMP\MIBS\LAG"></a><ul class="breadcrumb">
  74. <li>
  75. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  76. </li>
  77. <li><a href="../namespaces/OSS.html">OSS</a></li>
  78. <span class="divider">\</span><li><a href="../namespaces/OSS.SNMP.html">SNMP</a></li>
  79. <span class="divider">\</span><li><a href="../namespaces/OSS.SNMP.MIBS.html">MIBS</a></li>
  80. <li class="active">
  81. <span class="divider">\</span><a href="../classes/OSS.SNMP.MIBS.LAG.html">LAG</a>
  82. </li>
  83. </ul>
  84. <div href="../classes/OSS.SNMP.MIBS.LAG.html" class="element class">
  85. <p class="short_description">A class for performing SNMP V2 queries on generic devices</p>
  86. <div class="details">
  87. <p class="long_description"></p>
  88. <table class="table table-bordered">
  89. <tr>
  90. <th>copyright</th>
  91. <td>Copyright (c) 2012, Open Source Solutions Limited, Dublin, Ireland</td>
  92. </tr>
  93. <tr>
  94. <th>author</th>
  95. <td><a href="mailto:barry@opensolutions.ie">Barry O'Donovan</a></td>
  96. </tr>
  97. </table>
  98. <h3>
  99. <i class="icon-custom icon-method"></i> Methods</h3>
  100. <a name="findFailedLAGPorts" id="findFailedLAGPorts"></a><div class="element clickable method public findFailedLAGPorts" data-toggle="collapse" data-target=".findFailedLAGPorts .collapse">
  101. <h2>Utility function to identify configured but unattached LAG ports</h2>
  102. <pre>findFailedLAGPorts() : array</pre>
  103. <div class="labels"></div>
  104. <div class="row collapse"><div class="detail-description">
  105. <p class="long_description"></p>
  106. <h3>Returns</h3>
  107. <div class="subelement response">
  108. <code>array</code>Array of indexed port ids (array index, not value) of configured but unattached LAG ports</div>
  109. </div></div>
  110. </div>
  111. <a name="getLAGPorts" id="getLAGPorts"></a><div class="element clickable method public getLAGPorts" data-toggle="collapse" data-target=".getLAGPorts .collapse">
  112. <h2>Gets an associate array of LAG ports with the [id] =&gt; name of it's constituent ports</h2>
  113. <pre>getLAGPorts() : array</pre>
  114. <div class="labels"></div>
  115. <div class="row collapse"><div class="detail-description">
  116. <p class="long_description"><p>E.g.:
  117. [5048] => Array
  118. (
  119. [10111] => GigabitEthernet1/0/11
  120. [10112] => GigabitEthernet1/0/12
  121. )</p></p>
  122. <h3>Returns</h3>
  123. <div class="subelement response">
  124. <code>array</code>Associate array of LAG ports with the [id] => name of it's constituent ports</div>
  125. </div></div>
  126. </div>
  127. <a name="isAggregatePorts" id="isAggregatePorts"></a><div class="element clickable method public isAggregatePorts" data-toggle="collapse" data-target=".isAggregatePorts .collapse">
  128. <h2>Returns an associate array of port IDs with a boolean value to indicate if it's an aggregate port (true)
  129. or an individual port (false).</h2>
  130. <pre>isAggregatePorts() : array</pre>
  131. <div class="labels"></div>
  132. <div class="row collapse"><div class="detail-description">
  133. <p class="long_description"></p>
  134. <h3>Returns</h3>
  135. <div class="subelement response">
  136. <code>array</code>Associate array of port IDs with a boolean value to indicate if it's an aggregate port (true) or not</div>
  137. </div></div>
  138. </div>
  139. <a name="portAttachedIds" id="portAttachedIds"></a><div class="element clickable method public portAttachedIds" data-toggle="collapse" data-target=".portAttachedIds .collapse">
  140. <h2>Returns an associate array of port IDs with the ID of the aggregate port that
  141. they are a member of (else 0 if not a LAG port)</h2>
  142. <pre>portAttachedIds() : array</pre>
  143. <div class="labels"></div>
  144. <div class="row collapse"><div class="detail-description">
  145. <p class="long_description"></p>
  146. <h3>Returns</h3>
  147. <div class="subelement response">
  148. <code>array</code>Associate array of port IDs with the ID of the aggregate port that they are a member of</div>
  149. </div></div>
  150. </div>
  151. <h3>
  152. <i class="icon-custom icon-constant"></i> Constants</h3>
  153. <a name="OID_LAG_AGGREGATE_OR_INDIVIDUAL" id="OID_LAG_AGGREGATE_OR_INDIVIDUAL"> </a><div class="element clickable constant OID_LAG_AGGREGATE_OR_INDIVIDUAL" data-toggle="collapse" data-target=".OID_LAG_AGGREGATE_OR_INDIVIDUAL .collapse">
  154. <h2>OID_LAG_AGGREGATE_OR_INDIVIDUAL</h2>
  155. <pre>OID_LAG_AGGREGATE_OR_INDIVIDUAL </pre>
  156. <div class="labels"></div>
  157. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  158. </div>
  159. <a name="OID_LAG_PORT_ATTACHED_ID" id="OID_LAG_PORT_ATTACHED_ID"> </a><div class="element clickable constant OID_LAG_PORT_ATTACHED_ID" data-toggle="collapse" data-target=".OID_LAG_PORT_ATTACHED_ID .collapse">
  160. <h2>OID_LAG_PORT_ATTACHED_ID</h2>
  161. <pre>OID_LAG_PORT_ATTACHED_ID </pre>
  162. <div class="labels"></div>
  163. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  164. </div>
  165. </div>
  166. </div>
  167. </div>
  168. </div>
  169. <div class="row"><footer class="span12">
  170. Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
  171. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a5</a> and<br>
  172. generated on 2012-06-11T11:07:43+01:00.<br></footer></div>
  173. </div>
  174. </body>
  175. </html>