Модуль fortinet.fortios.fortios_system_automation_action – Действие для автоматизации швов в FortiOS и FortiGate Fortinet.

Примечание

Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).

Возможно, эта коллекция уже установлена, если вы используете пакет 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.15

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токенов. Сгенерировано в интерфейсе Fortigate.
enable_log логический тип	Включить/отключить ведение журнала для задачи. Выбор: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту элемента для обработки. Разделяется символом косой черты, если атрибутов несколько. Параметр, помеченный как member_path, подходит для выполнения операций с элементами.
member_state строка	Добавить или удалить элемент по указанному пути атрибута. Если указан member_state, опция state игнорируется. Выбор: `"present"` `"absent"`
state строка / обязательно	Указывает, нужно ли создать или удалить объект. Выбор: `"present"` `"absent"`
system_automation_action словарь	Действие для автоматизации.
accprofile строка	Профиль доступа для действия скрипта командной строки для доступа к функциям FortiGate. Имя параметра source.system.accprofile.
action_type строка	Тип действия. Выбор: `"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"` `"slack-notification"` `"microsoft-teams-notification"` `"ios-notification"`
alicloud_access_key_id строка	Идентификатор ключа доступа AliCloud.
alicloud_access_key_secret строка	Секретный ключ доступа AliCloud.
alicloud_account_id строка	Идентификатор учетной записи AliCloud.
alicloud_function строка	Имя функции AliCloud.
alicloud_function_authorization строка	Тип авторизации функции AliCloud. Выбор: `"anonymous"` `"function"`
alicloud_function_domain строка	Домен функции AliCloud.
alicloud_region строка	Регион AliCloud.
alicloud_service строка	Имя сервиса AliCloud.
alicloud_version строка	Версия AliCloud.
aws_api_id строка	Идентификатор шлюза API AWS.
aws_api_key строка	Ключ API шлюза API AWS.
aws_api_path строка	Путь шлюза API AWS.
aws_api_stage строка	Имя этапа развертывания шлюза API AWS.
aws_domain строка	Домен 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	Описание.
email_body string	Тело письма.
email_from string	Имя отправителя письма.
email_subject string	Тема письма.
email_to list / elements=dictionary	Электронные адреса.
name string / обязательно	Электронный адрес.
execute_security_fabric string	Включить/выключить выполнение скрипта командной строки на всех или только на одном устройстве FortiGate в Security Fabric. Варианты: `"enable"` `"disable"`
forticare_email string	Включить/выключить использование вашего электронного адреса FortiCare в качестве адреса email-to. Варианты: `"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	Заголовки запроса.

END_OF_DOCUMENT_MARKER

id integer / required	Идентификатор записи. См. <a href=’#notes’>Примечания</a>.
key string	Ключ заголовка запроса.
value string	Значение заголовка запроса.
message_type string	Тип сообщения. Варианты: `"text"` `"json"`
method string	Метод запроса (POST, PUT, GET, PATCH или DELETE). Варианты: `"post"` `"put"` `"get"` `"patch"` `"delete"`
minimum_interval integer	Ограничение выполнения не чаще одного раза за этот интервал (в секундах).
name string / required	Имя.
output_size integer	Количество мегабайт, до которого следует ограничить вывод скрипта (1 - 1024).
port integer	Порт протокола.
protocol string	Протокол запроса. Варианты: `"http"` `"https"`
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, который можно настроить и использовать как отдельный модуль.

Default: "root"

Примечания

Примечание

Устаревший fortiosapi был объявлен устаревшим, httpapi — предпочтительный способ запуска playbooks
Модуль поддерживает 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>"
          email_body: "<your_own_value>"
          email_from: "<your_own_value>"
          email_subject: "<your_own_value>"
          email_to:
              -
                  name: "default_name_31"
          execute_security_fabric: "enable"
          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: "43"
                  key: "<your_own_value>"
                  value: "<your_own_value>"
          message_type: "text"
          method: "post"
          minimum_interval: "0"
          name: "default_name_49"
          output_size: "10"
          port: "0"
          protocol: "http"
          replacement_message: "enable"
          replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
          required: "enable"
          script: "<your_own_value>"
          sdn_connector:
              -
                  name: "default_name_58 (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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_automation_action_module.html