Home/ Manual/ snmp / functions/ snmp3_get

snmp3_get

PHP function Edit on GitHub ✎

(PHP 4, PHP 5, PHP 7, PHP 8)

Fetch an SNMP object

Description

snmp3_get(string $hostname, string $security_name, string $security_level, string $auth_protocol, string $auth_passphrase, string $privacy_protocol, string $privacy_passphrase, array|string $object_id, int $timeout = -1, int $retries = -1): mixed

The snmp3_get() function is used to read the value of an SNMP object specified by the object_id.

Parameters

hostname: The hostname of the SNMP agent (server).
security_name: Security-name
security_level: Security-level
auth_protocol: Auth-protocol
auth_passphrase: Auth-passphrase
privacy_protocol: Privacy-protocol
privacy_passphrase: Privacy-passphrase
object_id: The SNMP object id.
timeout: The number of microseconds until the first timeout.
retries: The number of times to retry if timeouts occur.

Return Values

Returns SNMP object value on success or false on error.

Changelog

Version	Description
8.5.0	Now throws a `ValueError` when the hostname length is equal to or greater than 128 bytes, when the port is negative or greater than 65535, or when the timeout or retries values are lower than -1 or too large.

Examples

Using snmp3_get()

php

<?php
$nameOfSecondInterface = snmp3_get('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'IF-MIB::ifName.2');
?>