Timer \OSS\Timer

$_start $_time start start end end time time No DocBlock was found for property $_start No DocBlock was found for property $_time No DocBlock was found for method start() No DocBlock was found for method end() No DocBlock was found for method time() SNMP \OSS\SNMP

OID_OUTPUT_FULL OID_OUTPUT_FULL OID_OUTPUT_NUMERIC OID_OUTPUT_NUMERIC SNMP_TRUTHVALUE_TRUE SNMP_TRUTHVALUE_TRUE SNMP_TRUTHVALUE_FALSE SNMP_TRUTHVALUE_FALSE $_community $_host $_timeout $_retry $_lastResult $_resultCache $_disableCache $SNMP_TRUTHVALUES NULL, NULL => NULL)]]> __construct __construct

string string \OSS_SNMP $host $community realWalk realWalk

string array $oid get get

string mixed $oid walk1d walk1d

Walks the SNMP tree returning an array of key => value pairs.

This is a first degree walk and it will throw an exception if there is more that one degree of values.

I.e. the following query with sample results:

walk1d( '.1.0.8802.1.1.2.1.3.7.1.4' )

  .1.0.8802.1.1.2.1.3.7.1.4.1 = STRING: "GigabitEthernet1/0/1"
  .1.0.8802.1.1.2.1.3.7.1.4.2 = STRING: "GigabitEthernet1/0/2"
  .1.0.8802.1.1.2.1.3.7.1.4.3 = STRING: "GigabitEthernet1/0/3"
  .....

would yield an array:

 1 => GigabitEthernet1/0/1
 2 => GigabitEthernet1/0/2
 3 => GigabitEthernet1/0/3

]]>

string array $oid subOidWalk subOidWalk

I.e. the following query with sample results:

subOidWalk( '.1.3.6.1.4.1.9.9.23.1.2.1.1.9', 15 )

  .1.3.6.1.4.1.9.9.23.1.2.1.1.9.10101.5 = Hex-STRING: 00 00 00 01
  .1.3.6.1.4.1.9.9.23.1.2.1.1.9.10105.2 = Hex-STRING: 00 00 00 01
  .1.3.6.1.4.1.9.9.23.1.2.1.1.9.10108.4 = Hex-STRING: 00 00 00 01

would yield an array:

 10101 => Hex-STRING: 00 00 00 01
 10105 => Hex-STRING: 00 00 00 01
 10108 => Hex-STRING: 00 00 00 01

]]>

string int array $oid $position parseSnmpValue parseSnmpValue

For example, [STRING: "blah"] is parsed to a PHP string containing: blah

]]>

string mixed \Exception $v ppTruthValue ppTruthValue

integer boolean $value translate translate

I.e. all elements '$value' will be replaced with $translator( $value ) where $translator is an associated array.

Huh? Just read the code below!

]]>

mixed array mixed $values $translator setOidOutputFormat setOidOutputFormat

Should be one of the class OID_OUTPUT_* constants

]]>

int \OSS_SNMP $f setHost setHost

string \OSS_SNMP $h getHost getHost

string setCommunity setCommunity

string \OSS_SNMP $c getCommunity getCommunity

string setTimeout setTimeout

int \OSS_SNMP $t getTimeout getTimeout

int setRetry setRetry

int \OSS_SNMP $r getRetry getRetry

string getLastResult getLastResult

mixed getResultCache getResultCache

array disableCache disableCache

\SNMP enableCache enableCache

\SNMP cache cache

boolean __call __call

string array \Exception $method $args useExtension useExtension

Calling $this->useXXX_YYY_ZZZ()->fn() will instantiate an extension MIB class is the given name and this $this SNMP instance and then call fn().

See the examples for more information.

]]>

string array \OSS\SNMP\MIBS $mib $args No DocBlock was found for property $_community No DocBlock was found for property $_host No DocBlock was found for property $_timeout No DocBlock was found for property $_retry No DocBlock was found for property $_lastResult No DocBlock was found for property $_resultCache No DocBlock was found for property $_disableCache No DocBlock was found for property $SNMP_TRUTHVALUES Iface \OSS\SNMP\MIBS\Iface OSS\SNMP\MIB

OID_IF_DESCRIPTION OID_IF_DESCRIPTION OID_IF_SPEED OID_IF_SPEED OID_IF_OPER_STATUS OID_IF_OPER_STATUS OID_IF_NAME OID_IF_NAME OID_IF_ALIAS OID_IF_ALIAS IF_OPER_STATUS_UP IF_OPER_STATUS_UP IF_OPER_STATUS_DOWN IF_OPER_STATUS_DOWN IF_OPER_STATUS_TESTING IF_OPER_STATUS_TESTING IF_OPER_STATUS_UNKNOWN IF_OPER_STATUS_UNKNOWN IF_OPER_STATUS_DORMANT IF_OPER_STATUS_DORMANT IF_OPER_STATUS_NOT_PRESENT IF_OPER_STATUS_NOT_PRESENT IF_OPER_STATUS_LOWER_LAYER_DOWN IF_OPER_STATUS_LOWER_LAYER_DOWN $IF_OPER_STATES 'up', NULL => 'down', NULL => 'testing', NULL => 'unknown', NULL => 'dormant', NULL => 'notPresent', NULL => 'lowerLayerDown')]]> names names

E.g. the following SNMP output yields the shown array:

.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 ...

 [10128] => "Gi1/0/28"
 [10129] => "Gi1/0/29"

]]>

array aliases aliases

E.g. the followig SNMP output yields the shown array:

.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 ...

 [10128] => "Connection to switch2"
 [10129] => "Connection to switch3"

]]>

array descriptions descriptions

E.g. the following SNMP output yields the shown array:

.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 ...

 [10128] => "GigabitEthernet1/0/28"
 [10129] => "GigabitEthernet1/0/29"

]]>

array speeds speeds

E.g. the following SNMP output yields the shown array:

.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 ...

 [10128] => 1000000000
 [10129] => 100000000

NB: operating speed as opposed to maximum speed

]]>

array operationStates operationStates

E.g. the follow SNMP output yields the shown array:

.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) ...

 [10128] => 1
 [10129] => 2

]]>

boolean array $translate bridgeBasePortIfIndexes bridgeBasePortIfIndexes

e.g. [22] => 10122

]]>

array No DocBlock was found for property $IF_OPER_STATES Bridge \OSS\SNMP\MIBS\Bridge OSS\SNMP\MIB

OID_BRIDGE_BASE_PORT_IF_INDEX OID_BRIDGE_BASE_PORT_IF_INDEX basePortIfIndexes basePortIfIndexes

e.g. [22] => 10122

]]>

array LAG \OSS\SNMP\MIBS\LAG OSS\SNMP\MIB

OID_LAG_PORT_ATTACHED_ID OID_LAG_PORT_ATTACHED_ID OID_LAG_AGGREGATE_OR_INDIVIDUAL OID_LAG_AGGREGATE_OR_INDIVIDUAL isAggregatePorts isAggregatePorts

array portAttachedIds portAttachedIds

array getLAGPorts getLAGPorts name of it's constituent ports]]>

E.g.: [5048] => Array ( [10111] => GigabitEthernet1/0/11 [10112] => GigabitEthernet1/0/12 )

]]>

array findFailedLAGPorts findFailedLAGPorts

array Cisco \OSS\SNMP\MIBS\Cisco OSS\SNMP\MIB

Host \OSS\SNMP\MIBS\Host OSS\SNMP\MIB

CDP \OSS\SNMP\MIBS\Cisco\CDP OSS\SNMP\MIBS\Cisco

OID_CDP_INTERFACE_ENABLED OID_CDP_INTERFACE_ENABLED OID_CDP_INTERFACE_NAME OID_CDP_INTERFACE_NAME OID_CDP_NEIGHBOUR_ID OID_CDP_NEIGHBOUR_ID OID_CDP_NEIGHBOUR_PORT OID_CDP_NEIGHBOUR_PORT OID_CDP_NEIGHBOUR_CAPABILITY OID_CDP_NEIGHBOUR_CAPABILITY OID_CDP_DEVICE_ID OID_CDP_DEVICE_ID deviceId deviceId

string interfaceEnabled interfaceEnabled

Applies the TruthValue post processor (self::ppTruthValue()) to turn SNMP values into true / false.

]]>

array interfaceNames interfaceNames

array neighbourId neighbourId

array neighbourPort neighbourPort

E.g. a sample call may return:

Array ( [10101] => GigabitEthernet0/1 [10102] => FastEthernet0/2 [10103] => GigabitEthernet1/0/24 [10105] => GigabitEthernet1/0/2 )

meaning, for example, that our local port with ID 10101 is connected to port GigabitEthernet0/1 on the neighbour connected to that local port. You can discover the neighbour ID via neighbourId().

]]>

array neighbourCapability neighbourCapability

array neighbourInformation neighbourInformation

Returns an array of neighbours indexed by the neighbour CDP ID. For example:

Array ( [cr-sw03.ixdub1.opensolutions.ie] => Array ( [0] => Array ( [localPortId] => 10101 [localPort] => GigabitEthernet1/0/1 [remotePort] => GigabitEthernet0/1 )

        [1] => Array
            (
                [localPortId] => 10102
                [localPort] => GigabitEthernet1/0/2
                [remotePort] => FastEthernet0/2
            )

    )
[ ... ]

)

]]>

array VTP \OSS\SNMP\MIBS\Cisco\VTP OSS\SNMP\MIBS\Cisco

OID_VTP_VLAN_STATUS OID_VTP_VLAN_STATUS OID_VTP_VLAN_TYPE OID_VTP_VLAN_TYPE OID_VTP_VLAN_NAME OID_VTP_VLAN_NAME OID_STP_X_RSTP_PORT_ROLE OID_STP_X_RSTP_PORT_ROLE VTP_VLAN_STATE_OPERATIONAL VTP_VLAN_STATE_OPERATIONAL VTP_VLAN_STATE_SUSPENDED VTP_VLAN_STATE_SUSPENDED VTP_VLAN_STATE_MTU_TOO_BIG_FOR_DEVICE VTP_VLAN_STATE_MTU_TOO_BIG_FOR_DEVICE VTP_VLAN_STATE_MTU_TOO_BIG_FOR_TRUNK VTP_VLAN_STATE_MTU_TOO_BIG_FOR_TRUNK VTP_VLAN_TYPE_ETHERNET VTP_VLAN_TYPE_ETHERNET VTP_VLAN_TYPE_FDDI VTP_VLAN_TYPE_FDDI VTP_VLAN_TYPE_TOKEN_RING VTP_VLAN_TYPE_TOKEN_RING VTP_VLAN_TYPE_FDDI_NET VTP_VLAN_TYPE_FDDI_NET VTP_VLAN_TYPE_TR_NET VTP_VLAN_TYPE_TR_NET VTP_VLAN_TYPE_DEPRECATED VTP_VLAN_TYPE_DEPRECATED STP_X_RSTP_PORT_ROLE_DISABLED STP_X_RSTP_PORT_ROLE_DISABLED STP_X_RSTP_PORT_ROLE_ROOT STP_X_RSTP_PORT_ROLE_ROOT STP_X_RSTP_PORT_ROLE_DESIGNATED STP_X_RSTP_PORT_ROLE_DESIGNATED STP_X_RSTP_PORT_ROLE_ALTERNATE STP_X_RSTP_PORT_ROLE_ALTERNATE STP_X_RSTP_PORT_ROLE_BACKUP STP_X_RSTP_PORT_ROLE_BACKUP STP_X_RSTP_PORT_ROLE_BOUNDARY STP_X_RSTP_PORT_ROLE_BOUNDARY STP_X_RSTP_PORT_ROLE_MASTER STP_X_RSTP_PORT_ROLE_MASTER $VTP_VLAN_STATES 'operational', NULL => 'suspended', NULL => 'mtuTooBigForDevice', NULL => 'mtuTooBigForTrunk')]]> $VTP_VLAN_TYPES 'ethernet', NULL => 'fddi', NULL => 'tokenRing', NULL => 'fddiNet', NULL => 'trNet', NULL => 'deprecated')]]> $STP_X_RSTP_PORT_ROLES 'disabled', NULL => 'root', NULL => 'designated', NULL => 'alternate', NULL => 'backUp', NULL => 'boundary', NULL => 'master')]]> vlanStates vlanStates

boolean array $translate vlanTypes vlanTypes

boolean array $translate vlanNames vlanNames

array rstpPortRole rstpPortRole

Only ports participating in RSTP for the given VLAN id are returned.

This function will also convert STP port IDs to the device proper port IDs. E.g. sample output:

Array ( [10101] => 3 [10103] => 3 [10105] => 3 [5048] => 2 )

]]>

int boolean array $vid $translate No DocBlock was found for property $VTP_VLAN_STATES No DocBlock was found for property $VTP_VLAN_TYPES No DocBlock was found for property $STP_X_RSTP_PORT_ROLES RSTP \OSS\SNMP\MIBS\Cisco\RSTP OSS\SNMP\MIBS\Cisco

OID_STP_X_RSTP_PORT_ROLE OID_STP_X_RSTP_PORT_ROLE STP_X_RSTP_PORT_ROLE_DISABLED STP_X_RSTP_PORT_ROLE_DISABLED STP_X_RSTP_PORT_ROLE_ROOT STP_X_RSTP_PORT_ROLE_ROOT STP_X_RSTP_PORT_ROLE_DESIGNATED STP_X_RSTP_PORT_ROLE_DESIGNATED STP_X_RSTP_PORT_ROLE_ALTERNATE STP_X_RSTP_PORT_ROLE_ALTERNATE STP_X_RSTP_PORT_ROLE_BACKUP STP_X_RSTP_PORT_ROLE_BACKUP STP_X_RSTP_PORT_ROLE_BOUNDARY STP_X_RSTP_PORT_ROLE_BOUNDARY STP_X_RSTP_PORT_ROLE_MASTER STP_X_RSTP_PORT_ROLE_MASTER $STP_X_RSTP_PORT_ROLES 'disabled', NULL => 'root', NULL => 'designated', NULL => 'alternate', NULL => 'backUp', NULL => 'boundary', NULL => 'master')]]> rstpPortRole rstpPortRole

Only ports participating in RSTP for the given VLAN id are returned.

This function will also convert STP port IDs to the device proper port IDs. E.g. sample output:

Array ( [10101] => 3 [10103] => 3 [10105] => 3 [5048] => 2 )

]]>

int boolean array $vid $translate No DocBlock was found for property $STP_X_RSTP_PORT_ROLES MIB \OSS\SNMP\MIB

$_snmp setSNMP setSNMP

\OSS\SNMP \OSS\SNMP\MIB $snmp getSNMP getSNMP

\OSS\SNMP No DocBlock was found for property $_snmp Exception \OSS\Exception Exception

todo fixme