Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_system_automation_trigger — триггер для сценариев автоматизации в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

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

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

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

  • Этот модуль позволяет настраивать устройства FortiGate или FortiOS (FOS), задавая и изменяя системные функции и категорию automation_trigger. В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено на 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"

system_automation_trigger

dictionary

Триггер для сценариев автоматизации.

description

string

Описание.

event_type

string

Тип события.

Варианты:

  • "ioc"
  • "event-log"
  • "reboot"
  • "low-memory"
  • "high-cpu"
  • "license-near-expiry"
  • "local-cert-near-expiry"
  • "ha-failover"
  • "config-change"
  • "security-rating-summary"
  • "virus-ips-db-updated"
  • "faz-event"
  • "incoming-webhook"
  • "fabric-event"
  • "ips-logs"
  • "anomaly-logs"
  • "virus-logs"
  • "ssh-logs"
  • "webfilter-violation"
  • "traffic-violation"
  • "stitch"

fabric_event_name

string

Имя обработчика событий коннектора Fabric.

fabric_event_severity

string

Важность события коннектора Fabric.

faz_event_name

string

Имя обработчика событий FortiAnalyzer.

faz_event_severity

string

Важность события FortiAnalyzer.

faz_event_tags

string

Теги события FortiAnalyzer.

fields

list / elements=dictionary

Настройки пользовательских полей триггера.

id

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

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

name

string

Имя.

value

string

Значение.

ioc_level

string

Уровень угрозы IOC.

Варианты:

  • "medium"
  • "high"

license_type

string

Тип лицензии.

Варианты:

  • "forticare-support"
  • "fortiguard-webfilter"
  • "fortiguard-antispam"
  • "fortiguard-antivirus"
  • "fortiguard-ips"
  • "fortiguard-management"
  • "forticloud"
  • "any"

logid

list / elements=dictionary

Идентификаторы журналов для запуска события.

id

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

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

name

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

Имя.

report_type

string

Отчет Security Rating.

Варианты:

  • "posture"
  • "coverage"
  • "optimization"
  • "any"
  • "PostureReport"
  • "CoverageReport"
  • "OptimizationReport"

serial

string

Серийный номер коннектора Fabric.

stitch_name

string

Имя запускаемого сценария. Исходная система: system.automation-stitch.name.

trigger_datetime

string

Дата и время запуска триггера (YYYY-MM-DD HH:MM:SS).

trigger_day

integer

День месяца для запуска триггера.

trigger_frequency

string

Частота запуска триггера по расписанию.

Варианты:

  • "hourly"
  • "daily"
  • "weekly"
  • "monthly"
  • "once"

trigger_hour

integer

Час запуска триггера (0–23).

trigger_minute

integer

Минута часа, в которую запускается триггер (0–59).

trigger_type

string

Тип триггера.

Варианты:

  • "event-based"
  • "scheduled"

trigger_weekday

string

День недели для запуска триггера.

Варианты:

  • "sunday"
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"

vdom

list / elements=dictionary

Виртуальные домены, для которых действует этот триггер.

name

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

Имя виртуального домена. Исходная система: system.vdom.name.

vdom

string

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

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

Примечания

Примечание

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

Примеры

- name: Trigger for automation stitches.
  fortinet.fortios.fortios_system_automation_trigger:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_automation_trigger:
          description: "<your_own_value>"
          event_type: "ioc"
          fabric_event_name: "<your_own_value>"
          fabric_event_severity: "<your_own_value>"
          faz_event_name: "<your_own_value>"
          faz_event_severity: "<your_own_value>"
          faz_event_tags: "<your_own_value>"
          fields:
              -
                  id: "11"
                  name: "default_name_12"
                  value: "<your_own_value>"
          ioc_level: "medium"
          license_type: "forticare-support"
          logid:
              -
                  id: "17"
          name: "default_name_18"
          report_type: "posture"
          serial: "<your_own_value>"
          stitch_name: "<your_own_value> (source system.automation-stitch.name)"
          trigger_datetime: "<your_own_value>"
          trigger_day: "1"
          trigger_frequency: "hourly"
          trigger_hour: "0"
          trigger_minute: "0"
          trigger_type: "event-based"
          trigger_weekday: "sunday"
          vdom:
              -
                  name: "default_name_30 (source system.vdom.name)"

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

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

Ключ

Описание

build

string

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

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

Пример: "1547"

http_method

string

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

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

Пример: "PUT"

http_status

string

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

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

Пример: "200"

mkey

string

Мастер-ключ (идентификатор), использованный в последнем вызове 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_system_automation_trigger_module.html

Spec-Zone.ru

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