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

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

Чтобы использовать его в playbook, укажите: fortinet.fortimanager.fmgr_generic.

Добавлена в fortinet.fortimanager 2.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа к FortiManager без использования имени пользователя и пароля.
enable_log булево	Включить/выключить ведение журнала для задачи Выбор: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к forticloud API.
json строка	Сырые данные в формате JSON для отправки в FortiManager.
method строка	Метод json-rpc. Должен быть одним из [get, add, set, update, delete, move, clone, exec].
params список / элементы=словарь	Коллекция параметров.
...	...

Примечания

Примечание

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

Примеры

- name: Generic module
  hosts: fortimanagers
  connection: httpapi
  vars:
    adom: "root"
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Login a user
      fortinet.fortimanager.fmgr_generic:
        method: "exec"
        params:
          - url: "sys/login/user"
            data:
              - user: "APIUser"
                passwd: "Fortinet1!e"
    - name: Login another user
      fortinet.fortimanager.fmgr_generic:
        json: |
          {
           "method":"exec",
           "params":[
            {
                 "url":"sys/login/user",
                 "data":[
                    {
                       "user":"APIUser",
                       "passwd":"Fortinet1!"
                    }
                  ]
             }
            ]
          }

Возвращаемые значения

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

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

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Link Zheng (@zhengl)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_generic_module.html