OSS_SNMP.MIBS.BGP.html 71 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955
  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\BGP</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_SNMP.html"><i class="icon-th"></i> OSS_SNMP</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">39</span></a></li>
  35. <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
  36. <ul><li>todo 
  37. <span class="label label-info">1</span>
  38. </li></ul></a></li>
  39. <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
  40. <span class="label label-info">0</span></a></li>
  41. </ul>
  42. </li>
  43. </ul></div>
  44. </div></div>
  45. <div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
  46. </div>
  47. <div id="___" class="container">
  48. <noscript><div class="alert alert-warning">
  49. Javascript is disabled; several features are only available
  50. if Javascript is enabled.
  51. </div></noscript>
  52. <div class="row">
  53. <div class="span4">
  54. <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">
  55. <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>
  56. </div>
  57. <ul class="side-nav nav nav-list">
  58. <li class="nav-header">
  59. <i class="icon-custom icon-method"></i> Methods</li>
  60. <li class="method public "><a href="#identifier" title="identifier :: Returns the local BGP identifier"><span class="description">Returns the local BGP identifier</span><pre>identifier()</pre></a></li>
  61. <li class="method public "><a href="#localASN" title="localASN :: Returns the local BGP AS number"><span class="description">Returns the local BGP AS number</span><pre>localASN()</pre></a></li>
  62. <li class="method public "><a href="#peerAdminStates" title="peerAdminStates :: Returns the BGP peer admin states (see `self::$BGP_PEER_ADMIN_STATES`)"><span class="description">Returns the BGP peer admin states (see `self::$BGP_PEER_ADMIN_STATES`)</span><pre>peerAdminStates()</pre></a></li>
  63. <li class="method public "><a href="#peerConnectRetryIntervals" title="peerConnectRetryIntervals :: Returns Time interval in seconds for the ConnectRetry timer."><span class="description">Returns Time interval in seconds for the ConnectRetry timer.</span><pre>peerConnectRetryIntervals()</pre></a></li>
  64. <li class="method public "><a href="#peerConnectionStates" title="peerConnectionStates :: Returns the BGP peer connection state (see `self::$BGP_PEER_CONNECTION_STATES`)"><span class="description">Returns the BGP peer connection state (see `self::$BGP_PEER_CONNECTION_STATES`)</span><pre>peerConnectionStates()</pre></a></li>
  65. <li class="method public "><a href="#peerDetails" title="peerDetails :: Utility function to gather all peer information into a single array."><span class="description">Utility function to gather all peer information into a single array.</span><pre>peerDetails()</pre></a></li>
  66. <li class="method public "><a href="#peerEstabledTransitions" title="peerEstabledTransitions :: Returns The total number of times the BGP FSM transitioned into the established state."><span class="description">Returns The total number of times the BGP FSM transitioned into the established state.</span><pre>peerEstabledTransitions()</pre></a></li>
  67. <li class="method public "><a href="#peerEstablishedTimes" title="peerEstablishedTimes :: Returns how long (in seconds) this peer has been in the Established state or
  68. how long since this peer was last in the Established state"><span class="description">Returns how long (in seconds) this peer has been in the Established state or
  69. how long since this peer was last in the Established state</span><pre>peerEstablishedTimes()</pre></a></li>
  70. <li class="method public "><a href="#peerHoldTimes" title="peerHoldTimes :: Returns Time interval in seconds for the Hold Timer established with the peer."><span class="description">Returns Time interval in seconds for the Hold Timer established with the peer.</span><pre>peerHoldTimes()</pre></a></li>
  71. <li class="method public "><a href="#peerHoleTimesConfigured" title="peerHoleTimesConfigured :: Returns Time interval in seconds for the Hold Time configured for this BGP speaker with this peer."><span class="description">Returns Time interval in seconds for the Hold Time configured for this BGP speaker with this peer.</span><pre>peerHoleTimesConfigured()</pre></a></li>
  72. <li class="method public "><a href="#peerIdentifiers" title="peerIdentifiers :: Returns the BGP identifier of all peers indexed by neighbour IPv4 address"><span class="description">Returns the BGP identifier of all peers indexed by neighbour IPv4 address</span><pre>peerIdentifiers()</pre></a></li>
  73. <li class="method public "><a href="#peerInTotalMessages" title="peerInTotalMessages :: Returns The total number of messages received from the remote peer on this connection."><span class="description">Returns The total number of messages received from the remote peer on this connection.</span><pre>peerInTotalMessages()</pre></a></li>
  74. <li class="method public "><a href="#peerInUpdateElapsedTimes" title="peerInUpdateElapsedTimes :: Returns Elapsed time in seconds since the last BGP UPDATE message was received from the peer."><span class="description">Returns Elapsed time in seconds since the last BGP UPDATE message was received from the peer.</span><pre>peerInUpdateElapsedTimes()</pre></a></li>
  75. <li class="method public "><a href="#peerInUpdates" title="peerInUpdates :: Returns The number of BGP UPDATE messages received on this connection."><span class="description">Returns The number of BGP UPDATE messages received on this connection.</span><pre>peerInUpdates()</pre></a></li>
  76. <li class="method public "><a href="#peerKeepAlives" title="peerKeepAlives :: Returns Time interval in seconds for the KeepAlive timer established with the peer."><span class="description">Returns Time interval in seconds for the KeepAlive timer established with the peer.</span><pre>peerKeepAlives()</pre></a></li>
  77. <li class="method public "><a href="#peerKeepAlivesConfigured" title="peerKeepAlivesConfigured :: Returns Time interval in seconds for the KeepAlive timer configured for this BGP speaker with this peer."><span class="description">Returns Time interval in seconds for the KeepAlive timer configured for this BGP speaker with this peer.</span><pre>peerKeepAlivesConfigured()</pre></a></li>
  78. <li class="method public "><a href="#peerLastErrors" title="peerLastErrors :: Returns The last error code and subcode seen by this peer on this connection."><span class="description">Returns The last error code and subcode seen by this peer on this connection.</span><pre>peerLastErrors()</pre></a></li>
  79. <li class="method public "><a href="#peerLocalAddresses" title="peerLocalAddresses :: Returns the local IP address of this entry's BGP connection."><span class="description">Returns the local IP address of this entry's BGP connection.</span><pre>peerLocalAddresses()</pre></a></li>
  80. <li class="method public "><a href="#peerLocalPorts" title="peerLocalPorts :: Returns the local ports for the TCP connections between the BGP peers."><span class="description">Returns the local ports for the TCP connections between the BGP peers.</span><pre>peerLocalPorts()</pre></a></li>
  81. <li class="method public "><a href="#peerMinASOriginationIntervals" title="peerMinASOriginationIntervals :: Returns Time interval in seconds for the MinASOriginationInterval timer."><span class="description">Returns Time interval in seconds for the MinASOriginationInterval timer.</span><pre>peerMinASOriginationIntervals()</pre></a></li>
  82. <li class="method public "><a href="#peerMinRouteAdvertisementIntervals" title="peerMinRouteAdvertisementIntervals :: Returns Time interval in seconds for the MinRouteAdvertisementInterval timer."><span class="description">Returns Time interval in seconds for the MinRouteAdvertisementInterval timer.</span><pre>peerMinRouteAdvertisementIntervals()</pre></a></li>
  83. <li class="method public "><a href="#peerNegotiatedVersions" title="peerNegotiatedVersions :: Returns the negotiated version of BGP running between the two peers"><span class="description">Returns the negotiated version of BGP running between the two peers</span><pre>peerNegotiatedVersions()</pre></a></li>
  84. <li class="method public "><a href="#peerOutTotalMessages" title="peerOutTotalMessages :: Returns The total number of messages transmitted to the remote peer on this connection."><span class="description">Returns The total number of messages transmitted to the remote peer on this connection.</span><pre>peerOutTotalMessages()</pre></a></li>
  85. <li class="method public "><a href="#peerOutUpdates" title="peerOutUpdates :: Returns The number of BGP UPDATE messages transmitted on this connection."><span class="description">Returns The number of BGP UPDATE messages transmitted on this connection.</span><pre>peerOutUpdates()</pre></a></li>
  86. <li class="method public "><a href="#peerRemoteASNs" title="peerRemoteASNs :: Returns The remote autonomous system number."><span class="description">Returns The remote autonomous system number.</span><pre>peerRemoteASNs()</pre></a></li>
  87. <li class="method public "><a href="#peerRemoteAddresses" title="peerRemoteAddresses :: Returns the local IP address of this entry's BGP peer."><span class="description">Returns the local IP address of this entry's BGP peer.</span><pre>peerRemoteAddresses()</pre></a></li>
  88. <li class="method public "><a href="#peerRemotePorts" title="peerRemotePorts :: Returns the remote ports for the TCP connections between the BGP peers."><span class="description">Returns the remote ports for the TCP connections between the BGP peers.</span><pre>peerRemotePorts()</pre></a></li>
  89. <li class="method public "><a href="#version" title="version :: Returns the BGP version"><span class="description">Returns the BGP version</span><pre>version()</pre></a></li>
  90. <li class="nav-header">
  91. <i class="icon-custom icon-property"></i> Properties</li>
  92. <li class="property public "><a href="#%24BGP_PEER_ADMIN_STATES" title="$BGP_PEER_ADMIN_STATES :: "><span class="description">$BGP_PEER_ADMIN_STATES</span><pre>$BGP_PEER_ADMIN_STATES</pre></a></li>
  93. <li class="property public "><a href="#%24BGP_PEER_CONNECTION_STATES" title="$BGP_PEER_CONNECTION_STATES :: "><span class="description">$BGP_PEER_CONNECTION_STATES</span><pre>$BGP_PEER_CONNECTION_STATES</pre></a></li>
  94. <li class="nav-header">
  95. <i class="icon-custom icon-constant"></i> Constants</li>
  96. <li class="constant "><a href="#BGP_PEER_ADMIN_STATE_START" title="BGP_PEER_ADMIN_STATE_START :: "><span class="description">BGP_PEER_ADMIN_STATE_START</span><pre>BGP_PEER_ADMIN_STATE_START</pre></a></li>
  97. <li class="constant "><a href="#BGP_PEER_ADMIN_STATE_STOP" title="BGP_PEER_ADMIN_STATE_STOP :: "><span class="description">BGP_PEER_ADMIN_STATE_STOP</span><pre>BGP_PEER_ADMIN_STATE_STOP</pre></a></li>
  98. <li class="constant "><a href="#BGP_PEER_CONNECTION_STATE_ACTIVE" title="BGP_PEER_CONNECTION_STATE_ACTIVE :: "><span class="description">BGP_PEER_CONNECTION_STATE_ACTIVE</span><pre>BGP_PEER_CONNECTION_STATE_ACTIVE</pre></a></li>
  99. <li class="constant "><a href="#BGP_PEER_CONNECTION_STATE_CONNECT" title="BGP_PEER_CONNECTION_STATE_CONNECT :: "><span class="description">BGP_PEER_CONNECTION_STATE_CONNECT</span><pre>BGP_PEER_CONNECTION_STATE_CONNECT</pre></a></li>
  100. <li class="constant "><a href="#BGP_PEER_CONNECTION_STATE_ESTABLISHED" title="BGP_PEER_CONNECTION_STATE_ESTABLISHED :: "><span class="description">BGP_PEER_CONNECTION_STATE_ESTABLISHED</span><pre>BGP_PEER_CONNECTION_STATE_ESTABLISHED</pre></a></li>
  101. <li class="constant "><a href="#BGP_PEER_CONNECTION_STATE_IDLE" title="BGP_PEER_CONNECTION_STATE_IDLE :: "><span class="description">BGP_PEER_CONNECTION_STATE_IDLE</span><pre>BGP_PEER_CONNECTION_STATE_IDLE</pre></a></li>
  102. <li class="constant "><a href="#BGP_PEER_CONNECTION_STATE_OPENCONFIRM" title="BGP_PEER_CONNECTION_STATE_OPENCONFIRM :: "><span class="description">BGP_PEER_CONNECTION_STATE_OPENCONFIRM</span><pre>BGP_PEER_CONNECTION_STATE_OPENCONFIRM</pre></a></li>
  103. <li class="constant "><a href="#BGP_PEER_CONNECTION_STATE_OPENSENT" title="BGP_PEER_CONNECTION_STATE_OPENSENT :: "><span class="description">BGP_PEER_CONNECTION_STATE_OPENSENT</span><pre>BGP_PEER_CONNECTION_STATE_OPENSENT</pre></a></li>
  104. <li class="constant "><a href="#OID_BGP_IDENTIFIER" title="OID_BGP_IDENTIFIER :: "><span class="description">OID_BGP_IDENTIFIER</span><pre>OID_BGP_IDENTIFIER</pre></a></li>
  105. <li class="constant "><a href="#OID_BGP_LOCAL_ASN" title="OID_BGP_LOCAL_ASN :: "><span class="description">OID_BGP_LOCAL_ASN</span><pre>OID_BGP_LOCAL_ASN</pre></a></li>
  106. <li class="constant "><a href="#OID_BGP_PATH_ATTR_ADDR_PREFIX" title="OID_BGP_PATH_ATTR_ADDR_PREFIX :: "><span class="description">OID_BGP_PATH_ATTR_ADDR_PREFIX</span><pre>OID_BGP_PATH_ATTR_ADDR_PREFIX</pre></a></li>
  107. <li class="constant "><a href="#OID_BGP_PATH_ATTR_ADDR_PREFIX_LENGTH" title="OID_BGP_PATH_ATTR_ADDR_PREFIX_LENGTH :: "><span class="description">OID_BGP_PATH_ATTR_ADDR_PREFIX_LENGTH</span><pre>OID_BGP_PATH_ATTR_ADDR_PREFIX_LENGTH</pre></a></li>
  108. <li class="constant "><a href="#OID_BGP_PATH_ATTR_AGGREGATOR_ADDR" title="OID_BGP_PATH_ATTR_AGGREGATOR_ADDR :: "><span class="description">OID_BGP_PATH_ATTR_AGGREGATOR_ADDR</span><pre>OID_BGP_PATH_ATTR_AGGREGATOR_ADDR</pre></a></li>
  109. <li class="constant "><a href="#OID_BGP_PATH_ATTR_AGGREGATOR_AS" title="OID_BGP_PATH_ATTR_AGGREGATOR_AS :: "><span class="description">OID_BGP_PATH_ATTR_AGGREGATOR_AS</span><pre>OID_BGP_PATH_ATTR_AGGREGATOR_AS</pre></a></li>
  110. <li class="constant "><a href="#OID_BGP_PATH_ATTR_AS_PATH_SEGMENT" title="OID_BGP_PATH_ATTR_AS_PATH_SEGMENT :: "><span class="description">OID_BGP_PATH_ATTR_AS_PATH_SEGMENT</span><pre>OID_BGP_PATH_ATTR_AS_PATH_SEGMENT</pre></a></li>
  111. <li class="constant "><a href="#OID_BGP_PATH_ATTR_ATOMIC_AGGREGATE" title="OID_BGP_PATH_ATTR_ATOMIC_AGGREGATE :: "><span class="description">OID_BGP_PATH_ATTR_ATOMIC_AGGREGATE</span><pre>OID_BGP_PATH_ATTR_ATOMIC_AGGREGATE</pre></a></li>
  112. <li class="constant "><a href="#OID_BGP_PATH_ATTR_BEST" title="OID_BGP_PATH_ATTR_BEST :: "><span class="description">OID_BGP_PATH_ATTR_BEST</span><pre>OID_BGP_PATH_ATTR_BEST</pre></a></li>
  113. <li class="constant "><a href="#OID_BGP_PATH_ATTR_CALC_LOCAL_PREF" title="OID_BGP_PATH_ATTR_CALC_LOCAL_PREF :: "><span class="description">OID_BGP_PATH_ATTR_CALC_LOCAL_PREF</span><pre>OID_BGP_PATH_ATTR_CALC_LOCAL_PREF</pre></a></li>
  114. <li class="constant "><a href="#OID_BGP_PATH_ATTR_LOCAL_PREF" title="OID_BGP_PATH_ATTR_LOCAL_PREF :: "><span class="description">OID_BGP_PATH_ATTR_LOCAL_PREF</span><pre>OID_BGP_PATH_ATTR_LOCAL_PREF</pre></a></li>
  115. <li class="constant "><a href="#OID_BGP_PATH_ATTR_MED" title="OID_BGP_PATH_ATTR_MED :: "><span class="description">OID_BGP_PATH_ATTR_MED</span><pre>OID_BGP_PATH_ATTR_MED</pre></a></li>
  116. <li class="constant "><a href="#OID_BGP_PATH_ATTR_NEXT_HOP" title="OID_BGP_PATH_ATTR_NEXT_HOP :: "><span class="description">OID_BGP_PATH_ATTR_NEXT_HOP</span><pre>OID_BGP_PATH_ATTR_NEXT_HOP</pre></a></li>
  117. <li class="constant "><a href="#OID_BGP_PATH_ATTR_ORIGIN" title="OID_BGP_PATH_ATTR_ORIGIN :: "><span class="description">OID_BGP_PATH_ATTR_ORIGIN</span><pre>OID_BGP_PATH_ATTR_ORIGIN</pre></a></li>
  118. <li class="constant "><a href="#OID_BGP_PATH_ATTR_PEER" title="OID_BGP_PATH_ATTR_PEER :: "><span class="description">OID_BGP_PATH_ATTR_PEER</span><pre>OID_BGP_PATH_ATTR_PEER</pre></a></li>
  119. <li class="constant "><a href="#OID_BGP_PATH_ATTR_UNKNOWN" title="OID_BGP_PATH_ATTR_UNKNOWN :: "><span class="description">OID_BGP_PATH_ATTR_UNKNOWN</span><pre>OID_BGP_PATH_ATTR_UNKNOWN</pre></a></li>
  120. <li class="constant "><a href="#OID_BGP_PEER_ADMIN_STATE" title="OID_BGP_PEER_ADMIN_STATE :: "><span class="description">OID_BGP_PEER_ADMIN_STATE</span><pre>OID_BGP_PEER_ADMIN_STATE</pre></a></li>
  121. <li class="constant "><a href="#OID_BGP_PEER_CONNECTION_STATE" title="OID_BGP_PEER_CONNECTION_STATE :: "><span class="description">OID_BGP_PEER_CONNECTION_STATE</span><pre>OID_BGP_PEER_CONNECTION_STATE</pre></a></li>
  122. <li class="constant "><a href="#OID_BGP_PEER_CONNECT_RETRY_INTERVAL" title="OID_BGP_PEER_CONNECT_RETRY_INTERVAL :: "><span class="description">OID_BGP_PEER_CONNECT_RETRY_INTERVAL</span><pre>OID_BGP_PEER_CONNECT_RETRY_INTERVAL</pre></a></li>
  123. <li class="constant "><a href="#OID_BGP_PEER_FSM_ESTABLISHED_TIME" title="OID_BGP_PEER_FSM_ESTABLISHED_TIME :: "><span class="description">OID_BGP_PEER_FSM_ESTABLISHED_TIME</span><pre>OID_BGP_PEER_FSM_ESTABLISHED_TIME</pre></a></li>
  124. <li class="constant "><a href="#OID_BGP_PEER_FSM_ESTABLISHED_TRANSITIONS" title="OID_BGP_PEER_FSM_ESTABLISHED_TRANSITIONS :: "><span class="description">OID_BGP_PEER_FSM_ESTABLISHED_TRANSITIONS</span><pre>OID_BGP_PEER_FSM_ESTABLISHED_TRANSITIONS</pre></a></li>
  125. <li class="constant "><a href="#OID_BGP_PEER_HOLD_TIME" title="OID_BGP_PEER_HOLD_TIME :: "><span class="description">OID_BGP_PEER_HOLD_TIME</span><pre>OID_BGP_PEER_HOLD_TIME</pre></a></li>
  126. <li class="constant "><a href="#OID_BGP_PEER_HOLD_TIME_CONFIGURED" title="OID_BGP_PEER_HOLD_TIME_CONFIGURED :: "><span class="description">OID_BGP_PEER_HOLD_TIME_CONFIGURED</span><pre>OID_BGP_PEER_HOLD_TIME_CONFIGURED</pre></a></li>
  127. <li class="constant "><a href="#OID_BGP_PEER_IDENTIFIER" title="OID_BGP_PEER_IDENTIFIER :: "><span class="description">OID_BGP_PEER_IDENTIFIER</span><pre>OID_BGP_PEER_IDENTIFIER</pre></a></li>
  128. <li class="constant "><a href="#OID_BGP_PEER_IN_TOTAL_MESSAGES" title="OID_BGP_PEER_IN_TOTAL_MESSAGES :: "><span class="description">OID_BGP_PEER_IN_TOTAL_MESSAGES</span><pre>OID_BGP_PEER_IN_TOTAL_MESSAGES</pre></a></li>
  129. <li class="constant "><a href="#OID_BGP_PEER_IN_UPDATES" title="OID_BGP_PEER_IN_UPDATES :: "><span class="description">OID_BGP_PEER_IN_UPDATES</span><pre>OID_BGP_PEER_IN_UPDATES</pre></a></li>
  130. <li class="constant "><a href="#OID_BGP_PEER_IN_UPDATE_ELAPSED_TIME" title="OID_BGP_PEER_IN_UPDATE_ELAPSED_TIME :: "><span class="description">OID_BGP_PEER_IN_UPDATE_ELAPSED_TIME</span><pre>OID_BGP_PEER_IN_UPDATE_ELAPSED_TIME</pre></a></li>
  131. <li class="constant "><a href="#OID_BGP_PEER_KEEP_ALIVE" title="OID_BGP_PEER_KEEP_ALIVE :: "><span class="description">OID_BGP_PEER_KEEP_ALIVE</span><pre>OID_BGP_PEER_KEEP_ALIVE</pre></a></li>
  132. <li class="constant "><a href="#OID_BGP_PEER_KEEP_ALIVE_CONFIGURED" title="OID_BGP_PEER_KEEP_ALIVE_CONFIGURED :: "><span class="description">OID_BGP_PEER_KEEP_ALIVE_CONFIGURED</span><pre>OID_BGP_PEER_KEEP_ALIVE_CONFIGURED</pre></a></li>
  133. <li class="constant "><a href="#OID_BGP_PEER_LAST_ERROR" title="OID_BGP_PEER_LAST_ERROR :: "><span class="description">OID_BGP_PEER_LAST_ERROR</span><pre>OID_BGP_PEER_LAST_ERROR</pre></a></li>
  134. <li class="constant "><a href="#OID_BGP_PEER_LOCAL_ADDRESS" title="OID_BGP_PEER_LOCAL_ADDRESS :: "><span class="description">OID_BGP_PEER_LOCAL_ADDRESS</span><pre>OID_BGP_PEER_LOCAL_ADDRESS</pre></a></li>
  135. <li class="constant "><a href="#OID_BGP_PEER_LOCAL_PORT" title="OID_BGP_PEER_LOCAL_PORT :: "><span class="description">OID_BGP_PEER_LOCAL_PORT</span><pre>OID_BGP_PEER_LOCAL_PORT</pre></a></li>
  136. <li class="constant "><a href="#OID_BGP_PEER_MIN_AS_ORIGINATION_INTERVAL" title="OID_BGP_PEER_MIN_AS_ORIGINATION_INTERVAL :: "><span class="description">OID_BGP_PEER_MIN_AS_ORIGINATION_INTERVAL</span><pre>OID_BGP_PEER_MIN_AS_ORIGINATION_INTERVAL</pre></a></li>
  137. <li class="constant "><a href="#OID_BGP_PEER_MIN_ROUTE_ADVERTISEMENT_INTERVAL" title="OID_BGP_PEER_MIN_ROUTE_ADVERTISEMENT_INTERVAL :: "><span class="description">OID_BGP_PEER_MIN_ROUTE_ADVERTISEMENT_INTERVAL</span><pre>OID_BGP_PEER_MIN_ROUTE_ADVERTISEMENT_INTERVAL</pre></a></li>
  138. <li class="constant "><a href="#OID_BGP_PEER_NEGOTIATED_VERSION" title="OID_BGP_PEER_NEGOTIATED_VERSION :: "><span class="description">OID_BGP_PEER_NEGOTIATED_VERSION</span><pre>OID_BGP_PEER_NEGOTIATED_VERSION</pre></a></li>
  139. <li class="constant "><a href="#OID_BGP_PEER_OUT_TOTAL_MESSAGES" title="OID_BGP_PEER_OUT_TOTAL_MESSAGES :: "><span class="description">OID_BGP_PEER_OUT_TOTAL_MESSAGES</span><pre>OID_BGP_PEER_OUT_TOTAL_MESSAGES</pre></a></li>
  140. <li class="constant "><a href="#OID_BGP_PEER_OUT_UPDATES" title="OID_BGP_PEER_OUT_UPDATES :: "><span class="description">OID_BGP_PEER_OUT_UPDATES</span><pre>OID_BGP_PEER_OUT_UPDATES</pre></a></li>
  141. <li class="constant "><a href="#OID_BGP_PEER_REMOTE_ADDR" title="OID_BGP_PEER_REMOTE_ADDR :: "><span class="description">OID_BGP_PEER_REMOTE_ADDR</span><pre>OID_BGP_PEER_REMOTE_ADDR</pre></a></li>
  142. <li class="constant "><a href="#OID_BGP_PEER_REMOTE_ASN" title="OID_BGP_PEER_REMOTE_ASN :: "><span class="description">OID_BGP_PEER_REMOTE_ASN</span><pre>OID_BGP_PEER_REMOTE_ASN</pre></a></li>
  143. <li class="constant "><a href="#OID_BGP_PEER_REMOTE_PORT" title="OID_BGP_PEER_REMOTE_PORT :: "><span class="description">OID_BGP_PEER_REMOTE_PORT</span><pre>OID_BGP_PEER_REMOTE_PORT</pre></a></li>
  144. <li class="constant "><a href="#OID_BGP_VERSION" title="OID_BGP_VERSION :: "><span class="description">OID_BGP_VERSION</span><pre>OID_BGP_VERSION</pre></a></li>
  145. </ul>
  146. </div>
  147. <div class="span8">
  148. <a name="%5COSS_SNMP%5CMIBS%5CBGP" id="\OSS_SNMP\MIBS\BGP"></a><ul class="breadcrumb">
  149. <li>
  150. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  151. </li>
  152. <li><a href="../namespaces/OSS_SNMP.html">OSS_SNMP</a></li>
  153. <span class="divider">\</span><li><a href="../namespaces/OSS_SNMP.MIBS.html">MIBS</a></li>
  154. <li class="active">
  155. <span class="divider">\</span><a href="../classes/OSS_SNMP.MIBS.BGP.html">BGP</a>
  156. </li>
  157. </ul>
  158. <div href="../classes/OSS_SNMP.MIBS.BGP.html" class="element class">
  159. <p class="short_description">A class for performing SNMP V2 BGP queries</p>
  160. <div class="details">
  161. <p class="long_description"></p>
  162. <table class="table table-bordered">
  163. <tr>
  164. <th>see</th>
  165. <td>\OSS_SNMP\MIBS\http://tools.cisco.com/Support/SNMP/do/BrowseOID.do?local=en&amp;translate=Translate&amp;objectInput=1.3.6.1.2.1.15</td>
  166. </tr>
  167. <tr>
  168. <th>copyright</th>
  169. <td>Copyright (c) 2012, Open Source Solutions Limited, Dublin, Ireland</td>
  170. </tr>
  171. <tr>
  172. <th>author</th>
  173. <td><a href="mailto:barry@opensolutions.ie">Barry O'Donovan</a></td>
  174. </tr>
  175. </table>
  176. <h3>
  177. <i class="icon-custom icon-method"></i> Methods</h3>
  178. <a name="identifier" id="identifier"></a><div class="element clickable method public identifier" data-toggle="collapse" data-target=".identifier .collapse">
  179. <h2>Returns the local BGP identifier</h2>
  180. <pre>identifier() : string</pre>
  181. <div class="labels"></div>
  182. <div class="row collapse"><div class="detail-description">
  183. <p class="long_description"><blockquote>
  184. <p>"The BGP Identifier of local system."</p>
  185. </blockquote></p>
  186. <h3>Returns</h3>
  187. <div class="subelement response">
  188. <code>string</code>The BGP Identifier of local system.</div>
  189. </div></div>
  190. </div>
  191. <a name="localASN" id="localASN"></a><div class="element clickable method public localASN" data-toggle="collapse" data-target=".localASN .collapse">
  192. <h2>Returns the local BGP AS number</h2>
  193. <pre>localASN() : int</pre>
  194. <div class="labels"></div>
  195. <div class="row collapse"><div class="detail-description">
  196. <p class="long_description"><blockquote>
  197. <p>"The local autonomous system number."</p>
  198. </blockquote></p>
  199. <h3>Returns</h3>
  200. <div class="subelement response">
  201. <code>int</code>The local autonomous system number.</div>
  202. </div></div>
  203. </div>
  204. <a name="peerAdminStates" id="peerAdminStates"></a><div class="element clickable method public peerAdminStates" data-toggle="collapse" data-target=".peerAdminStates .collapse">
  205. <h2>Returns the BGP peer admin states (see `self::$BGP_PEER_ADMIN_STATES`)</h2>
  206. <pre>peerAdminStates(bool $translate) : array</pre>
  207. <div class="labels"></div>
  208. <div class="row collapse"><div class="detail-description">
  209. <p class="long_description"><blockquote>
  210. <p>"The desired state of the BGP connection. A transition from 'stop' to 'start' will
  211. cause the BGP Start Event to be generated. A transition from 'start' to 'stop' will
  212. cause the BGP Stop Event to be generated. This parameter can be used to restart BGP
  213. peer connections. Care should be used in providing write access to this object
  214. without adequate authentication."</p>
  215. </blockquote></p>
  216. <h3>Parameters</h3>
  217. <div class="subelement argument">
  218. <h4>$translate</h4>
  219. <code>bool</code><p>If true, use the <code>$BGP_PEER_ADMIN_STATES</code> array to return textual representation</p>
  220. </div>
  221. <h3>Returns</h3>
  222. <div class="subelement response">
  223. <code>array</code>The BGP peer admin states (see `self::$BGP_PEER_ADMIN_STATES`)</div>
  224. </div></div>
  225. </div>
  226. <a name="peerConnectRetryIntervals" id="peerConnectRetryIntervals"></a><div class="element clickable method public peerConnectRetryIntervals" data-toggle="collapse" data-target=".peerConnectRetryIntervals .collapse">
  227. <h2>Returns Time interval in seconds for the ConnectRetry timer.</h2>
  228. <pre>peerConnectRetryIntervals() : array</pre>
  229. <div class="labels"></div>
  230. <div class="row collapse"><div class="detail-description">
  231. <p class="long_description"><blockquote>
  232. <p>"Time interval in seconds for the ConnectRetry timer. The suggested value
  233. for this timer is 120 seconds."</p>
  234. </blockquote></p>
  235. <h3>Returns</h3>
  236. <div class="subelement response">
  237. <code>array</code>Time interval in seconds for the ConnectRetry timer.</div>
  238. </div></div>
  239. </div>
  240. <a name="peerConnectionStates" id="peerConnectionStates"></a><div class="element clickable method public peerConnectionStates" data-toggle="collapse" data-target=".peerConnectionStates .collapse">
  241. <h2>Returns the BGP peer connection state (see `self::$BGP_PEER_CONNECTION_STATES`)</h2>
  242. <pre>peerConnectionStates(bool $translate) : array</pre>
  243. <div class="labels"></div>
  244. <div class="row collapse"><div class="detail-description">
  245. <p class="long_description"><blockquote>
  246. <p>"The BGP peer connection state."</p>
  247. </blockquote></p>
  248. <h3>Parameters</h3>
  249. <div class="subelement argument">
  250. <h4>$translate</h4>
  251. <code>bool</code><p>If true, use the <code>$BGP_PEER_CONNECTION_STATES</code> array to return textual representation</p>
  252. </div>
  253. <h3>Returns</h3>
  254. <div class="subelement response">
  255. <code>array</code>The BGP peer connection state (see `self::$BGP_PEER_CONNECTION_STATES`)</div>
  256. </div></div>
  257. </div>
  258. <a name="peerDetails" id="peerDetails"></a><div class="element clickable method public peerDetails" data-toggle="collapse" data-target=".peerDetails .collapse">
  259. <h2>Utility function to gather all peer information into a single array.</h2>
  260. <pre>peerDetails(bool $translate) : array</pre>
  261. <div class="labels"></div>
  262. <div class="row collapse"><div class="detail-description">
  263. <p class="long_description"><p>For example, this would return something like:</p>
  264. <pre><code>Array
  265. (
  266. ....
  267. [192.0.2.126] =&gt; Array
  268. (
  269. [identity] =&gt; 192.0.2.45
  270. [connectionState] =&gt; established
  271. [adminState] =&gt; start
  272. [negotiatedVersion] =&gt; 4
  273. [localAddress] =&gt; 193.242.111.74
  274. [localPort] =&gt; 26789
  275. [remoteAddress] =&gt; 192.0.2.126
  276. [remotePort] =&gt; 179
  277. [remoteASN] =&gt; 65505
  278. [inUpdates] =&gt; 4
  279. [outUpdates] =&gt; 2
  280. [inTotalMessages] =&gt; 180988
  281. [outTotalMessages] =&gt; 181012
  282. [lastError] =&gt; 0000
  283. [establishedTransitions] =&gt; 1
  284. [establishedTime] =&gt; 9867469
  285. [connectRetryInterval] =&gt; 60
  286. [holdTime] =&gt; 180
  287. [keepAlive] =&gt; 60
  288. [holdTimeConfigured] =&gt; 180
  289. [keepAliveConfigured] =&gt; 60
  290. [minASOriginationInterval] =&gt; 30
  291. [minRouteAdvertisementInterval] =&gt; 30
  292. [inUpdateElapsedTime] =&gt; 0
  293. )
  294. ....
  295. )
  296. </code></pre></p>
  297. <h3>Parameters</h3>
  298. <div class="subelement argument">
  299. <h4>$translate</h4>
  300. <code>bool</code><p>Where a called function supports translation, if true then translate</p></div>
  301. <h3>Returns</h3>
  302. <div class="subelement response">
  303. <code>array</code>Array of peer details - see example above.</div>
  304. </div></div>
  305. </div>
  306. <a name="peerEstabledTransitions" id="peerEstabledTransitions"></a><div class="element clickable method public peerEstabledTransitions" data-toggle="collapse" data-target=".peerEstabledTransitions .collapse">
  307. <h2>Returns The total number of times the BGP FSM transitioned into the established state.</h2>
  308. <pre>peerEstabledTransitions() : array</pre>
  309. <div class="labels"></div>
  310. <div class="row collapse"><div class="detail-description">
  311. <p class="long_description"><blockquote>
  312. <p>"The total number of times the BGP FSM transitioned into the established state."</p>
  313. </blockquote></p>
  314. <h3>Returns</h3>
  315. <div class="subelement response">
  316. <code>array</code>The total number of times the BGP FSM transitioned into the established state.</div>
  317. </div></div>
  318. </div>
  319. <a name="peerEstablishedTimes" id="peerEstablishedTimes"></a><div class="element clickable method public peerEstablishedTimes" data-toggle="collapse" data-target=".peerEstablishedTimes .collapse">
  320. <h2>Returns how long (in seconds) this peer has been in the Established state or
  321. how long since this peer was last in the Established state</h2>
  322. <pre>peerEstablishedTimes() : array</pre>
  323. <div class="labels"></div>
  324. <div class="row collapse"><div class="detail-description">
  325. <p class="long_description"><blockquote>
  326. <p>"This timer indicates how long (in seconds) this peer has been in the
  327. Established state or how long since this peer was last in the
  328. Established state. It is set to zero when a new peer is configured or the router is
  329. booted"</p>
  330. </blockquote></p>
  331. <h3>Returns</h3>
  332. <div class="subelement response">
  333. <code>array</code>How long (secs) this peer has been in (or since it was last in) the Established state</div>
  334. </div></div>
  335. </div>
  336. <a name="peerHoldTimes" id="peerHoldTimes"></a><div class="element clickable method public peerHoldTimes" data-toggle="collapse" data-target=".peerHoldTimes .collapse">
  337. <h2>Returns Time interval in seconds for the Hold Timer established with the peer.</h2>
  338. <pre>peerHoldTimes() : array</pre>
  339. <div class="labels"></div>
  340. <div class="row collapse"><div class="detail-description">
  341. <p class="long_description"><blockquote>
  342. <p>"Time interval in seconds for the Hold Timer established with the peer. The
  343. value of this object is calculated by this BGP speaker by using the smaller of the
  344. value in bgpPeerHoldTimeConfigured and the Hold Time received in the OPEN message.
  345. This value must be at lease three seconds if it is not zero (0) in which case the
  346. Hold Timer has not been established with the peer, or, the value of
  347. bgpPeerHoldTimeConfigured is zero (0)."</p>
  348. </blockquote></p>
  349. <h3>Returns</h3>
  350. <div class="subelement response">
  351. <code>array</code>Time interval in seconds for the Hold Timer established with the peer.</div>
  352. </div></div>
  353. </div>
  354. <a name="peerHoleTimesConfigured" id="peerHoleTimesConfigured"></a><div class="element clickable method public peerHoleTimesConfigured" data-toggle="collapse" data-target=".peerHoleTimesConfigured .collapse">
  355. <h2>Returns Time interval in seconds for the Hold Time configured for this BGP speaker with this peer.</h2>
  356. <pre>peerHoleTimesConfigured() : array</pre>
  357. <div class="labels"></div>
  358. <div class="row collapse"><div class="detail-description">
  359. <p class="long_description"><blockquote>
  360. <p>"Time interval in seconds for the Hold Time configured for this BGP speaker with this
  361. peer. This value is placed in an OPEN message sent to this peer by this BGP
  362. speaker, and is compared with the Hold Time field in an OPEN message received
  363. from the peer when determining the Hold Time (bgpPeerHoldTime) with the peer.
  364. This value must not be less than three seconds if it is not zero (0) in which
  365. case the Hold Time is NOT to be established with the peer. The suggested
  366. value for this timer is 90 seconds."</p>
  367. </blockquote></p>
  368. <h3>Returns</h3>
  369. <div class="subelement response">
  370. <code>array</code>Time interval in seconds for the Hold Time configured for this BGP speaker with this peer.</div>
  371. </div></div>
  372. </div>
  373. <a name="peerIdentifiers" id="peerIdentifiers"></a><div class="element clickable method public peerIdentifiers" data-toggle="collapse" data-target=".peerIdentifiers .collapse">
  374. <h2>Returns the BGP identifier of all peers indexed by neighbour IPv4 address</h2>
  375. <pre>peerIdentifiers() : array</pre>
  376. <div class="labels"></div>
  377. <div class="row collapse"><div class="detail-description">
  378. <p class="long_description"><blockquote>
  379. <p>"The BGP Identifier of this entry's BGP peer."</p>
  380. </blockquote></p>
  381. <h3>Returns</h3>
  382. <div class="subelement response">
  383. <code>array</code>Returns the BGP identifier of all peers indexed by neighbour IPv4 address</div>
  384. </div></div>
  385. </div>
  386. <a name="peerInTotalMessages" id="peerInTotalMessages"></a><div class="element clickable method public peerInTotalMessages" data-toggle="collapse" data-target=".peerInTotalMessages .collapse">
  387. <h2>Returns The total number of messages received from the remote peer on this connection.</h2>
  388. <pre>peerInTotalMessages() : array</pre>
  389. <div class="labels"></div>
  390. <div class="row collapse"><div class="detail-description">
  391. <p class="long_description"><blockquote>
  392. <p>"The total number of messages received from the remote peer on this connection.
  393. This object should be initialized to zero when the connection is established."</p>
  394. </blockquote></p>
  395. <h3>Returns</h3>
  396. <div class="subelement response">
  397. <code>array</code>The total number of messages received from the remote peer on this connection.</div>
  398. </div></div>
  399. </div>
  400. <a name="peerInUpdateElapsedTimes" id="peerInUpdateElapsedTimes"></a><div class="element clickable method public peerInUpdateElapsedTimes" data-toggle="collapse" data-target=".peerInUpdateElapsedTimes .collapse">
  401. <h2>Returns Elapsed time in seconds since the last BGP UPDATE message was received from the peer.</h2>
  402. <pre>peerInUpdateElapsedTimes() : array</pre>
  403. <div class="labels"></div>
  404. <div class="row collapse"><div class="detail-description">
  405. <p class="long_description"><blockquote>
  406. <p>"Elapsed time in seconds since the last BGP UPDATE message was received from the peer.
  407. Each time bgpPeerInUpdates is incremented, the value of this object is set to zero (0)."</p>
  408. </blockquote></p>
  409. <h3>Returns</h3>
  410. <div class="subelement response">
  411. <code>array</code>Elapsed time in seconds since the last BGP UPDATE message was received from the peer.</div>
  412. </div></div>
  413. </div>
  414. <a name="peerInUpdates" id="peerInUpdates"></a><div class="element clickable method public peerInUpdates" data-toggle="collapse" data-target=".peerInUpdates .collapse">
  415. <h2>Returns The number of BGP UPDATE messages received on this connection.</h2>
  416. <pre>peerInUpdates() : array</pre>
  417. <div class="labels"></div>
  418. <div class="row collapse"><div class="detail-description">
  419. <p class="long_description"><blockquote>
  420. <p>"The number of BGP UPDATE messages received on this connection. This object
  421. should be initialized to zero (0) when the connection is established."</p>
  422. </blockquote></p>
  423. <h3>Returns</h3>
  424. <div class="subelement response">
  425. <code>array</code>The number of BGP UPDATE messages received on this connection.</div>
  426. </div></div>
  427. </div>
  428. <a name="peerKeepAlives" id="peerKeepAlives"></a><div class="element clickable method public peerKeepAlives" data-toggle="collapse" data-target=".peerKeepAlives .collapse">
  429. <h2>Returns Time interval in seconds for the KeepAlive timer established with the peer.</h2>
  430. <pre>peerKeepAlives() : array</pre>
  431. <div class="labels"></div>
  432. <div class="row collapse"><div class="detail-description">
  433. <p class="long_description"><blockquote>
  434. <p>"Time interval in seconds for the KeepAlive timer established with the peer. The value
  435. of this object is calculated by this BGP speaker such that, when compared with
  436. bgpPeerHoldTime, it has the same proportion as what bgpPeerKeepAliveConfigured has when
  437. compared with bgpPeerHoldTimeConfigured. If the value of this object is zero (0),
  438. it indicates that the KeepAlive timer has not been established with the peer, or,
  439. the value of bgpPeerKeepAliveConfigured is zero (0)."</p>
  440. </blockquote></p>
  441. <h3>Returns</h3>
  442. <div class="subelement response">
  443. <code>array</code>Time interval in seconds for the KeepAlive timer established with the peer.</div>
  444. </div></div>
  445. </div>
  446. <a name="peerKeepAlivesConfigured" id="peerKeepAlivesConfigured"></a><div class="element clickable method public peerKeepAlivesConfigured" data-toggle="collapse" data-target=".peerKeepAlivesConfigured .collapse">
  447. <h2>Returns Time interval in seconds for the KeepAlive timer configured for this BGP speaker with this peer.</h2>
  448. <pre>peerKeepAlivesConfigured() : array</pre>
  449. <div class="labels"></div>
  450. <div class="row collapse"><div class="detail-description">
  451. <p class="long_description"><blockquote>
  452. <p>"Time interval in seconds for the KeepAlive timer configured for this BGP
  453. speaker with this peer. The value of this object will only determine the
  454. KEEPALIVE messages' frequency relative to the value specified in
  455. bgpPeerHoldTimeConfigured; the actual time interval for the KEEPALIVE messages
  456. is indicated by bgpPeerKeepAlive. A reasonable maximum value for this timer
  457. would be configured to be one third of that of bgpPeerHoldTimeConfigured.
  458. If the value of this object is zero (0), no periodical KEEPALIVE messages are sent
  459. to the peer after the BGP connection has been established. The suggested value for
  460. this timer is 30 seconds"</p>
  461. </blockquote></p>
  462. <h3>Returns</h3>
  463. <div class="subelement response">
  464. <code>array</code>Time interval in seconds for the KeepAlive timer configured for this BGP speaker with this peer.</div>
  465. </div></div>
  466. </div>
  467. <a name="peerLastErrors" id="peerLastErrors"></a><div class="element clickable method public peerLastErrors" data-toggle="collapse" data-target=".peerLastErrors .collapse">
  468. <h2>Returns The last error code and subcode seen by this peer on this connection.</h2>
  469. <pre>peerLastErrors() : array</pre>
  470. <div class="labels"></div>
  471. <div class="row collapse"><div class="detail-description">
  472. <p class="long_description"><blockquote>
  473. <p>"The last error code and subcode seen by this peer on this connection. If no error has
  474. occurred, this field is zero. Otherwise, the first byte of this two byte OCTET STRING
  475. contains the error code, and the second byte contains the subcode."</p>
  476. </blockquote></p>
  477. <h3>Returns</h3>
  478. <div class="subelement response">
  479. <code>array</code>The last error code and subcode seen by this peer on this connection.</div>
  480. </div></div>
  481. </div>
  482. <a name="peerLocalAddresses" id="peerLocalAddresses"></a><div class="element clickable method public peerLocalAddresses" data-toggle="collapse" data-target=".peerLocalAddresses .collapse">
  483. <h2>Returns the local IP address of this entry's BGP connection.</h2>
  484. <pre>peerLocalAddresses() : array</pre>
  485. <div class="labels"></div>
  486. <div class="row collapse"><div class="detail-description">
  487. <p class="long_description"><blockquote>
  488. <p>"The local IP address of this entry's BGP connection."</p>
  489. </blockquote></p>
  490. <h3>Returns</h3>
  491. <div class="subelement response">
  492. <code>array</code>The local IP address of this entry's BGP connection.</div>
  493. </div></div>
  494. </div>
  495. <a name="peerLocalPorts" id="peerLocalPorts"></a><div class="element clickable method public peerLocalPorts" data-toggle="collapse" data-target=".peerLocalPorts .collapse">
  496. <h2>Returns the local ports for the TCP connections between the BGP peers.</h2>
  497. <pre>peerLocalPorts() : array</pre>
  498. <div class="labels"></div>
  499. <div class="row collapse"><div class="detail-description">
  500. <p class="long_description"><blockquote>
  501. <p>"The local port for the TCP connection between the BGP peers."</p>
  502. </blockquote></p>
  503. <h3>Returns</h3>
  504. <div class="subelement response">
  505. <code>array</code>The local ports for the TCP connections between the BGP peers.</div>
  506. </div></div>
  507. </div>
  508. <a name="peerMinASOriginationIntervals" id="peerMinASOriginationIntervals"></a><div class="element clickable method public peerMinASOriginationIntervals" data-toggle="collapse" data-target=".peerMinASOriginationIntervals .collapse">
  509. <h2>Returns Time interval in seconds for the MinASOriginationInterval timer.</h2>
  510. <pre>peerMinASOriginationIntervals() : array</pre>
  511. <div class="labels"></div>
  512. <div class="row collapse"><div class="detail-description">
  513. <p class="long_description"><blockquote>
  514. <p>"Time interval in seconds for the MinASOriginationInterval timer.
  515. The suggested value for this timer is 15 seconds."</p>
  516. </blockquote></p>
  517. <h3>Returns</h3>
  518. <div class="subelement response">
  519. <code>array</code>Time interval in seconds for the MinASOriginationInterval timer.</div>
  520. </div></div>
  521. </div>
  522. <a name="peerMinRouteAdvertisementIntervals" id="peerMinRouteAdvertisementIntervals"></a><div class="element clickable method public peerMinRouteAdvertisementIntervals" data-toggle="collapse" data-target=".peerMinRouteAdvertisementIntervals .collapse">
  523. <h2>Returns Time interval in seconds for the MinRouteAdvertisementInterval timer.</h2>
  524. <pre>peerMinRouteAdvertisementIntervals() : array</pre>
  525. <div class="labels"></div>
  526. <div class="row collapse"><div class="detail-description">
  527. <p class="long_description"><blockquote>
  528. <p>"Time interval in seconds for the MinRouteAdvertisementInterval timer.
  529. The suggested value for this timer is 30 seconds"</p>
  530. </blockquote></p>
  531. <h3>Returns</h3>
  532. <div class="subelement response">
  533. <code>array</code>Time interval in seconds for the MinRouteAdvertisementInterval timer.</div>
  534. </div></div>
  535. </div>
  536. <a name="peerNegotiatedVersions" id="peerNegotiatedVersions"></a><div class="element clickable method public peerNegotiatedVersions" data-toggle="collapse" data-target=".peerNegotiatedVersions .collapse">
  537. <h2>Returns the negotiated version of BGP running between the two peers</h2>
  538. <pre>peerNegotiatedVersions() : array</pre>
  539. <div class="labels"></div>
  540. <div class="row collapse"><div class="detail-description">
  541. <p class="long_description"><blockquote>
  542. <p>"The negotiated version of BGP running between the two peers"</p>
  543. </blockquote></p>
  544. <h3>Returns</h3>
  545. <div class="subelement response">
  546. <code>array</code>The negotiated version of BGP running between the two peers</div>
  547. </div></div>
  548. </div>
  549. <a name="peerOutTotalMessages" id="peerOutTotalMessages"></a><div class="element clickable method public peerOutTotalMessages" data-toggle="collapse" data-target=".peerOutTotalMessages .collapse">
  550. <h2>Returns The total number of messages transmitted to the remote peer on this connection.</h2>
  551. <pre>peerOutTotalMessages() : array</pre>
  552. <div class="labels"></div>
  553. <div class="row collapse"><div class="detail-description">
  554. <p class="long_description"><blockquote>
  555. <p>"The total number of messages transmitted to the remote peer on this connection. This
  556. object should be initialized to zero when the connection is established."</p>
  557. </blockquote></p>
  558. <h3>Returns</h3>
  559. <div class="subelement response">
  560. <code>array</code>The total number of messages transmitted to the remote peer on this connection.</div>
  561. </div></div>
  562. </div>
  563. <a name="peerOutUpdates" id="peerOutUpdates"></a><div class="element clickable method public peerOutUpdates" data-toggle="collapse" data-target=".peerOutUpdates .collapse">
  564. <h2>Returns The number of BGP UPDATE messages transmitted on this connection.</h2>
  565. <pre>peerOutUpdates() : array</pre>
  566. <div class="labels"></div>
  567. <div class="row collapse"><div class="detail-description">
  568. <p class="long_description"><blockquote>
  569. <p>"The number of BGP UPDATE messages transmitted on this connection. This
  570. object should be initialized to zero (0) when the connection is established."</p>
  571. </blockquote></p>
  572. <h3>Returns</h3>
  573. <div class="subelement response">
  574. <code>array</code>The number of BGP UPDATE messages transmitted on this connection.</div>
  575. </div></div>
  576. </div>
  577. <a name="peerRemoteASNs" id="peerRemoteASNs"></a><div class="element clickable method public peerRemoteASNs" data-toggle="collapse" data-target=".peerRemoteASNs .collapse">
  578. <h2>Returns The remote autonomous system number.</h2>
  579. <pre>peerRemoteASNs() : array</pre>
  580. <div class="labels"></div>
  581. <div class="row collapse"><div class="detail-description">
  582. <p class="long_description"><blockquote>
  583. <p>"The remote autonomous system number."</p>
  584. </blockquote></p>
  585. <h3>Returns</h3>
  586. <div class="subelement response">
  587. <code>array</code>The remote autonomous system number.</div>
  588. </div></div>
  589. </div>
  590. <a name="peerRemoteAddresses" id="peerRemoteAddresses"></a><div class="element clickable method public peerRemoteAddresses" data-toggle="collapse" data-target=".peerRemoteAddresses .collapse">
  591. <h2>Returns the local IP address of this entry's BGP peer.</h2>
  592. <pre>peerRemoteAddresses() : array</pre>
  593. <div class="labels"></div>
  594. <div class="row collapse"><div class="detail-description">
  595. <p class="long_description"><blockquote>
  596. <p>"The remote IP address of this entry's BGP peer."</p>
  597. </blockquote></p>
  598. <h3>Returns</h3>
  599. <div class="subelement response">
  600. <code>array</code>The remote IP address of this entry's BGP peer.</div>
  601. </div></div>
  602. </div>
  603. <a name="peerRemotePorts" id="peerRemotePorts"></a><div class="element clickable method public peerRemotePorts" data-toggle="collapse" data-target=".peerRemotePorts .collapse">
  604. <h2>Returns the remote ports for the TCP connections between the BGP peers.</h2>
  605. <pre>peerRemotePorts() : array</pre>
  606. <div class="labels"></div>
  607. <div class="row collapse"><div class="detail-description">
  608. <p class="long_description"><blockquote>
  609. <p>"The remote port for the TCP connection between the BGP peers."</p>
  610. </blockquote></p>
  611. <h3>Returns</h3>
  612. <div class="subelement response">
  613. <code>array</code>The remote ports for the TCP connections between the BGP peers.</div>
  614. </div></div>
  615. </div>
  616. <a name="version" id="version"></a><div class="element clickable method public version" data-toggle="collapse" data-target=".version .collapse">
  617. <h2>Returns the BGP version</h2>
  618. <pre>version() : string</pre>
  619. <div class="labels"></div>
  620. <div class="row collapse"><div class="detail-description">
  621. <p class="long_description"><blockquote>
  622. <p>"Vector of supported BGP protocol version numbers. Each peer negotiates the version
  623. from this vector. Versions are identified via the string of bits contained within this
  624. object. The first octet contains bits 0 to 7, the second octet contains bits 8 to 15,
  625. and so on, with the most significant bit referring to the lowest bit number in the
  626. octet (e.g., the MSB of the first octet refers to bit 0). If a bit, i, is present
  627. and set, then the version (i+1) of the BGP is supported."</p>
  628. </blockquote></p>
  629. <h3>Returns</h3>
  630. <div class="subelement response">
  631. <code>string</code>Returns the BGP version</div>
  632. </div></div>
  633. </div>
  634. <h3>
  635. <i class="icon-custom icon-property"></i> Properties</h3>
  636. <a name="%24BGP_PEER_ADMIN_STATES" id="$BGP_PEER_ADMIN_STATES"> </a><div class="element clickable property public $BGP_PEER_ADMIN_STATES" data-toggle="collapse" data-target=".$BGP_PEER_ADMIN_STATES .collapse">
  637. <h2>$BGP_PEER_ADMIN_STATES</h2>
  638. <pre>$BGP_PEER_ADMIN_STATES </pre>
  639. <div class="labels"></div>
  640. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  641. </div>
  642. <a name="%24BGP_PEER_CONNECTION_STATES" id="$BGP_PEER_CONNECTION_STATES"> </a><div class="element clickable property public $BGP_PEER_CONNECTION_STATES" data-toggle="collapse" data-target=".$BGP_PEER_CONNECTION_STATES .collapse">
  643. <h2>$BGP_PEER_CONNECTION_STATES</h2>
  644. <pre>$BGP_PEER_CONNECTION_STATES </pre>
  645. <div class="labels"></div>
  646. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  647. </div>
  648. <h3>
  649. <i class="icon-custom icon-constant"></i> Constants</h3>
  650. <a name="BGP_PEER_ADMIN_STATE_START" id="BGP_PEER_ADMIN_STATE_START"> </a><div class="element clickable constant BGP_PEER_ADMIN_STATE_START" data-toggle="collapse" data-target=".BGP_PEER_ADMIN_STATE_START .collapse">
  651. <h2>BGP_PEER_ADMIN_STATE_START</h2>
  652. <pre>BGP_PEER_ADMIN_STATE_START </pre>
  653. <div class="labels"></div>
  654. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  655. </div>
  656. <a name="BGP_PEER_ADMIN_STATE_STOP" id="BGP_PEER_ADMIN_STATE_STOP"> </a><div class="element clickable constant BGP_PEER_ADMIN_STATE_STOP" data-toggle="collapse" data-target=".BGP_PEER_ADMIN_STATE_STOP .collapse">
  657. <h2>BGP_PEER_ADMIN_STATE_STOP</h2>
  658. <pre>BGP_PEER_ADMIN_STATE_STOP </pre>
  659. <div class="labels"></div>
  660. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  661. </div>
  662. <a name="BGP_PEER_CONNECTION_STATE_ACTIVE" id="BGP_PEER_CONNECTION_STATE_ACTIVE"> </a><div class="element clickable constant BGP_PEER_CONNECTION_STATE_ACTIVE" data-toggle="collapse" data-target=".BGP_PEER_CONNECTION_STATE_ACTIVE .collapse">
  663. <h2>BGP_PEER_CONNECTION_STATE_ACTIVE</h2>
  664. <pre>BGP_PEER_CONNECTION_STATE_ACTIVE </pre>
  665. <div class="labels"></div>
  666. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  667. </div>
  668. <a name="BGP_PEER_CONNECTION_STATE_CONNECT" id="BGP_PEER_CONNECTION_STATE_CONNECT"> </a><div class="element clickable constant BGP_PEER_CONNECTION_STATE_CONNECT" data-toggle="collapse" data-target=".BGP_PEER_CONNECTION_STATE_CONNECT .collapse">
  669. <h2>BGP_PEER_CONNECTION_STATE_CONNECT</h2>
  670. <pre>BGP_PEER_CONNECTION_STATE_CONNECT </pre>
  671. <div class="labels"></div>
  672. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  673. </div>
  674. <a name="BGP_PEER_CONNECTION_STATE_ESTABLISHED" id="BGP_PEER_CONNECTION_STATE_ESTABLISHED"> </a><div class="element clickable constant BGP_PEER_CONNECTION_STATE_ESTABLISHED" data-toggle="collapse" data-target=".BGP_PEER_CONNECTION_STATE_ESTABLISHED .collapse">
  675. <h2>BGP_PEER_CONNECTION_STATE_ESTABLISHED</h2>
  676. <pre>BGP_PEER_CONNECTION_STATE_ESTABLISHED </pre>
  677. <div class="labels"></div>
  678. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  679. </div>
  680. <a name="BGP_PEER_CONNECTION_STATE_IDLE" id="BGP_PEER_CONNECTION_STATE_IDLE"> </a><div class="element clickable constant BGP_PEER_CONNECTION_STATE_IDLE" data-toggle="collapse" data-target=".BGP_PEER_CONNECTION_STATE_IDLE .collapse">
  681. <h2>BGP_PEER_CONNECTION_STATE_IDLE</h2>
  682. <pre>BGP_PEER_CONNECTION_STATE_IDLE </pre>
  683. <div class="labels"></div>
  684. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  685. </div>
  686. <a name="BGP_PEER_CONNECTION_STATE_OPENCONFIRM" id="BGP_PEER_CONNECTION_STATE_OPENCONFIRM"> </a><div class="element clickable constant BGP_PEER_CONNECTION_STATE_OPENCONFIRM" data-toggle="collapse" data-target=".BGP_PEER_CONNECTION_STATE_OPENCONFIRM .collapse">
  687. <h2>BGP_PEER_CONNECTION_STATE_OPENCONFIRM</h2>
  688. <pre>BGP_PEER_CONNECTION_STATE_OPENCONFIRM </pre>
  689. <div class="labels"></div>
  690. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  691. </div>
  692. <a name="BGP_PEER_CONNECTION_STATE_OPENSENT" id="BGP_PEER_CONNECTION_STATE_OPENSENT"> </a><div class="element clickable constant BGP_PEER_CONNECTION_STATE_OPENSENT" data-toggle="collapse" data-target=".BGP_PEER_CONNECTION_STATE_OPENSENT .collapse">
  693. <h2>BGP_PEER_CONNECTION_STATE_OPENSENT</h2>
  694. <pre>BGP_PEER_CONNECTION_STATE_OPENSENT </pre>
  695. <div class="labels"></div>
  696. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  697. </div>
  698. <a name="OID_BGP_IDENTIFIER" id="OID_BGP_IDENTIFIER"> </a><div class="element clickable constant OID_BGP_IDENTIFIER" data-toggle="collapse" data-target=".OID_BGP_IDENTIFIER .collapse">
  699. <h2>OID_BGP_IDENTIFIER</h2>
  700. <pre>OID_BGP_IDENTIFIER </pre>
  701. <div class="labels"></div>
  702. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  703. </div>
  704. <a name="OID_BGP_LOCAL_ASN" id="OID_BGP_LOCAL_ASN"> </a><div class="element clickable constant OID_BGP_LOCAL_ASN" data-toggle="collapse" data-target=".OID_BGP_LOCAL_ASN .collapse">
  705. <h2>OID_BGP_LOCAL_ASN</h2>
  706. <pre>OID_BGP_LOCAL_ASN </pre>
  707. <div class="labels"></div>
  708. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  709. </div>
  710. <a name="OID_BGP_PATH_ATTR_ADDR_PREFIX" id="OID_BGP_PATH_ATTR_ADDR_PREFIX"> </a><div class="element clickable constant OID_BGP_PATH_ATTR_ADDR_PREFIX" data-toggle="collapse" data-target=".OID_BGP_PATH_ATTR_ADDR_PREFIX .collapse">
  711. <h2>OID_BGP_PATH_ATTR_ADDR_PREFIX</h2>
  712. <pre>OID_BGP_PATH_ATTR_ADDR_PREFIX </pre>
  713. <div class="labels"></div>
  714. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  715. </div>
  716. <a name="OID_BGP_PATH_ATTR_ADDR_PREFIX_LENGTH" id="OID_BGP_PATH_ATTR_ADDR_PREFIX_LENGTH"> </a><div class="element clickable constant OID_BGP_PATH_ATTR_ADDR_PREFIX_LENGTH" data-toggle="collapse" data-target=".OID_BGP_PATH_ATTR_ADDR_PREFIX_LENGTH .collapse">
  717. <h2>OID_BGP_PATH_ATTR_ADDR_PREFIX_LENGTH</h2>
  718. <pre>OID_BGP_PATH_ATTR_ADDR_PREFIX_LENGTH </pre>
  719. <div class="labels"></div>
  720. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  721. </div>
  722. <a name="OID_BGP_PATH_ATTR_AGGREGATOR_ADDR" id="OID_BGP_PATH_ATTR_AGGREGATOR_ADDR"> </a><div class="element clickable constant OID_BGP_PATH_ATTR_AGGREGATOR_ADDR" data-toggle="collapse" data-target=".OID_BGP_PATH_ATTR_AGGREGATOR_ADDR .collapse">
  723. <h2>OID_BGP_PATH_ATTR_AGGREGATOR_ADDR</h2>
  724. <pre>OID_BGP_PATH_ATTR_AGGREGATOR_ADDR </pre>
  725. <div class="labels"></div>
  726. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  727. </div>
  728. <a name="OID_BGP_PATH_ATTR_AGGREGATOR_AS" id="OID_BGP_PATH_ATTR_AGGREGATOR_AS"> </a><div class="element clickable constant OID_BGP_PATH_ATTR_AGGREGATOR_AS" data-toggle="collapse" data-target=".OID_BGP_PATH_ATTR_AGGREGATOR_AS .collapse">
  729. <h2>OID_BGP_PATH_ATTR_AGGREGATOR_AS</h2>
  730. <pre>OID_BGP_PATH_ATTR_AGGREGATOR_AS </pre>
  731. <div class="labels"></div>
  732. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  733. </div>
  734. <a name="OID_BGP_PATH_ATTR_AS_PATH_SEGMENT" id="OID_BGP_PATH_ATTR_AS_PATH_SEGMENT"> </a><div class="element clickable constant OID_BGP_PATH_ATTR_AS_PATH_SEGMENT" data-toggle="collapse" data-target=".OID_BGP_PATH_ATTR_AS_PATH_SEGMENT .collapse">
  735. <h2>OID_BGP_PATH_ATTR_AS_PATH_SEGMENT</h2>
  736. <pre>OID_BGP_PATH_ATTR_AS_PATH_SEGMENT </pre>
  737. <div class="labels"></div>
  738. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  739. </div>
  740. <a name="OID_BGP_PATH_ATTR_ATOMIC_AGGREGATE" id="OID_BGP_PATH_ATTR_ATOMIC_AGGREGATE"> </a><div class="element clickable constant OID_BGP_PATH_ATTR_ATOMIC_AGGREGATE" data-toggle="collapse" data-target=".OID_BGP_PATH_ATTR_ATOMIC_AGGREGATE .collapse">
  741. <h2>OID_BGP_PATH_ATTR_ATOMIC_AGGREGATE</h2>
  742. <pre>OID_BGP_PATH_ATTR_ATOMIC_AGGREGATE </pre>
  743. <div class="labels"></div>
  744. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  745. </div>
  746. <a name="OID_BGP_PATH_ATTR_BEST" id="OID_BGP_PATH_ATTR_BEST"> </a><div class="element clickable constant OID_BGP_PATH_ATTR_BEST" data-toggle="collapse" data-target=".OID_BGP_PATH_ATTR_BEST .collapse">
  747. <h2>OID_BGP_PATH_ATTR_BEST</h2>
  748. <pre>OID_BGP_PATH_ATTR_BEST </pre>
  749. <div class="labels"></div>
  750. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  751. </div>
  752. <a name="OID_BGP_PATH_ATTR_CALC_LOCAL_PREF" id="OID_BGP_PATH_ATTR_CALC_LOCAL_PREF"> </a><div class="element clickable constant OID_BGP_PATH_ATTR_CALC_LOCAL_PREF" data-toggle="collapse" data-target=".OID_BGP_PATH_ATTR_CALC_LOCAL_PREF .collapse">
  753. <h2>OID_BGP_PATH_ATTR_CALC_LOCAL_PREF</h2>
  754. <pre>OID_BGP_PATH_ATTR_CALC_LOCAL_PREF </pre>
  755. <div class="labels"></div>
  756. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  757. </div>
  758. <a name="OID_BGP_PATH_ATTR_LOCAL_PREF" id="OID_BGP_PATH_ATTR_LOCAL_PREF"> </a><div class="element clickable constant OID_BGP_PATH_ATTR_LOCAL_PREF" data-toggle="collapse" data-target=".OID_BGP_PATH_ATTR_LOCAL_PREF .collapse">
  759. <h2>OID_BGP_PATH_ATTR_LOCAL_PREF</h2>
  760. <pre>OID_BGP_PATH_ATTR_LOCAL_PREF </pre>
  761. <div class="labels"></div>
  762. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  763. </div>
  764. <a name="OID_BGP_PATH_ATTR_MED" id="OID_BGP_PATH_ATTR_MED"> </a><div class="element clickable constant OID_BGP_PATH_ATTR_MED" data-toggle="collapse" data-target=".OID_BGP_PATH_ATTR_MED .collapse">
  765. <h2>OID_BGP_PATH_ATTR_MED</h2>
  766. <pre>OID_BGP_PATH_ATTR_MED </pre>
  767. <div class="labels"></div>
  768. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  769. </div>
  770. <a name="OID_BGP_PATH_ATTR_NEXT_HOP" id="OID_BGP_PATH_ATTR_NEXT_HOP"> </a><div class="element clickable constant OID_BGP_PATH_ATTR_NEXT_HOP" data-toggle="collapse" data-target=".OID_BGP_PATH_ATTR_NEXT_HOP .collapse">
  771. <h2>OID_BGP_PATH_ATTR_NEXT_HOP</h2>
  772. <pre>OID_BGP_PATH_ATTR_NEXT_HOP </pre>
  773. <div class="labels"></div>
  774. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  775. </div>
  776. <a name="OID_BGP_PATH_ATTR_ORIGIN" id="OID_BGP_PATH_ATTR_ORIGIN"> </a><div class="element clickable constant OID_BGP_PATH_ATTR_ORIGIN" data-toggle="collapse" data-target=".OID_BGP_PATH_ATTR_ORIGIN .collapse">
  777. <h2>OID_BGP_PATH_ATTR_ORIGIN</h2>
  778. <pre>OID_BGP_PATH_ATTR_ORIGIN </pre>
  779. <div class="labels"></div>
  780. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  781. </div>
  782. <a name="OID_BGP_PATH_ATTR_PEER" id="OID_BGP_PATH_ATTR_PEER"> </a><div class="element clickable constant OID_BGP_PATH_ATTR_PEER" data-toggle="collapse" data-target=".OID_BGP_PATH_ATTR_PEER .collapse">
  783. <h2>OID_BGP_PATH_ATTR_PEER</h2>
  784. <pre>OID_BGP_PATH_ATTR_PEER </pre>
  785. <div class="labels"></div>
  786. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  787. </div>
  788. <a name="OID_BGP_PATH_ATTR_UNKNOWN" id="OID_BGP_PATH_ATTR_UNKNOWN"> </a><div class="element clickable constant OID_BGP_PATH_ATTR_UNKNOWN" data-toggle="collapse" data-target=".OID_BGP_PATH_ATTR_UNKNOWN .collapse">
  789. <h2>OID_BGP_PATH_ATTR_UNKNOWN</h2>
  790. <pre>OID_BGP_PATH_ATTR_UNKNOWN </pre>
  791. <div class="labels"></div>
  792. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  793. </div>
  794. <a name="OID_BGP_PEER_ADMIN_STATE" id="OID_BGP_PEER_ADMIN_STATE"> </a><div class="element clickable constant OID_BGP_PEER_ADMIN_STATE" data-toggle="collapse" data-target=".OID_BGP_PEER_ADMIN_STATE .collapse">
  795. <h2>OID_BGP_PEER_ADMIN_STATE</h2>
  796. <pre>OID_BGP_PEER_ADMIN_STATE </pre>
  797. <div class="labels"></div>
  798. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  799. </div>
  800. <a name="OID_BGP_PEER_CONNECTION_STATE" id="OID_BGP_PEER_CONNECTION_STATE"> </a><div class="element clickable constant OID_BGP_PEER_CONNECTION_STATE" data-toggle="collapse" data-target=".OID_BGP_PEER_CONNECTION_STATE .collapse">
  801. <h2>OID_BGP_PEER_CONNECTION_STATE</h2>
  802. <pre>OID_BGP_PEER_CONNECTION_STATE </pre>
  803. <div class="labels"></div>
  804. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  805. </div>
  806. <a name="OID_BGP_PEER_CONNECT_RETRY_INTERVAL" id="OID_BGP_PEER_CONNECT_RETRY_INTERVAL"> </a><div class="element clickable constant OID_BGP_PEER_CONNECT_RETRY_INTERVAL" data-toggle="collapse" data-target=".OID_BGP_PEER_CONNECT_RETRY_INTERVAL .collapse">
  807. <h2>OID_BGP_PEER_CONNECT_RETRY_INTERVAL</h2>
  808. <pre>OID_BGP_PEER_CONNECT_RETRY_INTERVAL </pre>
  809. <div class="labels"></div>
  810. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  811. </div>
  812. <a name="OID_BGP_PEER_FSM_ESTABLISHED_TIME" id="OID_BGP_PEER_FSM_ESTABLISHED_TIME"> </a><div class="element clickable constant OID_BGP_PEER_FSM_ESTABLISHED_TIME" data-toggle="collapse" data-target=".OID_BGP_PEER_FSM_ESTABLISHED_TIME .collapse">
  813. <h2>OID_BGP_PEER_FSM_ESTABLISHED_TIME</h2>
  814. <pre>OID_BGP_PEER_FSM_ESTABLISHED_TIME </pre>
  815. <div class="labels"></div>
  816. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  817. </div>
  818. <a name="OID_BGP_PEER_FSM_ESTABLISHED_TRANSITIONS" id="OID_BGP_PEER_FSM_ESTABLISHED_TRANSITIONS"> </a><div class="element clickable constant OID_BGP_PEER_FSM_ESTABLISHED_TRANSITIONS" data-toggle="collapse" data-target=".OID_BGP_PEER_FSM_ESTABLISHED_TRANSITIONS .collapse">
  819. <h2>OID_BGP_PEER_FSM_ESTABLISHED_TRANSITIONS</h2>
  820. <pre>OID_BGP_PEER_FSM_ESTABLISHED_TRANSITIONS </pre>
  821. <div class="labels"></div>
  822. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  823. </div>
  824. <a name="OID_BGP_PEER_HOLD_TIME" id="OID_BGP_PEER_HOLD_TIME"> </a><div class="element clickable constant OID_BGP_PEER_HOLD_TIME" data-toggle="collapse" data-target=".OID_BGP_PEER_HOLD_TIME .collapse">
  825. <h2>OID_BGP_PEER_HOLD_TIME</h2>
  826. <pre>OID_BGP_PEER_HOLD_TIME </pre>
  827. <div class="labels"></div>
  828. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  829. </div>
  830. <a name="OID_BGP_PEER_HOLD_TIME_CONFIGURED" id="OID_BGP_PEER_HOLD_TIME_CONFIGURED"> </a><div class="element clickable constant OID_BGP_PEER_HOLD_TIME_CONFIGURED" data-toggle="collapse" data-target=".OID_BGP_PEER_HOLD_TIME_CONFIGURED .collapse">
  831. <h2>OID_BGP_PEER_HOLD_TIME_CONFIGURED</h2>
  832. <pre>OID_BGP_PEER_HOLD_TIME_CONFIGURED </pre>
  833. <div class="labels"></div>
  834. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  835. </div>
  836. <a name="OID_BGP_PEER_IDENTIFIER" id="OID_BGP_PEER_IDENTIFIER"> </a><div class="element clickable constant OID_BGP_PEER_IDENTIFIER" data-toggle="collapse" data-target=".OID_BGP_PEER_IDENTIFIER .collapse">
  837. <h2>OID_BGP_PEER_IDENTIFIER</h2>
  838. <pre>OID_BGP_PEER_IDENTIFIER </pre>
  839. <div class="labels"></div>
  840. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  841. </div>
  842. <a name="OID_BGP_PEER_IN_TOTAL_MESSAGES" id="OID_BGP_PEER_IN_TOTAL_MESSAGES"> </a><div class="element clickable constant OID_BGP_PEER_IN_TOTAL_MESSAGES" data-toggle="collapse" data-target=".OID_BGP_PEER_IN_TOTAL_MESSAGES .collapse">
  843. <h2>OID_BGP_PEER_IN_TOTAL_MESSAGES</h2>
  844. <pre>OID_BGP_PEER_IN_TOTAL_MESSAGES </pre>
  845. <div class="labels"></div>
  846. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  847. </div>
  848. <a name="OID_BGP_PEER_IN_UPDATES" id="OID_BGP_PEER_IN_UPDATES"> </a><div class="element clickable constant OID_BGP_PEER_IN_UPDATES" data-toggle="collapse" data-target=".OID_BGP_PEER_IN_UPDATES .collapse">
  849. <h2>OID_BGP_PEER_IN_UPDATES</h2>
  850. <pre>OID_BGP_PEER_IN_UPDATES </pre>
  851. <div class="labels"></div>
  852. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  853. </div>
  854. <a name="OID_BGP_PEER_IN_UPDATE_ELAPSED_TIME" id="OID_BGP_PEER_IN_UPDATE_ELAPSED_TIME"> </a><div class="element clickable constant OID_BGP_PEER_IN_UPDATE_ELAPSED_TIME" data-toggle="collapse" data-target=".OID_BGP_PEER_IN_UPDATE_ELAPSED_TIME .collapse">
  855. <h2>OID_BGP_PEER_IN_UPDATE_ELAPSED_TIME</h2>
  856. <pre>OID_BGP_PEER_IN_UPDATE_ELAPSED_TIME </pre>
  857. <div class="labels"></div>
  858. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  859. </div>
  860. <a name="OID_BGP_PEER_KEEP_ALIVE" id="OID_BGP_PEER_KEEP_ALIVE"> </a><div class="element clickable constant OID_BGP_PEER_KEEP_ALIVE" data-toggle="collapse" data-target=".OID_BGP_PEER_KEEP_ALIVE .collapse">
  861. <h2>OID_BGP_PEER_KEEP_ALIVE</h2>
  862. <pre>OID_BGP_PEER_KEEP_ALIVE </pre>
  863. <div class="labels"></div>
  864. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  865. </div>
  866. <a name="OID_BGP_PEER_KEEP_ALIVE_CONFIGURED" id="OID_BGP_PEER_KEEP_ALIVE_CONFIGURED"> </a><div class="element clickable constant OID_BGP_PEER_KEEP_ALIVE_CONFIGURED" data-toggle="collapse" data-target=".OID_BGP_PEER_KEEP_ALIVE_CONFIGURED .collapse">
  867. <h2>OID_BGP_PEER_KEEP_ALIVE_CONFIGURED</h2>
  868. <pre>OID_BGP_PEER_KEEP_ALIVE_CONFIGURED </pre>
  869. <div class="labels"></div>
  870. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  871. </div>
  872. <a name="OID_BGP_PEER_LAST_ERROR" id="OID_BGP_PEER_LAST_ERROR"> </a><div class="element clickable constant OID_BGP_PEER_LAST_ERROR" data-toggle="collapse" data-target=".OID_BGP_PEER_LAST_ERROR .collapse">
  873. <h2>OID_BGP_PEER_LAST_ERROR</h2>
  874. <pre>OID_BGP_PEER_LAST_ERROR </pre>
  875. <div class="labels"></div>
  876. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  877. </div>
  878. <a name="OID_BGP_PEER_LOCAL_ADDRESS" id="OID_BGP_PEER_LOCAL_ADDRESS"> </a><div class="element clickable constant OID_BGP_PEER_LOCAL_ADDRESS" data-toggle="collapse" data-target=".OID_BGP_PEER_LOCAL_ADDRESS .collapse">
  879. <h2>OID_BGP_PEER_LOCAL_ADDRESS</h2>
  880. <pre>OID_BGP_PEER_LOCAL_ADDRESS </pre>
  881. <div class="labels"></div>
  882. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  883. </div>
  884. <a name="OID_BGP_PEER_LOCAL_PORT" id="OID_BGP_PEER_LOCAL_PORT"> </a><div class="element clickable constant OID_BGP_PEER_LOCAL_PORT" data-toggle="collapse" data-target=".OID_BGP_PEER_LOCAL_PORT .collapse">
  885. <h2>OID_BGP_PEER_LOCAL_PORT</h2>
  886. <pre>OID_BGP_PEER_LOCAL_PORT </pre>
  887. <div class="labels"></div>
  888. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  889. </div>
  890. <a name="OID_BGP_PEER_MIN_AS_ORIGINATION_INTERVAL" id="OID_BGP_PEER_MIN_AS_ORIGINATION_INTERVAL"> </a><div class="element clickable constant OID_BGP_PEER_MIN_AS_ORIGINATION_INTERVAL" data-toggle="collapse" data-target=".OID_BGP_PEER_MIN_AS_ORIGINATION_INTERVAL .collapse">
  891. <h2>OID_BGP_PEER_MIN_AS_ORIGINATION_INTERVAL</h2>
  892. <pre>OID_BGP_PEER_MIN_AS_ORIGINATION_INTERVAL </pre>
  893. <div class="labels"></div>
  894. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  895. </div>
  896. <a name="OID_BGP_PEER_MIN_ROUTE_ADVERTISEMENT_INTERVAL" id="OID_BGP_PEER_MIN_ROUTE_ADVERTISEMENT_INTERVAL"> </a><div class="element clickable constant OID_BGP_PEER_MIN_ROUTE_ADVERTISEMENT_INTERVAL" data-toggle="collapse" data-target=".OID_BGP_PEER_MIN_ROUTE_ADVERTISEMENT_INTERVAL .collapse">
  897. <h2>OID_BGP_PEER_MIN_ROUTE_ADVERTISEMENT_INTERVAL</h2>
  898. <pre>OID_BGP_PEER_MIN_ROUTE_ADVERTISEMENT_INTERVAL </pre>
  899. <div class="labels"></div>
  900. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  901. </div>
  902. <a name="OID_BGP_PEER_NEGOTIATED_VERSION" id="OID_BGP_PEER_NEGOTIATED_VERSION"> </a><div class="element clickable constant OID_BGP_PEER_NEGOTIATED_VERSION" data-toggle="collapse" data-target=".OID_BGP_PEER_NEGOTIATED_VERSION .collapse">
  903. <h2>OID_BGP_PEER_NEGOTIATED_VERSION</h2>
  904. <pre>OID_BGP_PEER_NEGOTIATED_VERSION </pre>
  905. <div class="labels"></div>
  906. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  907. </div>
  908. <a name="OID_BGP_PEER_OUT_TOTAL_MESSAGES" id="OID_BGP_PEER_OUT_TOTAL_MESSAGES"> </a><div class="element clickable constant OID_BGP_PEER_OUT_TOTAL_MESSAGES" data-toggle="collapse" data-target=".OID_BGP_PEER_OUT_TOTAL_MESSAGES .collapse">
  909. <h2>OID_BGP_PEER_OUT_TOTAL_MESSAGES</h2>
  910. <pre>OID_BGP_PEER_OUT_TOTAL_MESSAGES </pre>
  911. <div class="labels"></div>
  912. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  913. </div>
  914. <a name="OID_BGP_PEER_OUT_UPDATES" id="OID_BGP_PEER_OUT_UPDATES"> </a><div class="element clickable constant OID_BGP_PEER_OUT_UPDATES" data-toggle="collapse" data-target=".OID_BGP_PEER_OUT_UPDATES .collapse">
  915. <h2>OID_BGP_PEER_OUT_UPDATES</h2>
  916. <pre>OID_BGP_PEER_OUT_UPDATES </pre>
  917. <div class="labels"></div>
  918. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  919. </div>
  920. <a name="OID_BGP_PEER_REMOTE_ADDR" id="OID_BGP_PEER_REMOTE_ADDR"> </a><div class="element clickable constant OID_BGP_PEER_REMOTE_ADDR" data-toggle="collapse" data-target=".OID_BGP_PEER_REMOTE_ADDR .collapse">
  921. <h2>OID_BGP_PEER_REMOTE_ADDR</h2>
  922. <pre>OID_BGP_PEER_REMOTE_ADDR </pre>
  923. <div class="labels"></div>
  924. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  925. </div>
  926. <a name="OID_BGP_PEER_REMOTE_ASN" id="OID_BGP_PEER_REMOTE_ASN"> </a><div class="element clickable constant OID_BGP_PEER_REMOTE_ASN" data-toggle="collapse" data-target=".OID_BGP_PEER_REMOTE_ASN .collapse">
  927. <h2>OID_BGP_PEER_REMOTE_ASN</h2>
  928. <pre>OID_BGP_PEER_REMOTE_ASN </pre>
  929. <div class="labels"></div>
  930. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  931. </div>
  932. <a name="OID_BGP_PEER_REMOTE_PORT" id="OID_BGP_PEER_REMOTE_PORT"> </a><div class="element clickable constant OID_BGP_PEER_REMOTE_PORT" data-toggle="collapse" data-target=".OID_BGP_PEER_REMOTE_PORT .collapse">
  933. <h2>OID_BGP_PEER_REMOTE_PORT</h2>
  934. <pre>OID_BGP_PEER_REMOTE_PORT </pre>
  935. <div class="labels"></div>
  936. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  937. </div>
  938. <a name="OID_BGP_VERSION" id="OID_BGP_VERSION"> </a><div class="element clickable constant OID_BGP_VERSION" data-toggle="collapse" data-target=".OID_BGP_VERSION .collapse">
  939. <h2>OID_BGP_VERSION</h2>
  940. <pre>OID_BGP_VERSION </pre>
  941. <div class="labels"></div>
  942. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  943. </div>
  944. </div>
  945. </div>
  946. </div>
  947. </div>
  948. <div class="row"><footer class="span12">
  949. 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>
  950. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a5</a> and<br>
  951. generated on 2012-06-22T10:05:27+01:00.<br></footer></div>
  952. </div>
  953. </body>
  954. </html>