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

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

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

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

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию system_replacemsg и категорию mm1. В примерах представлены все параметры; перед использованием их значения необходимо адаптировать к источникам данных. Протестировано с 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_mm1 dictionary	Сообщения замены.
add_smil string	добавление инкапсуляции сообщения Допустимые значения: `"enable"` `"disable"`
charset string	кодировка символов для сообщения замены Допустимые значения: `"utf-8"` `"us-ascii"`
class string	класс сообщения Допустимые значения: `"not-included"` `"personal"` `"advertisement"` `"information"` `"automatic"`
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-msg-not-found"` `"err-net-prob"` `"err-content-not-accept"` `"err-unsupp-msg"`
rsp_text string	текст ответа
sender_visibility string	видимость отправителя Допустимые значения: `"not-specified"` `"show"` `"hide"`
smil_part string	текст инкапсуляции сообщения
subject string	строка темы сообщения
vdom string	Виртуальный домен из числа предварительно определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Replacement messages.
  fortinet.fortios.fortios_system_replacemsg_mm1:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_replacemsg_mm1:
          add_smil: "enable"
          charset: "utf-8"
          class: "not-included"
          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"
          rsp_text: "<your_own_value>"
          sender_visibility: "not-specified"
          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_mm1_module.html