snmpsession(3) Library Functions Manual snmpsession(3)NAME
snmpsession - snmpkit functions dealing with a particular snmpsession.
SYNOPSIS
#include <snmpkit.h>
SNMPSESSION *sk_new_session(char *host, void *(start_routine)(SNMPSESSION*), const char *community);
DESCRIPTION
A snmpsession is an opaque data structure which specifies a
The new_snmpsession() creates a new session. The SNMPSOCK should have previously created by the application using, new_snmpsock(). The
host should will be looked up using gethostbyname() and the community string is something like a password in SNMP lingo but it doesn't have
a username associated with it and it is transmitted in clear text within the packets. In most cases, there are a couple of community
strings. One is only allowed to read and the other is allowed to both read and write. The default read-only community name is "public". If
set the community name to NULL, the community name will default to public.
The new_snmpsession_quick() function is very similar to the new_snmpsession() function except the community name always defaults to "pub-
lic".
The delete_snmpsock() function is the opposite of the new_snmpsession() function. It frees all memory and resources currently being used by
the SNMPSESSION structure.
RETURN VALUE
The new_snmpsock() and the new_snmpsock_quick() both return a pointer to the newly created snmpsock or NULL if there was an error.
AUTHOR
Ben Woodard <ben@users.sourceforge.net>
BUGS
The library can possibly throw different kinds of C++ exceptions that won't be caught by the glue code and therefore it can cause your pro-
gram to crash inexplicably.
SEE ALSO libsnmpkit(3), snmpsock(3), snmpstructfiller(3), snmptable(3), gethostbyname(3)GNU snmpkit 0.4 November 2000 snmpsession(3)
Check Out this Related Man Page
SNMP2_SET(3) 1 SNMP2_SET(3)snmp2_set - Set the value of anSNMPobjectSYNOPSIS
bool snmp2_set (string $host, string $community, string $object_id, string $type, string $value, [string $timeout = 1000000], [string
$retries = 5])
DESCRIPTION snmp2_set(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 snmp2_set(3)
<?php
snmp2_set("localhost", "public", "IF-MIB::ifAlias.3", "s", "foo");
?>
Example #2
Using snmp2_set(3) for setting BITS SNMP object id
<?php
snmp2_set("localhost", "public", 'FOO-MIB::bar.42', 'b', '0 1 2 3 4');
// or
snmp2_set("localhost", "public", 'FOO-MIB::bar.42', 'x', 'F0');
?>
SEE ALSO snmp2_get(3).
PHP Documentation Group SNMP2_SET(3)