Модуль fortinet.fortimanager.fmgr_casb_profile_saasapplication_customcontrol — пользовательское управление профилем CASB.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить коллекцию, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_casb_profile_saasapplication_customcontrol.
Добавлено в fortinet.fortimanager 2.3.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрашиваемом URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager: модуль продолжит выполнение без проверки параметров. Варианты:
|
casb_profile_saasapplication_customcontrol dictionary | Набор параметров верхнего уровня. |
|
attribute_filter псевдонимы: attribute-filter list / элементы=dictionary |
Фильтр атрибутов. |
|
action string |
Действие правила управления арендатором для доступа CASB. Варианты:
|
|
attribute_match псевдонимы: attribute-match list / элементы=string |
Условие соответствия арендатора в правиле доступа CASB. |
|
id integer |
Идентификатор управления арендатором CASB. |
|
name string / обязательный |
Имя действия пользователя для пользовательского управления CASB. |
|
option list / элементы=dictionary |
Параметр. |
|
name string |
Имя параметра пользовательского управления CASB. |
|
user_input псевдонимы: user-input list / элементы=string |
Пользовательский ввод для пользовательского управления CASB. |
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
profile string / обязательный | Параметр (profile) в запрашиваемом URL. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия возникновения ошибки. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
saas-application string | Устарело, используйте “saas_application” |
saas_application string | Параметр (saas-application) в запрашиваемом URL. |
state string / обязательный | Указание создать, обновить или удалить объект. Варианты:
|
workspace_locking_adom string | ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. Значением может быть global, а также другие ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания (в секундах) освобождения блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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 profile custom control.
fortinet.fortimanager.fmgr_casb_profile_saasapplication_customcontrol:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
profile: <your own value>
saas_application: <your own value>
state: present # <value in [present, absent]>
casb_profile_saasapplication_customcontrol:
name: "your value" # Required variable, string
# option:
# - name: <string>
# user_input: <list or string>
# attribute_filter:
# - action: <value in [block, monitor, bypass]>
# attribute_match: <list or string>
# id: <integer>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: составное значение |
Ссылки на коллекцию
© 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_profile_saasapplication_customcontrol_module.html
