Модуль fortinet.fortimanager.fmgr_securityconsole_install_package — копирование и установка пакета политик на устройства.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_securityconsole_install_package.
Добавлено в fortinet.fortimanager 1.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_install_package dictionary | Параметры верхнего уровня. |
|
adom string |
Имя исходного ADOM. |
|
adom_rev_comments string |
Комментарий к новой ревизии ADOM, если установлен флаг generate_rev. |
|
adom_rev_name string |
Имя новой ревизии ADOM, если установлен флаг generate_rev. |
|
dev_rev_comments string |
Комментарии к ревизии конфигурации устройства, которая будет создана во время установки. |
|
flags list / elements=string |
cp_all_objs — назначить все объекты при назначении глобальной политики. preview — создать только кэш предварительного просмотра. generate_rev — создать новую ревизию ADOM перед установкой. copy_assigned_pkg — при назначении глобальной политики скопировать назначенный пакет из ADOM на устройство. unassign — удалить глобальную политику из ADOM. ifpolicy_only — установить только политики интерфейсов. no_ifpolicy — установить только обычные политики, не устанавливая политики интерфейсов. objs_only — установить объекты. auto_lock_ws — автоматически блокировать и разблокировать рабочую область при выполнении задачи консоли безопасности. copy_only — только скопировать в базу данных устройства. Варианты:
|
|
pkg string |
Путь и имя исходного пакета. |
|
scope list / elements=dictionary |
Область действия. |
|
name 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
hosts: fortimanagers
gather_facts: false
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.
fortinet.fortimanager.fmgr_securityconsole_install_package:
bypass_validation: false
securityconsole_install_package:
adom: ansible
adom_rev_comments: ansible-comment
adom_rev_name: ansible-test
dev_rev_comments: ansible-comment
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: ansible
scope:
- name: Ansible-test
vdom: root
- name: INSTALL PREVIEW - POLICY PACKAGE
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
adom: demo
ppkg: ppkg_hubs
device: fgt_00_1
tasks:
- name: Install for policy package [preview mode] {{ ppkg }}
fortinet.fortimanager.fmgr_securityconsole_install_package:
securityconsole_install_package:
adom: "{{ adom }}"
flags:
- preview
pkg: "{{ ppkg }}"
scope:
- name: "{{ device }}"
vdom: root
register: r
- name: Poll the task of installing policy package
fortinet.fortimanager.fmgr_fact:
facts:
selector: "task_task"
params:
task: "{{ r.meta.response_data.task }}"
register: taskinfo
until: taskinfo.meta.response_data.percent == 100
retries: 30
delay: 5
- name: Trigger the preview report generation for policy package {{ ppkg }}
fortinet.fortimanager.fmgr_securityconsole_install_preview:
securityconsole_install_preview:
adom: "{{ adom }}"
device: "{{ device }}"
flags:
- json
vdoms: root
register: r
- name: Poll the task of generating preview report
fortinet.fortimanager.fmgr_fact:
facts:
selector: "task_task"
params:
task: "{{ r.meta.response_data.task }}"
register: taskinfo
until: taskinfo.meta.response_data.percent == 100
retries: 30
delay: 5
- name: Get the preview report for policy package {{ ppkg }}
fortinet.fortimanager.fmgr_securityconsole_preview_result:
securityconsole_preview_result:
adom: "{{ adom }}"
device: "{{ device }}"
register: r
- name: Cancel install task for policy package {{ ppkg }}
fortinet.fortimanager.fmgr_securityconsole_package_cancel_install:
securityconsole_package_cancel_install:
adom: "{{ adom }}"
- name: Show preview report
ansible.builtin.debug:
msg: "{{ r }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_install_package_module.html