Модуль fortinet.fortimanager.fmgr_casb_useractivity_match — Правила сопоставления активности пользователей 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.

Впервые в fortinet.fortimanager 2.3.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
casb_useractivity_match словарь	Установленные параметры верхнего уровня.
id целое число / обязательно	Идентификатор правил сопоставления активности пользователей CASB.
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"`
strategy строка	Стратегия правил активности пользователя CASB. Варианты: `"or"` `"and"`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут переопределены для отказа.

END_OF_DOCUMENT_MARKER

rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
user-activity строка	Устарело, используйте «user_activity»
user_activity строка	Параметр (user-activity) в запрошенном URL.
workspace_locking_adom строка	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 user activity match rules.
      fortinet.fortimanager.fmgr_casb_useractivity_match:
        # 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>
        state: present # <value in [present, absent]>
        casb_useractivity_match:
          id: <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, ...]>
          strategy: <value in [or, and]>

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

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

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