Spec-Zone.ru › Ansible 2.11

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

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
adom
строка / обязательно
параметр (adom) в запрошенном URL
bypass_validation
логическое
    Варианты:
  • нет ←
  • да
устанавливать только в значение True, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров
devprof
строка / обязательно
параметр (devprof) в запрошенном URL
devprof_system_replacemsg_webproxy
словарь
установленные параметры верхнего уровня
buffer
строка
Строка сообщения.
format
строка
    Варианты:
  • нет
  • текст
  • html
  • wml
Флаг формата.
header
строка
    Варианты:
  • нет
  • 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_webproxy:
        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_webproxy:
           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_webproxy_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API