Модуль fortinet.fortios.fortios_monitor_fact — получение фактов об объектах мониторинга FortiOS.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования; подробную информацию см. в разделе Требования.
Чтобы использовать модуль в сценарии, укажите: fortinet.fortios.fortios_monitor_fact.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Собирает факты мониторинга с сетевых устройств под управлением операционной системы FortiOS. Этот модуль фактов собирает только те факты, которые пользователь указал в сценарии.
Требования
На хосте, выполняющем этот модуль, должны быть установлены перечисленные ниже компоненты.
- Установить коллекцию Galaxy fortinet.fortios версии не ниже 2.0.0.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Создается в графическом интерфейсе Fortigate. |
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
filters list / elements=string | Список выражений для фильтрации возвращаемых результатов. Элементы списка объединяются логическим И с помощью оператора амперсанда. Отдельный элемент можно объединить запятой, используя логическое ИЛИ. |
formatters list / elements=string | Список полей для отображения в возвращаемых результатах. |
params dictionary | параметр для каждого селектора; см. описание в списке выше. |
selector string | селектор получаемых фактов fortiOS. Варианты:
|
selectors list / elements=dictionary | Список селекторов для получения фактов fortiOS. |
|
filters list / elements=string |
Список выражений для фильтрации возвращаемых результатов. Элементы списка объединяются логическим И с помощью оператора амперсанда. Отдельный элемент можно объединить запятой, используя логическое ИЛИ. |
|
formatters list / elements=string |
Список полей для отображения в возвращаемых результатах. |
|
params dictionary |
параметр для каждого селектора; см. описание в списке выше. |
|
selector string / обязательный |
селектор получаемых фактов fortiOS Варианты:
|
|
sorters list / elements=string |
Список выражений для сортировки возвращённых результатов. Элементы списка расположены в порядке возрастания и разделены оператором амперсанда. Отдельный элемент может задавать порядок убывания, если внутри него используется запятая. |
sorters list / elements=string | Список выражений для сортировки возвращённых результатов. Элементы списка расположены в порядке возрастания и разделены оператором амперсанда. Отдельный элемент может задавать порядок убывания, если внутри него используется запятая. |
vdom string | Виртуальный домен из числа предварительно определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- У разных селекторов могут быть разные параметры; пользователям следует уточнять их для конкретного селектора.
- Для некоторых селекторов объекты являются глобальными, поэтому параметры указывать не нужно.
- Не все параметры обязательны для селектора.
- Этот модуль предназначен исключительно для API мониторинга FortiOS.
- Результат запроса API сохраняется в results.
Примеры
- name: Get license status
fortinet.fortios.fortios_monitor_fact:
vdom: root
selectors:
- selector: license_status
- selector: system_status
- selector: firewall_security-policy
params:
policyid: '1'
- name: Get system status
fortinet.fortios.fortios_monitor_fact:
vdom: root
formatters:
- model_name
filters:
- model_name==FortiGat
selector: 'system_status'
- name: Get firewall acl info
fortinet.fortios.fortios_monitor_fact:
vdom: root
access_token: "you_own_value"
selector: 'firewall_acl'
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого на FortiGate Возвращается: всегда Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат выполнения операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки коллекции
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_monitor_fact_module.html