Модуль fortinet.fortios.fortios_system_replacemsg_mm7 — сообщения-замены в 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_mm7.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию system_replacemsg и категорию mm7. В примерах представлены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено с FOS v6.0.0
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, нужно ли создать или удалить объект. Варианты:
|
system_replacemsg_mm7 dictionary | Сообщения-замены. |
|
add_smil string |
добавить инкапсуляцию сообщения Варианты:
|
|
addr_type string |
тип адреса отправителя Варианты:
|
|
allow_content_adaptation string |
разрешить адаптацию содержимого Варианты:
|
|
charset string |
кодировка символов, используемая для сообщения-замены Варианты:
|
|
class string |
класс сообщения Варианты:
|
|
format string |
Флаг формата. Варианты:
|
|
fos_message string |
текст сообщения |
|
from string |
адрес отправителя |
|
from_sender string |
уведомление, отправленное получателю Варианты:
|
|
header string |
Флаг заголовка. Варианты:
|
|
image string |
Строка сообщения. Источник: system.replacemsg-image.name. |
|
msg_type string / обязательный |
Тип сообщения. |
|
priority string |
приоритет сообщения Варианты:
|
|
rsp_status string |
статус ответа Варианты:
|
|
smil_part string |
текст инкапсуляции сообщения |
|
subject string |
строка темы сообщения |
vdom string | Виртуальный домен из числа предварительно определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настраивать и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревшая библиотека fortiosapi объявлена устаревшей; предпочтительный способ запуска плейбуков — httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Replacement messages.
fortinet.fortios.fortios_system_replacemsg_mm7:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_mm7:
add_smil: "enable"
addr_type: "rfc2822-addr"
allow_content_adaptation: "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: "success"
smil_part: "<your_own_value>"
subject: "<your_own_value>"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого на FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращенный FortiGate при последней выполненной операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успешном выполнении Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат операции Возвращается: всегда Пример: |
vdom string | Использованный виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_mm7_module.html