fortinet.fortimanager.fmgr_dvmdb_script_execute – Выполнить скрипт.

Примечание

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

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

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

Добавлена в версии 2.10: модуля fortinet.fortimanager

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

Описание

Этот модуль может настроить устройство FortiManager, позволяя пользователю [exec] следующие API.
/dvmdb/adom/{adom}/script/execute
/dvmdb/global/script/execute
/dvmdb/script/execute
Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation логический тип	Варианты: no yes	Проверка параметров выполняется в свободном режиме
method строка / обязательный	Варианты: exec	Метод запроса
params список / элементы=строка		Параметры для каждого метода См. полный список параметров в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
url_params словарь		Параметры для каждого URL запроса к API См. также полный список параметров URL в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
workspace_locking_adom строка		Имя домена (adom), который нужно заблокировать, если FortiManager работает в режиме рабочей области Может быть глобальным или любым другим именем настраиваемого домена (adom).
workspace_locking_timeout целое число	Значение по умолчанию: 300	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область.

Примечания

Примечание

Существует только три параметра верхнего уровня, где ‘method’ всегда обязателен, а ‘params’ и ‘url_params’ могут быть необязательными
Из-за сложности схемы API fortimanager, проверка выполняется вне стандартной процедуры проверки параметров Ansible.
Синтаксис OPTIONS не соответствует стандартному указанию аргументов Ansible, но в соответствии со структурой схемы API fortimanager, нам нужна тривиальная трансформация при заполнении книги задач Ansible

Примеры

- 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: REQUESTING /DVMDB/SCRIPT/EXECUTE
     fmgr_dvmdb_script_execute:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [exec]>
        url_params:
           adom: <value in [none, global, custom dom]>
        params:
           -
              workflow:
                 adom: <value of string>
                 package: <value of string>
                 scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
                 script: <value of string>

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

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

Ключ	Возвращаемое значение	Описание
data словарь	всегда	Запрос, возвращаемый в ответ на запрос
status словарь	всегда	Статус запроса к API
url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user

Авторы

Frank Shen (@fshen01)
Link Zheng (@zhengl)

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