fortios_facts – Получение фактов о устройствах fortios
Новое в версии 2.9.
Описание
- Сбор фактов с сетевых устройств, работающих под управлением операционной системы fortios. Этот модуль помещает собранные факты в дерево фактов, индексированные соответствующим именем ресурса. Этот модуль фактов будет собирать только те факты, которые пользователь указал в книге задач.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- fortiosapi>=0.9.8
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| gather_subset список / элементы=словарь / обязательно | При указании этого аргумента будут ограничены факты, собираемые для данного подмножества. Возможные значения для этого аргумента включают system_current-admins_select, system_firmware_select, system_fortimanager_status, system_ha-checksums_select, system_interface_select, system_status_select и system_time_select | ||
| fact строка / обязательно | Имя собираемых фактов | ||
| filters список / элементы=словарь | Фильтры применяются при сборе фактов | ||
| host строка | IP-адрес FortiOS или FortiGate. | ||
| https логическое значение |
| Указывает, должны ли запросы к FortiGate использовать протокол HTTPS. | |
| password строка | По умолчанию: "" | Пароль FortiOS или FortiGate. | |
| ssl_verify логическое значение |
| Обеспечивает проверку сертификата FortiGate надлежащим центром сертификации. | |
| username строка | Имя пользователя FortiOS или FortiGate. | ||
| vdom строка | По умолчанию: "root" | Виртуальная область, определённая ранее. VDOM — виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. | |
Примечания
Примечание
- Поддерживаются оба режима: legacy (local_action) и httpapi
- Режим legacy работает как local_action в книге задач, требует библиотеку fortiosapi, разработанную Fortinet
- Режим httpapi — рекомендуемый способ для сетевых модулей
Примеры
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: gather basic system status facts
fortios_facts:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
gather_subset:
- fact: 'system_status_select'
- name: gather all physical interfaces status facts
fortios_facts:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
gather_subset:
- fact: 'system_interface_select'
- name: gather gather all physical and vlan interfaces status facts
fortios_facts:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
gather_subset:
- fact: 'system_interface_select'
filters:
- include_vlan: true
- name: gather basic system info and physical interface port3 status facts
fortios_facts:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
gather_subset:
- fact: 'system_status_select'
- fact: 'system_interface_select'
filters:
- interface_name: 'port3'
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| build строка | всегда | Номер сборки изображения fortigate Пример: 1547 |
| http_method строка | всегда | Последний метод, использованный для подготовки контента в FortiGate Пример: GET |
| name строка | всегда | Имя таблицы, используемой для выполнения запроса Пример: firmware |
| path строка | всегда | Путь к таблице, используемой для выполнения запроса Пример: system |
| revision строка | всегда | Внутренний номер ревизии Пример: 17.0.2.10658 |
| serial строка | всегда | Серийный номер устройства Пример: FGVMEVYYQT3AB5352 |
| status строка | всегда | Указание результата операции Пример: успешно |
| vdom строка | всегда | Используемая виртуальная область Пример: root |
| version строка | всегда | Версия FortiGate Пример: v5.6.3 |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Don Yao (@fortinetps)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_facts_module.html