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

Примечание

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

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
casb_useractivity_match_rules словарь	Настройка параметров верхнего уровня.
case_sensitive строка	Устарело, пожалуйста, переименуйте на case_sensitive. CASB пользовательская активность сопоставление чувствительности к регистру. Варианты: `"disable"` `"enable"`
domains список / элементы=строка	Список доменов CASB пользовательской активности.
header_name строка	Устарело, пожалуйста, переименуйте на header_name. Название заголовка правила CASB пользовательской активности.
id целое число / обязательно	Идентификатор правила CASB пользовательской активности.
match_pattern строка	Устарело, пожалуйста, переименуйте на match_pattern. Шаблон сопоставления правила CASB пользовательской активности. Варианты: `"simple"` `"substr"` `"regexp"`
match_value строка	Устарело, пожалуйста, переименуйте на match_value. Значение сопоставления правила CASB пользовательской активности.
methods список / элементы=строка	Список методов CASB пользовательской активности.
negate строка	Включить/выключить стратегию сопоставления, которая не должна применяться. Варианты: `"disable"` `"enable"`
type строка	Тип правила CASB пользовательской активности. Варианты: `"domains"` `"host"` `"path"` `"header"` `"header-value"` `"method"`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
match строка / обязательно	Параметр (match) в запрошенном URL.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут игнорироваться.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут выполняться.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`

user-activity string	Устаревшее, используйте «user_activity»
user_activity string	Параметр (user-activity) в запрошенном URL.
workspace_locking_adom string	ADOM для блокировки в режиме работы в рабочей области FortiManager, значение может быть глобальным и другими, включая корневой.
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 помогают в этом.
Для создания или обновления объекта используйте директиву 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 user activity rules.
      fortinet.fortimanager.fmgr_casb_useractivity_match_rules:
        # 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>
        user_activity: <your own value>
        match: <your own value>
        state: present # <value in [present, absent]>
        casb_useractivity_match_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, ...]>

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

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

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