fortios_system_automation_action – Модуль действий для автоматизации в Fortinet’s FortiOS и FortiGate

Новая версия 2.9.

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

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

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

Требования

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

fortiosapi>=0.9.8

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
host строка				IP-адрес FortiOS или FortiGate.
https булево			Варианты: no да ←	Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
password строка			Значение по умолчанию: ""	Пароль FortiOS или FortiGate.
ssl_verify булево			Варианты: no да ←	Обеспечивает проверку сертификата FortiGate надёжным центром сертификации.
state строка / обязательно			Варианты: present absent	Указывает, нужно ли создать или удалить объект.
system_automation_action словарь			Значение по умолчанию: null	Действие для автоматизации соединений.
	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_domain строка			Домен AWS.
	aws_region строка			Регион AWS.
	delay целое число			Задержка перед выполнением (в секундах).
	email_subject строка			Тема письма.
	email_to список			Электронные адреса.
		name строка / обязательно		Электронный адрес.
	headers список			Заголовки запроса.
		header строка / обязательно		Заголовок запроса.
	http_body строка			Тело запроса (при необходимости). Должно быть сериализованной строкой JSON.
	method строка		Варианты: post put get	Метод запроса (GET, POST или PUT).
	minimum_interval целое число			Ограничить выполнение не более одного раза в этом интервале (в секундах).
	name строка / обязательно			Имя.
	port целое число			Порт протокола.
	protocol строка		Варианты: http https	Протокол запроса.
	required строка		Варианты: enable disable	Обязательно в цепочке действий.
	uri строка			URI запроса API.
username строка				Имя пользователя FortiOS или FortiGate.
vdom строка			Значение по умолчанию: "root"	Виртуальная область (vdom), определённая ранее. VDOM — виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный блок.

Примечания

Примечание

Требует библиотеку fortiosapi, разработанную Fortinet
Выполняется как local_action в вашей книге задач

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Action for automation stitches.
    fortios_system_automation_action:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      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_domain: "<your_own_value>"
        aws_region: "<your_own_value>"
        delay: "10"
        email_subject: "<your_own_value>"
        email_to:
         -
            name: "default_name_13"
        headers:
         -
            header: "<your_own_value>"
        http_body: "<your_own_value>"
        method: "post"
        minimum_interval: "18"
        name: "default_name_19"
        port: "20"
        protocol: "http"
        required: "enable"
        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

Статус

Не гарантируется обратная совместимость этого модуля. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/fortios_system_automation_action_module.html