Модуль fortinet.fortios.fortios_monitor_fact – Получение фактов объектов мониторинга FortiOS.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка | Авторизация по токену. Сгенерирован из графического интерфейса Fortigate. |
enable_log логический | Включить/выключить ведение журнала для задачи. Варианты:
|
filters список / элементы=строка | Список выражений для фильтрации возвращаемых результатов. Элементы списка объединяются как ЛОГИЧЕСКОЕ И с оператором амперсанд. Один элемент сам может быть соединен запятой как ЛОГИЧЕСКОЕ ИЛИ. |
formatters список / элементы=строка | Список полей для отображения возвращаемых результатов. |
params словарь | параметр для каждого селектора, см. определение в списке выше. |
selector строка | Селектор извлекаемых фактов fortiOS. Варианты: |
|
| |
selectors список / элементы=словарь | Список селекторов для получения фактов fortiOS. |
|
filters список / элементы=строка |
Список выражений для фильтрации возвращаемых результатов. Элементы списка комбинируются как ЛОГИЧЕСКОЕ И с оператором амперсанд. Один элемент может быть соединён запятой, как ЛОГИЧЕСКОЕ ИЛИ. |
|
formatters список / элементы=строка |
Список полей для отображения возвращаемых результатов. |
|
params словарь |
Параметр для каждого селектора, см. определение в списке выше. |
|
selector строка / обязательный |
Селектор извлекаемых фактов fortiOS Варианты: |
|
| |
|
sorters список / элементы=строка |
Список выражений для сортировки возвращаемых результатов. Элементы списка упорядочены по возрастанию с использованием оператора амперсанд. Один элемент может быть упорядочен по убыванию с запятой внутри. |
sorters список / элементы=строка | Список выражений для сортировки возвращаемых результатов. Элементы списка упорядочены по возрастанию с использованием оператора амперсанд. Один элемент может быть упорядочен по убыванию с запятой внутри. |
vdom строка | Виртуальная область (vdom), определённая ранее. 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 строка | Номер сборки образа Fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, использованный для предоставления контента в FortiGate Возвращается: всегда Пример: |
name строка | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер ревизии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Использованная виртуальная область Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_monitor_fact_module.html