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

Примечание

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

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

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

Новое в версии 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_utm словарь			настройка параметров верхнего уровня
	buffer строка		Строка сообщения.
	format строка	Варианты: none text html wml	Флаг формата.
	header строка	Варианты: none http 8bit	Флаг заголовка.
	msg-type строка		Тип сообщения.
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_utm:
        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_utm:
           buffer: <value of string>
           format: <value in [none, text, html, ...]>
           header: <value in [none, http, 8bit]>
           msg-type: <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_utm_module.html