fortinet.fortimanager.fmgr_firewall_casbprofile модуль — Профиль брандмауэра casb

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.3.0

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

Обзор

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_casbprofile словарь	Установленные параметры верхнего уровня.
name строка / обязательно	Имя.
saas_application список / элементы=словарь	Устарело, пожалуйста, переименуйте на saas_application. Приложение SaaS.
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 строка	Имя.
safe_search строка	Устарело, пожалуйста, переименуйте на safe_search. Безопасный поиск. Варианты: `"disable"` `"enable"`

END_OF_DOCUMENT_MARKER

safe-search-control список / элементы=строка	Устаревший параметр, переименуйте его на safe_search_control. Управление безопасным поиском.
tenant-control строка	Устаревший параметр, переименуйте его на tenant_control. Управление арендаторами. Варианты: `"disable"` `"enable"`
tenant-control-tenants список / элементы=строка	Устаревший параметр, переименуйте его на tenant_control_tenants. Арендаторы с управлением.
forticloud_access_token строка	Авторизует клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут переопределены для завершения с ошибкой.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут переопределены для успешного завершения.
state строка / обязательный	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки в режиме работы с рабочей областью FortiManager, значение может быть глобальным и другими, включая root.
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: Firewall casb profile
      fortinet.fortimanager.fmgr_firewall_casbprofile:
        # 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>
        state: present # <value in [present, absent]>
        firewall_casbprofile:
          name: <string>
          saas_application:
            -
              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 список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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_module.html