Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_casb_user_activity — Настройка активности пользователей CASB в Fortinet FortiOS и FortiGate.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_casb_user_activity.

Добавлено в fortinet.fortios 2.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры категорий casb и user_activity. Примеры включают все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Протестировано с FOS v6.0.0

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создается в графическом интерфейсе Fortigate.

casb_user_activity

dictionary

Настройка действий пользователя CASB.

application

string

Имя SaaS-приложения CASB. Источник: casb.saas-application.name.

casb_name

string

Имя сигнатуры действия пользователя CASB.

category

string

Категория действия пользователя CASB.

Варианты:

  • "activity-control"
  • "tenant-control"
  • "domain-control"
  • "safe-search-control"
  • "advanced-tenant-control"
  • "other"

control_options

list / elements=dictionary

Параметры управления CASB.

name

string / обязательный

Имя параметра управления CASB.

operations

list / elements=dictionary

Операции параметра управления CASB.

action

string

Действие операции CASB.

Варианты:

  • "append"
  • "prepend"
  • "replace"
  • "new"
  • "new-on-not-found"
  • "delete"

case_sensitive

string

Учитывать регистр при поиске в операции CASB.

Варианты:

  • "enable"
  • "disable"

direction

string

Направление операции CASB.

Варианты:

  • "request"
  • "response"

header_name

string

Имя заголовка для поиска в операции CASB.

name

string / обязательный

Имя операции параметра управления CASB.

search_key

string

Ключ для поиска в операции CASB.

search_pattern

string

Шаблон поиска операции CASB.

Варианты:

  • "simple"
  • "substr"
  • "regexp"

target

string

Цель операции CASB.

Варианты:

  • "header"
  • "path"
  • "body"

value_from_input

string

Включить/отключить получение значения из пользовательского ввода.

Варианты:

  • "enable"
  • "disable"

value_name_from_input

string

Имя значения операции CASB, получаемое из пользовательского ввода.

values

list / elements=dictionary

Новые значения операции CASB.

value

string / обязательный

Значение операции.

status

string

Статус параметра управления CASB.

Варианты:

  • "enable"
  • "disable"

description

string

Описание действия пользователя CASB.

match

list / elements=dictionary

Правила сопоставления действий пользователя CASB.

id

integer / обязательный

Идентификатор правил сопоставления действий пользователя CASB. См. <a href=’#notes’>Примечания</a>.

rules

list / elements=dictionary

Правила действий пользователя CASB.

body_type

string

Тип тела правила сопоставления действий пользователя CASB.

Варианты:

  • "json"

case_sensitive

string

Учитывать регистр при сопоставлении действий пользователя CASB.

Варианты:

  • "enable"
  • "disable"

domains

list / elements=dictionary

Список доменов для действий пользователя CASB.

domain

string / обязательный

Список доменов, разделенных пробелами.

header_name

string

Имя заголовка правила действия пользователя CASB.

id

integer / обязательный

Идентификатор правила действия пользователя CASB. См. <a href=’#notes’>Примечания</a>.

jq

string

Сценарий jq для сопоставления правила действия пользователя CASB.

match_pattern

string

Шаблон сопоставления правила действия пользователя CASB.

Варианты:

  • "simple"
  • "substr"
  • "regexp"

match_value

string

Значение сопоставления правила действия пользователя CASB.

methods

list / elements=dictionary

Список методов действий пользователя CASB.

method

string / обязательный

Метод действия пользователя.

negate

string

Включить/отключить отрицание условия стратегии сопоставления.

Варианты:

  • "enable"
  • "disable"

type

string

Тип правила действия пользователя CASB.

Варианты:

  • "domains"
  • "host"
  • "path"
  • "header"
  • "header-value"
  • "method"
  • "body"

strategy

string

Стратегия правил действий пользователя CASB.

Варианты:

  • "and"
  • "or"

tenant_extraction

dictionary

Извлечение арендатора из действий пользователя CASB.

filters

list / elements=dictionary

Фильтры извлечения арендатора из действий пользователя CASB.

body_type

string

Тип тела фильтра извлечения арендатора CASB.

Варианты:

  • "json"

direction

string

Направление фильтра извлечения арендатора CASB.

Варианты:

  • "request"
  • "response"

header_name

string

Имя заголовка фильтра извлечения арендатора CASB.

id

integer / обязательный

Идентификатор фильтра извлечения арендатора CASB. См. <a href=’#notes’>Примечания</a>.

place

string

Тип места фильтра извлечения арендатора CASB.

Варианты:

  • "path"
  • "header"
  • "body"

jq

string

Сценарий jq для извлечения арендатора из действий пользователя CASB.

status

string

Включить/отключить извлечение арендатора CASB.

Варианты:

  • "disable"
  • "enable"

type

string

Тип извлечения арендатора из действий пользователя CASB.

Варианты:

  • "json-query"

match_strategy

string

Стратегия сопоставления действий пользователя CASB.

Варианты:

  • "and"
  • "or"

name

string / обязательный

Имя действия пользователя CASB.

status

string

Статус действия пользователя CASB.

Варианты:

  • "enable"
  • "disable"

type

string

Тип действия пользователя CASB.

Варианты:

  • "built-in"
  • "customized"

uuid

string

Универсальный уникальный идентификатор (UUID; присваивается автоматически, но может быть сброшен вручную).

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, над которым выполняется операция.

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

Параметр с указанным member_path можно использовать для выполнения операции над элементом.

member_state

string

Добавить или удалить элемент по указанному пути атрибута.

Если указан member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

string / обязательный

Указывает, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi больше не поддерживается; для запуска сценариев предпочтительно использовать httpapi.
  • Модуль поддерживает check_mode.

Примеры

- name: Configure CASB user activity.
  fortinet.fortios.fortios_casb_user_activity:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      casb_user_activity:
          application: "<your_own_value> (source casb.saas-application.name)"
          casb_name: "<your_own_value>"
          category: "activity-control"
          control_options:
              -
                  name: "default_name_7"
                  operations:
                      -
                          action: "append"
                          case_sensitive: "enable"
                          direction: "request"
                          header_name: "<your_own_value>"
                          name: "default_name_13"
                          search_key: "<your_own_value>"
                          search_pattern: "simple"
                          target: "header"
                          value_from_input: "enable"
                          value_name_from_input: "<your_own_value>"
                          values:
                              -
                                  value: "<your_own_value>"
                  status: "enable"
          description: "<your_own_value>"
          match:
              -
                  id: "24"
                  rules:
                      -
                          body_type: "json"
                          case_sensitive: "enable"
                          domains:
                              -
                                  domain: "<your_own_value>"
                          header_name: "<your_own_value>"
                          id: "31"
                          jq: "<your_own_value>"
                          match_pattern: "simple"
                          match_value: "<your_own_value>"
                          methods:
                              -
                                  method: "<your_own_value>"
                          negate: "enable"
                          type: "domains"
                  strategy: "and"
                  tenant_extraction:
                      filters:
                          -
                              body_type: "json"
                              direction: "request"
                              header_name: "<your_own_value>"
                              id: "45"
                              place: "path"
                      jq: "<your_own_value>"
                      status: "disable"
                      type: "json-query"
          match_strategy: "and"
          name: "default_name_51"
          status: "enable"
          type: "built-in"
          uuid: "<your_own_value>"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, полученный от FortiGate при выполнении последней операции

Возвращается: всегда

Пример: "200"

mkey

string

Мастер-ключ (идентификатор), использованный при последнем обращении к FortiGate

Возвращается: при успехе

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер ревизии

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

Возвращается: всегда

Пример: "success"

vdom

string

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки коллекции

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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/fortios/fortios_casb_user_activity_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API