Модуль fortinet.fortimanager.fmgr_vpn_ssl_settings_authenticationrule — правило аутентификации для SSL VPN.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
device string / обязательный	Параметр (device) в запрошенном URL.
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, переопределяющий условия успешного выполнения.
state string / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
vdom string / обязательный	Параметр (vdom) в запрошенном URL.
vpn_ssl_settings_authenticationrule dictionary	Набор параметров верхнего уровня.
auth string	Ограничение метода аутентификации SSL VPN. Варианты: `"any"` `"local"` `"radius"` `"ldap"` `"tacacs+"` `"peer"`
cipher string	Уровень стойкости шифра SSL VPN. Варианты: `"any"` `"high"` `"medium"`
client_cert псевдонимы: client-cert string	Включение/отключение ограничения по сертификату клиента SSL VPN. Варианты: `"disable"` `"enable"`
groups any	(список или строка) Группы пользователей.
id integer / обязательный	Идентификатор
portal string	Портал SSL VPN.
realm string	Область SSL VPN.
source_address псевдонимы: source-address any	(список или строка) Адрес источника входящего трафика.
source_address6 псевдонимы: source-address6 any	(список или строка) IPv6-адрес источника входящего трафика.
source_address6_negate псевдонимы: source-address6-negate string	Включение/отключение инвертированного сопоставления IPv6-адреса источника. Варианты: `"disable"` `"enable"`
source_address_negate псевдонимы: source-address-negate string	Включение/отключение инвертированного сопоставления адреса источника. Варианты: `"disable"` `"enable"`
source_interface псевдонимы: source-interface any	(список или строка) Исходный интерфейс SSL VPN для входящего трафика.
user_peer псевдонимы: user-peer string	Имя узла пользователя.
users any	(список или строка) Имя пользователя.
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: Authentication rule for SSL VPN.
      fortinet.fortimanager.fmgr_vpn_ssl_settings_authenticationrule:
        # workspace_locking_adom: <global or your adom name>
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        vpn_ssl_settings_authenticationrule:
          id: 0 # Required variable, integer
          # auth: <value in [any, local, radius, ...]>
          # cipher: <value in [any, high, medium]>
          # client_cert: <value in [disable, enable]>
          # groups: <list or string>
          # portal: <string>
          # realm: <string>
          # source_address: <list or string>
          # source_address_negate: <value in [disable, enable]>
          # source_address6: <list or string>
          # source_address6_negate: <value in [disable, enable]>
          # source_interface: <list or string>
          # user_peer: <string>
          # users: <list or string>

Возвращаемые значения

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=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_vpn_ssl_settings_authenticationrule_module.html