fortinet.fortimanager.fmgr_export_playbooks module – Экспорт конфигурации FortiManager в виде плейбуков.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_export_playbooks.
Добавлено в fortinet.fortimanager 2.1.0
Краткое описание
- Этот модуль предназначен для настройки устройства FortiManager.
- Примеры содержат все параметры и значения, которые необходимо скорректировать с учётом источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
export_playbooks dictionary / обязательный | Экспорт плейбуков для селекторов. |
|
params dictionary |
Специальные параметры для каждого отдельного селектора. |
|
path string |
Путь для сохранения экспортированных плейбуков и файлов журнала. По умолчанию: |
|
selector list / элементы=string / обязательный |
Селектор категории объектов FortiManager. Варианты: |
|
| |
forticloud_access_token string | Токен доступа пользователей API, управляемых FortiCloud; этот параметр доступен в FortiManager версии выше 6.4.0. |
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме workspace. Значением может быть global или другие варианты, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания в секундах, пока другие пользователи снимут блокировку workspace. По умолчанию: |
Примечания
Примечание
- В этом модуле FortiManager поддерживается работа в режиме блокировки workspace; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout позволяют выполнить эту задачу.
- Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код rc. Условия завершения с ошибкой или успехом также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Примеры
- name: Export Playbooks
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Export Playbooks
fortinet.fortimanager.fmgr_export_playbooks:
export_playbooks:
selector:
- all
path: "./exported"
params:
all:
adom: root
Возвращаемые значения
Общие возвращаемые значения описаны здесь; далее перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: сложное значение |
Ссылки на коллекцию
© 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/fortimanager/fmgr_export_playbooks_module.html