Модуль fortinet.fortios.fortios_export_config_playbook – Сбор текущих конфигураций модулей и преобразование их в плейбуки.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка | Аутентификация на основе токена. Создается в интерфейсе Fortigate. |
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
filters список / элементы=строка | Список выражений для фильтрации полученных результатов. Элементы списка объединяются оператором «И» (логическое И). Один элемент может быть соединён запятой как оператор «ИЛИ» (логическое ИЛИ). |
formatters список / элементы=строка | Список полей для отображения полученных результатов. |
output_path строка / обязательно | Путь для сохранения плейбука. |
params словарь | Параметр для каждого селектора, см. определение в списке выше. |
selector строка | Имя модуля, используемого для получения текущих конфигураций и экспорта плейбука. Варианты: |
|
|
| |
selectors список / элементы=словарь | Список селекторов, используемых для получения текущих конфигураций и экспорта плейбука. |
|
filters список / элементы=строка |
Список выражений для фильтрации возвращаемых результатов. Элементы списка объединяются как ЛОГИЧЕСКОЕ И с оператором амперсанд. Один элемент сам по себе может быть соединен запятой как ЛОГИЧЕСКОЕ ИЛИ. |
|
formatters список / элементы=строка |
Список полей для отображения возвращаемых результатов. |
|
params словарь |
Параметр для каждого селектора, см. определение в списке выше. |
|
selector строка / обязательно |
Имя модуля, используемого для получения текущих конфигураций и экспорта плейбука. Выбор: |
|
|
| |
|
sorters список / элементы=строка |
Список выражений для сортировки возвращаемых результатов. Элементы списка упорядочены по возрастанию с оператором амперсанд. Один элемент может быть упорядочен по убыванию с запятой внутри. |
sorters список / элементы=строка | Список выражений для сортировки возвращаемых результатов. Элементы списка упорядочены по возрастанию с оператором амперсанд. Один элемент может быть упорядочен по убыванию с запятой внутри. |
vdom строка | Виртуальная область (Virtual Domain), определённая ранее. VDOM — виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Разные селекторы могут иметь разные параметры; пользователям рекомендуется искать их для конкретного селектора.
- Для некоторых селекторов объекты являются глобальными; параметры не допускаются.
- Если параметры пустые, возвращается список всех объектов (не обязательно уникальных).
- Этот модуль поддерживает все конфигурационные API, за исключением API мониторинга.
- Результат запроса API хранится в результатах как список.
Примеры
- 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 строка | Номер сборки изображения 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_export_config_playbook_module.html