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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_system_replacemsggroup_mm4.

В версии 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_mm4 словарь			установка параметров верхнего уровня
	add-smil строка	Варианты: disable enable	добавить инкапсуляцию сообщения
	charset строка	Варианты: us-ascii utf-8	кодировка символов, используемая для сообщения замены
	class строка	Варианты: personal advertisement informational auto not-included	класс сообщения
	domain строка		домен адреса отправителя
	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 строка	Варианты: ok err-unspecified err-srv-denied err-msg-fmt-corrupt err-snd-addr-unresolv err-net-prob err-content-not-accept err-unsupp-msg	статус ответа
	smil-part строка		текст инкапсуляции сообщения
	subject строка		строка текста темы
workspace_locking_adom строка			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_mm4:
        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_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>

Значения возврата

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

Ключ	Возвращаемое значение	Описание
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_mm4_module.html