Модуль fortinet.fortios.fortios_system_automation_condition — условие для сценариев автоматизации в 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_condition.

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

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

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

Этот модуль позволяет настраивать устройства FortiGate или FortiOS (FOS), задавая и изменяя параметры функции system и категории automation_condition. В примерах приведены все параметры и значения, которые необходимо скорректировать в соответствии с источниками данных перед использованием. Протестировано с 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_condition dictionary	Условие для сценариев автоматизации.
condition_type string	Тип условия. Варианты: `"cpu"` `"memory"` `"vpn"`
cpu_usage_percent integer	Загрузка ЦП достигает заданного процента.
description string	Описание.
mem_usage_percent integer	Использование памяти достигает заданного процента.
name string / обязательный	Имя.
vdom string	Виртуальный домен, к которому относится туннель. Источник: system.vdom.name.
vpn_tunnel_name string	Имя VPN-туннеля.
vpn_tunnel_state string	Состояние VPN-туннеля. Варианты: `"tunnel-up"` `"tunnel-down"`
vdom string	Виртуальный домен из числа предварительно определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Condition for automation stitches.
  fortinet.fortios.fortios_system_automation_condition:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_automation_condition:
          condition_type: "cpu"
          cpu_usage_percent: "0"
          description: "<your_own_value>"
          mem_usage_percent: "0"
          name: "default_name_7"
          vdom: "<your_own_value> (source system.vdom.name)"
          vpn_tunnel_name: "<your_own_value>"
          vpn_tunnel_state: "tunnel-up"

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

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

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