OSS.SNMP.MIBS.System.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255
  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\System</title>
  7. <meta name="author" content="Mike van Riel">
  8. <meta name="description" content="">
  9. <link href="../css/template.css" rel="stylesheet" media="all">
  10. <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
  11. <link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
  12. <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
  13. <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
  14. </head>
  15. <body>
  16. <div class="navbar navbar-fixed-top">
  17. <div class="navbar-inner"><div class="container">
  18. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">OSS_SNMP</a><div class="nav-collapse"><ul class="nav">
  19. <li class="dropdown">
  20. <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
  21. API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
  22. <li><a>Namespaces</a></li>
  23. <li><a href="../namespaces/OSS.html"><i class="icon-th"></i> OSS</a></li>
  24. </ul>
  25. </li>
  26. <li class="dropdown" id="charts-menu">
  27. <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
  28. Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
  29. </li>
  30. <li class="dropdown" id="reports-menu">
  31. <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
  32. Reports <b class="caret"></b></a><ul class="dropdown-menu">
  33. <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
  34. <span class="label label-info">25</span></a></li>
  35. <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
  36. <ul></ul></a></li>
  37. <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
  38. <span class="label label-info">0</span></a></li>
  39. </ul>
  40. </li>
  41. </ul></div>
  42. </div></div>
  43. <div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
  44. </div>
  45. <div id="___" class="container">
  46. <noscript><div class="alert alert-warning">
  47. Javascript is disabled; several features are only available
  48. if Javascript is enabled.
  49. </div></noscript>
  50. <div class="row">
  51. <div class="span4">
  52. <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
  53. <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
  54. </div>
  55. <ul class="side-nav nav nav-list">
  56. <li class="nav-header">
  57. <i class="icon-custom icon-method"></i> Methods</li>
  58. <li class="method public "><a href="#contact" title="contact :: Returns the system contact of the device"><span class="description">Returns the system contact of the device</span><pre>contact()</pre></a></li>
  59. <li class="method public "><a href="#description" title="description :: Returns the system description of the device"><span class="description">Returns the system description of the device</span><pre>description()</pre></a></li>
  60. <li class="method public "><a href="#getAll" title="getAll :: Gets all system values as an associate array"><span class="description">Gets all system values as an associate array</span><pre>getAll()</pre></a></li>
  61. <li class="method public "><a href="#location" title="location :: Returns the system location of the device"><span class="description">Returns the system location of the device</span><pre>location()</pre></a></li>
  62. <li class="method public "><a href="#name" title="name :: Returns the system name of the device"><span class="description">Returns the system name of the device</span><pre>name()</pre></a></li>
  63. <li class="method public "><a href="#services" title="services :: Returns the system services of the device"><span class="description">Returns the system services of the device</span><pre>services()</pre></a></li>
  64. <li class="method public "><a href="#uptime" title="uptime :: Returns the system uptime of the device"><span class="description">Returns the system uptime of the device</span><pre>uptime()</pre></a></li>
  65. <li class="nav-header">
  66. <i class="icon-custom icon-constant"></i> Constants</li>
  67. <li class="constant "><a href="#OID_SYSTEM_CONTACT" title="OID_SYSTEM_CONTACT :: "><span class="description">OID_SYSTEM_CONTACT</span><pre>OID_SYSTEM_CONTACT</pre></a></li>
  68. <li class="constant "><a href="#OID_SYSTEM_DESCRIPTION" title="OID_SYSTEM_DESCRIPTION :: "><span class="description">OID_SYSTEM_DESCRIPTION</span><pre>OID_SYSTEM_DESCRIPTION</pre></a></li>
  69. <li class="constant "><a href="#OID_SYSTEM_LOCATION" title="OID_SYSTEM_LOCATION :: "><span class="description">OID_SYSTEM_LOCATION</span><pre>OID_SYSTEM_LOCATION</pre></a></li>
  70. <li class="constant "><a href="#OID_SYSTEM_NAME" title="OID_SYSTEM_NAME :: "><span class="description">OID_SYSTEM_NAME</span><pre>OID_SYSTEM_NAME</pre></a></li>
  71. <li class="constant "><a href="#OID_SYSTEM_SERVICES" title="OID_SYSTEM_SERVICES :: "><span class="description">OID_SYSTEM_SERVICES</span><pre>OID_SYSTEM_SERVICES</pre></a></li>
  72. <li class="constant "><a href="#OID_SYSTEM_UPTIME" title="OID_SYSTEM_UPTIME :: "><span class="description">OID_SYSTEM_UPTIME</span><pre>OID_SYSTEM_UPTIME</pre></a></li>
  73. </ul>
  74. </div>
  75. <div class="span8">
  76. <a name="%5COSS%5CSNMP%5CMIBS%5CSystem" id="\OSS\SNMP\MIBS\System"></a><ul class="breadcrumb">
  77. <li>
  78. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  79. </li>
  80. <li><a href="../namespaces/OSS.html">OSS</a></li>
  81. <span class="divider">\</span><li><a href="../namespaces/OSS.SNMP.html">SNMP</a></li>
  82. <span class="divider">\</span><li><a href="../namespaces/OSS.SNMP.MIBS.html">MIBS</a></li>
  83. <li class="active">
  84. <span class="divider">\</span><a href="../classes/OSS.SNMP.MIBS.System.html">System</a>
  85. </li>
  86. </ul>
  87. <div href="../classes/OSS.SNMP.MIBS.System.html" class="element class">
  88. <p class="short_description">A class for performing SNMP V2 queries on generic devices</p>
  89. <div class="details">
  90. <p class="long_description"></p>
  91. <table class="table table-bordered">
  92. <tr>
  93. <th>copyright</th>
  94. <td>Copyright (c) 2012, Open Source Solutions Limited, Dublin, Ireland</td>
  95. </tr>
  96. <tr>
  97. <th>author</th>
  98. <td><a href="mailto:barry@opensolutions.ie">Barry O'Donovan</a></td>
  99. </tr>
  100. </table>
  101. <h3>
  102. <i class="icon-custom icon-method"></i> Methods</h3>
  103. <a name="contact" id="contact"></a><div class="element clickable method public contact" data-toggle="collapse" data-target=".contact .collapse">
  104. <h2>Returns the system contact of the device</h2>
  105. <pre>contact() : string</pre>
  106. <div class="labels"></div>
  107. <div class="row collapse"><div class="detail-description">
  108. <p class="long_description"></p>
  109. <h3>Returns</h3>
  110. <div class="subelement response">
  111. <code>string</code>The system contact of the device</div>
  112. </div></div>
  113. </div>
  114. <a name="description" id="description"></a><div class="element clickable method public description" data-toggle="collapse" data-target=".description .collapse">
  115. <h2>Returns the system description of the device</h2>
  116. <pre>description() : string</pre>
  117. <div class="labels"></div>
  118. <div class="row collapse"><div class="detail-description">
  119. <p class="long_description"></p>
  120. <h3>Returns</h3>
  121. <div class="subelement response">
  122. <code>string</code>The system description of the device</div>
  123. </div></div>
  124. </div>
  125. <a name="getAll" id="getAll"></a><div class="element clickable method public getAll" data-toggle="collapse" data-target=".getAll .collapse">
  126. <h2>Gets all system values as an associate array</h2>
  127. <pre>getAll() : array</pre>
  128. <div class="labels"></div>
  129. <div class="row collapse"><div class="detail-description">
  130. <p class="long_description"><p>The keys of the array are contact, description, location,
  131. name, services, uptime</p></p>
  132. <h3>Returns</h3>
  133. <div class="subelement response">
  134. <code>array</code>All system values as an associate array</div>
  135. </div></div>
  136. </div>
  137. <a name="location" id="location"></a><div class="element clickable method public location" data-toggle="collapse" data-target=".location .collapse">
  138. <h2>Returns the system location of the device</h2>
  139. <pre>location() : string</pre>
  140. <div class="labels"></div>
  141. <div class="row collapse"><div class="detail-description">
  142. <p class="long_description"></p>
  143. <h3>Returns</h3>
  144. <div class="subelement response">
  145. <code>string</code>The system location of the device</div>
  146. </div></div>
  147. </div>
  148. <a name="name" id="name"></a><div class="element clickable method public name" data-toggle="collapse" data-target=".name .collapse">
  149. <h2>Returns the system name of the device</h2>
  150. <pre>name() : string</pre>
  151. <div class="labels"></div>
  152. <div class="row collapse"><div class="detail-description">
  153. <p class="long_description"></p>
  154. <h3>Returns</h3>
  155. <div class="subelement response">
  156. <code>string</code>The system name of the device</div>
  157. </div></div>
  158. </div>
  159. <a name="services" id="services"></a><div class="element clickable method public services" data-toggle="collapse" data-target=".services .collapse">
  160. <h2>Returns the system services of the device</h2>
  161. <pre>services() : string</pre>
  162. <div class="labels"></div>
  163. <div class="row collapse"><div class="detail-description">
  164. <p class="long_description"><p>"A value which indicates the set of services that
  165. this entity primarily offers.</p>
  166. <p>The value is a sum. This sum initially takes the
  167. value zero, Then, for each layer, L, in the range
  168. 1 through 7, that this node performs transactions
  169. for, 2 raised to (L - 1) is added to the sum. For
  170. example, a node which performs primarily routing
  171. functions would have a value of 4 (2^(3-1)). In
  172. contrast, a node which is a host offering
  173. application services would have a value of 72
  174. (2^(4-1) + 2^(7-1)). Note that in the context of
  175. the Internet suite of protocols, values should be
  176. calculated accordingly:</p>
  177. <pre><code>layer functionality
  178. 1 physical (e.g., repeaters)
  179. 2 datalink/subnetwork (e.g., bridges)
  180. 3 internet (e.g., IP gateways)
  181. 4 end-to-end (e.g., IP hosts)
  182. 7 applications (e.g., mail relays)
  183. </code></pre>
  184. <p>For systems including OSI protocols, layers 5 and
  185. 6 may also be counted."</p></p>
  186. <h3>Returns</h3>
  187. <div class="subelement response">
  188. <code>string</code>The system services of the device</div>
  189. </div></div>
  190. </div>
  191. <a name="uptime" id="uptime"></a><div class="element clickable method public uptime" data-toggle="collapse" data-target=".uptime .collapse">
  192. <h2>Returns the system uptime of the device</h2>
  193. <pre>uptime() : int</pre>
  194. <div class="labels"></div>
  195. <div class="row collapse"><div class="detail-description">
  196. <p class="long_description"><p>"The time (in hundredths of a second) since the
  197. network management portion of the system was last
  198. re-initialized."</p></p>
  199. <h3>Returns</h3>
  200. <div class="subelement response">
  201. <code>int</code>The system uptime of the device (in timeticks)</div>
  202. </div></div>
  203. </div>
  204. <h3>
  205. <i class="icon-custom icon-constant"></i> Constants</h3>
  206. <a name="OID_SYSTEM_CONTACT" id="OID_SYSTEM_CONTACT"> </a><div class="element clickable constant OID_SYSTEM_CONTACT" data-toggle="collapse" data-target=".OID_SYSTEM_CONTACT .collapse">
  207. <h2>OID_SYSTEM_CONTACT</h2>
  208. <pre>OID_SYSTEM_CONTACT </pre>
  209. <div class="labels"></div>
  210. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  211. </div>
  212. <a name="OID_SYSTEM_DESCRIPTION" id="OID_SYSTEM_DESCRIPTION"> </a><div class="element clickable constant OID_SYSTEM_DESCRIPTION" data-toggle="collapse" data-target=".OID_SYSTEM_DESCRIPTION .collapse">
  213. <h2>OID_SYSTEM_DESCRIPTION</h2>
  214. <pre>OID_SYSTEM_DESCRIPTION </pre>
  215. <div class="labels"></div>
  216. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  217. </div>
  218. <a name="OID_SYSTEM_LOCATION" id="OID_SYSTEM_LOCATION"> </a><div class="element clickable constant OID_SYSTEM_LOCATION" data-toggle="collapse" data-target=".OID_SYSTEM_LOCATION .collapse">
  219. <h2>OID_SYSTEM_LOCATION</h2>
  220. <pre>OID_SYSTEM_LOCATION </pre>
  221. <div class="labels"></div>
  222. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  223. </div>
  224. <a name="OID_SYSTEM_NAME" id="OID_SYSTEM_NAME"> </a><div class="element clickable constant OID_SYSTEM_NAME" data-toggle="collapse" data-target=".OID_SYSTEM_NAME .collapse">
  225. <h2>OID_SYSTEM_NAME</h2>
  226. <pre>OID_SYSTEM_NAME </pre>
  227. <div class="labels"></div>
  228. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  229. </div>
  230. <a name="OID_SYSTEM_SERVICES" id="OID_SYSTEM_SERVICES"> </a><div class="element clickable constant OID_SYSTEM_SERVICES" data-toggle="collapse" data-target=".OID_SYSTEM_SERVICES .collapse">
  231. <h2>OID_SYSTEM_SERVICES</h2>
  232. <pre>OID_SYSTEM_SERVICES </pre>
  233. <div class="labels"></div>
  234. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  235. </div>
  236. <a name="OID_SYSTEM_UPTIME" id="OID_SYSTEM_UPTIME"> </a><div class="element clickable constant OID_SYSTEM_UPTIME" data-toggle="collapse" data-target=".OID_SYSTEM_UPTIME .collapse">
  237. <h2>OID_SYSTEM_UPTIME</h2>
  238. <pre>OID_SYSTEM_UPTIME </pre>
  239. <div class="labels"></div>
  240. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  241. </div>
  242. </div>
  243. </div>
  244. </div>
  245. </div>
  246. <div class="row"><footer class="span12">
  247. 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>
  248. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a5</a> and<br>
  249. generated on 2012-06-11T11:07:43+01:00.<br></footer></div>
  250. </div>
  251. </body>
  252. </html>