fortinet.fortimanager.fmgr_generic – Создание и отправка универсального запроса к API FortiManager.

Примечание

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_generic.

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

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

Обзор

Этот модуль предназначен для общих запросов к FortiManager. Он получает данные в формате raw json-rpc, отправляет их в FortiManager и возвращает ответ пользователю.
Этот модуль также использует плагин fortimanager httpapi в качестве транспорта.
Загрузка не включает сеанс; плагин httpapi автоматически заполнит сеанс позже.
Имя пользователя и пароль не управляются модулем, а плагином.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
json строка		необработанная полезная нагрузка в формате JSON для отправки в FortiManager
method строка		метод json-rpc должно быть одно из значений: [get, add, set, update, delete, move, clone, exec]
params строка		коллекция параметров

Примечания

Примечание

Поддерживаются два варианта параметров: в формате raw json или в формате параметров, распознаваемых Ansible.
json определён как строка; пользователь отвечает за приведение его к формату JSON.
method и params должны быть указаны пользователем, если «json» отсутствует.
Если все три параметра предоставлены, «json» имеет приоритет.

Примеры

- hosts: fortimanager01
  connection: httpapi
  vars:
    adom: "root"
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
    -   name: 'login a user'
        fmgr_generic:
             method: 'exec'
             params:
                - url: 'sys/login/user'
                  data:
                   - user: 'APIUser'
                     passwd: 'Fortinet1!e'
    -   name: 'login another user'
        fmgr_generic:
             json: |
                  {
                   "method":"exec",
                   "params":[
                    {
                         "url":"sys/login/user",
                         "data":[
                            {
                               "user":"APIUser",
                               "passwd":"Fortinet1!"
                            }
                          ]
                     }
                    ]
                  }

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

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

Ключ	Возвращаемое значение	Описание
api_result строка	всегда	полный ответ API, включая код состояния и сообщение

Авторы

Link Zheng (@zhengl)
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_generic_module.html