Модуль fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy_identitybasedpolicy – Политика, основанная на идентификации.

Примечание

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

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

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

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

Новая функция в fortinet.fortimanager 2.2.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
explicit-proxy-policy строка	Устарело, используйте «explicit_proxy_policy»
explicit_proxy_policy строка	Параметр (explicit-proxy-policy) в запрошенном URL.
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
pkg строка / обязательно	Параметр (pkg) в запрошенном URL.
pkg_firewall_explicitproxypolicy_identitybasedpolicy словарь	Настройка параметров верхнего уровня.
application_list строка	Устарело, используйте application_list. Список приложений.
av_profile строка	Устарело, используйте av_profile. Профиль антивируса.
casi_profile строка	Устарело, используйте casi_profile. Профиль CASI.
disclaimer строка	Настройка отметки об отказе от ответственности веб-прокси. Варианты: `"disable"` `"domain"` `"policy"` `"user"`
dlp_sensor строка	Устарело, используйте dlp_sensor. DLP-датчик.
groups строка	Имя группы.
icap_profile строка	Устарело, используйте icap_profile. Профиль ICAP.
id целое число / обязательно	Идентификатор.
ips_sensor строка	Устарело, используйте ips_sensor. IPS-датчик.
logtraffic строка	Включить/выключить логирование трафика политики. Варианты: `"disable"` `"all"` `"utm"`
logtraffic_start строка	Устарело, используйте logtraffic_start. Включить/выключить запуск логирования трафика политики. Варианты: `"disable"` `"enable"`

mms-profile string	Устарело, пожалуйста, переименуйте на mms_profile. Профиль MMS
profile-group string	Устарело, пожалуйста, переименуйте на profile_group. Группа профилей
profile-protocol-options string	Устарело, пожалуйста, переименуйте на profile_protocol_options. Параметры протокола профиля.
profile-type string	Устарело, пожалуйста, переименуйте на profile_type. Тип профиля Варианты: `"single"` `"group"`
replacemsg-override-group string	Устарело, пожалуйста, переименуйте на replacemsg_override_group. Укажите группу замены сообщений аутентификации.
scan-botnet-connections string	Устарело, пожалуйста, переименуйте на scan_botnet_connections. Включить/выключить сканирование подключений к серверам ботнета. Варианты: `"disable"` `"block"` `"monitor"`
schedule string	Имя расписания.
spamfilter-profile string	Устарело, пожалуйста, переименуйте на spamfilter_profile. Профиль фильтра спама.
ssl-ssh-profile string	Устарело, пожалуйста, переименуйте на ssl_ssh_profile. Профиль SSL SSH.
users string	Имя пользователя.
utm-status string	Устарело, пожалуйста, переименуйте на utm_status. Включить профиль защиты AV/веб/IPS. Варианты: `"disable"` `"enable"`
waf-profile string	Устарело, пожалуйста, переименуйте на waf_profile. Профиль межсетевого экрана веб-приложений.
webfilter-profile string	Устарело, пожалуйста, переименуйте на webfilter_profile. Профиль фильтра веб-страниц.
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	ADOM для блокировки 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_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: Identity-based policy.
      fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy_identitybasedpolicy:
        # 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>
        pkg: <your own value>
        explicit_proxy_policy: <your own value>
        state: present # <value in [present, absent]>
        pkg_firewall_explicitproxypolicy_identitybasedpolicy:
          application_list: <string>
          av_profile: <string>
          casi_profile: <string>
          disclaimer: <value in [disable, domain, policy, ...]>
          dlp_sensor: <string>
          groups: <string>
          icap_profile: <string>
          id: <integer>
          ips_sensor: <string>
          logtraffic: <value in [disable, all, utm]>
          logtraffic_start: <value in [disable, enable]>
          mms_profile: <string>
          profile_group: <string>
          profile_protocol_options: <string>
          profile_type: <value in [single, group]>
          replacemsg_override_group: <string>
          scan_botnet_connections: <value in [disable, block, monitor]>
          schedule: <string>
          spamfilter_profile: <string>
          ssl_ssh_profile: <string>
          users: <string>
          utm_status: <value in [disable, enable]>
          waf_profile: <string>
          webfilter_profile: <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_pkg_firewall_explicitproxypolicy_identitybasedpolicy_module.html