Модуль fortinet.fortimanager.fmgr_casb_useractivity_controloptions_operations — операции параметров управления CASB.

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_casb_useractivity_controloptions_operations.

Новое в fortinet.fortimanager 2.3.0

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
casb_useractivity_controloptions_operations dictionary	Набор параметров верхнего уровня.
action string	Действие операции CASB. Варианты: `"append"` `"prepend"` `"replace"` `"new"` `"new-on-not-found"` `"delete"`
case_sensitive псевдонимы: case-sensitive string	Учитывать регистр при поиске в операции CASB. Варианты: `"disable"` `"enable"`
direction string	Направление операции CASB. Варианты: `"request"` `"response"`
header_name псевдонимы: header-name string	Имя заголовка для поиска в операции CASB.
name string / обязательный	Имя операции параметра управления CASB.
search_key псевдонимы: search-key string	Ключ для поиска в операции CASB.
search_pattern псевдонимы: search-pattern string	Шаблон поиска операции CASB. Варианты: `"simple"` `"substr"` `"regexp"`
target string	Целевой объект операции CASB. Варианты: `"header"` `"path"` `"body"`
value_from_input псевдонимы: value-from-input string	Включить или отключить использование значения, введённого пользователем. Варианты: `"disable"` `"enable"`
value_name_from_input псевдонимы: value-name-from-input string	Имя значения операции CASB, введённое пользователем.
values list / elements=string	Новые значения операции CASB.
control-options string	Устарело, используйте «control_options»
control_options string	Параметр (control-options) в запрошенном URL.
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"`
user-activity string	Устарело, используйте «user_activity»
user_activity string	Параметр (user-activity) в запрошенном URL.
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: CASB control option operations.
      fortinet.fortimanager.fmgr_casb_useractivity_controloptions_operations:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        user_activity: <your own value>
        control_options: <your own value>
        state: present # <value in [present, absent]>
        casb_useractivity_controloptions_operations:
          name: "your value" # Required variable, string
          # action: <value in [append, prepend, replace, ...]>
          # case_sensitive: <value in [disable, enable]>
          # direction: <value in [request, response]>
          # header_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>

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

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

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