PHP Manual
SNMP
Fetch an SNMP object

SNMP::get

(PHP 5 >= 5.4.0, PHP 7)

SNMP::get — Fetch an SNMP object

Description

public SNMP::get ( mixed $object_id [, bool $preserve_keys = FALSE ] ) : mixed

Fetch an SNMP object specified in object_id using GET query.

Parameters

If object_id is a string, then SNMP::get() will return SNMP object as string. If object_id is a array, all requested SNMP objects will be returned as associative array of the SNMP object ids and their values.

object_id: The SNMP object (OID) or objects
preserve_keys: When object_id is a array and preserve_keys set to TRUE keys in results will be taken exactly as in object_id, otherwise SNMP::oid_output_format property is used to determinate the form of keys.

Return Values

Returns SNMP objects requested as string or array depending on object_id type or FALSE on error.

Errors/Exceptions

This method does not throw any exceptions by default. To enable throwing an SNMPException exception when some of library errors occur the SNMP class parameter exceptions_enabled should be set to a corresponding value. See SNMP::$exceptions_enabled explanation for more details.

Examples

Example #1 Single SNMP object

Single SNMP object may be requested in two ways: as string resulting string return value or as single-element array with associative array as output.

<?php $session = new SNMP(SNMP::VERSION_1, "127.0.0.1", "public"); $sysdescr = $session->get("sysDescr.0"); echo "$sysdescr\n"; $sysdescr = $session->get(array("sysDescr.0")); print_r($sysdescr);?>

The above example will output something similar to:

STRING: Test server
Array
(
    [SNMPv2-MIB::sysDescr.0] => STRING: Test server
)

Example #2 Multiple SNMP objects

$session = new SNMP(SNMP::VERSION_1, "127.0.0.1", "public"); $results = $session->get(array("sysDescr.0", "sysName.0")); print_r($results); $session->close();