Модуль fortinet.fortimanager.fmgr_casb_useractivity_match_rules — правила сопоставления действий пользователей CASB.

Примечание

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

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

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

Чтобы использовать её в сценарии playbook, укажите: fortinet.fortimanager.fmgr_casb_useractivity_match_rules.

Новое в 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_rules dictionary	Набор параметров верхнего уровня.
body_type псевдонимы: body-type string	Тип тела правила сопоставления действий пользователей CASB. Варианты: `"json"`
case_sensitive псевдонимы: case-sensitive string	Учитывать ли регистр при сопоставлении действий пользователей CASB. Варианты: `"disable"` `"enable"`
domains list / элементы=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 / элементы=string	Список методов действий пользователей CASB.
negate string	Включить или отключить отрицание условия сопоставления. Варианты: `"disable"` `"enable"`
type string	Тип правила действий пользователей CASB. Варианты: `"domains"` `"host"` `"path"` `"header"` `"header-value"` `"method"` `"body"`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
match string / обязательный	Параметр (match) в запрашиваемом URL.
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"`
user-activity string	Устарел; используйте “user_activity”.
user_activity string	Параметр (user-activity) в запрашиваемом URL.
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: CASB user activity rules.
      fortinet.fortimanager.fmgr_casb_useractivity_match_rules:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        user_activity: <your own value>
        match: <your own value>
        state: present # <value in [present, absent]>
        casb_useractivity_match_rules:
          id: 0 # Required variable, integer
          # case_sensitive: <value in [disable, enable]>
          # domains: <list or string>
          # header_name: <string>
          # 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>

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

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

Ключ	Описание
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	Предупреждение о том, что используемые в сценарии 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–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_rules_module.html