fortinet.fortimanager.fmgr_firewall_casbprofile module – Профиль CASB брандмауэра

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_casbprofile dictionary	Параметры верхнего уровня.
name string / обязательный	Имя.
saas_application псевдонимы: saas-application list / элементы=dictionary	SaaS-приложение.
access_rule псевдонимы: access-rule list / элементы=dictionary	Правило доступа.
action string	Действие. Варианты: `"block"` `"monitor"` `"bypass"`
bypass list / элементы=string	Обход. Варианты: `"av"` `"dlp"` `"web-filter"` `"file-filter"` `"video-filter"`
name string	Имя.
custom_control псевдонимы: custom-control list / элементы=dictionary	Пользовательский элемент управления.
name string	Имя.
option list / элементы=dictionary	Параметр.
name string	Имя.
user_input псевдонимы: user-input list / элементы=string	Пользовательский ввод.
domain_control псевдонимы: domain-control string	Управление доменами. Варианты: `"disable"` `"enable"`
domain_control_domains псевдонимы: domain-control-domains list / элементы=string	Домены для управления доменами.
log string	Журналирование. Варианты: `"disable"` `"enable"`
name string	Имя.
safe_search псевдонимы: safe-search string	Безопасный поиск. Варианты: `"disable"` `"enable"`
safe_search_control псевдонимы: safe-search-control list / элементы=string	Управление безопасным поиском.
tenant_control псевдонимы: tenant-control string	Управление арендаторами. Варианты: `"disable"` `"enable"`
tenant_control_tenants псевдонимы: tenant-control-tenants list / элементы=string	Арендаторы для управления арендаторами.
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: Firewall casb profile
      fortinet.fortimanager.fmgr_firewall_casbprofile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        firewall_casbprofile:
          name: "your value" # Required variable, string
          # saas_application:
          #   - access_rule:
          #       - action: <value in [block, monitor, bypass]>
          #         bypass: ["av", "dlp", "web-filter", "file-filter", "video-filter"]
          #         name: <string>
          #     custom_control:
          #       - name: <string>
          #         option:
          #           - name: <string>
          #             user_input: <list or string>
          #     domain_control: <value in [disable, enable]>
          #     domain_control_domains: <list or string>
          #     log: <value in [disable, enable]>
          #     name: <string>
          #     safe_search: <value in [disable, enable]>
          #     safe_search_control: <list or string>
          #     tenant_control: <value in [disable, enable]>
          #     tenant_control_tenants: <list or string>

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

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

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