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

Примечание

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

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

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

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