Модуль fortinet.fortios.fortios_export_config_playbook — сбор текущих конфигураций модулей и преобразование их в плейбуки.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_export_config_playbook.
Добавлено в fortinet.fortios 2.1.0
Краткое описание
- Собирает текущие конфигурации модуля на работающем устройстве и преобразует возвращённые факты в плейбук, который пользователи могут применять напрямую.
- Если указано несколько селекторов, будет создано несколько плейбуков.
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- Установленная коллекция Galaxy fortinet.fortios версии >= 2.1.3.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Создается в графическом интерфейсе Fortigate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
filters list / elements=string | Список выражений для фильтрации возвращаемых результатов. Элементы списка объединяются логическим И с помощью оператора амперсанда. Один элемент может содержать объединение выражений через запятую по логическому ИЛИ. |
formatters list / elements=string | Список полей, отображаемых в возвращаемых результатах. |
output_path string / обязательный | путь для сохранения плейбука. |
params dictionary | параметр для каждого селектора; см. описание выше. |
selector string | Имя модуля, используемого для получения текущих конфигураций и экспорта плейбука. Варианты:
|
selectors list / elements=dictionary | Список селекторов, используемых для получения текущих конфигураций и экспорта плейбука. |
|
filters list / elements=string |
Список выражений для фильтрации возвращаемых результатов. Элементы списка объединяются оператором амперсанда как логическое И. Отдельный элемент можно объединить запятой как логическое ИЛИ. |
|
formatters list / elements=string |
Список полей для отображения в возвращаемых результатах. |
|
params dictionary |
параметр для каждого селектора; см. определение в списке выше. |
|
selector string / required |
Имя модуля, используемого для получения текущих конфигураций и экспорта плейбука. Варианты:
|
|
sorters list / elements=string |
Список выражений для сортировки возвращаемых результатов. Элементы списка располагаются в порядке возрастания с использованием оператора амперсанда. Отдельный элемент можно указать в порядке убывания, добавив запятую. |
sorters list / elements=string | Список выражений для сортировки возвращаемых результатов. Элементы списка располагаются в порядке возрастания с помощью оператора амперсанда. Отдельный элемент можно расположить в порядке убывания, указав запятую внутри него. |
vdom string | Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Для разных селекторов могут использоваться разные параметры; для конкретного селектора их следует уточнить.
- Для некоторых селекторов объекты являются глобальными, и параметры указывать нельзя.
- Если параметры не заданы для неуникального объекта, возвращается весь список объектов.
- Этот модуль поддерживает все API конфигурации, за исключением API мониторинга.
- Результат запроса API сохраняется в results в виде списка.
Примеры
- name: Will generate the playbooks for each selector/module.
fortinet.fortios.fortios_export_config_playbook:
selectors:
- selector: firewall_address
params:
name: "gmail.com"
- selector: system.snmp_user
params:
name: "snmp_user_test"
output_path: "./"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_export_config_playbook_module.html