Модуль fortinet.fortios.fortios_switch_controller_snmp_community — глобальная настройка сообществ SNMP v1/v2c FortiSwitch в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

Чтобы использовать его в сценарии, укажите: fortinet.fortios.fortios_switch_controller_snmp_community.

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

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Создаётся в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются косой чертой. Параметр с пометкой member_path можно использовать для выполнения операции над элементом.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state string / обязательный	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
switch_controller_snmp_community dictionary	Глобальная настройка сообществ SNMP v1/v2c FortiSwitch.
events list / элементы=string	Уведомления SNMP (трап-пакеты) для отправки. Варианты: `"cpu-high"` `"mem-low"` `"log-full"` `"intf-ip"` `"ent-conf-change"` `"l2mac"`
hosts list / элементы=dictionary	Настройка диспетчеров SNMP (хостов) IPv4.
id integer / обязательный	Идентификатор записи хоста. См. <a href=’#notes’>Примечания</a>.
ip string	IPv4-адрес диспетчера SNMP (хоста).
id integer / обязательный	Идентификатор сообщества SNMP. См. <a href=’#notes’>Примечания</a>.
name string	Имя сообщества SNMP.
query_v1_port integer	Порт запросов SNMP v1.
query_v1_status string	Включить или отключить запросы SNMP v1. Варианты: `"disable"` `"enable"`
query_v2c_port integer	Порт запросов SNMP v2c.
query_v2c_status string	Включить или отключить запросы SNMP v2c. Варианты: `"disable"` `"enable"`
status string	Включить или отключить это сообщество SNMP. Варианты: `"disable"` `"enable"`
trap_v1_lport integer	Локальный порт трап-пакетов SNMP v2c.
trap_v1_rport integer	Удалённый порт трап-пакетов SNMP v2c.
trap_v1_status string	Включить или отключить трап-пакеты SNMP v1. Варианты: `"disable"` `"enable"`
trap_v2c_lport integer	Локальный порт трап-пакетов SNMP v2c.
trap_v2c_rport integer	Удалённый порт трап-пакетов SNMP v2c.
trap_v2c_status string	Включить или отключить трап-пакеты SNMP v2c. Варианты: `"disable"` `"enable"`
vdom string	Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Настоятельно рекомендуем использовать собственное значение для id вместо 0. Значение «0» является специальным заполнителем, позволяющим серверной части назначить объекту последний доступный номер, однако у такого подхода есть ограничения. Подробнее см. в разделе «Вопросы и ответы».
Устаревший fortiosapi объявлен устаревшим; для запуска сценариев рекомендуется использовать httpapi.
Модуль поддерживает check_mode.

Примеры

- name: Configure FortiSwitch SNMP v1/v2c communities globally.
  fortinet.fortios.fortios_switch_controller_snmp_community:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_snmp_community:
          events: "cpu-high"
          hosts:
              -
                  id: "5"
                  ip: "<your_own_value>"
          id: "7"
          name: "default_name_8"
          query_v1_port: "161"
          query_v1_status: "disable"
          query_v2c_port: "161"
          query_v2c_status: "disable"
          status: "disable"
          trap_v1_lport: "162"
          trap_v1_rport: "162"
          trap_v1_status: "disable"
          trap_v2c_lport: "162"
          trap_v2c_rport: "162"
          trap_v2c_status: "disable"

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

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

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