Spec-Zone.ru › Ansible 2.10

fortinet.fortimanager.fmgr_task_task – Только для чтения таблица, содержащая 10000 самых последних задач системы. Эта таблица может использоваться для отслеживания неблокирующих задач, инициированных…

Примечание

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

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

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

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

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

Описание

  • Этот модуль позволяет настроить устройство FortiManager, позволяя пользователю [ получить ] следующие API.
  • /task/task
  • В примерах все параметры и значения должны быть скорректированы перед использованием.

Параметры

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

Примечания

Примечание

  • Существует только три параметра верхнего уровня, где «метод» всегда обязателен, а остальные два «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 /TASK/TASK
     fmgr_task_task:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [get]>
        params:
           -
              fields:
                -
                   - <value in [adom, end_tm, flags, ...]>
              filter:
                - <value of string>
              loadsub: <value of integer>
              option: <value in [count, 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_task_task_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API