fortinet.fortimanager.fmgr_firewall_casbprofile_saasapplication модуль — Профиль файрволла casb приложения SaaS

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логический тип	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
casb-profile строка	Устарело, используйте «casb_profile»
casb_profile строка	Параметр (casb-profile) в запрошенном URL.
enable_log логический тип	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_casbprofile_saasapplication словарь	Установленные параметры верхнего уровня.
access-rule список / элементы=словарь	Устарело, переименуйте на access_rule. Правило доступа.
action строка	Действие. Варианты: `"block"` `"monitor"` `"bypass"`
bypass список / элементы=строка	Обход. Варианты: `"av"` `"dlp"` `"web-filter"` `"file-filter"` `"video-filter"`
name строка	Имя.
custom-control список / элементы=словарь	Устарело, переименуйте на custom_control. Пользовательский контроль.
name строка	Имя.
option список / элементы=словарь	Опция.
name строка	Имя.
user-input список / элементы=строка	Устарело, переименуйте на user_input. Ввод пользователя.
domain-control строка	Устарело, переименуйте на domain_control. Управление доменом. Варианты: `"disable"` `"enable"`
domain-control-domains список / элементы=строка	Устарело, переименуйте на domain_control_domains. Домены управления доменами.
log строка	Журнал. Варианты: `"disable"` `"enable"`
name строка / обязательно	Имя.

END_OF_DOCUMENT_MARKER

safe-search string	Устаревшее, пожалуйста, переименуйте его в safe_search. Безопасный поиск. Варианты: `"disable"` `"enable"`
safe-search-control list / elements=string	Устаревшее, пожалуйста, переименуйте его в safe_search_control. Управление безопасным поиском.
tenant-control string	Устаревшее, пожалуйста, переименуйте его в tenant_control. Управление арендаторами. Варианты: `"disable"` `"enable"`
tenant-control-tenants list / elements=string	Устаревшее, пожалуйста, переименуйте его в tenant_control_tenants. Арендаторы управления.
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, при которых условия будут считаться выполненными.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	Область для блокировки в режиме работы FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая 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 помогают в этой работе.
Для создания или обновления объекта используйте директиву 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: Firewall casb profile saas application
      fortinet.fortimanager.fmgr_firewall_casbprofile_saasapplication:
        # 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>
        casb_profile: <your own value>
        state: present # <value in [present, absent]>
        firewall_casbprofile_saasapplication:
          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]>
          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>

Значения возврата

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

Ключ	Описание
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 список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_firewall_casbprofile_saasapplication_module.html