fortinet.fortimanager.fmgr_pkg_user_nacpolicy модуль — Настройка шаблона соответствия политики NAC для определения совместимых устройств NAC.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
pkg строка / обязательно	Параметр (pkg) в запрошенном URL.
pkg_user_nacpolicy словарь	Установленные параметры верхнего уровня.
category строка	Категория политики NAC. Варианты: `"device"` `"firewall-user"` `"ems-tag"` `"vulnerability"` `"fortivoice-tag"`
description строка	Описание шаблона сопоставления для политики NAC.
ems_tag строка	Устарело, пожалуйста, переименуйте на ems_tag. Тег EMS для сопоставления политики NAC.
family строка	Семейство для сопоставления политики NAC.
firewall_address любой тип	(список) Устарело, пожалуйста, переименуйте на firewall_address. Динамический адрес брандмауэра для сопоставления MAC, которые соответствуют этой политике.
fortivoice_tag любой тип	(список) Устарело, пожалуйста, переименуйте на fortivoice_tag. Тег FortiVoice для сопоставления политики NAC.
host строка	Хост для сопоставления политики NAC.
hw_vendor строка	Устарело, пожалуйста, переименуйте на hw_vendor. Производитель оборудования для сопоставления политики NAC.
hw_version строка	Устарело, пожалуйста, переименуйте на hw_version. Версия оборудования для сопоставления политики NAC.
mac строка	MAC-адрес для сопоставления политики NAC.
match_period целое число	Устарело, пожалуйста, переименуйте на match_period. Количество дней, в течение которых сопоставленные устройства будут сохранены.
match_type строка	Устарело, пожалуйста, переименуйте на match_type. Сопоставление и сохранение устройств на основе типа. Варианты: `"dynamic"` `"override"`
name строка / обязательно	Имя политики NAC.
os строка	Операционная система для сопоставления политики NAC.
severity любой тип	(список) Уровни критичности уязвимости устройств для сопоставления политики NAC.
src строка	Источник для сопоставления политики NAC.

END_OF_DOCUMENT_MARKER

ssid-policy string	Устарело, пожалуйста, переименуйте на ssid_policy. Политика SSID, которая должна быть применена к сопоставленной политике NAC.
status string	Включить/выключить политику NAC. Выбори: `"disable"` `"enable"`
sw-version string	Устарело, пожалуйста, переименуйте на sw_version. Версия ПО политики сопоставления NAC.
switch-auto-auth string	Устарело, пожалуйста, переименуйте на switch_auto_auth. Авторизация устройства NAC при обнаружении и соответствии политике nac. Выбори: `"disable"` `"enable"` `"global"`
switch-fortilink any	(список) Устарело, пожалуйста, переименуйте на switch_fortilink. Поддержка метапеременных Интерфейс FortiLink, к которому принадлежит эта политика NAC.
switch-group any	(список) Устарело, пожалуйста, переименуйте на switch_group. Поддержка метапеременных Список управляемых групп FortiSwitch, к которым может быть применена политика NAC.
switch-mac-policy any	(список) Устарело, пожалуйста, переименуйте на switch_mac_policy. Действие политики MAC коммутатора, которое должно быть применено к сопоставленной политике NAC.
switch-port-policy any	(список) Устарело, пожалуйста, переименуйте на switch_port_policy. Политика switch-port-policy, которая должна быть применена к сопоставленной политике NAC.
switch-scope any	(список) Устарело, пожалуйста, переименуйте на switch_scope. Список управляемых коммутаторов FortiSwitch, к которым может быть применена политика NAC.
type string	Тип сопоставления политики NAC.
user string	Пользователь для сопоставления политики NAC.
user-group string	Устарело, пожалуйста, переименуйте на user_group. Группа пользователей для сопоставления политики NAC.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Выбори: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, по которым условия будут отклоняться.
rc_succeeded list / elements=integer	Список кодов rc, по которым условия будут выполняться.
state string / обязательно	Директива для создания, обновления или удаления объекта. Выбори: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки при работе FortiManager в режиме рабочей области, значение может быть глобальным и другими, включая корень.
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 помогают в этой задаче.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно, выполнение одного модуля может завершиться неудачно, если возвращен ненулевой 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: Configure NAC policy matching pattern to identify matching NAC devices.
      fortinet.fortimanager.fmgr_pkg_user_nacpolicy:
        # 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, ...]
        adom: <your own value>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_user_nacpolicy:
          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>
          name: <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]>

Значения возврата

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

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