fortinet.fortios.fortios_system_replacemsg_mail – Сообщения замены в FortiOS и FortiGate Fortinet.
Примечание
Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).
Для его установки используйте: ansible-galaxy collection install fortinet.fortios.
Для использования в книге задач укажите: fortinet.fortios.fortios_system_replacemsg_mail.
Новое в версии 2.9: модуля fortinet.fortios
Обзор
- Этот модуль может настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию system_replacemsg и категорию почты. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось на FOS v6.0.0.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_token строка | Аутентификация на основе токена. Сгенерировано в GUI Fortigate. | ||
| state строка / обязательный |
| Указывает, нужно ли создать или удалить объект. | |
| system_replacemsg_mail словарь | Сообщения замены. | ||
| buffer строка | Строка сообщения. | ||
| format строка |
| Флаг формата. | |
| header строка |
| Флаг заголовка. | |
| msg_type строка | Тип сообщения. | ||
| vdom строка | По умолчанию: "root" | Виртуальная область (vdom) среди ранее определенных. Vdom — это виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. | |
Примечания
Примечание
- Модуль fortiosapi устарел, предпочтительным способом запуска playbooks является использование httpapi.
Примеры
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fortios_system_replacemsg_mail:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_mail:
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| build строка | всегда | Номер сборки образа Fortigate. Пример: 1547 |
| http_method строка | всегда | Последний метод, используемый для подготовки контента в FortiGate. Пример: PUT |
| http_status строка | всегда | Последний результат, предоставленный FortiGate при последней операции. Пример: 200 |
| mkey строка | успешно | Главный ключ (идентификатор), используемый в последнем вызове FortiGate. Пример: id |
| name строка | всегда | Имя таблицы, используемой для выполнения запроса. Пример: urlfilter |
| path строка | всегда | Путь к таблице, используемой для выполнения запроса. Пример: webfilter |
| revision строка | всегда | Внутренний номер ревизии. Пример: 17.0.2.10658 |
| serial строка | всегда | Серийный номер устройства. Пример: FGVMEVYYQT3AB5352 |
| status строка | всегда | Указание результата операции. Пример: успешно |
| 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_system_replacemsg_mail_module.html