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

Примечание

Этот плагин является частью коллекции community.fortios (версия 1.0.0).

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

Для использования в книге задач укажите: community.fortios.fmgr_query.

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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
  community.fortios.fmgr_query:
    object: "device"
    adom: "ansible"
    device_ip: "10.7.220.41"

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

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

- name: VERIFY CLUSTER MEMBERS AND STATUS
  community.fortios.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
  community.fortios.fmgr_query:
    adom: "ansible"
    object: "task"
    task_id: "3"

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

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

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

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

Авторы

Luke Weighall (@lweighall)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/fortios/fmgr_query_module.html