fmgr_query – Запрос данных объектов FortiManager для использования в рабочих процессах Ansible

Новое в версии 2.8.

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

Описание

Предоставляет информацию об объектах данных внутри FortiManager, чтобы playbook мог выполнять условные проверки.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
adom -	По умолчанию: "root"	ADOM, к которому должна принадлежать конфигурация.
custom_dict -		ТОЛЬКО ДЛЯ ПЕРЕДОВИТЫХ ПОЛЬЗОВАТЕЛЕЙ! ТРЕБУЕТСЯ ЗНАНИЕ API FMGR в формате JSON! ТОЛЬКО ФОРМАТ JSON СЛОВАРЯ — Пользовательский словарь/датаграмма для отправки на конечную точку.
custom_endpoint -		ТОЛЬКО ДЛЯ ПЕРЕДОВИТЫХ ПОЛЬЗОВАТЕЛЕЙ! ТРЕБУЕТСЯ ЗНАНИЕ API FMGR в формате JSON! HTTP-конечная точка в FortiManager, данные с которой необходимо получить методом GET.
device_ip -		IP-адрес устройства, которое нужно запросить.
device_serial -		Серийный номер устройства, которое нужно запросить.
device_unique_name -		Желаемое «дружественное» имя устройства, которое нужно запросить.
nodes -		СПИСОК из межсетевых экранов в кластере, которые нужно проверить, например ["firewall_A","firewall_B"].
object - / обязательно	Варианты: device cluster_nodes task custom	Объект данных, который нужно запросить (устройство, пакет, правило и т. д.). Список вариантов будет расширен по мере улучшений.
task_id -		Идентификатор задачи, статус которой нужно запросить. Если поле оставлено пустым, а object = 'task', возвращается список задач.

Примечания

Примечание

Полная документация по адресу https://ftnt-ansible-docs.readthedocs.io/en/latest/.

Примеры

- name: QUERY FORTIGATE DEVICE BY IP
  fmgr_query:
    object: "device"
    adom: "ansible"
    device_ip: "10.7.220.41"

- name: QUERY FORTIGATE DEVICE BY SERIAL
  fmgr_query:
    adom: "ansible"
    object: "device"
    device_serial: "FGVM000000117992"

- name: QUERY FORTIGATE DEVICE BY FRIENDLY NAME
  fmgr_query:
    adom: "ansible"
    object: "device"
    device_unique_name: "ansible-fgt01"

- name: VERIFY CLUSTER MEMBERS AND STATUS
  fmgr_query:
    adom: "ansible"
    object: "cluster_nodes"
    device_unique_name: "fgt-cluster01"
    nodes: ["ansible-fgt01", "ansible-fgt02", "ansible-fgt03"]

- name: GET STATUS OF TASK ID
  fmgr_query:
    adom: "ansible"
    object: "task"
    task_id: "3"

- name: USE CUSTOM TYPE TO QUERY AVAILABLE SCRIPTS
  fmgr_query:
    adom: "ansible"
    object: "custom"
    custom_endpoint: "/dvmdb/adom/ansible/script"
    custom_dict: { "type": "cli" }

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

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

Ключ	Возвращаемое значение	Описание
api_result строка	всегда	полный ответ API, включает код состояния и сообщение

Статус

Интерфейс этого модуля не гарантирует обратную совместимость. [предварительный просмотр]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Luke Weighall (@lweighall)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fmgr_query_module.html