Модуль fortinet.fortimanager.fmgr_securityconsole_import_dev_objs – Импорт объектов с устройства в ADOM или из ADOM в глобальную область.

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в playbook укажите: fortinet.fortimanager.fmgr_securityconsole_import_dev_objs.

Новое в fortinet.fortimanager 2.0.0

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль позволяет настраивать устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логический	Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логический	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
rc_failed список / элементы=целое	Список кодов rc, с которыми будут переопределены условия завершения задачи с ошибкой.
rc_succeeded список / элементы=целое	Список кодов rc, с которыми будут переопределены условия завершения задачи успешно.
securityconsole_import_dev_objs словарь	Настройка верхнего уровня параметров.
add_mappings строка	Автоматически добавить необходимые динамические сопоставления для устройства во время этапов поиска. Варианты: `"disable"` `"enable"`
adom строка	Имя ADOM-источника.
dst_name строка	Имя пакета правил, куда будут импортированы объекты.
dst_parent строка	Путь к папке для целевого пакета.
if_all_objs строка	Если все объекты. Варианты: `"none"` `"all"` `"filter"`
if_all_policy строка	Если все правила. Варианты: `"disable"` `"enable"`
import_action строка	do - Выполнить импорт правил и объектов. policy_search - Предварительная обработка и поиск в базе данных устройства для сбора информации о правилах, которые необходимо импортировать. obj_search - Предварительная обработка и поиск в базе данных устройства для сбора объектов, которые необходимо импортировать. Варианты: `"do"` `"policy_search"` `"obj_search"`
name строка	Имя источника устройства.
position строка	Позиция. Варианты: `"bottom"` `"top"`
vdom строка	Vdom.
workspace_locking_adom строка	ADOM для блокировки FortiManager, работающего в режиме рабочей области, значение может быть global и другими, включая root.
workspace_locking_timeout целое	Максимальное время в секундах ожидания пока другой пользователь не разблокирует рабочую область. По умолчанию: `300`

END_OF_DOCUMENT_MARKER

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют название в стиле snake_case (например, _var_name). Пожалуйста, измените аргументы, такие как «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но вы получите предупреждения о устаревании. Вы можете игнорировать это предупреждение, установив deprecation_warnings=False в файле ansible.cfg.
В этом модуле FortiManager поддерживается работа в режиме блокировки рабочей области. Параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой код возврата. Вы также можете переопределить условия для возврата ошибки или успешного завершения с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Import objects from device to ADOM, or from ADOM to Global.
      fortinet.fortimanager.fmgr_securityconsole_import_dev_objs:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложный

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на сборку

© 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_securityconsole_import_dev_objs_module.html