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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
casb_useractivity_controloptions_operations словарь	Установленные параметры верхнего уровня.
action строка	Действие операции CASB. Варианты: `"append"` `"prepend"` `"replace"` `"new"` `"new-on-not-found"` `"delete"`
case_sensitive строка	Устарело, пожалуйста, переименуйте на case_sensitive. Поиск операции CASB, учитывающий регистр. Варианты: `"disable"` `"enable"`
direction строка	Направление операции CASB. Варианты: `"request"`
header_name строка	Устарело, пожалуйста, переименуйте на header_name. Имя заголовка операции CASB для поиска.
name строка / обязательно	Имя операции управления CASB.
search_key строка	Устарело, пожалуйста, переименуйте на search_key. Ключ операции CASB для поиска.
search_pattern строка	Устарело, пожалуйста, переименуйте на search_pattern. Шаблон поиска операции CASB. Варианты: `"simple"` `"substr"` `"regexp"`
target строка	Цель операции CASB. Варианты: `"header"` `"path"`
value_from_input строка	Устарело, пожалуйста, переименуйте на value_from_input. Включить/отключить значение из пользовательского ввода. Варианты: `"disable"` `"enable"`
values список / элементы=строка	Новые значения операции CASB.
control_options строка	Устарело, используйте «control_options»
control_options строка	Параметр (control-options) в запрошенном URL.
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"`
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 control option operations.
      fortinet.fortimanager.fmgr_casb_useractivity_controloptions_operations:
        # 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>
        control_options: <your own value>
        state: present # <value in [present, absent]>
        casb_useractivity_controloptions_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>

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

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

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