---
canonical: https://docs.ideco.ru/v22/ru/ngfw/api/snmp-api
---



# SNMP

::: page-constructor
blocks:
  - type: content-layout-block
    textContent:
      buttons:
        - text: Классический VCE
          theme: action
          width: 'auto'
        - text: Высокопроизводительный VCE
          theme: outlined
          url: https://docs.ideco.ru/api/vpp-v22/ru/ngfw/monitor-api/snmp/
          width: 'auto'
        - text: Документация
          theme: outlined
          url: https://docs.ideco.ru/v22/ru/ngfw/settings/monitor/snmp
          width: 'auto'
    resetPaddings: false
    textWidth: l
    size: m
    centered: false
:::

{% cut "Получение настройки включенности модуля" %}{#poluchenie-nastroyki-vklyuchennosti-modulya}

```
GET /monitor_backend/snmp/state
```

**Ответ на успешный запрос:**

```json5
{
  "enabled": true | false
}
```

* `enabled` - статус модуля SNMP:
  * `true` - включен;
  * `false` - выключен.

{% endcut %}

{% cut "Управление модулем" %}{#upravlenie-modulem}

```
PATCH /monitor_backend/snmp/state
```

**Json-тело запроса:**

```json5
{
  "enabled": true | false
}
```

* `enabled` - статус модуля SNMP:
  * `true` - включен;
  * `false` - выключен.

**Ответ на успешный запрос:** 200 OK

{% endcut %}

{% cut "Получение состояния работы модуля" %}{#poluchenie-sostoyaniya-raboty-modulya}

```
GET /monitor_backend/snmp/status
```

**Ответ на успешный запрос:**

```json5
{
  "name": "string",
  "status": "active" | "activating" | "deactivating" | "failed" | "inactive" | "reloading", 
  "msg": ["string"]
}

```

* `name` - название модуля;
* `status` - статус работы модуля:
  * `active` - включен;
  * `activating` - включается;
  * `deactivating` - выключается;
  * `failed` - произошла ошибка;
  * `inactive` - выключен;
  * `reloading` - перезагрузка.
* `msg` - список сообщений, поясняющих текущее состояние службы. Может быть пустым.

{% endcut %}

{% cut "Получение настроек SNMP" %}{#poluchenie-nastroek-snmp}

```
GET /monitor_backend/snmp/settings
```

**Ответ на успешный запрос:**

```json5
{
  "community": "string",
  "allow_external": true | false,
  "version": "integer",
  "user": "string",
  "password": "string",
  "private_key": "string",
  "hosts": ["string"],
  "location": "string",
  "contact": "string",
  "name": "string"
}
```

* `community` - назначение поля. Может быть пустым;
* `allow_external` - опция **Разрешить другим устройствам доступ к Ideco NGFW Novum по SNMP**:
  * `true` - включена;
  * `false` - выключена.
* `version` - версия SNMP. Может принимать значения:
  * `2` - версия 1/2с;
  * `3` - версия 3.
* `user` - логин пользователя. Может быть пустым;
* `password` - пароль. Минимальная длина - 8 символов. Может быть пустым;
* `private_key` - приватный ключ. Поддерживается только для SNMPv3. Минимальная длина - 8 символов. Может быть пустым;
* `hosts` - список доверенных IP-адресов и сетей. Может быть пустым;
* `location` - местоположение. Может быть пустым;
* `contact` - контактная информация. Может быть пустым;
* `name` - имя узла. Может быть пустым.

{% endcut %}

{% cut "Изменение настроек SNMP" %}{#izmenenie-nastroek-snmp}

```
PATCH /monitor_backend/snmp/settings
```

**Json-тело запроса:**

```json5
{
  "community": "string",
  "allow_external": true | false,
  "version": "integer",
  "user": "string",
  "password": "string",
  "private_key": "string",
  "hosts": ["string"],
  "location": "string",
  "contact": "string",
  "name": "string"
}
```

* `community` - назначение поля. Может быть пустым;
* `allow_external` - опция **Разрешить другим устройствам доступ к Ideco NGFW Novum по SNMP**:
  * `true` - включена;
  * `false` - выключена.
* `version` - версия SNMP. Может принимать значения:
  * `2` - версия 1/2с;
  * `3` - версия 3.
* `user` - логин пользователя. Может быть пустым;
* `password` - пароль. Минимальная длина - 8 символов. Может быть пустым;
* `private_key` - приватный ключ. Поддерживается только для SNMPv3. Минимальная длина - 8 символов. Может быть пустым;
* `hosts` - список доверенных IP-адресов и сетей. Может быть пустым;
* `location` - местоположение. Может быть пустым;
* `contact` - контактная информация. Может быть пустым;
* `name` - имя узла. Может быть пустым.

**Ответ на успешный запрос:** 200 OK

{% endcut %}
