Spec-Zone.ru › Ansible

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

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

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

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

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

dictionary

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

accprofile

string

Профиль доступа для действия со скриптом CLI, определяющий доступ к функциям FortiGate. Источник: system.accprofile.name.

action_type

string

Тип действия.

Варианты:

  • "email"
  • "fortiexplorer-notification"
  • "alert"
  • "disable-ssid"
  • "system-actions"
  • "quarantine"
  • "quarantine-forticlient"
  • "quarantine-nsx"
  • "quarantine-fortinac"
  • "ban-ip"
  • "aws-lambda"
  • "azure-function"
  • "google-cloud-function"
  • "alicloud-function"
  • "webhook"
  • "cli-script"
  • "diagnose-script"
  • "regular-expression"
  • "slack-notification"
  • "microsoft-teams-notification"
  • "ios-notification"

alicloud_access_key_id

string

Идентификатор AccessKey AliCloud.

alicloud_access_key_secret

string

Секретный ключ AccessKey AliCloud.

alicloud_account_id

string

Идентификатор учётной записи AliCloud.

alicloud_function

string

Имя функции AliCloud.

alicloud_function_authorization

string

Тип авторизации функции AliCloud.

Варианты:

  • "anonymous"
  • "function"

alicloud_function_domain

string

Домен функции AliCloud.

alicloud_region

string

Регион AliCloud.

alicloud_service

string

Имя службы AliCloud.

alicloud_version

string

Версия AliCloud.

aws_api_id

string

Идентификатор AWS API Gateway.

aws_api_key

string

Ключ API AWS API Gateway.

aws_api_path

string

Путь AWS API Gateway.

aws_api_stage

string

Имя этапа развёртывания AWS API Gateway.

aws_domain

string

Домен AWS.

aws_region

string

Регион AWS.

azure_api_key

string

Ключ API функции Azure.

azure_app

string

Имя приложения функции Azure.

azure_domain

string

Домен функции Azure.

azure_function

string

Имя функции Azure.

azure_function_authorization

string

Уровень авторизации функции Azure.

Варианты:

  • "anonymous"
  • "function"
  • "admin"

delay

integer

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

description

string

Описание.

duration

integer

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

email_body

string

Текст электронного письма.

email_from

string

Имя отправителя электронного письма.

email_subject

string

Тема электронного письма.

email_to

list / elements=dictionary

Адреса электронной почты.

name

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

Адрес электронной почты.

execute_security_fabric

string

Включить или отключить выполнение скрипта CLI на всех устройствах FortiGate или только на одном устройстве в Security Fabric.

Варианты:

  • "enable"
  • "disable"

file_only

string

Включить или отключить вывод только в файлы.

Варианты:

  • "enable"
  • "disable"

form_data

list / elements=dictionary

Части данных формы для типа содержимого multipart/form-data.

id

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

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

key

string

Ключ части Multipart/form-data.

value

string

Значение части Multipart/form-data.

forticare_email

string

Включить или отключить использование адреса электронной почты FortiCare в качестве адреса получателя.

Варианты:

  • "enable"
  • "disable"

fos_message

string

Содержимое сообщения.

gcp_function

string

Имя функции Google Cloud.

gcp_function_domain

string

Домен функции Google Cloud.

gcp_function_region

string

Регион функции Google Cloud.

gcp_project

string

Имя проекта Google Cloud Platform.

headers

list / elements=dictionary

Заголовки запроса.

header

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

Заголовок запроса.

http_body

string

Тело запроса (при необходимости). Должно быть сериализованной строкой JSON.

http_headers

list / elements=dictionary

Заголовки запроса.

id

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

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

key

string

Ключ заголовка запроса.

value

string

Значение заголовка запроса.

log_debug_print

string

Включить или отключить запись в журнал отладочного вывода действия diagnose.

Варианты:

  • "enable"
  • "disable"

message_type

string

Тип сообщения.

Варианты:

  • "text"
  • "json"
  • "form-data"

method

string

Метод запроса (POST, PUT, GET, PATCH или DELETE).

Варианты:

  • "post"
  • "put"
  • "get"
  • "patch"
  • "delete"

minimum_interval

integer

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

name

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

Имя.

output_interval

integer

Собирать вывод через указанные интервалы в секундах (0 = без промежуточного вывода).

output_size

integer

Ограничение размера вывода скрипта в мегабайтах (1–1024).

port

integer

Порт протокола.

protocol

string

Протокол запроса.

Варианты:

  • "http"
  • "https"

regular_expression

string

Строка регулярного выражения.

replacement_message

string

Включить или отключить сообщение замены.

Варианты:

  • "enable"
  • "disable"

replacemsg_group

string

Группа сообщений замены. Источник: system.replacemsg-group.name.

required

string

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

Варианты:

  • "enable"
  • "disable"

script

string

Скрипт CLI.

sdn_connector

list / elements=dictionary

Имена коннекторов NSX SDN.

name

string / required

Имя коннектора SDN. Источник: system.sdn-connector.name.

security_tag

string

Тег безопасности NSX.

system_action

string

Тип системного действия.

Варианты:

  • "reboot"
  • "shutdown"
  • "backup-config"

timeout

integer

Максимальное время выполнения этого скрипта в секундах (0 = без ограничения времени).

tls_certificate

string

Пользовательский сертификат TLS для запроса API. Источник: certificate.local.name.

uri

string

URI запроса API.

verify_host_cert

string

Включить или отключить проверку сертификата удалённого узла.

Варианты:

  • "enable"
  • "disable"

vdom

string

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

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

Примечания

Примечание

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

Примеры

- name: Action for automation stitches.
  fortinet.fortios.fortios_system_automation_action:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_automation_action:
          accprofile: "<your_own_value> (source system.accprofile.name)"
          action_type: "email"
          alicloud_access_key_id: "<your_own_value>"
          alicloud_access_key_secret: "<your_own_value>"
          alicloud_account_id: "<your_own_value>"
          alicloud_function: "<your_own_value>"
          alicloud_function_authorization: "anonymous"
          alicloud_function_domain: "<your_own_value>"
          alicloud_region: "<your_own_value>"
          alicloud_service: "<your_own_value>"
          alicloud_version: "<your_own_value>"
          aws_api_id: "<your_own_value>"
          aws_api_key: "<your_own_value>"
          aws_api_path: "<your_own_value>"
          aws_api_stage: "<your_own_value>"
          aws_domain: "<your_own_value>"
          aws_region: "<your_own_value>"
          azure_api_key: "<your_own_value>"
          azure_app: "<your_own_value>"
          azure_domain: "<your_own_value>"
          azure_function: "<your_own_value>"
          azure_function_authorization: "anonymous"
          delay: "0"
          description: "<your_own_value>"
          duration: "5"
          email_body: "<your_own_value>"
          email_from: "<your_own_value>"
          email_subject: "<your_own_value>"
          email_to:
              -
                  name: "default_name_32"
          execute_security_fabric: "enable"
          file_only: "enable"
          form_data:
              -
                  id: "36"
                  key: "<your_own_value>"
                  value: "<your_own_value>"
          forticare_email: "enable"
          fos_message: "<your_own_value>"
          gcp_function: "<your_own_value>"
          gcp_function_domain: "<your_own_value>"
          gcp_function_region: "<your_own_value>"
          gcp_project: "<your_own_value>"
          headers:
              -
                  header: "<your_own_value>"
          http_body: "<your_own_value>"
          http_headers:
              -
                  id: "49"
                  key: "<your_own_value>"
                  value: "<your_own_value>"
          log_debug_print: "enable"
          message_type: "text"
          method: "post"
          minimum_interval: "0"
          name: "default_name_56"
          output_interval: "0"
          output_size: "10"
          port: "0"
          protocol: "http"
          regular_expression: "<your_own_value>"
          replacement_message: "enable"
          replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
          required: "enable"
          script: "<your_own_value>"
          sdn_connector:
              -
                  name: "default_name_67 (source system.sdn-connector.name)"
          security_tag: "<your_own_value>"
          system_action: "reboot"
          timeout: "0"
          tls_certificate: "<your_own_value> (source certificate.local.name)"
          uri: "<your_own_value>"
          verify_host_cert: "enable"

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

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

Ключ

Описание

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_action_module.html

Spec-Zone.ru

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