VendorSoftware
/
OSS_SNPM


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
							<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>phpDocumentor » \OSS\SNMP\MIBS\Iface</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<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">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<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">phpDocumentor</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="../namespaces/OSS.html"><i class="icon-th"></i> OSS</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    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>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">19</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<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">
<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>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#aliases" title="aliases :: Get an array of device interface aliases (e.g. as set by the interface description / port-name parameter)"><span class="description">Get an array of device interface aliases (e.g. as set by the interface description / port-name parameter)</span><pre>aliases()</pre></a></li>
<li class="method public "><a href="#bridgeBasePortIfIndexes" title="bridgeBasePortIfIndexes :: Returns an associate array of STP port IDs (key) to interface IDs (value)"><span class="description">Returns an associate array of STP port IDs (key) to interface IDs (value)</span><pre>bridgeBasePortIfIndexes()</pre></a></li>
<li class="method public "><a href="#descriptions" title="descriptions :: Get an array of device interface descriptions"><span class="description">Get an array of device interface descriptions</span><pre>descriptions()</pre></a></li>
<li class="method public "><a href="#names" title="names :: Get an array of device interface names"><span class="description">Get an array of device interface names</span><pre>names()</pre></a></li>
<li class="method public "><a href="#operationStates" title="operationStates :: Get an array of device interface operating status (up / down)"><span class="description">Get an array of device interface operating status (up / down)</span><pre>operationStates()</pre></a></li>
<li class="method public "><a href="#speeds" title="speeds :: Get an array of device interface (operating) speeds"><span class="description">Get an array of device interface (operating) speeds</span><pre>speeds()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="property public "><a href="#%24IF_OPER_STATES" title="$IF_OPER_STATES :: "><span class="description">$IF_OPER_STATES</span><pre>$IF_OPER_STATES</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants</li>
<li class="constant  "><a href="#IF_OPER_STATUS_DORMANT" title="IF_OPER_STATUS_DORMANT :: "><span class="description">IF_OPER_STATUS_DORMANT</span><pre>IF_OPER_STATUS_DORMANT</pre></a></li>
<li class="constant  "><a href="#IF_OPER_STATUS_DOWN" title="IF_OPER_STATUS_DOWN :: "><span class="description">IF_OPER_STATUS_DOWN</span><pre>IF_OPER_STATUS_DOWN</pre></a></li>
<li class="constant  "><a href="#IF_OPER_STATUS_LOWER_LAYER_DOWN" title="IF_OPER_STATUS_LOWER_LAYER_DOWN :: "><span class="description">IF_OPER_STATUS_LOWER_LAYER_DOWN</span><pre>IF_OPER_STATUS_LOWER_LAYER_DOWN</pre></a></li>
<li class="constant  "><a href="#IF_OPER_STATUS_NOT_PRESENT" title="IF_OPER_STATUS_NOT_PRESENT :: "><span class="description">IF_OPER_STATUS_NOT_PRESENT</span><pre>IF_OPER_STATUS_NOT_PRESENT</pre></a></li>
<li class="constant  "><a href="#IF_OPER_STATUS_TESTING" title="IF_OPER_STATUS_TESTING :: "><span class="description">IF_OPER_STATUS_TESTING</span><pre>IF_OPER_STATUS_TESTING</pre></a></li>
<li class="constant  "><a href="#IF_OPER_STATUS_UNKNOWN" title="IF_OPER_STATUS_UNKNOWN :: "><span class="description">IF_OPER_STATUS_UNKNOWN</span><pre>IF_OPER_STATUS_UNKNOWN</pre></a></li>
<li class="constant  "><a href="#IF_OPER_STATUS_UP" title="IF_OPER_STATUS_UP :: "><span class="description">IF_OPER_STATUS_UP</span><pre>IF_OPER_STATUS_UP</pre></a></li>
<li class="constant  "><a href="#OID_IF_ALIAS" title="OID_IF_ALIAS :: "><span class="description">OID_IF_ALIAS</span><pre>OID_IF_ALIAS</pre></a></li>
<li class="constant  "><a href="#OID_IF_DESCRIPTION" title="OID_IF_DESCRIPTION :: "><span class="description">OID_IF_DESCRIPTION</span><pre>OID_IF_DESCRIPTION</pre></a></li>
<li class="constant  "><a href="#OID_IF_NAME" title="OID_IF_NAME :: "><span class="description">OID_IF_NAME</span><pre>OID_IF_NAME</pre></a></li>
<li class="constant  "><a href="#OID_IF_OPER_STATUS" title="OID_IF_OPER_STATUS :: "><span class="description">OID_IF_OPER_STATUS</span><pre>OID_IF_OPER_STATUS</pre></a></li>
<li class="constant  "><a href="#OID_IF_SPEED" title="OID_IF_SPEED :: "><span class="description">OID_IF_SPEED</span><pre>OID_IF_SPEED</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5COSS%5CSNMP%5CMIBS%5CIface" id="\OSS\SNMP\MIBS\Iface"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/OSS.html">OSS</a></li>
<span class="divider">\</span><li><a href="../namespaces/OSS.SNMP.html">SNMP</a></li>
<span class="divider">\</span><li><a href="../namespaces/OSS.SNMP.MIBS.html">MIBS</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/OSS.SNMP.MIBS.Iface.html">Iface</a>
</li>
</ul>
<div href="../classes/OSS.SNMP.MIBS.Iface.html" class="element class">
<p class="short_description">A class for performing SNMP V2 queries on generic devices</p>
<div class="details">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>copyright</th>
<td>Copyright (c) 2012, Open Source Solutions Limited, Dublin, Ireland</td>
</tr>
<tr>
<th>author</th>
<td><a href="mailto:barry@opensolutions.ie">Barry O'Donovan</a></td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="aliases" id="aliases"></a><div class="element clickable method public aliases" data-toggle="collapse" data-target=".aliases .collapse">
<h2>Get an array of device interface aliases (e.g. as set by the interface description / port-name parameter)</h2>
<pre>aliases() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>E.g. the followig SNMP output yields the shown array:</p>

<p>.1.3.6.1.2.1.2.2.1.2.18.10128 = STRING: Connection to switch2
.1.3.6.1.2.1.2.2.1.2.18.10129 = STRING: Connection to switch3
...</p>

<pre><code> [10128] =&gt; "Connection to switch2"
 [10129] =&gt; "Connection to switch3"
</code></pre></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>An array of interface aliases</div>
</div></div>
</div>
<a name="bridgeBasePortIfIndexes" id="bridgeBasePortIfIndexes"></a><div class="element clickable method public bridgeBasePortIfIndexes" data-toggle="collapse" data-target=".bridgeBasePortIfIndexes .collapse">
<h2>Returns an associate array of STP port IDs (key) to interface IDs (value)</h2>
<pre>bridgeBasePortIfIndexes() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>e.g.  [22] => 10122</p></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>Associate array of STP port IDs (key) to interface IDs (value)</div>
</div></div>
</div>
<a name="descriptions" id="descriptions"></a><div class="element clickable method public descriptions" data-toggle="collapse" data-target=".descriptions .collapse">
<h2>Get an array of device interface descriptions</h2>
<pre>descriptions() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>E.g. the following SNMP output yields the shown array:</p>

<p>.1.3.6.1.2.1.31.1.1.1.1.10128 = STRING: GigabitEthernet1/0/28
.1.3.6.1.2.1.31.1.1.1.1.10129 = STRING: GigabitEthernet1/0/29
...</p>

<pre><code> [10128] =&gt; "GigabitEthernet1/0/28"
 [10129] =&gt; "GigabitEthernet1/0/29"
</code></pre></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>An array of interface descriptions</div>
</div></div>
</div>
<a name="names" id="names"></a><div class="element clickable method public names" data-toggle="collapse" data-target=".names .collapse">
<h2>Get an array of device interface names</h2>
<pre>names() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>E.g. the following SNMP output yields the shown array:</p>

<p>.1.3.6.1.2.1.31.1.1.1.1.10128 = STRING: Gi1/0/28
.1.3.6.1.2.1.31.1.1.1.1.10129 = STRING: Gi1/0/29
...</p>

<pre><code> [10128] =&gt; "Gi1/0/28"
 [10129] =&gt; "Gi1/0/29"
</code></pre></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>An array of interface names</div>
</div></div>
</div>
<a name="operationStates" id="operationStates"></a><div class="element clickable method public operationStates" data-toggle="collapse" data-target=".operationStates .collapse">
<h2>Get an array of device interface operating status (up / down)</h2>
<pre>operationStates(boolean $translate) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>E.g. the follow SNMP output yields the shown array:</p>

<p>.1.3.6.1.2.1.2.2.1.8.10128 = INTEGER: up(1)
.1.3.6.1.2.1.2.2.1.8.10129 = INTEGER: down(2)
...</p>

<pre><code> [10128] =&gt; 1
 [10129] =&gt; 2
</code></pre></p>
<table class="table table-bordered"><tr>
<th>see</th>
<td>\IF_OPER_STATES</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$translate</h4>
<code>boolean</code><p>If true, return the string representation</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>An array of interface states</div>
</div></div>
</div>
<a name="speeds" id="speeds"></a><div class="element clickable method public speeds" data-toggle="collapse" data-target=".speeds .collapse">
<h2>Get an array of device interface (operating) speeds</h2>
<pre>speeds() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>E.g. the following SNMP output yields the shown array:</p>

<p>.1.3.6.1.2.1.2.2.1.5.10128 = Gauge32: 1000000000
.1.3.6.1.2.1.2.2.1.5.10129 = Gauge32: 100000000
...</p>

<pre><code> [10128] =&gt; 1000000000
 [10129] =&gt; 100000000
</code></pre>

<p>NB: operating speed as opposed to maximum speed</p></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>An array of interface operating speeds</div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24IF_OPER_STATES" id="$IF_OPER_STATES"> </a><div class="element clickable property public $IF_OPER_STATES" data-toggle="collapse" data-target=".$IF_OPER_STATES .collapse">
<h2>$IF_OPER_STATES</h2>
<pre>$IF_OPER_STATES </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<h3>
<i class="icon-custom icon-constant"></i> Constants</h3>
<a name="IF_OPER_STATUS_DORMANT" id="IF_OPER_STATUS_DORMANT"> </a><div class="element clickable constant  IF_OPER_STATUS_DORMANT" data-toggle="collapse" data-target=".IF_OPER_STATUS_DORMANT .collapse">
<h2>IF_OPER_STATUS_DORMANT</h2>
<pre>IF_OPER_STATUS_DORMANT </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="IF_OPER_STATUS_DOWN" id="IF_OPER_STATUS_DOWN"> </a><div class="element clickable constant  IF_OPER_STATUS_DOWN" data-toggle="collapse" data-target=".IF_OPER_STATUS_DOWN .collapse">
<h2>IF_OPER_STATUS_DOWN</h2>
<pre>IF_OPER_STATUS_DOWN </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="IF_OPER_STATUS_LOWER_LAYER_DOWN" id="IF_OPER_STATUS_LOWER_LAYER_DOWN"> </a><div class="element clickable constant  IF_OPER_STATUS_LOWER_LAYER_DOWN" data-toggle="collapse" data-target=".IF_OPER_STATUS_LOWER_LAYER_DOWN .collapse">
<h2>IF_OPER_STATUS_LOWER_LAYER_DOWN</h2>
<pre>IF_OPER_STATUS_LOWER_LAYER_DOWN </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="IF_OPER_STATUS_NOT_PRESENT" id="IF_OPER_STATUS_NOT_PRESENT"> </a><div class="element clickable constant  IF_OPER_STATUS_NOT_PRESENT" data-toggle="collapse" data-target=".IF_OPER_STATUS_NOT_PRESENT .collapse">
<h2>IF_OPER_STATUS_NOT_PRESENT</h2>
<pre>IF_OPER_STATUS_NOT_PRESENT </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="IF_OPER_STATUS_TESTING" id="IF_OPER_STATUS_TESTING"> </a><div class="element clickable constant  IF_OPER_STATUS_TESTING" data-toggle="collapse" data-target=".IF_OPER_STATUS_TESTING .collapse">
<h2>IF_OPER_STATUS_TESTING</h2>
<pre>IF_OPER_STATUS_TESTING </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="IF_OPER_STATUS_UNKNOWN" id="IF_OPER_STATUS_UNKNOWN"> </a><div class="element clickable constant  IF_OPER_STATUS_UNKNOWN" data-toggle="collapse" data-target=".IF_OPER_STATUS_UNKNOWN .collapse">
<h2>IF_OPER_STATUS_UNKNOWN</h2>
<pre>IF_OPER_STATUS_UNKNOWN </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="IF_OPER_STATUS_UP" id="IF_OPER_STATUS_UP"> </a><div class="element clickable constant  IF_OPER_STATUS_UP" data-toggle="collapse" data-target=".IF_OPER_STATUS_UP .collapse">
<h2>IF_OPER_STATUS_UP</h2>
<pre>IF_OPER_STATUS_UP </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="OID_IF_ALIAS" id="OID_IF_ALIAS"> </a><div class="element clickable constant  OID_IF_ALIAS" data-toggle="collapse" data-target=".OID_IF_ALIAS .collapse">
<h2>OID_IF_ALIAS</h2>
<pre>OID_IF_ALIAS </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="OID_IF_DESCRIPTION" id="OID_IF_DESCRIPTION"> </a><div class="element clickable constant  OID_IF_DESCRIPTION" data-toggle="collapse" data-target=".OID_IF_DESCRIPTION .collapse">
<h2>OID_IF_DESCRIPTION</h2>
<pre>OID_IF_DESCRIPTION </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="OID_IF_NAME" id="OID_IF_NAME"> </a><div class="element clickable constant  OID_IF_NAME" data-toggle="collapse" data-target=".OID_IF_NAME .collapse">
<h2>OID_IF_NAME</h2>
<pre>OID_IF_NAME </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="OID_IF_OPER_STATUS" id="OID_IF_OPER_STATUS"> </a><div class="element clickable constant  OID_IF_OPER_STATUS" data-toggle="collapse" data-target=".OID_IF_OPER_STATUS .collapse">
<h2>OID_IF_OPER_STATUS</h2>
<pre>OID_IF_OPER_STATUS </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="OID_IF_SPEED" id="OID_IF_SPEED"> </a><div class="element clickable constant  OID_IF_SPEED" data-toggle="collapse" data-target=".OID_IF_SPEED .collapse">
<h2>OID_IF_SPEED</h2>
<pre>OID_IF_SPEED </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            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>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a5</a> and<br>
            generated on 2012-06-08T14:43:32+01:00.<br></footer></div>
</div>
</body>
</html>