fortinet.fortimanager.fmgr_casb_useractivity модуль — Настройка активности пользователя CASB.

Примечание

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

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_casb_useractivity.

Новая функция в fortinet.fortimanager 2.3.0

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

Описание

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
casb_useractivity dictionary	Набор параметров верхнего уровня.
application string	Имя приложения CASB SaaS.
casb-name string	Устарело, переименуйте в casb_name. Имя сигнатуры активности пользователя CASB.
category string	Категория активности пользователя CASB. Варианты: `"activity-control"` `"tenant-control"` `"domain-control"` `"safe-search-control"` `"other"`
control-options list / elements=dictionary	Устарело, переименуйте в control_options. Параметры управления.
name string	Имя параметра управления CASB.
operations list / elements=dictionary	Операции.
action string	Действие операции CASB. Варианты: `"append"` `"prepend"` `"replace"` `"new"` `"new-on-not-found"` `"delete"`
case-sensitive string	Устарело, переименуйте в case_sensitive. Регистрозависимый поиск операции CASB. Варианты: `"disable"` `"enable"`
direction string	Направление операции CASB. Варианты: `"request"`
header-name string	Устарело, переименуйте в header_name. Имя заголовка операции CASB для поиска.
name string	Имя операции параметра управления CASB.
search-key string	Устарело, переименуйте в search_key. Ключ операции CASB для поиска.
search-pattern string	Устарело, переименуйте в search_pattern. Шаблон поиска операции CASB. Варианты: `"simple"` `"substr"` `"regexp"`
target string	Целевая операция CASB. Варианты: `"header"` `"path"`
value-from-input string	Устарело, переименуйте в value_from_input. Включить/отключить значение из пользовательского ввода. Варианты: `"disable"` `"enable"`
values list / elements=string	Новые значения операции CASB.

status string	Статус опции управления CASB. Варианты: `"disable"` `"enable"`
description string	Описание пользовательской активности CASB.
match list / элементы=словарь	Соответствие.
id целое число	Идентификатор правил соответствия пользовательской активности CASB.
rules list / элементы=словарь	Правила.
case-sensitive строка	Устаревшее, переименуйте на case_sensitive. Числoвое соответствие пользовательской активности CASB. Варианты: `"disable"` `"enable"`
domains list / элементы=строка	Список доменов пользовательской активности CASB.
header-name строка	Устаревшее, переименуйте на header_name. Имя заголовка правила пользовательской активности CASB.
id целое число	Идентификатор правила пользовательской активности CASB.
match-pattern строка	Устаревшее, переименуйте на match_pattern. Шаблон соответствия правила пользовательской активности CASB. Варианты: `"simple"` `"substr"` `"regexp"`
match-value строка	Устаревшее, переименуйте на match_value. Значение соответствия правила пользовательской активности CASB.
methods list / элементы=строка	Список методов пользовательской активности CASB.
negate строка	Включить/отключить, что стратегия соответствия не должна быть. Варианты: `"disable"` `"enable"`
type строка	Тип правила пользовательской активности CASB. Варианты: `"domains"` `"host"` `"path"` `"header"` `"header-value"` `"method"`
strategy строка	Стратегия правил пользовательской активности CASB. Варианты: `"or"` `"and"`
match-strategy строка	Устаревшее, переименуйте на match_strategy. Стратегия соответствия пользовательской активности CASB. Варианты: `"or"` `"and"`
name строка / обязательно	Имя пользовательской активности CASB.
status строка	Статус пользовательской активности CASB. Варианты: `"disable"` `"enable"`
type строка	Тип пользовательской активности CASB. Варианты: `"built-in"` `"customized"`
uuid строка	Универсальный идентификатор
enable_log логический	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`

forticloud_access_token строка	Проверка подлинности клиента Ansible с помощью маркера доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут переопределены для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут переопределены для успеха.
state строка / обязательно	Направление создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
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: Configure CASB user activity.
      fortinet.fortimanager.fmgr_casb_useractivity:
        # 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>
        state: present # <value in [present, absent]>
        casb_useractivity:
          application: <string>
          casb_name: <string>
          category: <value in [activity-control, tenant-control, domain-control, ...]>
          control_options:
            -
              name: <string>
              operations:
                -
                  action: <value in [append, prepend, replace, ...]>
                  case_sensitive: <value in [disable, enable]>
                  direction: <value in [request]>
                  header_name: <string>
                  name: <string>
                  search_key: <string>
                  search_pattern: <value in [simple, substr, regexp]>
                  target: <value in [header, path]>
                  value_from_input: <value in [disable, enable]>
                  values: <list or string>
              status: <value in [disable, enable]>
          description: <string>
          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]>
          match_strategy: <value in [or, and]>
          name: <string>
          type: <value in [built-in, customized]>
          uuid: <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_useractivity_module.html