fortinet.fortimanager.fmgr_dvmdb_script – Таблица скриптов.

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров выполняется свободно
method string / обязательно	Варианты: add get set update	Метод запроса
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 строка		Имя домена для блокировки в случае работы FortiManager в режиме рабочего пространства Может быть global или любыми другими именами пользовательских домен
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
     fmgr_dvmdb_script:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [add, set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
        params:
           -
              data:
                -
                    content: <value of string>
                    desc: <value of string>
                    filter_build: <value of integer>
                    filter_device: <value of integer>
                    filter_hostname: <value of string>
                    filter_ostype: <value in [unknown, fos]>
                    filter_osver: <value in [unknown, 4.00, 5.00]>
                    filter_platform: <value of string>
                    filter_serial: <value of string>
                    modification_time: <value of string>
                    name: <value of string>
                    script_schedule:
                      -
                          datetime: <value of string>
                          day_of_week: <value in [unknown, sun, mon, ...]>
                          device: <value of integer>
                          name: <value of string>
                          run_on_db: <value in [disable, enable]>
                          type: <value in [auto, onetime, daily, ...]>
                    target: <value in [device_database, remote_device, adom_database]>
                    type: <value in [cli, tcl, cligrp]>

   - name: REQUESTING /DVMDB/SCRIPT
     fmgr_dvmdb_script:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [get]>
        url_params:
           adom: <value in [none, global, custom dom]>
        params:
           -
              expand member: <value of string>
              fields:
                -
                   - <value in [content, desc, filter_build, ...]>
              filter:
                - <value of string>
              loadsub: <value of integer>
              option: <value in [count, object member, syntax]>
              range:
                - <value of integer>
              sortings:
                -
                    varidic.attr_name: <value in [1, -1]>

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

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

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