fortinet.fortimanager.fmgr_system_replacemsggroup – Настройка групп замены сообщений.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_replacemsggroup

Новое в версии 2.10: of fortinet.fortimanager

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

Обзор

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно				параметр (adom) в запрошенном URL
bypass_validation логическое			Варианты: нет ← да	устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed список / элементы=строка				список кодов rc, при которых условия завершения работы будут переопределены
rc_succeeded список / элементы=строка				список кодов rc, при которых условия успешного завершения будут переопределены
state строка / обязательно			Варианты: present absent	директива для создания, обновления или удаления объекта
system_replacemsggroup словарь				параметры верхнего уровня
	admin список / элементы=строка			нет описания
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg-type строка		Тип сообщения.
	alertmail список / элементы=строка			нет описания
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg-type строка		Тип сообщения.
	auth список / элементы=строка			нет описания
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg-type строка		Тип сообщения.
	comment строка			Комментарий.
	custom-message список / элементы=строка			нет описания
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg-type строка		Тип сообщения.
	device-detection-portal список / элементы=строка			нет описания
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg-type строка		Тип сообщения.
	ec список / элементы=строка			нет описания
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg-type строка		Тип сообщения.
	fortiguard-wf список / элементы=строка			нет описания
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg-type строка		Тип сообщения.
	ftp список / элементы=строка			нет описания
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg-type строка		Тип сообщения.
	group-type строка		Варианты: default utm auth ec captive-portal	Тип группы.
	http список / элементы=строка			нет описания
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.

	заголовок строка	Варианты: нет http 8bit	Флаг заголовка.
	тип-сообщения строка		Тип сообщения.
icap список / элементы=строка			без описания
	буфер строка		Строка сообщения.
	формат строка	Варианты: нет текст html wml	Флаг формата.
	заголовок строка	Варианты: нет http 8bit	Флаг заголовка.
	тип-сообщения строка		Тип сообщения.
mail список / элементы=строка			без описания
	буфер строка		Строка сообщения.
	формат строка	Варианты: нет текст html wml	Флаг формата.
	заголовок строка	Варианты: нет http 8bit	Флаг заголовка.
	тип-сообщения строка		Тип сообщения.
mm1 список / элементы=строка			без описания
	add-smil строка	Варианты: отключить включить	Добавить инкапсуляцию сообщения
	charset строка	Варианты: us-ascii utf-8	Кодировка символов, используемая для сообщения-замены
	класс строка	Варианты: личный реклама информационный автоматический не включено	Класс сообщения
	формат строка	Варианты: нет текст html wml	Флаг формата.
	от строка		Адрес отправителя
	отправитель-отправитель строка	Варианты: отключить включить	Сообщение уведомления отправлено от получателя
	заголовок строка	Варианты: нет http 8bit	Флаг заголовка.
	изображение строка		Строка сообщения.
	сообщение строка		Текст сообщения
	тип-сообщения строка		Тип сообщения.
	приоритет строка	Варианты: низкий нормальный высокий не включено	Приоритет сообщения
	статус-ответа строка	Варианты: ok ошибка-неопределенная ошибка-запрещен-сервером ошибка-формат-сообщения-некорректен ошибка-адрес-отправителя-неразрешим ошибка-сообщение-ненайдено ошибка-проблемы-сети ошибка-содержимое-неприемлемо ошибка-неподдерживаемое-сообщение	Код ответа состояния
	текст-ответа строка		Текст ответа
	видимость-отправителя строка	Варианты: скрыть показать не указано	Видимость отправителя
	smil-часть строка		Текст инкапсулированного сообщения
	тема строка		Строка текста темы
mm3 список / элементы=строка			без описания
	add-smil строка	Варианты: отключить включить	Добавить инкапсуляцию сообщения
	charset строка	Варианты: us-ascii utf-8	Кодировка символов, используемая для сообщения-замены
	формат строка	Варианты: нет текст html wml	Флаг формата.
	от строка		Адрес отправителя
	отправитель-отправитель строка	Варианты: отключить включить	Сообщение уведомления отправлено от получателя
	заголовок строка	Варианты: нет http 8bit	Флаг заголовка.
	html-часть строка		Текст инкапсулированного сообщения
	изображение строка		Строка сообщения.
	сообщение строка		Текст сообщения
	тип-сообщения строка		Тип сообщения.
	приоритет строка	Варианты: низкий нормальный высокий не включено	Приоритет сообщения
	тема строка		Строка текста темы
mm4 список / элементы=строка			без описания
	add-smil строка	Варианты: отключить включить	Добавить инкапсуляцию сообщения
	charset строка	Варианты: us-ascii utf-8	Кодировка символов, используемая для сообщения-замены
	класс строка	Варианты: личный реклама информационный авто не включено	Класс сообщения
	домен строка		Домен адреса отправителя
	формат строка	Варианты: нет текст html wml	Флаг формата.

	от строка		адрес отправителя
	отправитель строка	Варианты: отключить включить	сообщение уведомления, отправленное получателем
	заголовок строка	Варианты: нет http 8bit	Флаг заголовка.
	изображение строка		Строка сообщения.
	сообщение строка		текст сообщения
	тип_сообщ строка		Тип сообщения.
	приоритет строка	Варианты: низкий нормальный высокий не включен	приоритет сообщения
	статус_ответа строка	Варианты: ok err-неуказано err-сервер_запретил err-ошибка_формата_сообщ err-не_разрешен_адрес err-проблемы_сети err-содержание_не_поддерживается err-неподдерживаемое_сообщ	статус ответа
	smil_часть строка		текст инкапсуляции сообщения
	тема строка		строка текста темы
mm7 список / элементы=строка			нет описания
	добавить_smil строка	Варианты: отключить включить	добавить инкапсуляцию сообщения
	тип_адреса строка	Варианты: rfc2822-addr число короткий_код	тип адреса отправителя
	разрешить_адаптацию_содержания строка	Варианты: отключить включить	разрешить адаптации контента
	кодировка строка	Варианты: us-ascii utf-8	кодировка символов, используемая для замены сообщения
	класс строка	Варианты: личное реклама информационное авто не включено	класс сообщения
	формат строка	Варианты: нет текст html wml	Флаг формата.
	от строка		адрес отправителя
	отправитель строка	Варианты: отключить включить	сообщение уведомления, отправленное получателем
	заголовок строка	Варианты: нет http 8bit	Флаг заголовка.
	изображение строка		Строка сообщения.
	сообщение строка		текст сообщения
	тип_сообщ строка		Тип сообщения.
	приоритет строка	Варианты: низкий нормальный высокий не включен	приоритет сообщения
	статус_ответа строка	Варианты: успешно частичный_успех ошибка_клиента ограничения_операций ошибка_адреса адрес_не_найден содержание_отклонено идентификатор_сообщ_не_найден идентификатор_связи_не_найден ошибка_формата_сообщ идентификатор_прил_не_найден идентификатор_заменяемого_прил_не_найден ошибка_сервера невозможно сообщение_отклонено несколько_адресов_не_поддерживаются адрес_приложения_не_поддерживается общая_ошибка_сервиса неправильная_идентификация неподдерживаемая_версия неподдерживаемая_операция ошибка_валидации ошибка_сервиса сервис_недоступен сервис_запрещен приложение_запрещено	статус ответа
	smil_часть строка		текст инкапсуляции сообщения
	тема строка		строка текста темы
mms список / элементы=строка			нет описания
	буфер строка		Строка сообщения.
	кодировка строка	Варианты: us-ascii utf-8	кодировка символов, используемая для замены сообщения
	формат строка	Варианты: нет текст html wml	Флаг формата.
	заголовок строка	Варианты: нет http 8bit	Флаг заголовка.
	тип_сообщ строка		Тип сообщения.
nac-quar список / элементы=строка			нет описания
	буфер строка		Строка сообщения.
	формат строка	Варианты: нет текст html wml	Флаг формата.
	заголовок строка	Варианты: нет http 8bit	Флаг заголовка.
	тип_сообщ строка		Тип сообщения.
имя строка			Имя группы.
nntp список / элементы=строка			нет описания
	буфер строка		Строка сообщения.
	формат строка	Варианты: нет текст html wml	Флаг формата.
	заголовок строка	Варианты: нет http 8bit	Флаг заголовка.
	тип_сообщ строка		Тип сообщения.
spam список / элементы=строка			нет описания
	буфер строка		Строка сообщения.

		формат строка	Варианты: нет текст html wml	Флаг формата.
		заголовок строка	Варианты: нет http 8bit	Флаг заголовка.
		тип_сообщения строка		Тип сообщения.
	sslvpn список / элементы=строка			без описания
		буфер строка		Строка сообщения.
		формат строка	Варианты: нет текст html wml	Флаг формата.
		заголовок строка	Варианты: нет http 8bit	Флаг заголовка.
		тип_сообщения строка		Тип сообщения.
	квота_трафика список / элементы=строка			без описания
		буфер строка		Строка сообщения.
		формат строка	Варианты: нет текст html wml	Флаг формата.
		заголовок строка	Варианты: нет http 8bit	Флаг заголовка.
		тип_сообщения строка		Тип сообщения.
	utm список / элементы=строка			без описания
		буфер строка		Строка сообщения.
		формат строка	Варианты: нет текст html wml	Флаг формата.
		заголовок строка	Варианты: нет http 8bit	Флаг заголовка.
		тип_сообщения строка		Тип сообщения.
	webproxy список / элементы=строка			без описания
		буфер строка		Строка сообщения.
		формат строка	Варианты: нет текст html wml	Флаг формата.
		заголовок строка	Варианты: нет http 8bit	Флаг заголовка.
		тип_сообщения строка		Тип сообщения.
блокировка_рабочей_области_adom строка				adom для блокировки FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая корень.
тайм_аут_блокировки_рабочей_области целое_число			По умолчанию: 300	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область.

Примечания

Примечание

Поддержка работы в режиме блокировки рабочей области в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращен ненулевой код rc. Вы также можете переопределить условия для завершения ошибкой или успехом с параметрами rc_failed и rc_succeeded.

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure replacement message groups.
     fmgr_system_replacemsggroup:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        system_replacemsggroup:
           admin:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           alertmail:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           auth:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           comment: <value of string>
           custom-message:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           device-detection-portal:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           ec:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           fortiguard-wf:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           ftp:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           group-type: <value in [default, utm, auth, ...]>
           http:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           icap:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           mail:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           mm1:
             -
                 add-smil: <value in [disable, enable]>
                 charset: <value in [us-ascii, utf-8]>
                 class: <value in [personal, advertisement, information, ...]>
                 format: <value in [none, text, html, ...]>
                 from: <value of string>
                 from-sender: <value in [disable, enable]>
                 header: <value in [none, http, 8bit]>
                 image: <value of string>
                 message: <value of string>
                 msg-type: <value of string>
                 priority: <value in [low, normal, high, ...]>
                 rsp-status: <value in [ok, err-unspecified, err-srv-denied, ...]>
                 rsp-text: <value of string>
                 sender-visibility: <value in [hide, show, not-specified]>
                 smil-part: <value of string>
                 subject: <value of string>
           mm3:
             -
                 add-html: <value in [disable, enable]>
                 charset: <value in [us-ascii, utf-8]>
                 format: <value in [none, text, html, ...]>
                 from: <value of string>
                 from-sender: <value in [disable, enable]>
                 header: <value in [none, http, 8bit]>
                 html-part: <value of string>
                 image: <value of string>
                 message: <value of string>
                 msg-type: <value of string>
                 priority: <value in [low, normal, high, ...]>
                 subject: <value of string>
           mm4:
             -
                 add-smil: <value in [disable, enable]>
                 charset: <value in [us-ascii, utf-8]>
                 class: <value in [personal, advertisement, informational, ...]>
                 domain: <value of string>
                 format: <value in [none, text, html, ...]>
                 from: <value of string>
                 from-sender: <value in [disable, enable]>
                 header: <value in [none, http, 8bit]>
                 image: <value of string>
                 message: <value of string>
                 msg-type: <value of string>
                 priority: <value in [low, normal, high, ...]>
                 rsp-status: <value in [ok, err-unspecified, err-srv-denied, ...]>
                 smil-part: <value of string>
                 subject: <value of string>
           mm7:
             -
                 add-smil: <value in [disable, enable]>
                 addr-type: <value in [rfc2822-addr, number, short-code]>
                 allow-content-adaptation: <value in [disable, enable]>
                 charset: <value in [us-ascii, utf-8]>
                 class: <value in [personal, advertisement, informational, ...]>
                 format: <value in [none, text, html, ...]>
                 from: <value of string>
                 from-sender: <value in [disable, enable]>
                 header: <value in [none, http, 8bit]>
                 image: <value of string>
                 message: <value of string>
                 msg-type: <value of string>
                 priority: <value in [low, normal, high, ...]>
                 rsp-status: <value in [success, partial-success, client-err, ...]>
                 smil-part: <value of string>
                 subject: <value of string>
           mms:
             -
                 buffer: <value of string>
                 charset: <value in [us-ascii, utf-8]>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 image: <value of string>
                 msg-type: <value of string>
           nac-quar:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           name: <value of string>
           nntp:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           spam:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           sslvpn:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           traffic-quota:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           utm:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>
           webproxy:
             -
                 buffer: <value of string>
                 format: <value in [none, text, html, ...]>
                 header: <value in [none, http, 8bit]>
                 msg-type: <value of string>

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
url_запроса строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user
код_ответа целое_число	всегда	Статус запроса API
сообщение_ответа строка	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_replacemsggroup_module.html