Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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.
  • В примерах указаны все параметры и значения, которые необходимо скорректировать с учётом источников данных перед использованием.

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

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

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров.

Варианты:

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

casb_useractivity

dictionary

Набор параметров верхнего уровня.

application

string

Название SaaS-приложения CASB.

casb_name

aliases: casb-name

string

Название сигнатуры активности пользователя CASB.

category

string

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

Варианты:

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

control_options

aliases: control-options

list / elements=dictionary

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

name

string

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

operations

list / elements=dictionary

Операции.

action

string

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

Варианты:

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

case_sensitive

aliases: case-sensitive

string

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

Варианты:

  • "disable"
  • "enable"

direction

string

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

Варианты:

  • "request"
  • "response"

header_name

aliases: header-name

string

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

name

string

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

search_key

aliases: search-key

string

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

search_pattern

aliases: search-pattern

string

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

Варианты:

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

target

string

Целевой объект операции CASB.

Варианты:

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

value_from_input

aliases: value-from-input

string

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

Варианты:

  • "disable"
  • "enable"

value_name_from_input

aliases: value-name-from-input

string

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

values

list / elements=string

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

status

string

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

Варианты:

  • "disable"
  • "enable"

description

string

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

match

list / elements=dictionary

Сопоставление.

id

integer

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

rules

list / elements=dictionary

Правила.

body_type

aliases: body-type

string

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

Варианты:

  • "json"

case_sensitive

aliases: case-sensitive

string

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

Варианты:

  • "disable"
  • "enable"

domains

list / elements=string

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

header_name

aliases: header-name

string

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

id

integer

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

jq

string

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

match_pattern

aliases: match-pattern

string

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

Варианты:

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

match_value

aliases: match-value

string

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

methods

list / elements=string

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

negate

string

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

Варианты:

  • "disable"
  • "enable"

type

string

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

Варианты:

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

strategy

string

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

Варианты:

  • "or"
  • "and"

tenant_extraction

aliases: tenant-extraction

dictionary

Извлечение арендатора.

filters

list / elements=dictionary

Фильтры.

body_type

aliases: body-type

string

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

Варианты:

  • "json"

direction

string

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

Варианты:

  • "request"
  • "response"

header_name

aliases: header-name

string

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

id

integer

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

place

string

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

Варианты:

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

jq

string

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

status

string

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

Варианты:

  • "disable"
  • "enable"

type

string

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

Варианты:

  • "json-query"

match_strategy

aliases: match-strategy

string

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

Варианты:

  • "or"
  • "and"

name

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

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

status

string

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

Варианты:

  • "disable"
  • "enable"

type

string

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

Варианты:

  • "built-in"
  • "customized"

uuid

string

Универсальный уникальный идентификатор

enable_log

boolean

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

Варианты:

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

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

string

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, которыми переопределяются условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, которыми переопределяются условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

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

Директива для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

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: Configure CASB user activity.
      fortinet.fortimanager.fmgr_casb_useractivity:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        casb_useractivity:
          name: "your value" # Required variable, string
          # 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, response]>
          #         header_name: <string>
          #         name: <string>
          #         search_key: <string>
          #         search_pattern: <value in [simple, substr, regexp]>
          #         target: <value in [header, path, body]>
          #         value_from_input: <value in [disable, enable]>
          #         values: <list or string>
          #         value_name_from_input: <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, ...]>
          #         body_type: <value in [json]>
          #         jq: <string>
          #     strategy: <value in [or, and]>
          #     tenant_extraction:
          #       filters:
          #         - body_type: <value in [json]>
          #           direction: <value in [request, response]>
          #           header_name: <string>
          #           id: <integer>
          #           place: <value in [path, header, body]>
          #       jq: <string>
          #       status: <value in [disable, enable]>
          #       type: <value in [json-query]>
          # match_strategy: <value in [or, and]>
          # type: <value in [built-in, customized]>
          # uuid: <string>
          # status: <value in [disable, enable]>

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

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

Ключ

Описание

meta

dictionary

Результат запроса.

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

request_url

string

Полный URL запроса.

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

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

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

Пример: 0

response_data

list / elements=string

Ответ API.

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

response_message

string

Описание ответа API.

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

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

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

rc

integer

Статус запроса.

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

Пример: 0

version_check_warning

list / elements=string

Предупреждение, если используемые в сценарии параметры не поддерживаются текущей версией 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_module.html

Spec-Zone.ru

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