fortinet.fortimanager.fmgr_devprof_system_replacemsg_fortiguardwf – Сообщения замены.

Примечание

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

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

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

Новое в версии 2.10: модуля fortinet.fortimanager

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием из источников данных.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательный			параметр (adom) в запрошенном URL
bypass_validation логическое значение		Варианты: нет ← да	устанавливать в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
devprof строка / обязательный			параметр (devprof) в запрошенном URL
devprof_system_replacemsg_fortiguardwf словарь			устанавливаемые параметры верхнего уровня
	buffer строка		Строка сообщения.
	format строка	Варианты: none текст html wml	Флаг формата.
	header строка	Варианты: none http 8bit	Флаг заголовка.
	msg-type строка		Тип сообщения.
rc_failed список / элементы=строка			список кодов rc, при которых условия будут нарушены
rc_succeeded список / элементы=строка			список кодов rc, при которых условия будут выполнены
state строка / обязательный		Варианты: present absent	направление для создания, обновления или удаления объекта
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 messages.
     fmgr_devprof_system_replacemsg_fortiguardwf:
        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>
        devprof: <your own value>
        devprof_system_replacemsg_fortiguardwf:
           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_devprof_system_replacemsg_fortiguardwf_module.html