Модуль fortinet.fortios.fortios_system_snmp_sysinfo – Настройка SNMP информации о системе в FortiOS и FortiGate Fortinet.

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет 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.15

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Сгенерирован из графического интерфейса Fortigate.
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту члена для обработки. Разделяется с помощью символа косой черты, если атрибутов больше одного. Параметр, помеченный member_path, подходит для выполнения операции с членом.
member_state строка	Добавить или удалить члена по указанному пути атрибута. Если member_state указан, опция state игнорируется. Варианты: `"present"` `"absent"`
system_snmp_sysinfo словарь	Настройка SNMP информации о системе.
append_index строка	Включить/выключить возможность добавления индекса vdom или интерфейса в некоторые таблицы RFC. Варианты: `"enable"` `"disable"`
contact_info строка	Контактная информация.
description строка	Описание системы.
engine_id строка	Строка локального SNMP engineID (максимум 27 символов).
engine_id_type строка	Тип локального SNMP engineID (текст/шестнадцатеричный/mac). Варианты: `"text"` `"hex"` `"mac"`
location строка	Местоположение системы.
status строка	Включить/выключить SNMP. Варианты: `"enable"` `"disable"`
trap_free_memory_threshold целое число	Использование свободной памяти при отправке ловушки.
trap_freeable_memory_threshold целое число	Использование освобождаемой памяти при отправке ловушки.
trap_high_cpu_threshold целое число	Использование ЦП при отправке ловушки.
trap_log_full_threshold целое число	Использование дискового пространства журнала при отправке ловушки.
trap_low_memory_threshold целое число	Использование памяти при отправке ловушки.
vdom строка	Виртуальная область, среди ранее определенных. Vdom – виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi был снят с поддержки, httpapi является предпочтительным способом запуска playbooks

Примеры

- 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>"
          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	Мастер-ключ (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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_snmp_sysinfo_module.html