Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_system_automation_stitch — цепочки автоматизации в 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_stitch.

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

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

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

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

dictionary

Цепочки автоматизации.

action

list / elements=dictionary

Имена действий.

name

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

Имя действия. Источник: system.automation-action.name.

actions

list / elements=dictionary

Настройка действий цепочки.

action

string

Имя действия. Источник: system.automation-action.name.

delay

integer

Задержка перед выполнением (в секундах).

id

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

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

required

string

Обязательность в цепочке действий.

Варианты:

  • "enable"
  • "disable"

condition

list / elements=dictionary

Условия автоматизации.

name

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

Имя условия. Источник: system.automation-condition.name.

condition_logic

string

Применить логику AND/OR к указанным условиям автоматизации.

Варианты:

  • "and"
  • "or"

description

string

Описание.

destination

list / elements=dictionary

Серийные номера или имена групп HA устройств назначения.

name

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

Имя назначения. Источник: system.automation-destination.name.

name

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

Имя.

status

string

Включить или отключить эту цепочку.

Варианты:

  • "enable"
  • "disable"

trigger

string

Имя триггера. Источник: system.automation-trigger.name.

vdom

string

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

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

Примечания

Примечание

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

Примеры

- name: Automation stitches.
  fortinet.fortios.fortios_system_automation_stitch:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_automation_stitch:
          action:
              -
                  name: "default_name_4 (source system.automation-action.name)"
          actions:
              -
                  action: "<your_own_value> (source system.automation-action.name)"
                  delay: "0"
                  id: "8"
                  required: "enable"
          condition:
              -
                  name: "default_name_11 (source system.automation-condition.name)"
          condition_logic: "and"
          description: "<your_own_value>"
          destination:
              -
                  name: "default_name_15 (source system.automation-destination.name)"
          name: "default_name_16"
          status: "enable"
          trigger: "<your_own_value> (source system.automation-trigger.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_stitch_module.html

Spec-Zone.ru

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