Модуль fortinet.fortimanager.fmgr_pkg_user_nacpolicy — Настройка шаблона сопоставления политики NAC для идентификации соответствующих устройств NAC.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
pkg string / обязательный	Параметр (pkg) в запрошенном URL.
pkg_user_nacpolicy dictionary	Набор параметров верхнего уровня.
category string	Категория политики NAC. Варианты: `"device"` `"firewall-user"` `"ems-tag"` `"vulnerability"` `"fortivoice-tag"`
description string	Описание шаблона сопоставления политики NAC.
ems_tag псевдонимы: ems-tag string	Тег EMS для сопоставления с политикой NAC.
family string	Семейство для сопоставления с политикой NAC.
firewall_address псевдонимы: firewall-address any	(список) Динамический адрес брандмауэра для привязки MAC-адреса, соответствующего этой политике.
fortivoice_tag псевдонимы: fortivoice-tag any	(список) Тег FortiVoice для сопоставления с политикой NAC.
host string	Хост для сопоставления с политикой NAC.
hw_vendor псевдонимы: hw-vendor string	Производитель оборудования для сопоставления с политикой NAC.
hw_version псевдонимы: hw-version string	Версия оборудования для сопоставления с политикой NAC.
mac string	MAC-адрес для сопоставления с политикой NAC.
match_period псевдонимы: match-period integer	Количество дней, в течение которых будут сохраняться сопоставленные устройства.
match_remove псевдонимы: match-remove string	Параметры удаления сопоставленных устройств с переопределениями. Варианты: `"link-down"` `"default"`
match_type псевдонимы: match-type string	Сопоставление устройств и их сохранение в зависимости от типа. Варианты: `"dynamic"` `"override"`
name string / обязательный	Имя политики NAC.
os string	Операционная система для сопоставления с политикой NAC.
severity any	(список) Списки уровней критичности уязвимостей устройств для сопоставления с политикой NAC.
src string	Источник для сопоставления с политикой NAC.
ssid_policy псевдонимы: ssid-policy string	Политика SSID, применяемая к сопоставленной политике NAC.
status string	Включение/отключение политики NAC. Варианты: `"disable"` `"enable"`
sw_version псевдонимы: sw-version string	Версия программного обеспечения для сопоставления с политикой NAC.
switch_auto_auth псевдонимы: switch-auto-auth string	Автоматическая авторизация устройства NAC при обнаружении и совпадении с политикой NAC. Варианты: `"disable"` `"enable"` `"global"`
switch_fortilink псевдонимы: switch-fortilink any	(список) Поддерживает метапеременную Интерфейс FortiLink, к которому относится эта политика NAC.
switch_group псевдонимы: switch-group any	(список) Поддерживает метапеременную Список управляемых групп FortiSwitch, к которым можно применить политику NAC.
switch_mac_policy псевдонимы: switch-mac-policy any	(список) Действие политики MAC коммутатора, применяемое к сопоставленной политике NAC.
switch_port_policy псевдонимы: switch-port-policy any	(список) Политика порта коммутатора, применяемая к сопоставленной политике NAC.
switch_scope псевдонимы: switch-scope any	(список) Список управляемых коммутаторов FortiSwitch, к которым можно применить политику NAC.
type string	Тип для сопоставления с политикой NAC.
user string	Пользователь для сопоставления с политикой NAC.
user_group псевдонимы: user-group string	Группа пользователей для сопоставления с политикой NAC.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
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.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure NAC policy matching pattern to identify matching NAC devices.
      fortinet.fortimanager.fmgr_pkg_user_nacpolicy:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_user_nacpolicy:
          name: "your value" # Required variable, string
          # category: <value in [device, firewall-user, ems-tag, ...]>
          # description: <string>
          # ems_tag: <string>
          # family: <string>
          # host: <string>
          # hw_vendor: <string>
          # hw_version: <string>
          # mac: <string>
          # os: <string>
          # src: <string>
          # ssid_policy: <string>
          # status: <value in [disable, enable]>
          # sw_version: <string>
          # type: <string>
          # user: <string>
          # user_group: <string>
          # severity: <list or integer>
          # firewall_address: <list or string>
          # fortivoice_tag: <list or string>
          # match_period: <integer>
          # match_type: <value in [dynamic, override]>
          # switch_fortilink: <list or string>
          # switch_group: <list or string>
          # switch_mac_policy: <list or string>
          # switch_scope: <list or string>
          # switch_port_policy: <list or string>
          # switch_auto_auth: <value in [disable, enable, global]>
          # match_remove: <value in [link-down, default]>

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

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

Ключ	Описание
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_pkg_user_nacpolicy_module.html