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

Впервые в fortinet.fortios 2.0.0

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

Описание

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию system_replacemsg и категорию mm1. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось на 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_mm1 словарь	Сообщения для замены.
add_smil строка	Добавление инкапсуляции сообщения. Варианты: `"enable"` `"disable"`
charset строка	Кодировка символов, используемая для сообщения замены. Варианты: `"utf-8"` `"us-ascii"`
class строка	Класс сообщения. Варианты: `"not-included"` `"personal"` `"advertisement"` `"information"` `"automatic"`
format строка	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
fos_message строка	Текст сообщения.
from строка	Адрес отправителя.
from_sender строка	Сообщение уведомления, отправленное от получателя. Варианты: `"enable"` `"disable"`
header строка	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
image строка	Строка сообщения. Источник системы system.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-msg-not-found"` `"err-net-prob"` `"err-content-not-accept"` `"err-unsupp-msg"`
rsp_text строка	Текст ответа.
sender_visibility строка	Видимость отправителя. Варианты: `"not-specified"` `"show"` `"hide"`

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

Примечания

Примечание

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