Модуль fortinet.fortios.fortios_system_replacemsg_mm4 – Сообщения о замене в Fortinet FortiOS и FortiGate.

Примечание

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

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

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Сгенерировано в интерфейсе Fortigate.
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту члена для обработки. Разделяется символом слеша, если есть более одного атрибута. Параметр, помеченный member_path, является допустимым для выполнения операций с членами.
member_state строка	Добавить или удалить члена по указанному пути к атрибуту. При указании member_state параметр state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательный	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
system_replacemsg_mm4 словарь	Сообщения замены.
add_smil строка	добавление инкапсуляции сообщения Варианты: `"enable"` `"disable"`
charset строка	кодировка символов, используемая для сообщения замены Варианты: `"utf-8"` `"us-ascii"`
class строка	класс сообщения Варианты: `"not-included"` `"personal"` `"informational"` `"advertisement"` `"auto"`
domain строка	домен отправителя
format строка	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
fos_message строка	текст сообщения
from строка	адрес отправителя
from_sender строка	сообщение уведомления отправлено получателем Варианты: `"enable"` `"disable"`
header строка	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
image строка	Строка сообщения. Источник системы.replacemsg-image.name.
msg_type строка / обязательный	Тип сообщения.
priority строка	приоритет сообщения Варианты: `"not-included"` `"low"` `"normal"` `"high"`
rsp_status строка	статус ответа Варианты: `"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 строка	текст инкапсуляции сообщения

subject string	Строка текста темы
vdom string	Виртуальный домен, среди ранее определенных. vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный блок. Default: `"root"`

Примечания

Примечание

Устаревшее fortiosapi было прекращено, httpapi — предпочтительный способ запуска playbooks
Модуль поддерживает 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	Мастер-ключ (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_replacemsg_mm4_module.html