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

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое значение	Устанавливать в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
device строка / обязательный	Параметр (устройство) в запрошенном URL.
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для неудачи.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.
state строка / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
vdom строка / обязательный	Параметр (vdom) в запрошенном URL.
vpn_ssl_settings_authenticationrule словарь	Набор параметров верхнего уровня.
auth строка	Ограничение метода аутентификации SSL VPN. Варианты: `"any"` `"local"` `"radius"` `"ldap"` `"tacacs+"` `"peer"`
cipher строка	Уровень шифрования SSL VPN. Варианты: `"any"` `"high"` `"medium"`
client_cert строка	Устарело, пожалуйста, переименуйте на client_cert. Включение/выключение ограничений по сертификату клиента SSL VPN. Варианты: `"disable"` `"enable"`
groups любой	(список или строка) Группы пользователей.
id целое число / обязательный	Идентификатор
portal строка	Портал SSL VPN.
realm строка	Область SSL VPN.
source_address любой	(список или строка) Источник адреса входящего трафика.
source_address_negate строка	Включение/выключение совпадения адреса источника с отрицанием. Варианты: `"disable"` `"enable"`

END_OF_DOCUMENT_MARKER

source-address6 any	(список или строка) Устаревшее, пожалуйста, переименуйте на source_address6. IPv6 адрес источника входящего трафика.
source-address6-negate строка	Устаревшее, пожалуйста, переименуйте на source_address6_negate. Включить/выключить сопоставление с отрицанием IPv6 адреса источника. Выбори: `"disable"` `"enable"`
source-interface any	(список или строка) Устаревшее, пожалуйста, переименуйте на source_interface. Интерфейс источника SSL VPN входящего трафика.
user-peer строка	Устаревшее, пожалуйста, переименуйте на user_peer. Имя пользователя-партнёра.
users any	(список или строка) Имя пользователя.
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_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: Authentication rule for SSL VPN.
      fortinet.fortimanager.fmgr_vpn_ssl_settings_authenticationrule:
        # 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, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        vpn_ssl_settings_authenticationrule:
          auth: <value in [any, local, radius, ...]>
          cipher: <value in [any, high, medium]>
          client_cert: <value in [disable, enable]>
          groups: <list or string>
          id: <integer>
          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 словарь	Результат запроса. Возвращается: всегда
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_vpn_ssl_settings_authenticationrule_module.html