Home/ Manual/ snmp / functions/ snmp3_walk

snmp3_walk

PHP function Edit on GitHub ✎

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

Fetch all the SNMP objects from an agent

Description

snmp3_walk(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): array|false

snmp3_walk() function is used to read all the values from an SNMP agent specified by the hostname.

The authentication and privacy arguments must always be passed, but their values are ignored when security_level does not use them.

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

If an empty string, object_id is taken as .1.3.6.1.2.1, the root of the SNMP objects tree, and all objects under that tree are returned as an array.

If object_id is specified, all the SNMP objects below that object_id are returned.

timeout

The number of microseconds until the first timeout.

retries

The number of times to retry if timeouts occur.

Return Values

Returns an array of SNMP object values starting from the object_id as root or false on error.

Changelog

Version	Description

Examples

snmp3_walk() Example

php

<?php
$ret = snmp3_walk('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'IF-MIB::ifName');
var_export($ret);
?>

Above function call would return all the SNMP objects from the SNMP agent running on localhost: array ( 0 => 'STRING: lo', 1 => 'STRING: eth0', 2 => 'STRING: eth2', 3 => 'STRING: sit0', 4 => 'STRING: sixxs', )