Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_casb_profile — настройка профиля CASB.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Новое в fortinet.fortimanager 2.3.0

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

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

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

Параметры

Параметр

Комментарии

access_token

string

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

adom

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

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

bypass_validation

boolean

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

Варианты:

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

casb_profile

dictionary

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

comment

string

Комментарий.

name

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

Имя профиля CASB.

saas_application

псевдонимы: saas-application

list / элементы=dictionary

SaaS-приложение.

access_rule

псевдонимы: access-rule

list / элементы=dictionary

Правило доступа.

action

string

Действие правила доступа CASB.

Варианты:

  • "block"
  • "bypass"
  • "monitor"

attribute_filter

псевдонимы: attribute-filter

list / элементы=dictionary

Фильтр атрибутов.

action

string

Действие управления клиентами для правила доступа CASB.

Варианты:

  • "block"
  • "monitor"
  • "bypass"

attribute_match

псевдонимы: attribute-match

list / элементы=string

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

id

integer

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

bypass

list / элементы=string

Параметры обхода CASB.

Варианты:

  • "av"
  • "dlp"
  • "web-filter"
  • "file-filter"
  • "video-filter"

name

string

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

advanced_tenant_control

псевдонимы: advanced-tenant-control

list / элементы=dictionary

Расширенное управление клиентами.

attribute

list / элементы=dictionary

Атрибут.

input

list / элементы=string

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

name

string

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

name

list / элементы=string

Имя расширенного управления клиентами CASB.

custom_control

псевдонимы: custom-control

list / элементы=dictionary

Пользовательское управление.

attribute_filter

псевдонимы: attribute-filter

list / элементы=dictionary

Фильтр атрибутов.

action

string

Действие управления клиентами для правила доступа CASB.

Варианты:

  • "block"
  • "monitor"
  • "bypass"

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.

domain_control

псевдонимы: domain-control

string

Включение/отключение управления доменами.

Варианты:

  • "disable"
  • "enable"

domain_control_domains

псевдонимы: domain-control-domains

list / элементы=string

Домены управления доменами профиля CASB.

log

string

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

Варианты:

  • "disable"
  • "enable"

name

string

Имя SaaS-приложения профиля CASB.

safe_search

псевдонимы: safe-search

string

Включение/отключение безопасного поиска.

Варианты:

  • "disable"
  • "enable"

safe_search_control

псевдонимы: safe-search-control

list / элементы=string

Управление безопасным поиском профиля CASB.

status

string

Включение/отключение параметра.

Варианты:

  • "disable"
  • "enable"

tenant_control

псевдонимы: tenant-control

string

Включение/отключение управления клиентами.

Варианты:

  • "disable"
  • "enable"

tenant_control_tenants

псевдонимы: tenant-control-tenants

list / элементы=string

Клиенты управления клиентами профиля CASB.

enable_log

boolean

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

Варианты:

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

forticloud_access_token

string

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

proposed_method

string

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

Варианты:

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

rc_failed

list / элементы=integer

Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.

rc_succeeded

list / элементы=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 profile.
      fortinet.fortimanager.fmgr_casb_profile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        casb_profile:
          name: "your value" # Required variable, string
          # saas_application:
          #   - access_rule:
          #       - action: <value in [block, bypass, monitor]>
          #         bypass: ["av", "dlp", "web-filter", "file-filter", "video-filter"]
          #         name: <string>
          #         attribute_filter:
          #           - action: <value in [block, monitor, bypass]>
          #             attribute_match: <list or string>
          #             id: <integer>
          #     custom_control:
          #       - name: <string>
          #         option:
          #           - name: <string>
          #             user_input: <list or string>
          #         attribute_filter:
          #           - action: <value in [block, monitor, bypass]>
          #             attribute_match: <list or string>
          #             id: <integer>
          #     domain_control: <value in [disable, enable]>
          #     domain_control_domains: <list or string>
          #     log: <value in [disable, enable]>
          #     name: <string>
          #     safe_search: <value in [disable, enable]>
          #     safe_search_control: <list or string>
          #     tenant_control: <value in [disable, enable]>
          #     tenant_control_tenants: <list or string>
          #     status: <value in [disable, enable]>
          #     advanced_tenant_control:
          #       - attribute:
          #           - input: <list or string>
          #             name: <string>
          #         name: <list or string>
          # comment: <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–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_module.html

Spec-Zone.ru

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