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

Примечание

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

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

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

Новое в версии 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_mm1 словарь			настройка верхнего уровня
	add-smil строка	Варианты: выключить включить	добавление инкапсуляции сообщения
	charset строка	Варианты: us-ascii utf-8	кодировка символов, используемая для сообщения замены
	class строка	Варианты: личное реклама информация автоматическое не включено	класс сообщения
	format строка	Варианты: без текст html wml	Флаг формата.
	from строка		адрес отправителя
	from-sender строка	Варианты: выключить включить	сообщение уведомления отправляется от получателя
	header строка	Варианты: без http 8bit	Флаг заголовка.
	image строка		Строка сообщения.
	message строка		текст сообщения
	msg-type строка		Тип сообщения.
	priority строка	Варианты: низкий нормальный высокий не включено	приоритет сообщения
	rsp-status строка	Варианты: ok err-unspecified err-srv-denied err-msg-fmt-corrupt err-snd-addr-unresolv err-msg-not-found err-net-prob err-content-not-accept err-unsupp-msg	код состояния ответа
	rsp-text строка		текст ответа
	sender-visibility строка	Варианты: скрыть показать не указано	видимость отправителя
	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_mm1:
        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_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>

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

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

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