fortinet.fortimanager.fmgr_sys_proxy_json – Отправка и получение запросов JSON к/от управляемых устройствах. Ответ будет массивом данных, по одному для каждого запрошенного устройства.

Примечание

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

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

Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_sys_proxy_json.

Новое в версии 2.10: of fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed список / элементы=строка			список кодов rc, при которых будут игнорироваться условия отказа
rc_succeeded список / элементы=строка			список кодов rc, при которых будут игнорироваться условия успеха
sys_proxy_json словарь			настроены верхнего уровня параметры
	action строка	Варианты: get post put delete	Укажите HTTP-действие для запроса.
	payload словарь		нет описания
	resource строка		URL на удаленном устройстве для доступа.
	target список / элементы=строка		нет описания
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: Send and receive JSON request to/from managed devices. The response will be an array of data, one for each queried device.
     fmgr_sys_proxy_json:
        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, ...]
        sys_proxy_json:
           action: <value in [get, post, put, ...]>
           payload: <value of dict>
           resource: <value of string>
           target: <value of list>

Значения возврата

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

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