fortinet.fortimanager.fmgr_casb_profile модуль — Настройка профиля CASB.

Примечание

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

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

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

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

Новая функция в fortinet.fortimanager 2.3.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
casb_profile словарь	Параметры верхнего уровня.
comment строка	Комментарий.
name строка / обязательно	Имя профиля CASB.
saas_application список / элементы=словарь	Устарело, пожалуйста, переименуйте на saas_application. Приложение SaaS.
access_rule список / элементы=словарь	Устарело, пожалуйста, переименуйте на access_rule. Правило доступа.
action строка	Действие правила доступа CASB. Варианты: `"block"` `"bypass"` `"monitor"`
bypass список / элементы=строка	Варианты обхода CASB. Варианты: `"av"` `"dlp"` `"web-filter"` `"file-filter"` `"video-filter"`
name строка	Имя действия правила доступа CASB.
custom_control список / элементы=словарь	Устарело, пожалуйста, переименуйте на custom_control. Пользовательское управление.
name строка	Имя пользовательского управления CASB.
option список / элементы=словарь	Параметр.
name строка	Имя параметра пользовательского управления CASB.
user_input список / элементы=строка	Устарело, пожалуйста, переименуйте на user_input. Ввод пользователя для пользовательского управления CASB.
domain_control строка	Устарело, пожалуйста, переименуйте на domain_control. Включить/выключить управление доменами. Варианты: `"disable"` `"enable"`
domain_control_domains список / элементы=строка	Устарело, пожалуйста, переименуйте на domain_control_domains. Домены управления доменами профиля CASB.
log строка	Включить/выключить настройки логирования. Варианты: `"disable"` `"enable"`
name строка	Имя приложения SaaS профиля CASB.
safe_search строка	Устарело, пожалуйста, переименуйте на safe_search. Включить/выключить безопасный поиск. Варианты: `"disable"` `"enable"`

safe-search-control список / элементы=строка	Устаревшее, пожалуйста, переименуйте на safe_search_control. Управление безопасным поиском профиля CASB.
status строка	Включение/выключение параметра. Выбора: `"disable"` `"enable"`
tenant-control строка	Устаревшее, пожалуйста, переименуйте на tenant_control. Включение/выключение управления арендаторами. Выбора: `"disable"` `"enable"`
tenant-control-tenants список / элементы=строка	Устаревшее, пожалуйста, переименуйте на tenant_control_tenants. Арендаторы управления профилем CASB.
enable_log булево	Включение/отключение ведения журнала для задачи. Выбора: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Выбора: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для завершения работы с ошибкой.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успешного завершения работы.
state строка / обязательно	Направление для создания, обновления или удаления объекта. Выбора: `"present"` `"absent"`
workspace_locking_adom строка	Область для блокировки FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure CASB profile.
      fortinet.fortimanager.fmgr_casb_profile:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        casb_profile:
          name: <string>
          saas_application:
            -
              access_rule:
                -
                  action: <value in [block, bypass, monitor]>
                  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>
              status: <value in [disable, enable]>
          comment: <string>

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_casb_profile_module.html