cvs: /phpdoc/functions snmp.sgml

jim Tue Jul 13 16:41:27 1999 EDT Modified files: /phpdoc/functions snmp.sgml Log: Add snmpset documentation (largely copied from snmpget). Various other wording tweaks to the SNMP documentation. Index: phpdoc/functions/snmp.sgml diff -u phpdoc/functions/snmp.sgml:1.3 phpdoc/functions/snmp.sgml:1.4 --- phpdoc/functions/snmp.sgml:1.3 Sun Jun 20 08:05:09 1999 +++ phpdoc/functions/snmp.sgml Tue Jul 13 16:41:26 1999 @@ -36,10 +36,12 @@ <refsect1> <title>Description</title> <funcsynopsis> - <funcdef>int <function>snmpget</function></funcdef> + <funcdef>string <function>snmpget</function></funcdef> <paramdef>string <parameter>hostname</parameter></paramdef> <paramdef>string <parameter>community</parameter></paramdef> <paramdef>string <parameter>object_id</parameter></paramdef> + <paramdef>int <parameter><optional>timeout</optional></parameter></paramdef> + <paramdef>int <parameter><optional>retries</optional></parameter></paramdef> </funcsynopsis> <para> @@ -55,13 +57,45 @@ <para> <informalexample> <literallayout> -snmpget("127.0.0.1", "public", "system.SysContact.0") +$syscontact = snmpget("127.0.0.1", "public", "system.SysContact.0") </literallayout> </informalexample> </refsect1> </refentry> + <refentry id="function.snmpset"> + <refnamediv> + <refname>snmpset</refname> + <refpurpose>Set an SNMP object</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>string <function>snmpget</function></funcdef> + <paramdef>string <parameter>hostname</parameter></paramdef> + <paramdef>string <parameter>community</parameter></paramdef> + <paramdef>string <parameter>object_id</parameter></paramdef> + <paramdef>string <parameter>type</parameter></paramdef> + <paramdef>mixed <parameter>value</parameter></paramdef> + <paramdef>int <parameter><optional>timeout</optional></parameter></paramdef> + <paramdef>int <parameter><optional>retries</optional></parameter></paramdef> + </funcsynopsis> + + <para> + Sets the specified SNMP object value, returning true on success + and false on error. + + <para> + The <function>snmpset</function> function is used + to set the value of an SNMP object specified by the + <parameter>object_id</parameter>. SNMP agent is specified by the + <parameter>hostname</parameter> and the read community is specified + by the <parameter>community</parameter> parameter. + + </refsect1> + </refentry> + <refentry id="function.snmpwalk"> <refnamediv> <refname>snmpwalk</refname> @@ -205,24 +239,22 @@ </informalexample> <para> - Above function call would return 0 (false) if quick_print is on, and 1 - (true) if quick_print is on. + Above function call would return <systemitem>false</systemitem> if + quick_print is on, and <systemitem>true</systemitem> if quick_print + is on. <para> <function>snmp_get_quick_print</function> is only available when using - the UCD SNMP library. This function is not applicable to Windows NT. + the UCD SNMP library. This function is not available when using the + Windows SNMP library. <para> - See: <function>snmp_set_quick_print</function> for a description of - what quick_print actually does. + See: <function>snmp_set_quick_print</function> for a full description + of what quick_print does. </refsect1> </refentry> - - - - <refentry id="function.snmp-set-quick-print"> <refnamediv> <refname>snmp_set_quick_print</refname> @@ -274,7 +306,8 @@ <para> <function>snmp_set_quick_print</function> is only available when using - the UCD SNMP library. This function is not applicable to Windows NT. + the UCD SNMP library. This function is not available when using + the Windows SNMP library. </refsect1> </refentry>