fortinet.fortimanager.fmgr_casb_profile_saasapplication модуль — Профиль CASB SaaS-приложения.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.3.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
casb_profile_saasapplication dictionary	Набор параметров верхнего уровня.
access-rule list / elements=dictionary	Устарело, переименуйте в access_rule. Правило доступа.
action string	Действие правила доступа CASB. Варианты: `"block"` `"bypass"` `"monitor"`
bypass list / elements=string	Варианты обхода CASB. Варианты: `"av"` `"dlp"` `"web-filter"` `"file-filter"` `"video-filter"`
name string	Имя действия правила доступа CASB.
custom-control list / elements=dictionary	Устарело, переименуйте в custom_control. Пользовательский контроль.
name string	Имя действия пользовательского контроля CASB.
option list / elements=dictionary	Опция.
name string	Имя опции пользовательского контроля CASB.
user-input list / elements=string	Устарело, переименуйте в user_input. Ввод пользователя для пользовательского контроля CASB.
domain-control string	Устарело, переименуйте в domain_control. Включить/выключить контроль доменов. Варианты: `"disable"` `"enable"`
domain-control-domains list / elements=string	Устарело, переименуйте в domain_control_domains. Домены контроля доменов профиля CASB.
log string	Включить/выключить настройки журнала. Варианты: `"disable"` `"enable"`
name string / required	Имя приложения SaaS профиля CASB.
safe-search string	Устарело, переименуйте в safe_search. Включить/выключить безопасный поиск. Варианты: `"disable"` `"enable"`
safe-search-control list / elements=string	Устарело, переименуйте в safe_search_control. Контроль безопасного поиска профиля CASB.
status string	Включить/выключить настройку. Варианты: `"disable"` `"enable"`

tenant-control string	Устаревшее, пожалуйста, переименуйте на tenant_control. Включить/выключить контроль арендатора. Варианты: `"disable"` `"enable"`
tenant-control-tenants список / элементы=строка	Устаревшее, пожалуйста, переименуйте на tenant_control_tenants. Арендаторы профиля CASB.
enable_log логический	Включить/Выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать клиент Ansible с помощью токена доступа к API forticloud.
profile строка / обязательно	Параметр (profile) в запрошенном URL.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список кодов rc, при которых будут переопределены условия для отказа.
rc_succeeded список / элементы=целое	Список кодов rc, при которых будут переопределены условия для успешного завершения.
state строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	Область, которую следует заблокировать для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корень.
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: CASB profile SaaS application.
      fortinet.fortimanager.fmgr_casb_profile_saasapplication:
        # 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>
        profile: <your own value>
        state: present # <value in [present, absent]>
        casb_profile_saasapplication:
          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]>

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

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

Ключ	Описание
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 список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_saasapplication_module.html