-
Notifications
You must be signed in to change notification settings - Fork 70
/
snmp3-walk.xml
218 lines (211 loc) · 7.1 KB
/
snmp3-walk.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 1051736a4ca76eb71c5c651e8c78ac808e8edc02 Maintainer: evvc Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.snmp3-walk" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>snmp3_walk</refname>
<refpurpose>Получает все объекты <acronym>SNMP</acronym> из агента</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>snmp3_walk</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>security_name</parameter></methodparam>
<methodparam><type>string</type><parameter>security_level</parameter></methodparam>
<methodparam><type>string</type><parameter>auth_protocol</parameter></methodparam>
<methodparam><type>string</type><parameter>auth_passphrase</parameter></methodparam>
<methodparam><type>string</type><parameter>privacy_protocol</parameter></methodparam>
<methodparam><type>string</type><parameter>privacy_passphrase</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter><initializer>-1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>retries</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
<para>
Функция <function>snmp3_walk</function> используется для чтения всех значений из агента <acronym>SNMP</acronym>,
указанного в <parameter>hostname</parameter>.
</para>
<para>
Даже если уровень безопасности не использует протокол авторизации или пароль, необходимо указать корректные значения.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem>
<para>
Имя хоста агента (сервера) SNMP.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>security_name</parameter></term>
<listitem>
<para>
Имя безопасности, обычно какое-то имя пользователя.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>security_level</parameter></term>
<listitem>
<para>
Уровень безопасности (noAuthNoPriv|authNoPriv|authPriv).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auth_protocol</parameter></term>
<listitem>
<para>
Протокол аутентификации (<literal>"MD5"</literal>, <literal>"SHA"</literal>,
<literal>"SHA256"</literal> или <literal>"SHA512"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auth_passphrase</parameter></term>
<listitem>
<para>
Пароль для аутентификации.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privacy_protocol</parameter></term>
<listitem>
<para>
Протокол конфиденциальности (DES или AES).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privacy_passphrase</parameter></term>
<listitem>
<para>
Пароль конфиденциальности.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>object_id</parameter></term>
<listitem>
<para>
Если &null;, <parameter>object_id</parameter> берётся в качестве корня дерева объектов <acronym>SNMP</acronym>
и все объекты этого дерева возвращаются в виде массива.
</para>
<para>
Если указан <parameter>object_id</parameter>, возвращаются все объекты <acronym>SNMP</acronym>
ниже этого <parameter>object_id</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
Время ожидания в микросекундах.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>retries</parameter></term>
<listitem>
<para>
Количество повторных попыток при истечении времени ожидания.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает массив значений объекта <acronym>SNMP</acronym>,
начиная с <parameter>object_id</parameter> в качестве корня или &false; в случае возникновения ошибки.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.1.0</entry>
<entry>
Параметр <parameter>auth_protocol</parameter> теперь принимает <literal>"SHA256"</literal>
и <literal>"SHA512"</literal>, если поддерживается libnetsnmp.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>snmp3_walk</function></title>
<programlisting role="php">
<![CDATA[
<?php
$ret = snmp3_walk('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'IF-MIB::ifName');
var_export($ret);
?>
]]>
</programlisting>
</example>
</para>
<para>
Вызов функции вернёт все объекты <acronym>SNMP</acronym> из агента <acronym>SNMP</acronym>,
запущенного на localhost:
<![CDATA[
array (
0 => 'STRING: lo',
1 => 'STRING: eth0',
2 => 'STRING: eth2',
3 => 'STRING: sit0',
4 => 'STRING: sixxs',
)
]]>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>snmp3_real_walk</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->