Модуль fortinet.fortimanager.fmgr_export_playbooks – Экспорт конфигурации fortimanager в playbook.
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook укажите: fortinet.fortimanager.fmgr_export_playbooks.
Добавлен в fortinet.fortimanager 2.1.0
Описание
- Этот модуль способен настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать, прежде чем использовать их для данных.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
enable_log логический | Включить/выключить ведение журнала для задачи. Варианты:
|
export_playbooks словарь / обязательно | Экспорт playbooks для селекторов. |
|
params словарь |
Конкретные параметры для каждого селектора. |
|
path строка |
Путь для хранения экспортированных playbooks и лог-файлов. По умолчанию: |
|
selector список / элементы=строка / обязательно |
Селектор категории объекта FortiManager. Варианты: |
|
|
|
| |
forticloud_access_token строка | Токен доступа к FortiCloud, управляемому API-пользователям, этот параметр доступен для FortiManager версии позже 6.4.0. |
workspace_locking_adom строка | ADOM для блокировки FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая root. |
workspace_locking_timeout целое число | Максимальное время ожидания в секундах, пока другие пользователи не освободят блокировку рабочего пространства. По умолчанию: |
Примечания
Примечание
- Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в работе.
- Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой код возврата. Вы также можете переопределить условия для завершения с ошибкой или успехом с помощью параметров 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 словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложный |
Ссылки на коллекцию
© 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/fortimanager/fmgr_export_playbooks_module.html