Модуль fortinet.fortios.fortios_configuration_fact — получение сведений о настраиваемых объектах FortiOS.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля могут потребоваться дополнительные компоненты. Подробнее см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_configuration_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 | селектор для получения фактов Fortigate Варианты:
|
selectors list / elements=dictionary | список селекторов для получения фактов Fortigate |
|
filters list / elements=string |
Список выражений для фильтрации возвращаемых результатов. Элементы списка объединяются оператором ampersand как логическое И. Один элемент можно объединить с другим через запятую как логическое ИЛИ. |
|
formatters list / elements=string |
Список полей для отображения в возвращаемых результатах. |
|
params dictionary |
параметр для каждого селектора; см. определение в списке выше. |
|
selector string / обязательный |
селектор для получения фактов FortiGate Варианты:
|
|
sorters list / elements=string |
Список выражений для сортировки возвращаемых результатов. Элементы списка сортируются по возрастанию с помощью оператора ampersand. Отдельный элемент можно отсортировать по убыванию, добавив запятую. |
sorters list / elements=string | Список выражений для сортировки возвращаемых результатов. Элементы списка сортируются по возрастанию с помощью оператора ampersand. Отдельный элемент можно отсортировать по убыванию, добавив запятую. |
vdom string | Виртуальный домен из числа предварительно определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настраивать и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Для разных селекторов могут требоваться разные параметры; пользователям следует проверить их для конкретного селектора.
- Для некоторых селекторов объекты являются глобальными, поэтому параметры указывать нельзя.
- Если параметр params пуст для неуникального объекта, возвращается весь список объектов.
- Этот модуль поддерживает все API конфигурации, за исключением API мониторинга.
- Результат запроса API сохраняется в results в виде списка.
Примеры
- 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 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_configuration_fact_module.html