fortinet.fortimanager.fmgr_user_radius – Настройка записей сервера RADIUS.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_user_radius.
Новое в версии 2.10: плагина fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||||
| bypass_validation логическое |
| устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров | |||
| rc_failed список / элементы=строка | список кодов rc, с которыми будут переопределены условия для отказа | ||||
| rc_succeeded список / элементы=строка | список кодов rc, с которыми будут переопределены условия для успеха | ||||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |||
| user_radius словарь | параметры верхнего уровня | ||||
| accounting-server список / элементы=строка | нет описания | ||||
| id целое число | Идентификатор (0 - 4294967295). | ||||
| port целое число | Номер порта RADIUS учёта. | ||||
| secret строка | нет описания | ||||
| server строка | {<имя_строки|ip_строки>} Имя домена CN сервера или IP-адрес. | ||||
| source-ip строка | IP-адрес источника для связи с RADIUS-сервером. | ||||
| status строка |
| Статус. | |||
| acct-all-servers строка |
| Включение/выключение отправки сообщений учёта всем настроенным серверам (по умолчанию = disable). | |||
| acct-interim-interval целое число | Время в секундах между каждым промежуточным сообщением обновления учёта. | ||||
| all-usergroup строка |
| Включение/выключение автоматического включения этого RADIUS-сервера во все группы пользователей. | |||
| auth-type строка |
| Методы/протоколы аутентификации, разрешённые для этого RADIUS-сервера. | |||
| class строка | нет описания | ||||
| dynamic_mapping список / элементы=строка | нет описания | ||||
| _scope список / элементы=строка | нет описания | ||||
| name строка | нет описания | ||||
| vdom строка | нет описания | ||||
| acct-all-servers строка |
| нет описания | |||
| acct-interim-interval целое число | нет описания | ||||
| all-usergroup строка |
| нет описания | |||
| auth-type строка |
| нет описания | |||
| class строка | нет описания | ||||
| dp-carrier-endpoint-attribute строка |
| нет описания | |||
| dp-carrier-endpoint-block-attribute строка |
| нет описания | |||
| dp-context-timeout целое число | нет описания | ||||
| dp-flush-ip-session строка |
| нет описания | |||
| dp-hold-time целое число | нет описания | ||||
| dp-http-header строка | нет описания | ||||
| dp-http-header-fallback строка |
| нет описания | |||
| dp-http-header-status строка |
| нет описания | |||
| dp-http-header-suppress строка |
| нет описания | |||
| dp-log-dyn_flags список / элементы=строка |
| нет описания | |||
| dp-log-period целое число | нет описания | ||||
| dp-mem-percent целое число | нет описания | ||||
| dp-profile-attribute строка |
| нет описания | |||
| dp-profile-attribute-key строка | нет описания | ||||
| dp-radius-response строка |
| нет описания | |||
| dp-radius-server-port целое число | нет описания | ||||
| dp-secret строка | нет описания | ||||
| dp-validate-request-secret строка |
| нет описания | |||
| dynamic-profile строка |
| нет описания | |||
| endpoint-translation строка |
| нет описания | |||
| ep-carrier-endpoint-convert-hex строка |
| нет описания | |||
| ep-carrier-endpoint-header строка | нет описания | ||||
| ep-carrier-endpoint-header-suppress строка |
| нет описания | |||
| ep-carrier-endpoint-prefix строка |
| нет описания | |||
| ep-carrier-endpoint-prefix-range-max целое число | нет описания | ||||
| ep-carrier-endpoint-prefix-range-min целое число | нет описания | ||||
| ep-carrier-endpoint-prefix-string строка | нет описания | ||||
| ep-carrier-endpoint-source строка |
| нет описания | |||
| ep-ip-header строка | нет описания | ||||
| ep-ip-header-suppress строка |
| нет описания | |||
| ep-missing-header-fallback строка |
| нет описания | |||
| ep-profile-query-type строка |
| нет описания | |||
| h3c-compatibility строка |
| нет описания | |||
| nas-ip строка | нет описания | ||||
| password-encoding строка |
| нет описания | |||
| password-renewal строка |
| нет описания | |||
| radius-coa строка |
| нет описания | |||
| radius-port целое число | нет описания | ||||
| rsso строка |
| нет описания | |||
| rsso-context-timeout целое число | нет описания | ||||
| rsso-endpoint-attribute строка |
| нет описания | |||
| rsso-endpoint-block-attribute строка |
| нет описания | |||
| rsso-ep-one-ip-only string |
| нет описания | |||
| rsso-flush-ip-session string |
| нет описания | |||
| rsso-log-flags list / elements=string |
| нет описания | |||
| rsso-log-period integer | нет описания | ||||
| rsso-radius-response string |
| нет описания | |||
| rsso-radius-server-port integer | нет описания | ||||
| rsso-secret string | нет описания | ||||
| rsso-validate-request-secret string |
| нет описания | |||
| secondary-secret string | нет описания | ||||
| secondary-server string | нет описания | ||||
| secret string | нет описания | ||||
| server string | нет описания | ||||
| source-ip string | нет описания | ||||
| sso-attribute string |
| нет описания | |||
| sso-attribute-key string | нет описания | ||||
| sso-attribute-value-override string |
| нет описания | |||
| tertiary-secret string | нет описания | ||||
| tertiary-server string | нет описания | ||||
| timeout integer | нет описания | ||||
| use-group-for-profile string |
| нет описания | |||
| use-management-vdom string |
| нет описания | |||
| username-case-sensitive string |
| нет описания | |||
| h3c-compatibility string |
| Включить/выключить совместимость с H3C, механизмом, который выполняет проверку безопасности для аутентификации. | |||
| name string | Имя записи сервера RADIUS. | ||||
| nas-ip string | IP-адрес, используемый для связи с сервером RADIUS и используемый в качестве атрибутов NAS-IP-Address и Called-Station-ID. | ||||
| password-encoding string |
| Кодировка пароля. | |||
| password-renewal string |
| Включить/выключить обновление пароля. | |||
| radius-coa string |
| Включить для использования механизма изменения атрибутов сессии аутентификации, авторизации и учета после ее... | |||
| radius-port integer | Номер порта службы RADIUS. | ||||
| rsso string |
| Включить/выключить функцию единого входа на основе RADIUS. | |||
| rsso-context-timeout integer | Время в секундах, в течение которого отключенный пользователь удаляется из "списка контекста пользователей" вошедших пользователей. | ||||
| rsso-endpoint-attribute string |
| Атрибуты RADIUS, используемые для извлечения идентификатора конечной точки пользователя из записи RADIUS Start. | |||
| rsso-endpoint-block-attribute string |
| Атрибуты RADIUS, используемые для блокировки пользователя. | |||
| rsso-ep-one-ip-only string |
| Включить/отключить замену старых IP-адресов новыми для того же конечного узла в сообщениях учёта RADIUS. | |||
| rsso-flush-ip-session string |
| Включить/отключить сброс сессий пользователя IP при сообщениях остановки учёта RADIUS. | |||
| rsso-log-flags список / элементы=строка |
| без описания | |||
| rsso-log-period целое число | Интервал времени в секундах, в течение которого групповые сообщения журнала событий генерируются для динамических событий профиля. | ||||
| rsso-radius-response строка |
| Включить/отключить отправку пакетов ответа RADIUS после получения записей «Начало» и «Остановка». | |||
| rsso-radius-server-port целое число | Порт UDP для прослушивания записей «Начало» и «Остановка» RADIUS. | ||||
| rsso-secret строка | без описания | ||||
| rsso-validate-request-secret строка |
| Включить/отключить проверку общего секрета запроса RADIUS в записи «Начало» или «Окончание». | |||
| secondary-secret строка | без описания | ||||
| secondary-server строка | {<имя_строки|ip_строки>} имя домена или IP-адрес дополнительного сервера RADIUS CN. | ||||
| secret строка | без описания | ||||
| server строка | Основное имя домена или IP-адрес сервера RADIUS CN. | ||||
| source-ip строка | IP-адрес источника для связи с сервером RADIUS. | ||||
| sso-attribute строка |
| Атрибут RADIUS, содержащий имя группы профиля, которое нужно извлечь из записи «Начало» RADIUS. | |||
| sso-attribute-key строка | Префикс ключа для значения группы SSO в атрибуте SSO. | ||||
| sso-attribute-value-override строка |
| Включить/отключить переопределение старого значения атрибута новым значением для одного и того же конечного узла. | |||
| tertiary-secret строка | без описания | ||||
| tertiary-server строка | {<имя_строки|ip_строки>} имя домена или IP-адрес третичного сервера RADIUS CN. | ||||
| timeout целое число | Время в секундах между повторной отправкой запросов аутентификации. | ||||
| use-management-vdom строка |
| Включить/отключить использование VDOM управления для отправки запросов. | |||
| username-case-sensitive строка |
| Включить/отключить учет регистра в именах пользователей. | |||
| workspace_locking_adom строка | adom для блокировки в режиме рабочего пространства FortiManager. Значение может быть глобальным и другими, включая корневой. | ||||
| workspace_locking_timeout целое число | По умолчанию: 300 | Максимальное время в секундах ожидания пока другой пользователь разблокирует рабочее пространство. | |||
Примечания
Примечание
- Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращен ненулевой код rc. Вы также можете переопределить условия завершения с помощью параметров rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure RADIUS server entries.
fmgr_user_radius:
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: <value in [present, absent]>
user_radius:
accounting-server:
-
id: <value of integer>
port: <value of integer>
secret: <value of string>
server: <value of string>
source-ip: <value of string>
status: <value in [disable, enable]>
acct-all-servers: <value in [disable, enable]>
acct-interim-interval: <value of integer>
all-usergroup: <value in [disable, enable]>
auth-type: <value in [pap, chap, ms_chap, ...]>
class: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
acct-all-servers: <value in [disable, enable]>
acct-interim-interval: <value of integer>
all-usergroup: <value in [disable, enable]>
auth-type: <value in [pap, chap, ms_chap, ...]>
class: <value of string>
dp-carrier-endpoint-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
dp-carrier-endpoint-block-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
dp-context-timeout: <value of integer>
dp-flush-ip-session: <value in [disable, enable]>
dp-hold-time: <value of integer>
dp-http-header: <value of string>
dp-http-header-fallback: <value in [ip-header-address, default-profile]>
dp-http-header-status: <value in [disable, enable]>
dp-http-header-suppress: <value in [disable, enable]>
dp-log-dyn_flags:
- none
- protocol-error
- profile-missing
- context-missing
- accounting-stop-missed
- accounting-event
- radiusd-other
- endpoint-block
dp-log-period: <value of integer>
dp-mem-percent: <value of integer>
dp-profile-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
dp-profile-attribute-key: <value of string>
dp-radius-response: <value in [disable, enable]>
dp-radius-server-port: <value of integer>
dp-secret: <value of string>
dp-validate-request-secret: <value in [disable, enable]>
dynamic-profile: <value in [disable, enable]>
endpoint-translation: <value in [disable, enable]>
ep-carrier-endpoint-convert-hex: <value in [disable, enable]>
ep-carrier-endpoint-header: <value of string>
ep-carrier-endpoint-header-suppress: <value in [disable, enable]>
ep-carrier-endpoint-prefix: <value in [disable, enable]>
ep-carrier-endpoint-prefix-range-max: <value of integer>
ep-carrier-endpoint-prefix-range-min: <value of integer>
ep-carrier-endpoint-prefix-string: <value of string>
ep-carrier-endpoint-source: <value in [http-header, cookie]>
ep-ip-header: <value of string>
ep-ip-header-suppress: <value in [disable, enable]>
ep-missing-header-fallback: <value in [session-ip, policy-profile]>
ep-profile-query-type: <value in [session-ip, extract-ip, extract-carrier-endpoint]>
h3c-compatibility: <value in [disable, enable]>
nas-ip: <value of string>
password-encoding: <value in [ISO-8859-1, auto]>
password-renewal: <value in [disable, enable]>
radius-coa: <value in [disable, enable]>
radius-port: <value of integer>
rsso: <value in [disable, enable]>
rsso-context-timeout: <value of integer>
rsso-endpoint-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
rsso-endpoint-block-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
rsso-ep-one-ip-only: <value in [disable, enable]>
rsso-flush-ip-session: <value in [disable, enable]>
rsso-log-flags:
- none
- protocol-error
- profile-missing
- context-missing
- accounting-stop-missed
- accounting-event
- radiusd-other
- endpoint-block
rsso-log-period: <value of integer>
rsso-radius-response: <value in [disable, enable]>
rsso-radius-server-port: <value of integer>
rsso-secret: <value of string>
rsso-validate-request-secret: <value in [disable, enable]>
secondary-secret: <value of string>
secondary-server: <value of string>
secret: <value of string>
server: <value of string>
source-ip: <value of string>
sso-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
sso-attribute-key: <value of string>
sso-attribute-value-override: <value in [disable, enable]>
tertiary-secret: <value of string>
tertiary-server: <value of string>
timeout: <value of integer>
use-group-for-profile: <value in [disable, enable]>
use-management-vdom: <value in [disable, enable]>
username-case-sensitive: <value in [disable, enable]>
h3c-compatibility: <value in [disable, enable]>
name: <value of string>
nas-ip: <value of string>
password-encoding: <value in [ISO-8859-1, auto]>
password-renewal: <value in [disable, enable]>
radius-coa: <value in [disable, enable]>
radius-port: <value of integer>
rsso: <value in [disable, enable]>
rsso-context-timeout: <value of integer>
rsso-endpoint-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
rsso-endpoint-block-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
rsso-ep-one-ip-only: <value in [disable, enable]>
rsso-flush-ip-session: <value in [disable, enable]>
rsso-log-flags:
- none
- protocol-error
- profile-missing
- context-missing
- accounting-stop-missed
- accounting-event
- radiusd-other
- endpoint-block
rsso-log-period: <value of integer>
rsso-radius-response: <value in [disable, enable]>
rsso-radius-server-port: <value of integer>
rsso-secret: <value of string>
rsso-validate-request-secret: <value in [disable, enable]>
secondary-secret: <value of string>
secondary-server: <value of string>
secret: <value of string>
server: <value of string>
source-ip: <value of string>
sso-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
sso-attribute-key: <value of string>
sso-attribute-value-override: <value in [disable, enable]>
tertiary-secret: <value of string>
tertiary-server: <value of string>
timeout: <value of integer>
use-management-vdom: <value in [disable, enable]>
username-case-sensitive: <value in [disable, enable]>
Значения возврата
Общие значения возврата описаны здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрашиваемый URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Детальное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_user_radius_module.html