Модуль fortinet.fortios.fortios_casb_saas_application — настройка SaaS-приложения CASB в FortiOS и FortiGate от Fortinet.

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования; подробные сведения см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_casb_saas_application.

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

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

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

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.
casb_saas_application dictionary	Настройка SaaS-приложения CASB.
casb_name string	Имя сигнатуры SaaS-приложения.
description string	Описание SaaS-приложения.
domains list / elements=dictionary	Список доменов SaaS-приложения.
domain string / обязательный	Список доменов, разделенных пробелами.
input_attributes list / elements=dictionary	Входные атрибуты SaaS-приложения.
attr_type string	Тип атрибута CASB. Допустимые значения: `"tenant"`
default string	Значение атрибута CASB по умолчанию. Допустимые значения: `"string"` `"string-list"`
description string	Описание атрибута CASB.
fallback_input string	Устаревший ввод атрибута CASB. Допустимые значения: `"enable"` `"disable"`
name string / обязательный	Имя атрибута CASB.
required string	Обязательность входного атрибута CASB. Допустимые значения: `"enable"` `"disable"`
type string	Тип формата атрибута CASB. Допустимые значения: `"string"` `"string-list"` `"integer"` `"integer-list"` `"boolean"`
name string / обязательный	Имя SaaS-приложения.
output_attributes list / elements=dictionary	Выходные атрибуты SaaS-приложения.
attr_type string	Тип атрибута CASB. Допустимые значения: `"tenant"`
description string	Описание атрибута CASB.
name string / обязательный	Имя атрибута CASB.
optional string	Необязательность выходного атрибута CASB. Допустимые значения: `"enable"` `"disable"`
required string	Обязательность атрибута CASB. Допустимые значения: `"enable"` `"disable"`
type string	Тип формата атрибута CASB. Допустимые значения: `"string"` `"string-list"` `"integer"` `"integer-list"` `"boolean"`
status string	Включение или отключение параметра. Допустимые значения: `"enable"` `"disable"`
type string	Тип SaaS-приложения. Допустимые значения: `"built-in"` `"customized"`
uuid string	Универсальный уникальный идентификатор (UUID; назначается автоматически, но может быть сброшен вручную).
enable_log boolean	Включение или отключение ведения журнала для задачи. Допустимые значения: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту-члену, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции с членом.
member_state string	Добавить или удалить член по указанному пути атрибута. Если указан параметр member_state, параметр state игнорируется. Допустимые значения: `"present"` `"absent"`
state string / обязательный	Указывает, нужно ли создать или удалить объект. Допустимые значения: `"present"` `"absent"`
vdom string	Виртуальный домен из числа предварительно определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure CASB SaaS application.
  fortinet.fortios.fortios_casb_saas_application:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      casb_saas_application:
          casb_name: "<your_own_value>"
          description: "<your_own_value>"
          domains:
              -
                  domain: "<your_own_value>"
          input_attributes:
              -
                  attr_type: "tenant"
                  default: "string"
                  description: "<your_own_value>"
                  fallback_input: "enable"
                  name: "default_name_12"
                  required: "enable"
                  type: "string"
          name: "default_name_15"
          output_attributes:
              -
                  attr_type: "tenant"
                  description: "<your_own_value>"
                  name: "default_name_19"
                  optional: "enable"
                  required: "enable"
                  type: "string"
          status: "enable"
          type: "built-in"
          uuid: "<your_own_value>"

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

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

Ключ	Описание
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_casb_saas_application_module.html