Модуль fortinet.fortimanager.fmgr_securityconsole_assign_package – назначение или отмена назначения пакета глобальных политик пакетам ADOM.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_securityconsole_assign_package.

Добавлено в fortinet.fortimanager 2.0.0

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

Краткое описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия завершения с ошибкой.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия успешного завершения.
securityconsole_assign_package dictionary	Набор параметров верхнего уровня.
flags list / elements=string	cp_all_objs — назначить все объекты при назначении глобальных политик. copy_assigned_pkg — при назначении глобальных политик скопировать назначенный пакет из ADOM на устройство. unassign — удалить глобальную политику из ADOM. Варианты: `"none"` `"cp_all_objs"` `"copy_assigned_pkg"` `"unassign"`
pkg string	Путь и имя исходного пакета.
target list / elements=dictionary	Целевой объект.
adom string	Целевая ADOM.
excluded string	disable — включать только пакеты, перечисленные в списке pkg. enable — исключить пакет, указанный в списке pkg, и назначить пакет всем остальным пакетам в ADOM. Варианты: `"disable"` `"enable"`
pkg string	Путь и имя пакета политик целевой ADOM.
workspace_locking_adom string	ADOM, которую нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другая ADOM, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания, пока другой пользователь освободит блокировку рабочей области. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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: Assign or unassign global policy package to ADOM packages.
      fortinet.fortimanager.fmgr_securityconsole_assign_package:
        # workspace_locking_adom: <global or your adom name>
        securityconsole_assign_package:
          # flags: ["none", "cp_all_objs", "copy_assigned_pkg", "unassign"]
          # pkg: <string>
          # target:
          #   - adom: <string>
          #     excluded: <value in [disable, enable]>
          #     pkg: <string>

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, относящиеся только к этому модулю:

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией 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–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_assign_package_module.html