Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_user_radius — настройка записей серверов RADIUS в Fortinet FortiOS и FortiGate.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_user_radius.

Добавлено в fortinet.fortios 2.0.0

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

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

  • Этот модуль позволяет настраивать устройства FortiGate или FortiOS (FOS), задавая и изменяя параметры функции user и категории radius. Перед использованием необходимо настроить все параметры и значения в примерах в соответствии с источниками данных. Проверено на FOS v6.0.0

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создается в графическом интерфейсе Fortigate.

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, для которого выполняется операция.

Если атрибутов несколько, они разделяются косой чертой.

Параметр, отмеченный как member_path, можно использовать для выполнения операции с элементом.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если указан member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

string / обязательный

Определяет, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

user_radius

dictionary

Настроить записи серверов RADIUS.

account_key_cert_field

string

Задать поле идентификатора субъекта в сертификате для проверки прав доступа пользователя.

Варианты:

  • "othername"
  • "rfc822name"
  • "dnsname"
  • "cn"

account_key_processing

string

Операция обработки ключа учетной записи. FortiGate сохранит домен целиком или удалит его из идентификатора субъекта.

Варианты:

  • "same"
  • "strip"

accounting_server

list / элементы=dictionary

Дополнительные серверы учета.

id

integer / обязательный

Идентификатор (0–4294967295). См. <a href=’#notes’>примечания</a>.

interface

string

Указать исходящий интерфейс для доступа к серверу. Источник: system.interface.name.

interface_select_method

string

Указать способ выбора исходящего интерфейса для доступа к серверу.

Варианты:

  • "auto"
  • "sdwan"
  • "specify"

port

integer

Номер порта учета RADIUS.

secret

string

Секретный ключ.

server

string

Доменное имя CN сервера или IP-адрес.

source_ip

string

Исходный IP-адрес для связи с сервером RADIUS.

status

string

Состояние.

Варианты:

  • "enable"
  • "disable"

vrf_select

integer

Идентификатор VRF, используемый для подключения к серверу.

acct_all_servers

string

Включить/отключить отправку сообщений учета всем настроенным серверам.

Варианты:

  • "enable"
  • "disable"

acct_interim_interval

integer

Интервал в секундах между промежуточными сообщениями обновления учета.

all_usergroup

string

Включить/отключить автоматическое добавление этого сервера RADIUS во все группы пользователей.

Варианты:

  • "disable"
  • "enable"

auth_type

string

Методы/протоколы аутентификации, разрешенные для этого сервера RADIUS.

Варианты:

  • "auto"
  • "ms_chap_v2"
  • "ms_chap"
  • "chap"
  • "pap"

ca_cert

string

Центр сертификации сервера, которому следует доверять при использовании TLS. Источник: vpn.certificate.ca.name.

call_station_id_type

string

Настройка типа идентификатора вызывающей и вызываемой станции; этот параметр недоступен для аутентификации 802.1x.

Варианты:

  • "legacy"
  • "IP"
  • "MAC"

class

list / элементы=dictionary

Имя (имена) атрибута Class.

name

string / обязательный

Имя класса.

client_cert

string

Сертификат клиента для использования с TLS. Источник: vpn.certificate.local.name.

delimiter

string

Настроить разделитель для разделения имен групп профилей в атрибуте SSO.

Варианты:

  • "plus"
  • "comma"

group_override_attr_type

string

Тип атрибута RADIUS для переопределения сведений о группе пользователей.

Варианты:

  • "filter-Id"
  • "class"

h3c_compatibility

string

Включить/отключить совместимость с H3C — механизмом, выполняющим проверку безопасности при аутентификации.

Варианты:

  • "enable"
  • "disable"

interface

string

Указать исходящий интерфейс для доступа к серверу. Источник: system.interface.name.

interface_select_method

string

Указать способ выбора исходящего интерфейса для доступа к серверу.

Варианты:

  • "auto"
  • "sdwan"
  • "specify"

mac_case

string

Регистр символов при MAC-аутентификации.

Варианты:

  • "uppercase"
  • "lowercase"

mac_password_delimiter

string

Разделитель пароля при MAC-аутентификации.

Варианты:

  • "hyphen"
  • "single-hyphen"
  • "colon"
  • "none"

mac_username_delimiter

string

Разделитель имени пользователя при MAC-аутентификации.

Варианты:

  • "hyphen"
  • "single-hyphen"
  • "colon"
  • "none"

name

string / обязательный

Имя записи сервера RADIUS.

nas_id

string

Пользовательский идентификатор NAS.

nas_id_type

string

Настройка типа идентификатора NAS.

Варианты:

  • "legacy"
  • "custom"
  • "hostname"

nas_ip

string

IP-адрес для связи с сервером RADIUS, используемый в атрибутах NAS-IP-Address и Called-Station-ID.

password_encoding

string

Кодировка пароля.

Варианты:

  • "auto"
  • "ISO-8859-1"

password_renewal

string

Включить/отключить обновление пароля.

Варианты:

  • "enable"
  • "disable"

radius_coa

string

Включить механизм изменения атрибутов сеанса аутентификации, авторизации и учета после его аутентификации.

Варианты:

  • "enable"
  • "disable"

radius_port

integer

Номер порта службы RADIUS.

require_message_authenticator

string

Требовать наличие аутентификатора сообщения в ответе на запрос аутентификации.

Варианты:

  • "enable"
  • "disable"

rsso

string

Включить/отключить функцию единого входа на основе RADIUS.

Варианты:

  • "enable"
  • "disable"

rsso_context_timeout

integer

Время в секундах, по истечении которого вышедший из системы пользователь удаляется из «списка контекстов пользователей», находящихся в системе.

rsso_endpoint_attribute

string

Атрибуты RADIUS, используемые для извлечения идентификатора конечной точки пользователя из записи начала сеанса RADIUS.

Варианты:

  • "User-Name"
  • "NAS-IP-Address"
  • "Framed-IP-Address"
  • "Framed-IP-Netmask"
  • "Filter-Id"
  • "Login-IP-Host"
  • "Reply-Message"
  • "Callback-Number"
  • "Callback-Id"
  • "Framed-Route"
  • "Framed-IPX-Network"
  • "Class"
  • "Called-Station-Id"
  • "Calling-Station-Id"
  • "NAS-Identifier"
  • "Proxy-State"
  • "Login-LAT-Service"
  • "Login-LAT-Node"
  • "Login-LAT-Group"
  • "Framed-AppleTalk-Zone"
  • "Acct-Session-Id"
  • "Acct-Multi-Session-Id"

rsso_endpoint_block_attribute

string

Атрибуты RADIUS, используемые для блокировки пользователя.

Варианты:

  • "User-Name"
  • "NAS-IP-Address"
  • "Framed-IP-Address"
  • "Framed-IP-Netmask"
  • "Filter-Id"
  • "Login-IP-Host"
  • "Reply-Message"
  • "Callback-Number"
  • "Callback-Id"
  • "Framed-Route"
  • "Framed-IPX-Network"
  • "Class"
  • "Called-Station-Id"
  • "Calling-Station-Id"
  • "NAS-Identifier"
  • "Proxy-State"
  • "Login-LAT-Service"
  • "Login-LAT-Node"
  • "Login-LAT-Group"
  • "Framed-AppleTalk-Zone"
  • "Acct-Session-Id"
  • "Acct-Multi-Session-Id"

rsso_ep_one_ip_only

string

Включить/отключить замену старых IP-адресов новыми для одной и той же конечной точки в сообщениях начала учета RADIUS.

Варианты:

  • "enable"
  • "disable"

rsso_flush_ip_session

string

Включить/отключить сброс IP-сеансов пользователя при получении сообщений остановки учета RADIUS.

Варианты:

  • "enable"
  • "disable"

rsso_log_flags

list / элементы=string

События для записи в журнал.

Варианты:

  • "protocol-error"
  • "profile-missing"
  • "accounting-stop-missed"
  • "accounting-event"
  • "endpoint-block"
  • "radiusd-other"
  • "none"

rsso_log_period

integer

Интервал времени в секундах, с которым создаются сообщения журнала событий группы для событий динамического профиля.

rsso_radius_response

string

Включить или отключить отправку пакетов ответа RADIUS после получения записей Start и Stop.

Варианты:

  • "enable"
  • "disable"

rsso_radius_server_port

integer

UDP-порт для прослушивания записей Start и Stop RADIUS.

rsso_secret

string

Секретный ключ RADIUS, используемый сервером учета RADIUS.

rsso_validate_request_secret

string

Включить или отключить проверку общего секретного ключа запроса RADIUS в записи Start или End.

Варианты:

  • "enable"
  • "disable"

secondary_secret

string

Секретный ключ для доступа к вторичному серверу.

secondary_server

string

Доменное имя CN или IP-адрес вторичного сервера RADIUS.

secret

string

Заранее согласованный секретный ключ для доступа к основному серверу RADIUS.

server

string

Доменное имя CN или IP-адрес основного сервера RADIUS.

server_identity_check

string

Включить или отключить проверку подлинности сервера RADIUS (сверку доменного имени/IP-адреса сервера с сертификатом сервера).

Варианты:

  • "enable"
  • "disable"

source_ip

string

Исходный IP-адрес для связи с сервером RADIUS.

source_ip_interface

string

Исходный интерфейс для связи с сервером RADIUS. Источник system.interface.name.

sso_attribute

string

Атрибут RADIUS, содержащий имя группы профиля, которое нужно извлечь из записи Start RADIUS.

Варианты:

  • "User-Name"
  • "NAS-IP-Address"
  • "Framed-IP-Address"
  • "Framed-IP-Netmask"
  • "Filter-Id"
  • "Login-IP-Host"
  • "Reply-Message"
  • "Callback-Number"
  • "Callback-Id"
  • "Framed-Route"
  • "Framed-IPX-Network"
  • "Class"
  • "Called-Station-Id"
  • "Calling-Station-Id"
  • "NAS-Identifier"
  • "Proxy-State"
  • "Login-LAT-Service"
  • "Login-LAT-Node"
  • "Login-LAT-Group"
  • "Framed-AppleTalk-Zone"
  • "Acct-Session-Id"
  • "Acct-Multi-Session-Id"

sso_attribute_key

string

Префикс ключа для значения группы SSO в атрибуте SSO.

sso_attribute_value_override

string

Включить или отключить замену старого значения атрибута новым для той же конечной точки.

Варианты:

  • "enable"
  • "disable"

status_ttl

integer

Время кэширования доступности сервера: если сервер недоступен, повторная попытка подключения не выполняется в течение как минимум этого периода (0 = кэширование отключено).

switch_controller_acct_fast_framedip_detect

integer

Обнаружение Framed-IP в сообщениях учета контроллера коммутатора на основе DHCP snooping (секунды).

switch_controller_nas_ip_dynamic

string

Включить или отключить динамическую настройку nas-ip контроллером коммутатора.

Варианты:

  • "enable"
  • "disable"

switch_controller_service_type

list / elements=string

Тип службы RADIUS.

Варианты:

  • "login"
  • "framed"
  • "callback-login"
  • "callback-framed"
  • "outbound"
  • "administrative"
  • "nas-prompt"
  • "authenticate-only"
  • "callback-nas-prompt"
  • "call-check"
  • "callback-administrative"

tertiary_secret

string

Секретный ключ для доступа к третичному серверу.

tertiary_server

string

Доменное имя CN или IP-адрес третичного сервера RADIUS.

timeout

integer

Время в секундах до повторной попытки подключения к серверу.

tls_min_proto_version

string

Минимальная поддерживаемая версия протокола для TLS-подключений.

Варианты:

  • "default"
  • "SSLv3"
  • "TLSv1"
  • "TLSv1-1"
  • "TLSv1-2"
  • "TLSv1-3"

transport_protocol

string

Используемый транспортный протокол.

Варианты:

  • "udp"
  • "tcp"
  • "tls"

use_management_vdom

string

Включить или отключить использование управляющего VDOM для отправки запросов.

Варианты:

  • "enable"
  • "disable"

username_case_sensitive

string

Включить или отключить учет регистра в именах пользователей.

Варианты:

  • "enable"
  • "disable"

vrf_select

integer

Идентификатор VRF, используемый для подключения к серверу.

vdom

string

Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска плейбуков — httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: Configure RADIUS server entries.
  fortinet.fortios.fortios_user_radius:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_radius:
          account_key_cert_field: "othername"
          account_key_processing: "same"
          accounting_server:
              -
                  id: "6"
                  interface: "<your_own_value> (source system.interface.name)"
                  interface_select_method: "auto"
                  port: "0"
                  secret: "<your_own_value>"
                  server: "192.168.100.40"
                  source_ip: "84.230.14.43"
                  status: "enable"
                  vrf_select: "0"
          acct_all_servers: "enable"
          acct_interim_interval: "0"
          all_usergroup: "disable"
          auth_type: "auto"
          ca_cert: "<your_own_value> (source vpn.certificate.ca.name)"
          call_station_id_type: "legacy"
          class:
              -
                  name: "default_name_22"
          client_cert: "<your_own_value> (source vpn.certificate.local.name)"
          delimiter: "plus"
          group_override_attr_type: "filter-Id"
          h3c_compatibility: "enable"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          mac_case: "uppercase"
          mac_password_delimiter: "hyphen"
          mac_username_delimiter: "hyphen"
          name: "default_name_32"
          nas_id: "<your_own_value>"
          nas_id_type: "legacy"
          nas_ip: "<your_own_value>"
          password_encoding: "auto"
          password_renewal: "enable"
          radius_coa: "enable"
          radius_port: "0"
          require_message_authenticator: "enable"
          rsso: "enable"
          rsso_context_timeout: "28800"
          rsso_endpoint_attribute: "User-Name"
          rsso_endpoint_block_attribute: "User-Name"
          rsso_ep_one_ip_only: "enable"
          rsso_flush_ip_session: "enable"
          rsso_log_flags: "protocol-error"
          rsso_log_period: "0"
          rsso_radius_response: "enable"
          rsso_radius_server_port: "1813"
          rsso_secret: "<your_own_value>"
          rsso_validate_request_secret: "enable"
          secondary_secret: "<your_own_value>"
          secondary_server: "<your_own_value>"
          secret: "<your_own_value>"
          server: "192.168.100.40"
          server_identity_check: "enable"
          source_ip: "84.230.14.43"
          source_ip_interface: "<your_own_value> (source system.interface.name)"
          sso_attribute: "User-Name"
          sso_attribute_key: "<your_own_value>"
          sso_attribute_value_override: "enable"
          status_ttl: "300"
          switch_controller_acct_fast_framedip_detect: "2"
          switch_controller_nas_ip_dynamic: "enable"
          switch_controller_service_type: "login"
          tertiary_secret: "<your_own_value>"
          tertiary_server: "<your_own_value>"
          timeout: "5"
          tls_min_proto_version: "default"
          transport_protocol: "udp"
          use_management_vdom: "enable"
          username_case_sensitive: "enable"
          vrf_select: "0"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для настройки содержимого на FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, полученный от FortiGate при выполнении последней операции

Возвращается: всегда

Пример: "200"

mkey

string

Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер редакции

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат выполнения операции

Возвращается: всегда

Пример: "success"

vdom

string

Использованный виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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/fortios/fortios_user_radius_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API