SNMPSET(3)								 1								SNMPSET(3)

snmpset - Set the value of anSNMPobject

SYNOPSIS

       bool  snmpset  (string	$host,	string	 $community,  string   $object_id,  string   $type, mixed  $value, [int  $timeout = 1000000], [int
       $retries = 5])

DESCRIPTION

       snmpset(3) is used to set the value of an SNMP object specified by the $object_id.

PARAMETERS

	      o $host
		- The hostname of the SNMP agent (server).

	      o $community
		- The write community.

	      o $object_id
		- The SNMP object id.

	      o $type
		- The MIB defines the type of each object id. It has to be specified as a single character from the below list.

	      types

	      +--+--------------------------------+
	      |= |				  |
	      |  |				  |
	      |  | The type is taken from the MIB |
	      |  |				  |
	      |i |				  |
	      |  |				  |
	      |  |	      INTEGER		  |
	      |  |				  |
	      |u |				  |
	      |  |				  |
	      |  |	      INTEGER		  |
	      |  |				  |
	      |s |				  |
	      |  |				  |
	      |  |	       STRING		  |
	      |  |				  |
	      |x |				  |
	      |  |				  |
	      |  |	     HEX STRING 	  |
	      |  |				  |
	      |d |				  |
	      |  |				  |
	      |  |	   DECIMAL STRING	  |
	      |  |				  |
	      |n |				  |
	      |  |				  |
	      |  |	      NULLOBJ		  |
	      |  |				  |
	      |o |				  |
	      |  |				  |
	      |  |	       OBJID		  |
	      |  |				  |
	      |t |				  |
	      |  |				  |
	      |  |	     TIMETICKS		  |
	      |  |				  |
	      |a |				  |
	      |  |				  |
	      |  |	     IPADDRESS		  |
	      |  |				  |
	      |b |				  |
	      |  |				  |
	      |  |		BITS		  |
	      |  |				  |
	      +--+--------------------------------+
	       If OPAQUE_SPECIAL_TYPES was defined while compiling the SNMP library, the following are also valid:

	      types

	      +--+----------------+
	      |U |		  |
	      |  |		  |
	      |  | unsigned int64 |
	      |  |		  |
	      |I |		  |
	      |  |		  |
	      |  |  signed int64  |
	      |  |		  |
	      |F |		  |
	      |  |		  |
	      |  |     float	  |
	      |  |		  |
	      |D |		  |
	      |  |		  |
	      |  |     double	  |
	      |  |		  |
	      +--+----------------+
	       Most of these will use the obvious corresponding ASN.1 type. 's', 'x', 'd' and 'b' are all different ways of  specifying  an  OCTET
	      STRING  value, and the 'u' unsigned type is also used for handling Gauge32 values.  If the MIB-Files are loaded by into the MIB Tree
	      with "snmp_read_mib" or by specifying it in the libsnmp config, '=' may be used as the $type parameter for all  object  ids  as  the
	      type can then be automatically read from the MIB.  Note that there are two ways to set a variable of the type BITS like e.g. "SYNTAX
	      BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":

		     o Using type "b" and a list of bit numbers. This method is not recommended since GET query for the same OID would return e.g.
		     0xF8.

		     o Using type "x" and a hex number but without(!) the usual "0x" prefix.

	       See examples section for more details.

	      o $value
		- The new value.

	      o $timeout
		- The number of microseconds until the first timeout.

	      o $retries
		- The number of times to retry if timeouts occur.

RETURN VALUES

	Returns TRUE on success or FALSE on failure.

	If  the  SNMP  host rejects the data type, an E_WARNING message like "Warning: Error in packet. Reason: (badValue) The value given has the
       wrong type or length." is shown. If an unknown or invalid OID is specified the warning probably reads "Could not add variable".

EXAMPLES

       Example #1

	      Using snmpset(3)

	      <?php
		snmpset("localhost", "public", "IF-MIB::ifAlias.3", "s", "foo");
	      ?>

       Example #2

	      Using snmpset(3) for setting BITS SNMP object id

	      <?php
		snmpset("localhost", "public", 'FOO-MIB::bar.42', 'b', '0 1 2 3 4');
	      // or
		snmpset("localhost", "public", 'FOO-MIB::bar.42', 'x', 'F0');
	      ?>

SEE ALSO

       snmpget(3).

PHP Documentation Group 														SNMPSET(3)