Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_firewall_casbprofile_saasapplication module – SaaS-приложение профиля межсетевого экрана CASB

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.3.0

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

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

Параметры

Параметр

Комментарии

access_token

string

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

adom

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

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

bypass_validation

boolean

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

Варианты:

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

casb-profile

string

Устаревший параметр, используйте «casb_profile»

casb_profile

string

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

enable_log

boolean

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

Варианты:

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

firewall_casbprofile_saasapplication

dictionary

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

access_rule

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

list / elements=dictionary

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

action

string

Действие.

Варианты:

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

bypass

list / elements=string

Обход.

Варианты:

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

name

string

Имя.

custom_control

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

list / elements=dictionary

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

name

string

Имя.

option

list / elements=dictionary

Параметр.

name

string

Имя.

user_input

псевдонимы: user-input

list / elements=string

Ввод пользователя.

domain_control

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

string

Управление доменами.

Варианты:

  • "disable"
  • "enable"

domain_control_domains

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

list / elements=string

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

log

string

Журнал.

Варианты:

  • "disable"
  • "enable"

name

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

Имя.

safe_search

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

string

Безопасный поиск.

Варианты:

  • "disable"
  • "enable"

safe_search_control

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

list / elements=string

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

tenant_control

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

string

Управление арендаторами.

Варианты:

  • "disable"
  • "enable"

tenant_control_tenants

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

list / elements=string

Арендаторы для управления арендаторами.

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 или другой ADOM, включая 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: Firewall casb profile saas application
      fortinet.fortimanager.fmgr_firewall_casbprofile_saasapplication:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        casb_profile: <your own value>
        state: present # <value in [present, absent]>
        firewall_casbprofile_saasapplication:
          name: "your value" # Required variable, string
          # access_rule:
          #   - action: <value in [block, monitor, bypass]>
          #     bypass: ["av", "dlp", "web-filter", "file-filter", "video-filter"]
          #     name: <string>
          # custom_control:
          #   - name: <string>
          #     option:
          #       - name: <string>
          #         user_input: <list or string>
          # domain_control: <value in [disable, enable]>
          # domain_control_domains: <list or string>
          # log: <value in [disable, enable]>
          # safe_search: <value in [disable, enable]>
          # safe_search_control: <list or string>
          # tenant_control: <value in [disable, enable]>
          # tenant_control_tenants: <list or 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_firewall_casbprofile_saasapplication_module.html

Spec-Zone.ru

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