Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_virtual_patch_profile — настройка профиля виртуальных исправлений в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_virtual_patch_profile.

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

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

Обзор

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

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Токен создается в графическом интерфейсе Fortigate.

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, над которым выполняется операция.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр member_path предназначен для выполнения операций над элементами.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

string / обязательный

Указывает, нужно ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

virtual_patch_profile

dictionary

Настройка профиля виртуальных исправлений.

action

string

Действие (пропустить/блокировать).

Варианты:

  • "pass"
  • "block"

comment

string

Комментарий.

exemption

list / elements=dictionary

Устройства или правила, на которые не распространяется действие профиля.

device

list / elements=dictionary

MAC-адреса устройств.

mac

string / обязательный

MAC-адрес устройства.

id

integer / обязательный

Идентификаторы. См. <a href=’#notes’>Примечания</a>.

rule

list / elements=dictionary

Идентификаторы правил сигнатур исправлений.

id

integer / обязательный

Идентификаторы правил. См. <a href=’#notes’>Примечания</a>.

status

string

Включить или отключить исключение.

Варианты:

  • "enable"
  • "disable"

log

string

Включить или отключить регистрацию обнаружений в журнале.

Варианты:

  • "enable"
  • "disable"

name

string / обязательный

Имя профиля.

severity

list / elements=string

Относительная степень серьезности сигнатуры (низкая, средняя, высокая, критическая).

Варианты:

  • "info"
  • "low"
  • "medium"
  • "high"
  • "critical"

Примечания

Примечание

  • Устаревшая библиотека fortiosapi объявлена устаревшей; для запуска плейбуков рекомендуется использовать httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: Configure virtual-patch profile.
  fortinet.fortios.fortios_virtual_patch_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      virtual_patch_profile:
          action: "pass"
          comment: "Comment."
          exemption:
              -
                  device:
                      -
                          mac: "<your_own_value>"
                  id: "8"
                  rule:
                      -
                          id: "10"
                  status: "enable"
          log: "enable"
          name: "default_name_13"
          severity: "info"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, полученный от FortiGate при выполнении последней операции

Возвращается: всегда

Пример: "200"

mkey

string

Мастер-ключ (id), использованный при последнем вызове FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер редакции

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

Возвращается: всегда

Пример: "success"

vdom

string

Использованный виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_virtual_patch_profile_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API