fortinet.fortimanager.fmgr_system_replacemsggroup_mm7 – Записи таблицы сообщений замены.

Примечание

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

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

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

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation логическое значение		Варианты: нет ← да	устанавливать в True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжит выполнение без проверки параметров
rc_failed список / элементы=строка			список кодов rc, с которыми условия завершения работы будут переопределены
rc_succeeded список / элементы=строка			список кодов rc, с которыми условия успешного выполнения будут переопределены
replacemsg-group строка / обязательно			параметр (replacemsg-group) в запрошенном URL
state строка / обязательно		Варианты: present absent	направление для создания, обновления или удаления объекта
system_replacemsggroup_mm7 словарь			установленные параметры верхнего уровня
	add-smil строка	Варианты: disable enable	добавление инкапсуляции сообщения
	addr-type строка	Варианты: rfc2822-addr number short-code	тип адреса отправителя
	allow-content-adaptation строка	Варианты: disable enable	разрешение адаптации содержимого
	charset строка	Варианты: us-ascii utf-8	кодировка символов, используемая для сообщения замены
	class строка	Варианты: personal advertisement informational auto not-included	класс сообщения
	format строка	Варианты: none text html wml	Флаг формата.
	from строка		адрес отправителя
	from-sender строка	Варианты: disable enable	сообщение уведомления, отправленное получателем
	header строка	Варианты: none http 8bit	Флаг заголовка.
	image строка		Строка сообщения.
	message строка		текст сообщения
	msg-type строка		Тип сообщения.
	priority строка	Варианты: low normal high not-included	приоритет сообщения
	rsp-status строка	Варианты: ... (Список значений) ...	статус ответа
	smil-part строка		текст инкапсуляции сообщения
	subject строка		строка текста темы
workspace_locking_adom строка			область, которая должна быть заблокирована для FortiManager, работающего в режиме рабочей области, значение может быть глобальным и другими, включая корень
workspace_locking_timeout целое число		Значение по умолчанию: 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: Replacement message table entries.
     fmgr_system_replacemsggroup_mm7:
        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>
        replacemsg-group: <your own value>
        state: <value in [present, absent]>
        system_replacemsggroup_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>

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

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Дескриптивное сообщение ответа 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_mm7_module.html