модуль fortinet.fortimanager.fmgr_casb_saasapplication — настройка SaaS-приложения CASB.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_casb_saasapplication.

Добавлено в fortinet.fortimanager 2.3.0

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

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

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать в соответствии с источниками данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
casb_saasapplication dictionary	Набор параметров верхнего уровня.
casb_name псевдонимы: casb-name string	Имя сигнатуры SaaS-приложения.
description string	Описание SaaS-приложения.
domains list / элементы=string	Список доменов SaaS-приложения.
input_attributes псевдонимы: input-attributes list / элементы=dictionary	Входные атрибуты.
attr_type псевдонимы: attr-type string	Тип атрибута CASB. Варианты: `"tenant"`
default string	Значение атрибута CASB по умолчанию. Варианты: `"string"` `"string-list"`
description string	Описание атрибута CASB.
fallback_input псевдонимы: fallback-input string	Устаревший ввод атрибута CASB. Варианты: `"disable"` `"enable"`
name string	Имя атрибута CASB.
required string	Обязательность атрибута CASB. Варианты: `"disable"` `"enable"`
type string	Тип формата атрибута CASB. Варианты: `"string"` `"string-list"` `"integer"` `"integer-list"` `"boolean"`
name string / обязательный	Имя SaaS-приложения.
output_attributes псевдонимы: output-attributes list / элементы=dictionary	Выходные атрибуты.
attr_type псевдонимы: attr-type string	Тип атрибута CASB. Варианты: `"tenant"`
description string	Описание атрибута CASB.
name string	Имя атрибута CASB.
optional string	Необязательный выходной атрибут CASB. Варианты: `"disable"` `"enable"`
required string	Обязательность атрибута CASB. Варианты: `"disable"` `"enable"`
type string	Тип формата атрибута CASB. Варианты: `"string"` `"string-list"` `"integer"` `"integer-list"` `"boolean"`
status string	Включение/отключение настройки. Варианты: `"disable"` `"enable"`
type string	Тип SaaS-приложения. Варианты: `"built-in"` `"customized"`
uuid string	Универсальный уникальный идентификатор
enable_log boolean	Включение/отключение ведения журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки в FortiManager, работающем в режиме рабочей области. Значением может быть global или другие значения, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все аргументы ввода именуются в соответствии с соглашением об использовании подчёркиваний (snake_case). Измените аргументы, например “var-name” на “var_name”. Старые имена аргументов по-прежнему доступны, однако будут выводиться предупреждения об устаревании. Это предупреждение можно игнорировать, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля может завершиться с ошибкой, если возвращается ненулевой код rc. Условия, при которых выполнение считается неудачным или успешным, можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure CASB SaaS application.
      fortinet.fortimanager.fmgr_casb_saasapplication:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        casb_saasapplication:
          name: "your value" # Required variable, string
          # casb_name: <string>
          # description: <string>
          # domains: <list or string>
          # type: <value in [built-in, customized]>
          # uuid: <string>
          # status: <value in [disable, enable]>
          # input_attributes:
          #   - attr_type: <value in [tenant]>
          #     default: <value in [string, string-list]>
          #     description: <string>
          #     fallback_input: <value in [disable, enable]>
          #     name: <string>
          #     required: <value in [disable, enable]>
          #     type: <value in [string, string-list, integer, ...]>
          # output_attributes:
          #   - attr_type: <value in [tenant]>
          #     description: <string>
          #     name: <string>
          #     required: <value in [disable, enable]>
          #     type: <value in [string, string-list, integer, ...]>
          #     optional: <value in [disable, enable]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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/fortimanager/fmgr_casb_saasapplication_module.html