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

Примечание

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

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

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

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

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

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль предназначен для универсальных запросов FortiManager. Он получает необработанные данные JSON-RPC, отправляет их в FortiManager и возвращает ответ пользователям.
Для передачи данных модуль также использует плагин httpapi FortiManager.
Полезная нагрузка не содержит сеанс; плагин httpapi автоматически добавляет его позднее.
Управление именем пользователя и паролем выполняет плагин, а не модуль.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
enable_log boolean	Включить или отключить ведение журнала для задачи Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud
json string	Необработанная полезная нагрузка в формате JSON для отправки в FortiManager
method string	Метод JSON-RPC Допустимые значения: [get, add, set, update, delete, move, clone, exec]
params list / elements=dictionary	Коллекция параметров.
rc_failed list / elements=integer	Список кодов возврата rc, переопределяющий условия сбоя
rc_succeeded list / elements=integer	Список кодов возврата rc, переопределяющий условия успеха
workspace_locking_adom string	Описание отсутствует
workspace_locking_timeout integer	Описание отсутствует По умолчанию: `300`

Примечания

Примечание

Поддерживаются две схемы параметров: необработанный формат JSON или формат параметров верхнего уровня, распознаваемый Ansible.
Параметр json задан как строка; пользователь должен самостоятельно обеспечить формат JSON.
Если параметр ‘json’ не указан, пользователи должны указать method и params.
Если указаны все три параметра, предпочтение отдается ‘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 string	Полный ответ 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_generic_module.html