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