Changes between Initial Version and Version 1 of ApiSnmpget

Timestamp:

Jul 29, 2022, 6:34:18 PM (2 years ago)

Author:

alx

Comment:

--

ApiSnmpget

@@ +1 @@
+=  Команда snmpget  =
+
+== Назначение команды ==
+
+Команда `snmpget` служит для запроса значений переменных плат блока MC04-DSL-3U (чтения переменных). 
+
+== Ключи запроса ==
+
+||  '''Ключ'''  ||  '''Тип значения'''  ||  '''обязательный'''  ||  '''Назначение'''  ||
+||  cmd  ||  строка  ||  да  || "snmpget" - имя команды ||
+||  varlist  ||  массив  ||  да  || список OID запрашиваемых переменных ||
+||  strings2data  ||  логический  ||  нет  || формат возвращаемых значений строк ||
+
+Команде `snmpget` требуется параметр "varlist", содержащий массив строк, каждая из которых представляет собой OID запрашиваемой переменной. OID состоит из элементов, представляющих собой число от 0 до 255 с точкой перед ним. При обращении к переменной платы первый элемент OID должен быть равен 4, второй элемент - номеру слота. Элементы OID начиная с третьего являются идентификатором переменной внутри платы. OID должен завершаться элементом 0.
+
+Переменные плат типа "строка" не всегда содержат в себе текст. Часто их значение представляет собой просто набор байтов (например в такой форме в плату могут передаваться ее настройки). Значение таких переменных не всегда может быть представлено в форме текстовой строки (так как не является валидной последовательностью UTF-8). Значения таких переменных может быть возвращено в форме массива байтов. Для этого необходимо указать в запросе параметр `strings2data`, имеющий значение `true`. Этот параметр влияет сразу на все переменные, указанные в запросе, если они имеют тип "строка". По умолчанию (при отсутствии в запросе параметра `strings2data`) значения переменных типа "строка" возвращаются в форме строк (как если бы было указано `"strings2data":false`). Рекомендуется использовать запросы без параметра `strings2data` только в тех случаях, когда известно, что значением всех запрашиваемых переменных типа "строка" является текст. В противном случае (если возможно получение нетекстовых бинарных данных) рекомендуется добавлять в запрос параметр `"strings2data":true`.
+
+=== Примеры запроса ===
+
+Запрос названий плат, установленных в слотах 2 и 3:
+
+ `{"cmd":"snmpget","varlist":[".4.2.2.0", ".4.3.2.0"]}` (1)
+
+Запрос переменных `.5.4.2.0` и `.7.1.1.0` из платы в слоте 17 с возвратом их значений в виде массива байт:
+
+ `{"cmd":"snmpget","varlist":[".4.17.5.4.2.0", ".4.17.7.1.1.0"],"strings2data":true}` (2)
+
+== Права доступа ==
+
+Для выполнения команды `snmpget` не требуется наличия каких-либо прав. 
+
+== Возвращаемые данные ==
+
+В случае успешного выполнения команда `snmpget` возвращает ключ `result`, значением которого является объект, содержащий результаты чтения переменных. :
+
+||  '''Ключ'''  ||  '''Тип значения'''  ||  '''Описание'''  ||
+
+Пример ответа:
+
+{{{
+}}}
+
+
+== См. также ==
+
+[ApiSnmpset команда snmpset]