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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к 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_assign_package словарь	Настройка параметров верхнего уровня.
flags список / элементы=строка	cp_all_objs — Назначение всех объектов при назначении глобальной политики. copy_assigned_pkg — Для назначения глобальной политики — копирование назначенного пакета из ADOM на устройство. unassign — Удаление глобальной политики из ADOM. Варианты: `"none"` `"cp_all_objs"` `"copy_assigned_pkg"` `"unassign"`
pkg строка	Путь и имя исходного пакета.
target список / элементы=словарь	Цель.
adom строка	Целевой ADOM.
excluded строка	disable — Учитывать только пакеты, указанные в списке pkg. enable — Исключить пакет, указанный в списке pkg, и назначить всем остальным пакетам в ADOM. Варианты: `"disable"` `"enable"`
pkg строка	Путь и имя целевого пакета политики ADOM.
workspace_locking_adom строка	ADOM для блокировки при работе с FortiManager в режиме рабочего пространства; значение может быть глобальным или другим, включая root.
workspace_locking_timeout целое	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Assign or unassign global policy package to ADOM packages.
      fortinet.fortimanager.fmgr_securityconsole_assign_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_assign_package:
          flags:
            - none
            - cp_all_objs
            - copy_assigned_pkg
            - unassign
          pkg: <string>
          target:
            -
              adom: <string>
              excluded: <value in [disable, enable]>
              pkg: <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_assign_package_module.html