fortinet.fortios.fortios_system_automation_action – Действие для автоматизации операций в FortiOS и FortiGate Fortinet.

Примечание

Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).

Для его установки используйте: ansible-galaxy collection install fortinet.fortios.

Чтобы использовать его в книге задач, укажите: fortinet.fortios.fortios_system_automation_action.

Новое в версии 2.9: модуля fortinet.fortios

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять системные функции и категорию automation_action. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0.

Требования

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

ansible>=2.9.0

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
access_token строка				Аутентификация на основе токена. Сгенерировано в GUI Fortigate.
state строка / обязательно			Варианты: present absent	Указывает, нужно ли создать или удалить объект.
system_automation_action словарь				Действие для автоматизации операций.
	action_type строка		Варианты: email ios-notification alert disable-ssid quarantine quarantine-forticlient ban-ip aws-lambda webhook	Тип действия.
	aws_api_id строка			Идентификатор AWS API Gateway.
	aws_api_key строка			Ключ API AWS API Gateway.
	aws_api_path строка			Путь AWS API Gateway.
	aws_api_stage строка			Имя этапа развертывания AWS API Gateway.
	aws_region строка			Регион AWS.
	email_subject строка			Тема письма.
	email_to список / элементы=строка			Электронные адреса.
		name строка / обязательно		Электронный адрес.
	headers список / элементы=строка			Заголовки запроса.
		header строка / обязательно		Заголовок запроса.
	http_body строка			Тело запроса (при необходимости). Должно быть сериализованной строкой json.
	method строка		Варианты: post put get	Метод запроса (GET, POST или PUT).
	minimum_interval целое число			Ограничить выполнение не более чем один раз в этом интервале (в секундах).
	name строка / обязательно			Имя.
	port целое число			Порт протокола.
	protocol строка		Варианты: http https	Протокол запроса.
	uri строка			URI API запроса.
vdom строка			Значение по умолчанию: "root"	Виртуальная доменная область, среди тех, что определены ранее. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

Примечания

Примечание

Модуль fortiosapi устарел, httpapi предпочтительнее для выполнения playbooks.

Примеры

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Action for automation stitches.
    fortios_system_automation_action:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_automation_action:
        action_type: "email"
        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_region: "<your_own_value>"
        email_subject: "<your_own_value>"
        email_to:
         -
            name: "default_name_11"
        headers:
         -
            header: "<your_own_value>"
        http_body: "<your_own_value>"
        method: "post"
        minimum_interval: "16"
        name: "default_name_17"
        port: "18"
        protocol: "http"
        uri: "<your_own_value>"

Значения возврата

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

Ключ	Возвращаемое значение	Описание
build строка	всегда	Номер сборки образа fortigate Пример: 1547
http_method строка	всегда	Последний метод, используемый для предоставления содержимого в FortiGate Пример: PUT
http_status строка	всегда	Последний результат, полученный от FortiGate при последнем примененном действии Пример: 200
mkey строка	успех	Главный ключ (id), используемый при последнем обращении к FortiGate Пример: id
name строка	всегда	Имя таблицы, используемой для выполнения запроса Пример: urlfilter
path строка	всегда	Путь таблицы, используемой для выполнения запроса Пример: webfilter
revision строка	всегда	Внутренний номер ревизии Пример: 17.0.2.10658
serial строка	всегда	Серийный номер устройства Пример: FGVMEVYYQT3AB5352
status строка	всегда	Указание результата операции Пример: успех
vdom строка	всегда	Используемая виртуальная доменная область Пример: root
version строка	всегда	Версия 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_system_automation_action_module.html