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

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров выполняется свободным способом
method string / обязательно	Варианты: delete get set update add	Метод запроса
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 в режиме рабочего пространства Может быть глобальным или любым другим именем настраиваемого домена
workspace_locking_timeout целое число	Значение по умолчанию: 300	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство

Примечания

Примечание

Существует только три параметра верхнего уровня, где «метод» всегда обязателен, в то время как два других «параметры» и «параметры_url» могут быть необязательными
Из-за сложности схемы 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/{SCRIPT}
     fmgr_dvmdb_script_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [delete]>
        url_params:
           adom: <value in [none, global, custom dom]>
           script: <value of string>
        params:
           -
              data:
                -
                    name: <value of string>
                    vdom: <value of string>

   - name: REQUESTING /DVMDB/SCRIPT/{SCRIPT}
     fmgr_dvmdb_script_obj:
        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]>
           script: <value of string>
        params:
           -
              option: <value in [object member, chksum]>

   - name: REQUESTING /DVMDB/SCRIPT/{SCRIPT}
     fmgr_dvmdb_script_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
           script: <value of string>
        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/{SCRIPT}
     fmgr_dvmdb_script_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
           script: <value of string>
        params:
           -
              data:
                -
                    name: <value of string>
                    vdom: <value of string>

   - name: REQUESTING /DVMDB/SCRIPT/{SCRIPT}
     fmgr_dvmdb_script_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [add]>
        url_params:
           adom: <value in [none, global, custom dom]>
           script: <value of string>
        params:
           -
              data:
                -
                    name: <value of string>
                    vdom: <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_obj_module.html