Модуль fortinet.fortios.fortios_user_quarantine – Настройка поддержки карантина в FortiOS и FortiGate Fortinet.

Примечание

Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты. Подробности смотрите в разделе Требования.

Для использования в плейбуке укажите: fortinet.fortios.fortios_user_quarantine.

Новая функция в fortinet.fortios 2.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю задавать и изменять параметры пользователя и категории карантина. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.0

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

ansible>=2.15

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Сгенерировано в веб-интерфейсе Fortigate.
enable_log логический тип	Включение/выключение ведения журнала для задачи. Выбор: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту члена для обработки. Разделяется символом косой черты, если атрибутов более одного. Параметр с member_path допустим для операций с членами.
member_state строка	Добавление или удаление члена по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Выбор: `"present"` `"absent"`
user_quarantine словарь	Настройка поддержки карантина.
firewall_groups строка	Группа адресов брандмауэра, которая включает все MAC-адреса карантина. Имя группы адресов брандмауэра.
quarantine строка	Включение/выключение карантина. Выбор: `"enable"` `"disable"`
targets список / элементы=словарь	Запись карантина, содержащая несколько MAC-адресов.
description строка	Описание записи карантина.
entry строка / обязательно	Имя записи карантина.
macs список / элементы=словарь	MAC-адреса карантина.
description строка	Описание MAC-адреса карантина.
drop строка	Включение/выключение отбрасывания трафика с карантинных устройств. Выбор: `"disable"` `"enable"`
entry_id целое число	Идентификатор записи FSW для MAC-адреса карантина.
mac строка / обязательно	MAC-адрес карантина.
parent строка	Имя родительской записи.
traffic_policy строка	Политика трафика для MAC-адресов карантина. Имя политики трафика контроллера переключателя.
vdom строка	Виртуальная область (vdom), среди ранее определённых. VDOM – виртуальная копия FortiGate, которая может быть настроена и использована как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Модуль fortiosapi устарел, httpapi является предпочтительным способом выполнения плейбуков.

Примеры

- name: Configure quarantine support.
  fortinet.fortios.fortios_user_quarantine:
      vdom: "{{ vdom }}"
      user_quarantine:
          firewall_groups: "<your_own_value> (source firewall.addrgrp.name)"
          quarantine: "enable"
          targets:
              -
                  description: "<your_own_value>"
                  entry: "<your_own_value>"
                  macs:
                      -
                          description: "<your_own_value>"
                          drop: "disable"
                          entry_id: "2147483647"
                          mac: "<your_own_value>"
                          parent: "<your_own_value>"
          traffic_policy: "<your_own_value> (source switch-controller.traffic-policy.name)"

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

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

Ключ	Описание
build строка	Номер сборки образа fortigate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, используемый для предоставления контента в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, предоставленный FortiGate при последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (id), используемый при последнем запросе к FortiGate Возвращается: успех Пример: `"id"`
name строка	Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom строка	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Ссылки на коллекцию

© 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/fortios/fortios_user_quarantine_module.html