fortinet.fortimanager.fmgr_securityconsole_install_package – Копирование и установка пакета политики на устройства.
Примечание
Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_securityconsole_install_package.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| bypass_validation boolean |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут считаться ошибкой | |||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут считаться успехом | |||
| securityconsole_install_package словарь | устанавливаемые параметры верхнего уровня | |||
| adom строка | Имя исходного ADOM. | |||
| adom_rev_comments строка | Если установлен флаг "generate_rev", комментарий к новой ревизии ADOM. | |||
| adom_rev_name строка | Если установлен флаг "generate_rev", имя новой ревизии ADOM. | |||
| dev_rev_comments строка | Комментарии к ревизии конфигурации устройства, которая будет сгенерирована во время установки. | |||
| flags список / элементы=строка |
| нет описания | ||
| pkg строка | Путь и имя исходного пакета. | |||
| scope список / элементы=строка | нет описания | |||
| name строка | нет описания | |||
| vdom строка | нет описания | |||
| workspace_locking_adom строка | adom для блокировки при работе FortiManager в режиме рабочей области, значение может быть глобальным и другими, включая root | |||
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | максимальное время ожидания в секундах, пока другой пользователь не разблокирует рабочую область | ||
Примечания
Примечание
- Работа в режиме блокировки рабочей области поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву present.
- Для удаления объекта используйте директиву absent.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой код rc. Вы также можете переопределить условия для ошибок или успешного завершения с помощью параметров rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Copy and install a policy package to devices.
fmgr_securityconsole_install_package:
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_install_package:
adom: <value of string>
adom_rev_comments: <value of string>
adom_rev_name: <value of string>
dev_rev_comments: <value of string>
flags:
- none
- cp_all_objs
- preview
- generate_rev
- copy_assigned_pkg
- unassign
- ifpolicy_only
- no_ifpolicy
- objs_only
- auto_lock_ws
- check_pkg_st
- copy_only
pkg: <value of string>
scope:
-
name: <value of string>
vdom: <value of string>
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрашиваемый URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Детальное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_securityconsole_install_package_module.html