OSS.SNMP.MIBS.Cisco.RSTP.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211
  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\Cisco\RSTP</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="#rstpPortRole" title="rstpPortRole :: Get the device's RSTP port roles (by given vlan id)"><span class="description">Get the device's RSTP port roles (by given vlan id)</span><pre>rstpPortRole()</pre></a></li>
  59. <li class="nav-header">
  60. <i class="icon-custom icon-property"></i> Properties</li>
  61. <li class="property public "><a href="#%24STP_X_RSTP_PORT_ROLES" title="$STP_X_RSTP_PORT_ROLES :: "><span class="description">$STP_X_RSTP_PORT_ROLES</span><pre>$STP_X_RSTP_PORT_ROLES</pre></a></li>
  62. <li class="nav-header">
  63. <i class="icon-custom icon-constant"></i> Constants</li>
  64. <li class="constant "><a href="#OID_STP_X_RSTP_PORT_ROLE" title="OID_STP_X_RSTP_PORT_ROLE :: "><span class="description">OID_STP_X_RSTP_PORT_ROLE</span><pre>OID_STP_X_RSTP_PORT_ROLE</pre></a></li>
  65. <li class="constant "><a href="#STP_X_RSTP_PORT_ROLE_ALTERNATE" title="STP_X_RSTP_PORT_ROLE_ALTERNATE :: "><span class="description">STP_X_RSTP_PORT_ROLE_ALTERNATE</span><pre>STP_X_RSTP_PORT_ROLE_ALTERNATE</pre></a></li>
  66. <li class="constant "><a href="#STP_X_RSTP_PORT_ROLE_BACKUP" title="STP_X_RSTP_PORT_ROLE_BACKUP :: "><span class="description">STP_X_RSTP_PORT_ROLE_BACKUP</span><pre>STP_X_RSTP_PORT_ROLE_BACKUP</pre></a></li>
  67. <li class="constant "><a href="#STP_X_RSTP_PORT_ROLE_BOUNDARY" title="STP_X_RSTP_PORT_ROLE_BOUNDARY :: "><span class="description">STP_X_RSTP_PORT_ROLE_BOUNDARY</span><pre>STP_X_RSTP_PORT_ROLE_BOUNDARY</pre></a></li>
  68. <li class="constant "><a href="#STP_X_RSTP_PORT_ROLE_DESIGNATED" title="STP_X_RSTP_PORT_ROLE_DESIGNATED :: "><span class="description">STP_X_RSTP_PORT_ROLE_DESIGNATED</span><pre>STP_X_RSTP_PORT_ROLE_DESIGNATED</pre></a></li>
  69. <li class="constant "><a href="#STP_X_RSTP_PORT_ROLE_DISABLED" title="STP_X_RSTP_PORT_ROLE_DISABLED :: "><span class="description">STP_X_RSTP_PORT_ROLE_DISABLED</span><pre>STP_X_RSTP_PORT_ROLE_DISABLED</pre></a></li>
  70. <li class="constant "><a href="#STP_X_RSTP_PORT_ROLE_MASTER" title="STP_X_RSTP_PORT_ROLE_MASTER :: "><span class="description">STP_X_RSTP_PORT_ROLE_MASTER</span><pre>STP_X_RSTP_PORT_ROLE_MASTER</pre></a></li>
  71. <li class="constant "><a href="#STP_X_RSTP_PORT_ROLE_ROOT" title="STP_X_RSTP_PORT_ROLE_ROOT :: "><span class="description">STP_X_RSTP_PORT_ROLE_ROOT</span><pre>STP_X_RSTP_PORT_ROLE_ROOT</pre></a></li>
  72. </ul>
  73. </div>
  74. <div class="span8">
  75. <a name="%5COSS%5CSNMP%5CMIBS%5CCisco%5CRSTP" id="\OSS\SNMP\MIBS\Cisco\RSTP"></a><ul class="breadcrumb">
  76. <li>
  77. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  78. </li>
  79. <li><a href="../namespaces/OSS.html">OSS</a></li>
  80. <span class="divider">\</span><li><a href="../namespaces/OSS.SNMP.html">SNMP</a></li>
  81. <span class="divider">\</span><li><a href="../namespaces/OSS.SNMP.MIBS.html">MIBS</a></li>
  82. <span class="divider">\</span><li><a href="../namespaces/OSS.SNMP.MIBS.Cisco.html">Cisco</a></li>
  83. <li class="active">
  84. <span class="divider">\</span><a href="../classes/OSS.SNMP.MIBS.Cisco.RSTP.html">RSTP</a>
  85. </li>
  86. </ul>
  87. <div href="../classes/OSS.SNMP.MIBS.Cisco.RSTP.html" class="element class">
  88. <p class="short_description">A class for performing SNMP V2 queries on Cisco devices</p>
  89. <div class="details">
  90. <p class="long_description"></p>
  91. <table class="table table-bordered">
  92. <tr>
  93. <th>copyright</th>
  94. <td>Copyright (c) 2012, Open Source Solutions Limited, Dublin, Ireland</td>
  95. </tr>
  96. <tr>
  97. <th>author</th>
  98. <td><a href="mailto:barry@opensolutions.ie">Barry O'Donovan</a></td>
  99. </tr>
  100. </table>
  101. <h3>
  102. <i class="icon-custom icon-method"></i> Methods</h3>
  103. <a name="rstpPortRole" id="rstpPortRole"></a><div class="element clickable method public rstpPortRole" data-toggle="collapse" data-target=".rstpPortRole .collapse">
  104. <h2>Get the device's RSTP port roles (by given vlan id)</h2>
  105. <pre>rstpPortRole(int $vid, boolean $translate) : array</pre>
  106. <div class="labels"></div>
  107. <div class="row collapse"><div class="detail-description">
  108. <p class="long_description"><p>Only ports participating in RSTP for the given VLAN id are returned.</p>
  109. <p>This function will also convert STP port IDs to the device proper port IDs.
  110. E.g. sample output:</p>
  111. <p>Array
  112. (
  113. [10101] => 3
  114. [10103] => 3
  115. [10105] => 3
  116. [5048] => 2
  117. )</p></p>
  118. <table class="table table-bordered">
  119. <tr>
  120. <th>see</th>
  121. <td>\$STP_X_RSTP_PORT_ROLES</td>
  122. </tr>
  123. <tr>
  124. <th>see</th>
  125. <td>\STP_X_RSTP_PORT_ROLE_ROOT</td>
  126. </tr>
  127. </table>
  128. <h3>Parameters</h3>
  129. <div class="subelement argument">
  130. <h4>$vid</h4>
  131. <code>int</code><p>The RSTP VLAN ID to query port roles for</p></div>
  132. <div class="subelement argument">
  133. <h4>$translate</h4>
  134. <code>boolean</code><p>If true, return the string representation via self::$STP_X_RSTP_PORT_ROLES</p>
  135. </div>
  136. <h3>Returns</h3>
  137. <div class="subelement response">
  138. <code>array</code>The device's RSTP port roles (by given vlan id)</div>
  139. </div></div>
  140. </div>
  141. <h3>
  142. <i class="icon-custom icon-property"></i> Properties</h3>
  143. <a name="%24STP_X_RSTP_PORT_ROLES" id="$STP_X_RSTP_PORT_ROLES"> </a><div class="element clickable property public $STP_X_RSTP_PORT_ROLES" data-toggle="collapse" data-target=".$STP_X_RSTP_PORT_ROLES .collapse">
  144. <h2>$STP_X_RSTP_PORT_ROLES</h2>
  145. <pre>$STP_X_RSTP_PORT_ROLES </pre>
  146. <div class="labels"></div>
  147. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  148. </div>
  149. <h3>
  150. <i class="icon-custom icon-constant"></i> Constants</h3>
  151. <a name="OID_STP_X_RSTP_PORT_ROLE" id="OID_STP_X_RSTP_PORT_ROLE"> </a><div class="element clickable constant OID_STP_X_RSTP_PORT_ROLE" data-toggle="collapse" data-target=".OID_STP_X_RSTP_PORT_ROLE .collapse">
  152. <h2>OID_STP_X_RSTP_PORT_ROLE</h2>
  153. <pre>OID_STP_X_RSTP_PORT_ROLE </pre>
  154. <div class="labels"></div>
  155. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  156. </div>
  157. <a name="STP_X_RSTP_PORT_ROLE_ALTERNATE" id="STP_X_RSTP_PORT_ROLE_ALTERNATE"> </a><div class="element clickable constant STP_X_RSTP_PORT_ROLE_ALTERNATE" data-toggle="collapse" data-target=".STP_X_RSTP_PORT_ROLE_ALTERNATE .collapse">
  158. <h2>STP_X_RSTP_PORT_ROLE_ALTERNATE</h2>
  159. <pre>STP_X_RSTP_PORT_ROLE_ALTERNATE </pre>
  160. <div class="labels"></div>
  161. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  162. </div>
  163. <a name="STP_X_RSTP_PORT_ROLE_BACKUP" id="STP_X_RSTP_PORT_ROLE_BACKUP"> </a><div class="element clickable constant STP_X_RSTP_PORT_ROLE_BACKUP" data-toggle="collapse" data-target=".STP_X_RSTP_PORT_ROLE_BACKUP .collapse">
  164. <h2>STP_X_RSTP_PORT_ROLE_BACKUP</h2>
  165. <pre>STP_X_RSTP_PORT_ROLE_BACKUP </pre>
  166. <div class="labels"></div>
  167. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  168. </div>
  169. <a name="STP_X_RSTP_PORT_ROLE_BOUNDARY" id="STP_X_RSTP_PORT_ROLE_BOUNDARY"> </a><div class="element clickable constant STP_X_RSTP_PORT_ROLE_BOUNDARY" data-toggle="collapse" data-target=".STP_X_RSTP_PORT_ROLE_BOUNDARY .collapse">
  170. <h2>STP_X_RSTP_PORT_ROLE_BOUNDARY</h2>
  171. <pre>STP_X_RSTP_PORT_ROLE_BOUNDARY </pre>
  172. <div class="labels"></div>
  173. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  174. </div>
  175. <a name="STP_X_RSTP_PORT_ROLE_DESIGNATED" id="STP_X_RSTP_PORT_ROLE_DESIGNATED"> </a><div class="element clickable constant STP_X_RSTP_PORT_ROLE_DESIGNATED" data-toggle="collapse" data-target=".STP_X_RSTP_PORT_ROLE_DESIGNATED .collapse">
  176. <h2>STP_X_RSTP_PORT_ROLE_DESIGNATED</h2>
  177. <pre>STP_X_RSTP_PORT_ROLE_DESIGNATED </pre>
  178. <div class="labels"></div>
  179. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  180. </div>
  181. <a name="STP_X_RSTP_PORT_ROLE_DISABLED" id="STP_X_RSTP_PORT_ROLE_DISABLED"> </a><div class="element clickable constant STP_X_RSTP_PORT_ROLE_DISABLED" data-toggle="collapse" data-target=".STP_X_RSTP_PORT_ROLE_DISABLED .collapse">
  182. <h2>STP_X_RSTP_PORT_ROLE_DISABLED</h2>
  183. <pre>STP_X_RSTP_PORT_ROLE_DISABLED </pre>
  184. <div class="labels"></div>
  185. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  186. </div>
  187. <a name="STP_X_RSTP_PORT_ROLE_MASTER" id="STP_X_RSTP_PORT_ROLE_MASTER"> </a><div class="element clickable constant STP_X_RSTP_PORT_ROLE_MASTER" data-toggle="collapse" data-target=".STP_X_RSTP_PORT_ROLE_MASTER .collapse">
  188. <h2>STP_X_RSTP_PORT_ROLE_MASTER</h2>
  189. <pre>STP_X_RSTP_PORT_ROLE_MASTER </pre>
  190. <div class="labels"></div>
  191. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  192. </div>
  193. <a name="STP_X_RSTP_PORT_ROLE_ROOT" id="STP_X_RSTP_PORT_ROLE_ROOT"> </a><div class="element clickable constant STP_X_RSTP_PORT_ROLE_ROOT" data-toggle="collapse" data-target=".STP_X_RSTP_PORT_ROLE_ROOT .collapse">
  194. <h2>STP_X_RSTP_PORT_ROLE_ROOT</h2>
  195. <pre>STP_X_RSTP_PORT_ROLE_ROOT </pre>
  196. <div class="labels"></div>
  197. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  198. </div>
  199. </div>
  200. </div>
  201. </div>
  202. </div>
  203. <div class="row"><footer class="span12">
  204. 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>
  205. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a5</a> and<br>
  206. generated on 2012-06-11T10:19:20+01:00.<br></footer></div>
  207. </div>
  208. </body>
  209. </html>