модуль fortinet.fortimanager.fmgr_casb_useractivity_match – правила сопоставления действий пользователей CASB.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.3.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Возможные значения: `false` ← (по умолчанию) `true`
casb_useractivity_match dictionary	Набор параметров верхнего уровня.
id integer / обязательный	Идентификатор правил сопоставления действий пользователей CASB.
rules list / elements=dictionary	Правила.
body_type псевдонимы: body-type string	Тип тела правила сопоставления действий пользователей CASB. Возможные значения: `"json"`
case_sensitive псевдонимы: case-sensitive string	Учитывать ли регистр при сопоставлении действий пользователей CASB. Возможные значения: `"disable"` `"enable"`
domains list / elements=string	Список доменов действий пользователей CASB.
header_name псевдонимы: header-name string	Имя заголовка правила действий пользователей CASB.
id integer	Идентификатор правила действий пользователей CASB.
jq string	Скрипт jq для сопоставления правила действий пользователей CASB.
match_pattern псевдонимы: match-pattern string	Шаблон сопоставления правила действий пользователей CASB. Возможные значения: `"simple"` `"substr"` `"regexp"`
match_value псевдонимы: match-value string	Значение сопоставления правила действий пользователей CASB.
methods list / elements=string	Список методов действий пользователей CASB.
negate string	Включить или отключить инверсию условия сопоставления. Возможные значения: `"disable"` `"enable"`
type string	Тип правила действий пользователей CASB. Возможные значения: `"domains"` `"host"` `"path"` `"header"` `"header-value"` `"method"` `"body"`
strategy string	Стратегия правил действий пользователей CASB. Возможные значения: `"or"` `"and"`
tenant_extraction псевдонимы: tenant-extraction dictionary	Извлечение арендатора.
filters list / elements=dictionary	Фильтры.
body_type псевдонимы: body-type string	Тип тела фильтра извлечения арендатора CASB. Возможные значения: `"json"`
direction string	Направление фильтра извлечения арендатора CASB. Возможные значения: `"request"` `"response"`
header_name псевдонимы: header-name string	Имя заголовка фильтра извлечения арендатора CASB.
id integer	Идентификатор фильтра извлечения арендатора CASB.
place string	Тип расположения фильтра извлечения арендатора CASB. Возможные значения: `"path"` `"header"` `"body"`
jq string	Скрипт jq для извлечения арендатора из действий пользователей CASB.
status string	Включить или отключить извлечение арендатора CASB. Возможные значения: `"disable"` `"enable"`
type string	Тип извлечения арендатора из действий пользователей CASB. Возможные значения: `"json-query"`
enable_log boolean	Включить или отключить ведение журнала для задачи. Возможные значения: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Возможные значения: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия неудачного выполнения.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Возможные значения: `"present"` `"absent"`
user-activity string	Устарело, используйте “user_activity”
user_activity string	Параметр (user-activity) в запрошенном URL.
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочего пространства. Значением может быть global или другой ADOM, включая 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: CASB user activity match rules.
      fortinet.fortimanager.fmgr_casb_useractivity_match:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        user_activity: <your own value>
        state: present # <value in [present, absent]>
        casb_useractivity_match:
          id: 0 # Required variable, integer
          # rules:
          #   - case_sensitive: <value in [disable, enable]>
          #     domains: <list or string>
          #     header_name: <string>
          #     id: <integer>
          #     match_pattern: <value in [simple, substr, regexp]>
          #     match_value: <string>
          #     methods: <list or string>
          #     negate: <value in [disable, enable]>
          #     type: <value in [domains, host, path, ...]>
          #     body_type: <value in [json]>
          #     jq: <string>
          # strategy: <value in [or, and]>
          # tenant_extraction:
          #   filters:
          #     - body_type: <value in [json]>
          #       direction: <value in [request, response]>
          #       header_name: <string>
          #       id: <integer>
          #       place: <value in [path, header, body]>
          #   jq: <string>
          #   status: <value in [disable, enable]>
          #   type: <value in [json-query]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный запрошенный URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=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_useractivity_match_module.html