OSS_SNMP.MIBS.Asterisk.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299
  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\Asterisk</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="#callsActive" title="callsActive :: Returns the number of calls currently active on the Asterisk PBX."><span class="description">Returns the number of calls currently active on the Asterisk PBX.</span><pre>callsActive()</pre></a></li>
  61. <li class="method public "><a href="#callsProcessed" title="callsProcessed :: Returns the total number of calls processed through the Asterisk PBX since last restart."><span class="description">Returns the total number of calls processed through the Asterisk PBX since last restart.</span><pre>callsProcessed()</pre></a></li>
  62. <li class="method public "><a href="#controlSocket" title="controlSocket :: Returns the path for the control socket for giving Asterisk commands"><span class="description">Returns the path for the control socket for giving Asterisk commands</span><pre>controlSocket()</pre></a></li>
  63. <li class="method public "><a href="#modules" title="modules :: Returns the number of modules currently loaded into Asterisk."><span class="description">Returns the number of modules currently loaded into Asterisk.</span><pre>modules()</pre></a></li>
  64. <li class="method public "><a href="#pid" title="pid :: Returns the process ID of the Asterisk instance"><span class="description">Returns the process ID of the Asterisk instance</span><pre>pid()</pre></a></li>
  65. <li class="method public "><a href="#reloadTime" title="reloadTime :: Returns the time ticks (100th sec) since the Asterisk config was reload"><span class="description">Returns the time ticks (100th sec) since the Asterisk config was reload</span><pre>reloadTime()</pre></a></li>
  66. <li class="method public "><a href="#tag" title="tag :: Returns the Subversion (SVN) revision of Asterisk"><span class="description">Returns the Subversion (SVN) revision of Asterisk</span><pre>tag()</pre></a></li>
  67. <li class="method public "><a href="#uptime" title="uptime :: Returns the time ticks (100th sec) since Asterisk was started"><span class="description">Returns the time ticks (100th sec) since Asterisk was started</span><pre>uptime()</pre></a></li>
  68. <li class="method public "><a href="#version" title="version :: Returns the version of Asterisk"><span class="description">Returns the version of Asterisk</span><pre>version()</pre></a></li>
  69. <li class="nav-header">
  70. <i class="icon-custom icon-constant"></i> Constants</li>
  71. <li class="constant "><a href="#OID_ASTERISK_CALLS_ACTIVE" title="OID_ASTERISK_CALLS_ACTIVE :: "><span class="description">OID_ASTERISK_CALLS_ACTIVE</span><pre>OID_ASTERISK_CALLS_ACTIVE</pre></a></li>
  72. <li class="constant "><a href="#OID_ASTERISK_CALLS_PROCESSED" title="OID_ASTERISK_CALLS_PROCESSED :: "><span class="description">OID_ASTERISK_CALLS_PROCESSED</span><pre>OID_ASTERISK_CALLS_PROCESSED</pre></a></li>
  73. <li class="constant "><a href="#OID_ASTERISK_CONTROL_SOCKET" title="OID_ASTERISK_CONTROL_SOCKET :: "><span class="description">OID_ASTERISK_CONTROL_SOCKET</span><pre>OID_ASTERISK_CONTROL_SOCKET</pre></a></li>
  74. <li class="constant "><a href="#OID_ASTERISK_MODULES" title="OID_ASTERISK_MODULES :: "><span class="description">OID_ASTERISK_MODULES</span><pre>OID_ASTERISK_MODULES</pre></a></li>
  75. <li class="constant "><a href="#OID_ASTERISK_PID" title="OID_ASTERISK_PID :: "><span class="description">OID_ASTERISK_PID</span><pre>OID_ASTERISK_PID</pre></a></li>
  76. <li class="constant "><a href="#OID_ASTERISK_RELOAD_TIME" title="OID_ASTERISK_RELOAD_TIME :: "><span class="description">OID_ASTERISK_RELOAD_TIME</span><pre>OID_ASTERISK_RELOAD_TIME</pre></a></li>
  77. <li class="constant "><a href="#OID_ASTERISK_UP_TIME" title="OID_ASTERISK_UP_TIME :: "><span class="description">OID_ASTERISK_UP_TIME</span><pre>OID_ASTERISK_UP_TIME</pre></a></li>
  78. <li class="constant "><a href="#OID_ASTERISK_VERSION_STRING" title="OID_ASTERISK_VERSION_STRING :: "><span class="description">OID_ASTERISK_VERSION_STRING</span><pre>OID_ASTERISK_VERSION_STRING</pre></a></li>
  79. <li class="constant "><a href="#OID_ASTERISK_VERSION_TAG" title="OID_ASTERISK_VERSION_TAG :: "><span class="description">OID_ASTERISK_VERSION_TAG</span><pre>OID_ASTERISK_VERSION_TAG</pre></a></li>
  80. </ul>
  81. </div>
  82. <div class="span8">
  83. <a name="%5COSS_SNMP%5CMIBS%5CAsterisk" id="\OSS_SNMP\MIBS\Asterisk"></a><ul class="breadcrumb">
  84. <li>
  85. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  86. </li>
  87. <li><a href="../namespaces/OSS_SNMP.html">OSS_SNMP</a></li>
  88. <span class="divider">\</span><li><a href="../namespaces/OSS_SNMP.MIBS.html">MIBS</a></li>
  89. <li class="active">
  90. <span class="divider">\</span><a href="../classes/OSS_SNMP.MIBS.Asterisk.html">Asterisk</a>
  91. </li>
  92. </ul>
  93. <div href="../classes/OSS_SNMP.MIBS.Asterisk.html" class="element class">
  94. <p class="short_description">A class for performing SNMP V2 queries on Asterisk</p>
  95. <div class="details">
  96. <p class="long_description"></p>
  97. <table class="table table-bordered">
  98. <tr>
  99. <th>see</th>
  100. <td>\OSS_SNMP\MIBS\https://wiki.asterisk.org/wiki/display/AST/Asterisk+MIB+Definitions</td>
  101. </tr>
  102. <tr>
  103. <th>copyright</th>
  104. <td>Copyright (c) 2012, Open Source Solutions Limited, Dublin, Ireland</td>
  105. </tr>
  106. <tr>
  107. <th>author</th>
  108. <td><a href="mailto:barry@opensolutions.ie">Barry O'Donovan</a></td>
  109. </tr>
  110. </table>
  111. <h3>
  112. <i class="icon-custom icon-method"></i> Methods</h3>
  113. <a name="callsActive" id="callsActive"></a><div class="element clickable method public callsActive" data-toggle="collapse" data-target=".callsActive .collapse">
  114. <h2>Returns the number of calls currently active on the Asterisk PBX.</h2>
  115. <pre>callsActive() : int</pre>
  116. <div class="labels"></div>
  117. <div class="row collapse"><div class="detail-description">
  118. <p class="long_description"><blockquote>
  119. <p>The number of calls currently active on the Asterisk PBX.</p>
  120. </blockquote></p>
  121. <h3>Returns</h3>
  122. <div class="subelement response">
  123. <code>int</code>The number of calls currently active on the Asterisk PBX.</div>
  124. </div></div>
  125. </div>
  126. <a name="callsProcessed" id="callsProcessed"></a><div class="element clickable method public callsProcessed" data-toggle="collapse" data-target=".callsProcessed .collapse">
  127. <h2>Returns the total number of calls processed through the Asterisk PBX since last restart.</h2>
  128. <pre>callsProcessed() : int</pre>
  129. <div class="labels"></div>
  130. <div class="row collapse"><div class="detail-description">
  131. <p class="long_description"><blockquote>
  132. <p>The total number of calls processed through the Asterisk PBX since last restart.</p>
  133. </blockquote></p>
  134. <h3>Returns</h3>
  135. <div class="subelement response">
  136. <code>int</code>The total number of calls processed through the Asterisk PBX since last restart.</div>
  137. </div></div>
  138. </div>
  139. <a name="controlSocket" id="controlSocket"></a><div class="element clickable method public controlSocket" data-toggle="collapse" data-target=".controlSocket .collapse">
  140. <h2>Returns the path for the control socket for giving Asterisk commands</h2>
  141. <pre>controlSocket() : string</pre>
  142. <div class="labels"></div>
  143. <div class="row collapse"><div class="detail-description">
  144. <p class="long_description"><blockquote>
  145. <p>The control socket for giving Asterisk commands.</p>
  146. </blockquote></p>
  147. <h3>Returns</h3>
  148. <div class="subelement response">
  149. <code>string</code>The control socket for giving Asterisk commands</div>
  150. </div></div>
  151. </div>
  152. <a name="modules" id="modules"></a><div class="element clickable method public modules" data-toggle="collapse" data-target=".modules .collapse">
  153. <h2>Returns the number of modules currently loaded into Asterisk.</h2>
  154. <pre>modules() : int</pre>
  155. <div class="labels"></div>
  156. <div class="row collapse"><div class="detail-description">
  157. <p class="long_description"><blockquote>
  158. <p>Number of modules currently loaded into Asterisk.</p>
  159. </blockquote></p>
  160. <h3>Returns</h3>
  161. <div class="subelement response">
  162. <code>int</code>The number of modules currently loaded into Asterisk</div>
  163. </div></div>
  164. </div>
  165. <a name="pid" id="pid"></a><div class="element clickable method public pid" data-toggle="collapse" data-target=".pid .collapse">
  166. <h2>Returns the process ID of the Asterisk instance</h2>
  167. <pre>pid() : int</pre>
  168. <div class="labels"></div>
  169. <div class="row collapse"><div class="detail-description">
  170. <p class="long_description"><blockquote>
  171. <p>The process id of the running Asterisk process.</p>
  172. </blockquote></p>
  173. <h3>Returns</h3>
  174. <div class="subelement response">
  175. <code>int</code>The process ID of the Asterisk instance</div>
  176. </div></div>
  177. </div>
  178. <a name="reloadTime" id="reloadTime"></a><div class="element clickable method public reloadTime" data-toggle="collapse" data-target=".reloadTime .collapse">
  179. <h2>Returns the time ticks (100th sec) since the Asterisk config was reload</h2>
  180. <pre>reloadTime() : int</pre>
  181. <div class="labels"></div>
  182. <div class="row collapse"><div class="detail-description">
  183. <p class="long_description"><blockquote>
  184. <p>Time ticks since Asterisk was last reloaded.</p>
  185. </blockquote></p>
  186. <h3>Returns</h3>
  187. <div class="subelement response">
  188. <code>int</code>Time ticks since the Asterisk config was reload</div>
  189. </div></div>
  190. </div>
  191. <a name="tag" id="tag"></a><div class="element clickable method public tag" data-toggle="collapse" data-target=".tag .collapse">
  192. <h2>Returns the Subversion (SVN) revision of Asterisk</h2>
  193. <pre>tag() : int</pre>
  194. <div class="labels"></div>
  195. <div class="row collapse"><div class="detail-description">
  196. <p class="long_description"><blockquote>
  197. <p>SubVersion revision of the version of Asterisk that
  198. the SNMP Agent was compiled to run against -- this is
  199. typically 0 for release-versions of Asterisk.</p>
  200. </blockquote></p>
  201. <h3>Returns</h3>
  202. <div class="subelement response">
  203. <code>int</code>The SVN revision of Asterisk</div>
  204. </div></div>
  205. </div>
  206. <a name="uptime" id="uptime"></a><div class="element clickable method public uptime" data-toggle="collapse" data-target=".uptime .collapse">
  207. <h2>Returns the time ticks (100th sec) since Asterisk was started</h2>
  208. <pre>uptime() : int</pre>
  209. <div class="labels"></div>
  210. <div class="row collapse"><div class="detail-description">
  211. <p class="long_description"><blockquote>
  212. <p>Time ticks since Asterisk was started.</p>
  213. </blockquote></p>
  214. <h3>Returns</h3>
  215. <div class="subelement response">
  216. <code>int</code>Time ticks since Asterisk was started</div>
  217. </div></div>
  218. </div>
  219. <a name="version" id="version"></a><div class="element clickable method public version" data-toggle="collapse" data-target=".version .collapse">
  220. <h2>Returns the version of Asterisk</h2>
  221. <pre>version() : string</pre>
  222. <div class="labels"></div>
  223. <div class="row collapse"><div class="detail-description">
  224. <p class="long_description"><blockquote>
  225. <p>Text version string of the version of Asterisk that
  226. the SNMP Agent was compiled to run against.</p>
  227. </blockquote></p>
  228. <h3>Returns</h3>
  229. <div class="subelement response">
  230. <code>string</code>The version of Asterisk</div>
  231. </div></div>
  232. </div>
  233. <h3>
  234. <i class="icon-custom icon-constant"></i> Constants</h3>
  235. <a name="OID_ASTERISK_CALLS_ACTIVE" id="OID_ASTERISK_CALLS_ACTIVE"> </a><div class="element clickable constant OID_ASTERISK_CALLS_ACTIVE" data-toggle="collapse" data-target=".OID_ASTERISK_CALLS_ACTIVE .collapse">
  236. <h2>OID_ASTERISK_CALLS_ACTIVE</h2>
  237. <pre>OID_ASTERISK_CALLS_ACTIVE </pre>
  238. <div class="labels"></div>
  239. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  240. </div>
  241. <a name="OID_ASTERISK_CALLS_PROCESSED" id="OID_ASTERISK_CALLS_PROCESSED"> </a><div class="element clickable constant OID_ASTERISK_CALLS_PROCESSED" data-toggle="collapse" data-target=".OID_ASTERISK_CALLS_PROCESSED .collapse">
  242. <h2>OID_ASTERISK_CALLS_PROCESSED</h2>
  243. <pre>OID_ASTERISK_CALLS_PROCESSED </pre>
  244. <div class="labels"></div>
  245. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  246. </div>
  247. <a name="OID_ASTERISK_CONTROL_SOCKET" id="OID_ASTERISK_CONTROL_SOCKET"> </a><div class="element clickable constant OID_ASTERISK_CONTROL_SOCKET" data-toggle="collapse" data-target=".OID_ASTERISK_CONTROL_SOCKET .collapse">
  248. <h2>OID_ASTERISK_CONTROL_SOCKET</h2>
  249. <pre>OID_ASTERISK_CONTROL_SOCKET </pre>
  250. <div class="labels"></div>
  251. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  252. </div>
  253. <a name="OID_ASTERISK_MODULES" id="OID_ASTERISK_MODULES"> </a><div class="element clickable constant OID_ASTERISK_MODULES" data-toggle="collapse" data-target=".OID_ASTERISK_MODULES .collapse">
  254. <h2>OID_ASTERISK_MODULES</h2>
  255. <pre>OID_ASTERISK_MODULES </pre>
  256. <div class="labels"></div>
  257. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  258. </div>
  259. <a name="OID_ASTERISK_PID" id="OID_ASTERISK_PID"> </a><div class="element clickable constant OID_ASTERISK_PID" data-toggle="collapse" data-target=".OID_ASTERISK_PID .collapse">
  260. <h2>OID_ASTERISK_PID</h2>
  261. <pre>OID_ASTERISK_PID </pre>
  262. <div class="labels"></div>
  263. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  264. </div>
  265. <a name="OID_ASTERISK_RELOAD_TIME" id="OID_ASTERISK_RELOAD_TIME"> </a><div class="element clickable constant OID_ASTERISK_RELOAD_TIME" data-toggle="collapse" data-target=".OID_ASTERISK_RELOAD_TIME .collapse">
  266. <h2>OID_ASTERISK_RELOAD_TIME</h2>
  267. <pre>OID_ASTERISK_RELOAD_TIME </pre>
  268. <div class="labels"></div>
  269. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  270. </div>
  271. <a name="OID_ASTERISK_UP_TIME" id="OID_ASTERISK_UP_TIME"> </a><div class="element clickable constant OID_ASTERISK_UP_TIME" data-toggle="collapse" data-target=".OID_ASTERISK_UP_TIME .collapse">
  272. <h2>OID_ASTERISK_UP_TIME</h2>
  273. <pre>OID_ASTERISK_UP_TIME </pre>
  274. <div class="labels"></div>
  275. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  276. </div>
  277. <a name="OID_ASTERISK_VERSION_STRING" id="OID_ASTERISK_VERSION_STRING"> </a><div class="element clickable constant OID_ASTERISK_VERSION_STRING" data-toggle="collapse" data-target=".OID_ASTERISK_VERSION_STRING .collapse">
  278. <h2>OID_ASTERISK_VERSION_STRING</h2>
  279. <pre>OID_ASTERISK_VERSION_STRING </pre>
  280. <div class="labels"></div>
  281. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  282. </div>
  283. <a name="OID_ASTERISK_VERSION_TAG" id="OID_ASTERISK_VERSION_TAG"> </a><div class="element clickable constant OID_ASTERISK_VERSION_TAG" data-toggle="collapse" data-target=".OID_ASTERISK_VERSION_TAG .collapse">
  284. <h2>OID_ASTERISK_VERSION_TAG</h2>
  285. <pre>OID_ASTERISK_VERSION_TAG </pre>
  286. <div class="labels"></div>
  287. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  288. </div>
  289. </div>
  290. </div>
  291. </div>
  292. </div>
  293. <div class="row"><footer class="span12">
  294. 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>
  295. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a5</a> and<br>
  296. generated on 2012-06-22T10:05:27+01:00.<br></footer></div>
  297. </div>
  298. </body>
  299. </html>