Модуль fortinet.fortios.fortios_system_snmp_user — настройка пользователя SNMP в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_snmp_user.

Добавлено в fortinet.fortios 2.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию system_snmp и категорию user. Примеры содержат все параметры и значения, которые перед использованием необходимо адаптировать к источникам данных. Проверено на FOS v6.0.0

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.
enable_log логическое значение	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту элемента, с которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с указанным member_path можно использовать для выполнения операции с элементом.
member_state строка	Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательный	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
system_snmp_user словарь	Настройка пользователя SNMP.
auth_proto строка	Протокол аутентификации. Варианты: `"md5"` `"sha"` `"sha224"` `"sha256"` `"sha384"` `"sha512"`
auth_pwd строка	Пароль для протокола аутентификации.
events список / элементы=строка	Уведомления SNMP (трап-пакеты), которые необходимо отправлять. Варианты: `"cpu-high"` `"mem-low"` `"log-full"` `"intf-ip"` `"vpn-tun-up"` `"vpn-tun-down"` `"ha-switch"` `"ha-hb-failure"` `"ips-signature"` `"ips-anomaly"` `"av-virus"` `"av-oversize"` `"av-pattern"` `"av-fragmented"` `"fm-if-change"` `"fm-conf-change"` `"bgp-established"` `"bgp-backward-transition"` `"ha-member-up"` `"ha-member-down"` `"ent-conf-change"` `"av-conserve"` `"av-bypass"` `"av-oversize-passed"` `"av-oversize-blocked"` `"ips-pkg-update"` `"ips-fail-open"` `"temperature-high"` `"voltage-alert"` `"power-supply"` `"faz-disconnect"` `"faz"` `"fan-failure"` `"wc-ap-up"` `"wc-ap-down"` `"fswctl-session-up"` `"fswctl-session-down"` `"load-balance-real-server-down"` `"device-new"` `"per-cpu-high"` `"dhcp"` `"pool-usage"` `"ippool"` `"interface"` `"ospf-nbr-state-change"` `"ospf-virtnbr-state-change"` `"bfd"` `"power-supply-failure"`
ha_direct строка	Включить или отключить прямое управление участниками кластера HA. Варианты: `"enable"` `"disable"`
interface строка	Укажите исходящий интерфейс для связи с сервером. Источник: system.interface.name.
interface_select_method строка	Укажите способ выбора исходящего интерфейса для связи с сервером. Варианты: `"auto"` `"sdwan"` `"specify"`
mib_view строка	Представление MIB для управления доступом SNMP. Источник: system.snmp.mib-view.name.
name строка / обязательный	Имя пользователя SNMP.
notify_hosts список / элементы=строка	Менеджеры SNMP, которым отправляются уведомления (трап-пакеты).
notify_hosts6 список / элементы=строка	Менеджеры IPv6 SNMP, которым отправляются уведомления (трап-пакеты).
priv_proto строка	Протокол конфиденциальности (шифрования). Варианты: `"aes"` `"des"` `"aes256"` `"aes256cisco"`
priv_pwd строка	Пароль для протокола конфиденциальности (шифрования).
queries строка	Включить или отключить запросы SNMP для этого пользователя. Варианты: `"enable"` `"disable"`
query_port целое число	Порт запросов SNMPv3.
security_level строка	Уровень безопасности для аутентификации и шифрования сообщений. Варианты: `"no-auth-no-priv"` `"auth-no-priv"` `"auth-priv"`
source_ip строка	Исходный IP-адрес для трап-пакетов SNMP.
source_ipv6 строка	Исходный IPv6-адрес для трап-пакетов SNMP.
status строка	Включить или отключить этого пользователя SNMP. Варианты: `"enable"` `"disable"`
trap_lport целое число	Локальный порт трап-пакетов SNMPv3.
trap_rport целое число	Удаленный порт трап-пакетов SNMPv3.
trap_status строка	Включить или отключить трап-пакеты для этого пользователя SNMP. Варианты: `"enable"` `"disable"`
vdoms список / элементы=словарь	VDOM для управления доступом SNMP.
name строка / обязательный	Имя VDOM. Источник: system.vdom.name.
vrf_select целое число	Идентификатор VRF, используемый для подключения к серверу.
vdom строка	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настраивать и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi объявлен устаревшим; для запуска плейбуков рекомендуется использовать httpapi
Модуль поддерживает check_mode.

Примеры

- name: SNMP user configuration.
  fortinet.fortios.fortios_system_snmp_user:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_snmp_user:
          auth_proto: "md5"
          auth_pwd: "<your_own_value>"
          events: "cpu-high"
          ha_direct: "enable"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          mib_view: "<your_own_value> (source system.snmp.mib-view.name)"
          name: "default_name_10"
          notify_hosts: "<your_own_value>"
          notify_hosts6: "<your_own_value>"
          priv_proto: "aes"
          priv_pwd: "<your_own_value>"
          queries: "enable"
          query_port: "161"
          security_level: "no-auth-no-priv"
          source_ip: "84.230.14.43"
          source_ipv6: "<your_own_value>"
          status: "enable"
          trap_lport: "162"
          trap_rport: "162"
          trap_status: "enable"
          vdoms:
              -
                  name: "default_name_25 (source system.vdom.name)"
          vrf_select: "0"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
build строка	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, полученный от FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Основной ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успехе Пример: `"id"`
name строка	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Результат операции Возвращается: всегда Пример: `"success"`
vdom строка	Использованный виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_system_snmp_user_module.html