Модуль fortinet.fortios.fortios_system_snmp_sysinfo — настройка системной информации 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_sysinfo.

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

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

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

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), устанавливая и изменяя параметры функции system_snmp и категории sysinfo. В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Протестировано с 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"`
system_snmp_sysinfo dictionary	Настройка системной информации SNMP.
append_index string	Включить или отключить добавление индекса vdom или интерфейса в некоторые таблицы RFC. Варианты: `"enable"` `"disable"`
contact_info string	Контактная информация.
description string	Описание системы.
engine_id string	Локальная строка engineID SNMP (максимум 27 символов).
engine_id_type string	Тип локального engineID SNMP (текст/шестнадцатеричный формат/MAC). Варианты: `"text"` `"hex"` `"mac"`
location string	Местоположение системы.
non_mgmt_vdom_query string	Включить или отключить возможность выполнения запросов SNMPv3 из виртуальных доменов, не предназначенных для управления. Варианты: `"enable"` `"disable"`
status string	Включить или отключить SNMP. Варианты: `"enable"` `"disable"`
trap_free_memory_threshold integer	Использование свободной памяти, при котором отправляется trap.
trap_freeable_memory_threshold integer	Использование памяти, доступной для освобождения, при котором отправляется trap.
trap_high_cpu_threshold integer	Использование ЦП, при котором отправляется trap.
trap_log_full_threshold integer	Использование дискового пространства для журналов, при котором отправляется trap.
trap_low_memory_threshold integer	Использование памяти, при котором отправляется trap.
vdom string	Виртуальный домен из числа ранее определённых. vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: SNMP system info configuration.
  fortinet.fortios.fortios_system_snmp_sysinfo:
      vdom: "{{ vdom }}"
      system_snmp_sysinfo:
          append_index: "enable"
          contact_info: "<your_own_value>"
          description: "<your_own_value>"
          engine_id: "<your_own_value>"
          engine_id_type: "text"
          location: "<your_own_value>"
          non_mgmt_vdom_query: "enable"
          status: "enable"
          trap_free_memory_threshold: "5"
          trap_freeable_memory_threshold: "60"
          trap_high_cpu_threshold: "80"
          trap_log_full_threshold: "90"
          trap_low_memory_threshold: "80"

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

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

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи данных в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, полученный от FortiGate после последней выполненной операции Возвращается: всегда Пример: `"200"`
mkey string	Главный ключ (идентификатор), использованный при последнем обращении к 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_system_snmp_sysinfo_module.html