fortinet.fortimanager.fmgr_system_replacemsggroup_mm3 – Таблица замен сообщений.

Примечание

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_replacemsggroup_mm3.

Новое в версии 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_mm3 словарь			параметры верхнего уровня
	add-html строка	Варианты: disable enable	Добавить инкапсуляцию сообщения
	charset строка	Варианты: us-ascii utf-8	Кодировка символов, используемая для сообщения замены
	format строка	Варианты: none text html wml	Флаг формата.
	from строка		адрес отправителя
	from-sender строка	Варианты: disable enable	Сообщение уведомления отправляется получателем
	header строка	Варианты: none http 8bit	Флаг заголовка.
	html-part строка		Текст инкапсулированного сообщения
	image строка		Строка сообщения.
	message строка		Текст сообщения
	msg-type строка		Тип сообщения.
	priority строка	Варианты: low normal high not-included	Приоритет сообщения
	subject строка		строка текста темы
workspace_locking_adom строка			adom для блокировки FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая root
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_mm3:
        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_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>

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

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

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