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

Новый в fortinet.fortios 2.0.0

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

Описание

Этот модуль может настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию system_replacemsg и категорию mm3. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось на 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_mm3 словарь	Сообщения для замены.
add_html строка	Добавление инкапсуляции сообщения. Варианты: `"enable"` `"disable"`
charset строка	Кодировка символов, используемая для сообщения замены. Варианты: `"utf-8"` `"us-ascii"`
format строка	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
fos_message строка	Текст сообщения.
from строка	Адрес отправителя.
from_sender строка	Сообщение уведомления отправляется получателю. Варианты: `"enable"` `"disable"`
header строка	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
html_part строка	Текст инкапсуляции сообщения.
image строка	Строка сообщения. Исходная система.replacemsg-image.name.
msg_type строка / обязательно	Тип сообщения.
priority строка	Приоритет сообщения. Варианты: `"not-included"` `"low"` `"normal"` `"high"`
subject строка	Строка текста темы.
vdom строка	Виртуальная область (vdom), определённая ранее. Vdom — это виртуальная инстанция FortiGate, которая может быть настроена и использоваться как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Модуль fortiosapi устарел, предпочтительный способ запуска playbooks — httpapi.
Модуль поддерживает режим check_mode.

Примеры

- name: Replacement messages.
  fortinet.fortios.fortios_system_replacemsg_mm3:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_replacemsg_mm3:
          add_html: "enable"
          charset: "utf-8"
          format: "none"
          fos_message: "<your_own_value>"
          from: "<your_own_value>"
          from_sender: "enable"
          header: "none"
          html_part: "<your_own_value>"
          image: "<your_own_value> (source system.replacemsg-image.name)"
          msg_type: "<your_own_value>"
          priority: "not-included"
          subject: "<your_own_value>"

Значения возврата

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

Ключ	Описание
build строка	Номер сборки образа fortigate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, используемый для предоставления содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, предоставленный FortiGate после последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (id), используемый в последнем запросе к FortiGate Возвращается: успех Пример: `"id"`
name строка	Название таблицы, используемой для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom строка	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия 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_mm3_module.html