Home/ Manual/ snmp / snmp/ SNMP::get

SNMP::get

PHP function Edit on GitHub ✎

(PHP 5 >= 5.4.0, PHP 7, PHP 8)

Fetch an SNMP object

Description

SNMP::get(array|string $objectId, bool $preserveKeys = false): mixed

Fetch an SNMP object specified in objectId using GET query.

Parameters

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

objectId: The SNMP object (OID) or objects
preserveKeys: When objectId is an array and preserveKeys set to true keys in results will be taken exactly as in objectId, 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 objectId type or false on error.

Refsect

Examples

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

<?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:

output

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

Multiple SNMP objects

php

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