Модуль fortinet.fortios.fortios_system_replacemsg_mm4 — сообщения-замены в 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_replacemsg_mm4.

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

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

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

Этот модуль позволяет настраивать устройства FortiGate или FortiOS (FOS), задавая и изменяя параметры функции system_replacemsg и категории mm4. Перед использованием необходимо скорректировать все параметры и значения в примерах с учетом источников данных. Протестировано с 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"`
system_replacemsg_mm4 dictionary	Сообщения-замены.
add_smil string	добавить инкапсуляцию сообщения Варианты: `"enable"` `"disable"`
charset string	кодировка символов, используемая для сообщения-замены Варианты: `"utf-8"` `"us-ascii"`
class string	класс сообщения Варианты: `"not-included"` `"personal"` `"informational"` `"advertisement"` `"auto"`
domain string	домен адреса отправителя
format string	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
fos_message string	текст сообщения
from string	адрес отправителя
from_sender string	уведомление отправлено получателю Варианты: `"enable"` `"disable"`
header string	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
image string	Строка сообщения. Источник: system.replacemsg-image.name.
msg_type string / обязательный	Тип сообщения.
priority string	приоритет сообщения Варианты: `"not-included"` `"low"` `"normal"` `"high"`
rsp_status string	статус ответа Варианты: `"ok"` `"err-unspecified"` `"err-srv-denied"` `"err-msg-fmt-corrupt"` `"err-snd-addr-unresolv"` `"err-net-prob"` `"err-content-not-accept"` `"err-unsupp-msg"`
smil_part string	текст инкапсуляции сообщения
subject string	строка темы сообщения
vdom string	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Replacement messages.
  fortinet.fortios.fortios_system_replacemsg_mm4:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_replacemsg_mm4:
          add_smil: "enable"
          charset: "utf-8"
          class: "not-included"
          domain: "<your_own_value>"
          format: "none"
          fos_message: "<your_own_value>"
          from: "<your_own_value>"
          from_sender: "enable"
          header: "none"
          image: "<your_own_value> (source system.replacemsg-image.name)"
          msg_type: "<your_own_value>"
          priority: "not-included"
          rsp_status: "ok"
          smil_part: "<your_own_value>"
          subject: "<your_own_value>"

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

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

Ключ	Описание
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_replacemsg_mm4_module.html