Модуль fortinet.fortios.fortios_system_automation_trigger — Триггер для автоматизации в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токенов. Сгенерировано в графическом интерфейсе Fortigate. |
enable_log булево | Включение/выключение ведения журнала для задачи. Варианты:
|
member_path строка | Путь к атрибуту члена для обработки. Разделяется символом косой черты, если атрибутов более одного. Параметр, помеченный как member_path, подходит для выполнения операций с членами. |
member_state строка | Добавление или удаление члена по указанному пути к атрибуту. Когда указан member_state, опция state игнорируется. Варианты:
|
state строка / обязательно | Указывает, создавать или удалять объект. Варианты:
|
system_automation_trigger словарь | Триггер для автоматизации стыковки. |
|
description строка |
Описание. |
|
event_type строка |
Тип события. Варианты:
|
|
fabric_event_name строка |
Имя обработчика событий Fabric connector. |
|
fabric_event_severity строка |
Уровень серьезности события Fabric connector. |
|
faz_event_name строка |
Имя обработчика событий FortiAnalyzer. |
|
faz_event_severity строка |
Уровень серьезности события FortiAnalyzer. |
|
faz_event_tags строка |
Тэги событий FortiAnalyzer. |
|
fields список / элементы=словарь |
Настройки настраиваемых полей триггера. |
|
id целое число / обязательно | |
|
name строка |
Имя. |
|
value строка |
Значение. |
|
ioc_level строка |
Уровень угрозы IOC. Варианты:
|
|
license_type строка |
Тип лицензии. Варианты:
|
|
logid список / элементы=словарь |
Идентификаторы журналов для запуска события. |
|
id целое число / обязательно |
|
name string / обязательно |
Имя. |
|
report_type string |
Отчет об оценке безопасности. Варианты:
|
|
serial string |
Серийный номер концентратора Fabric. |
|
trigger_datetime string |
Дата и время срабатывания (ГГГГ-ММ-ДД ЧЧ:ММ:СС). |
|
trigger_day целое число |
День месяца для запуска. |
|
trigger_frequency string |
Расписание частоты запуска. Варианты:
|
|
trigger_hour целое число |
Час дня для запуска (0 - 23). |
|
trigger_minute целое число |
Минута часа для запуска (0 - 59). |
|
trigger_type string |
Тип запуска. Варианты:
|
|
trigger_weekday string |
День недели для запуска. Варианты:
|
|
vdom список / элементы=словарь |
Виртуальная(ые) область(и) для которой данная настройка триггера имеет силу. |
|
name string / обязательно |
Имя виртуальной области. Источник system.vdom.name. |
vdom string | Виртуальная область, среди ранее определенных. Виртуальная область (VDOM) — виртуальная экземпляр FortiGate, которую можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Модуль fortiosapi устарел, httpapi — предпочтительный способ запуска playbooks
- Модуль поддерживает режим проверки (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>"
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_29 (source system.vdom.name)"
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
build строка | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для предоставления контента в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, полученный от FortiGate при последнем применённом действии Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), используемый при последнем обращении к FortiGate Возвращается: успех Пример: |
name строка | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер ревизии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Используемый виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_system_automation_trigger_module.html
