Модуль fortinet.fortios.fortios_configuration_fact — Получение фактов конфигурируемых объектов FortiOS.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Для использования в playbook укажите: fortinet.fortios.fortios_configuration_fact.
Впервые появился в fortinet.fortios 2.0.0
Описание
- Сбор фактов с сетевых устройств, работающих под управлением операционной системы fortios. Этот модуль помещает собранные факты в дерево фактов, ключи которого — имена соответствующих ресурсов. Этот модуль фактов будет собирать только те факты, которые пользователь указал в playbook.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- Установите коллекцию galaxy fortinet.fortios >= 2.0.0.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация по токену. Сгенерировано в веб-интерфейсе Fortigate. |
enable_log булево | Включение/выключение ведения журнала для задачи. Варианты:
|
filters список / элементы=строка | Список выражений для фильтрации возвращаемых результатов. Элементы списка комбинируются как ЛОГИЧЕСКОЕ И с оператором амперсанд. Один элемент сам по себе может быть соединён запятой как ЛОГИЧЕСКОЕ ИЛИ. |
formatters список / элементы=строка | Список полей для отображения возвращаемых результатов. |
params словарь | параметры для каждого селектора, см. определение в списке выше. |
selector строка | селектор для получения фактов fortigate Варианты: |
|
|
| |
selectors список / элементы=словарь | список селекторов для получения фактов fortigate |
|
filters список / элементы=строка |
Список выражений для фильтрации возвращаемых результатов. Элементы списка комбинируются как ЛОГИЧЕСКОЕ И с оператором амперсанд. Один элемент сам по себе может быть соединён запятой как ЛОГИЧЕСКОЕ ИЛИ. |
|
formatters список / элементы=строка |
Список полей для отображения возвращаемых результатов. |
|
params словарь |
параметр для каждого селектора, см. определение в списке выше. |
|
selector строка / обязательно |
селектор для получения фактов fortigate Варианты: |
|
|
| |
|
sorters список / элементы=строка |
Список выражений для сортировки возвращаемых результатов. Элементы списка расположены в порядке возрастания с оператором амперсанд. Один элемент может быть упорядочен по убыванию с запятой внутри. |
sorters список / элементы=строка | Список выражений для сортировки возвращаемых результатов. Элементы списка расположены в порядке возрастания с оператором амперсанд. Один элемент может быть упорядочен по убыванию с запятой внутри. |
vdom строка | Виртуальная область, среди ранее определенных. ВДОМ — виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Разные селекторы могут иметь разные параметры, пользователи должны искать их для конкретного селектора.
- Для некоторых селекторов объекты являются глобальными, параметры не допускаются.
- Если параметры пустые, возвращается весь список объектов.
- Этот модуль поддерживает все конфигурационные API, за исключением API мониторинга.
- Результат запроса API сохраняется в результатах в виде списка.
Примеры
- name: Get multiple selectors info concurrently
fortinet.fortios.fortios_configuration_fact:
selectors:
- selector: firewall_address
params:
name: "gmail.com"
- selector: system_interface
- selector: log_eventfilter
params: {}
- name: fact gathering
fortinet.fortios.fortios_configuration_fact:
vdom: root
filters:
- name==port1
- vlanid==0
sorters:
- name,vlanid
- management-ip
formatters:
- name
- management-ip
- vlanid
selector: 'system_interface'
- name: get all
fortinet.fortios.fortios_configuration_fact:
vdom: root
access_token: ""
selector: log_custom-field
- name: get single
fortinet.fortios.fortios_configuration_fact:
vdom: root
access_token: ""
selector: log_custom-field
params:
id: "3"
- name: fetch one firewall address
fortinet.fortios.fortios_configuration_fact:
selector: firewall_address
params:
name: "login.microsoft.com"
- name: fetch all firewall addresses
fortinet.fortios.fortios_configuration_fact:
selector: firewall_address
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
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_configuration_fact_module.html
