Модуль fortinet.fortimanager.fmgr_securityconsole_import_dev_objs — импорт объектов с устройства в ADOM или из ADOM в Global.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_securityconsole_import_dev_objs.
Добавлено в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation boolean | Устанавливайте значение True только в случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
rc_failed list / elements=integer | Список кодов rc, переопределяющий условия сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, переопределяющий условия успешного выполнения. |
securityconsole_import_dev_objs dictionary | Набор параметров верхнего уровня. |
|
add_mappings string |
Автоматически добавлять необходимые динамические сопоставления для устройства на этапах поиска. Варианты:
|
|
adom string |
Имя исходного ADOM. |
|
dst_name string |
Имя пакета политик, в который импортируются объекты. |
|
dst_parent string |
Путь к папке целевого пакета. |
|
if_all_objs string |
Если все объекты. Варианты:
|
|
if_all_policy string |
Если все политики. Варианты:
|
|
import_action string |
do — выполнить импорт политик и объектов. policy_search — выполнить предварительную обработку и просканировать базу данных устройства, чтобы собрать сведения о политиках, которые необходимо импортировать. obj_search — выполнить предварительную обработку и просканировать базу данных устройства, чтобы собрать объекты, необходимые для импорта. Варианты:
|
|
name string |
Имя исходного устройства. |
|
position string |
Позиция. Варианты:
|
|
vdom string |
VDOM. |
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global и другие ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания в секундах, пока другой пользователь снимет блокировку рабочей области. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, имена всех входных аргументов используют соглашение об именовании с подчёркиванием (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, однако будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
- Обычно выполнение модуля может завершиться ошибкой, если возвращён ненулевой код rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Import objects from device to ADOM, or from ADOM to Global.
fortinet.fortimanager.fmgr_securityconsole_import_dev_objs:
# workspace_locking_adom: <global or your adom name>
securityconsole_import_dev_objs:
# add_mappings: <value in [disable, enable]>
# adom: <string>
# dst_name: <string>
# dst_parent: <string>
# if_all_objs: <value in [none, all, filter]>
# if_all_policy: <value in [disable, enable]>
# import_action: <value in [do, policy_search, obj_search]>
# name: <string>
# position: <value in [bottom, top]>
# vdom: <string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_securityconsole_import_dev_objs_module.html