Модуль fortinet.fortimanager.fmgr_user_radius_dynamicmapping — настройка записей серверов RADIUS.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_user_radius_dynamicmapping.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо скорректировать с учётом источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True, только если схема модуля отличается от структуры API FortiManager: в этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Метод, переопределяющий метод базового запроса Json RPC. Варианты:
|
radius string / обязательный | Параметр (radius) в запрошенном URL. |
rc_failed list / elements=integer | Список кодов rc, переопределяющий условия сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, переопределяющий условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
user_radius_dynamicmapping dictionary | Набор параметров верхнего уровня. |
|
_scope list / elements=dictionary |
Область действия. |
|
name string |
Имя. |
|
vdom string |
VDOM. |
|
account_key_cert_field aliases: account-key-cert-field string |
Определяет поле идентификатора субъекта в сертификате для проверки прав доступа пользователя. Варианты:
|
|
account_key_processing aliases: account-key-processing string |
Операция обработки ключа учетной записи. Варианты:
|
|
accounting_server aliases: accounting-server list / elements=dictionary |
Сервер учета. |
|
id integer |
Идентификатор. |
|
interface string |
Интерфейс. |
|
interface_select_method aliases: interface-select-method string |
Метод выбора интерфейса. Варианты:
|
|
port integer |
Порт. |
|
secret any |
(список) Секрет. |
|
server string |
Сервер. |
|
source_ip aliases: source-ip string |
IP-адрес источника. |
|
status string |
Статус. Варианты:
|
|
vrf_select aliases: vrf-select integer |
Идентификатор VRF, используемый для подключения к серверу. |
|
acct_all_servers aliases: acct-all-servers string |
Учет на всех серверах. Варианты:
|
|
acct_interim_interval aliases: acct-interim-interval integer |
Промежуточный интервал учета. |
|
all_usergroup aliases: all-usergroup string |
Все группы пользователей. Варианты:
|
|
auth_type aliases: auth-type string |
Тип аутентификации. Варианты:
|
|
ca_cert aliases: ca-cert string |
Центр сертификации сервера, которому следует доверять при использовании TLS. |
|
call_station_id_type aliases: call-station-id-type string |
Настройка типа идентификатора вызывающей и вызываемой станции Варианты:
|
|
class any |
(список) Класс. |
|
client_cert aliases: client-cert string |
Сертификат клиента для использования с TLS. |
|
delimiter string |
Настройка разделителя для разделения имен групп профилей в атрибуте SSO Варианты:
|
|
dp_carrier_endpoint_attribute aliases: dp-carrier-endpoint-attribute string |
Атрибут конечной точки оператора DP. Варианты:
|
|
dp_carrier_endpoint_block_attribute aliases: dp-carrier-endpoint-block-attribute string |
Атрибут блока конечной точки оператора DP. Варианты:
|
|
dp_context_timeout aliases: dp-context-timeout integer |
Тайм-аут контекста DP. |
|
dp_flush_ip_session aliases: dp-flush-ip-session string |
Очистка IP-сеанса DP. Варианты:
|
|
dp_hold_time aliases: dp-hold-time integer |
Время удержания DP. |
|
dp_http_header aliases: dp-http-header string |
Заголовок HTTP DP. |
|
dp_http_header_fallback aliases: dp-http-header-fallback string |
Резервный заголовок HTTP DP. Варианты:
|
|
dp_http_header_status aliases: dp-http-header-status string |
Статус заголовка HTTP DP. Варианты:
|
|
dp_http_header_suppress aliases: dp-http-header-suppress string |
Подавление заголовка HTTP DP. Варианты:
|
|
dp_log_dyn_flags aliases: dp-log-dyn_flags list / elements=string |
Динамические флаги журнала DP. Варианты:
|
|
dp_log_period aliases: dp-log-period integer |
Период ведения журнала DP. |
|
dp_mem_percent aliases: dp-mem-percent integer |
Процент памяти DP. |
|
dp_profile_attribute aliases: dp-profile-attribute string |
Атрибут профиля DP. Варианты:
|
|
dp_profile_attribute_key aliases: dp-profile-attribute-key string |
Ключ атрибута профиля DP. |
|
dp_radius_response aliases: dp-radius-response string |
Ответ RADIUS DP. Варианты:
|
|
dp_radius_server_port aliases: dp-radius-server-port integer |
Порт сервера RADIUS DP. |
|
dp_secret aliases: dp-secret any |
(список) Секрет DP. |
|
dp_validate_request_secret aliases: dp-validate-request-secret string |
Проверка секрета запроса DP. Варианты:
|
|
dynamic_profile aliases: dynamic-profile string |
Динамический профиль. Варианты:
|
|
endpoint_translation aliases: endpoint-translation string |
Преобразование конечной точки. Варианты:
|
|
ep_carrier_endpoint_convert_hex aliases: ep-carrier-endpoint-convert-hex string |
Преобразование конечной точки оператора EP в шестнадцатеричный формат. Варианты:
|
|
ep_carrier_endpoint_header aliases: ep-carrier-endpoint-header string |
Заголовок конечной точки оператора EP. |
|
ep_carrier_endpoint_header_suppress aliases: ep-carrier-endpoint-header-suppress string |
Подавление заголовка конечной точки оператора EP. Варианты:
|
|
ep_carrier_endpoint_prefix aliases: ep-carrier-endpoint-prefix string |
Префикс конечной точки оператора EP. Варианты:
|
|
ep_carrier_endpoint_prefix_range_max aliases: ep-carrier-endpoint-prefix-range-max integer |
Максимальное значение диапазона префиксов конечной точки оператора EP. |
|
ep_carrier_endpoint_prefix_range_min aliases: ep-carrier-endpoint-prefix-range-min integer |
Минимальное значение диапазона префиксов конечной точки оператора EP. |
|
ep_carrier_endpoint_prefix_string aliases: ep-carrier-endpoint-prefix-string string |
Строка префикса конечной точки оператора EP. |
|
ep_carrier_endpoint_source aliases: ep-carrier-endpoint-source string |
Источник конечной точки оператора EP. Варианты:
|
|
ep_ip_header aliases: ep-ip-header string |
IP-заголовок EP. |
|
ep_ip_header_suppress aliases: ep-ip-header-suppress string |
Подавление IP-заголовка EP. Варианты:
|
|
ep_missing_header_fallback aliases: ep-missing-header-fallback string |
Резервное значение при отсутствии заголовка EP. Варианты:
|
|
ep_profile_query_type aliases: ep-profile-query-type string |
Тип запроса профиля EP. Варианты:
|
|
group_override_attr_type aliases: group-override-attr-type string |
Тип атрибута переопределения группы. Варианты:
|
|
h3c_compatibility aliases: h3c-compatibility string |
Совместимость с H3C. Варианты:
|
|
interface string |
Интерфейс. |
|
interface_select_method aliases: interface-select-method string |
Метод выбора интерфейса. Варианты:
|
|
mac_case aliases: mac-case string |
Регистр символов при аутентификации MAC Варианты:
|
|
mac_password_delimiter aliases: mac-password-delimiter string |
Разделитель пароля при аутентификации MAC Варианты:
|
|
mac_username_delimiter aliases: mac-username-delimiter string |
Разделитель имени пользователя при аутентификации MAC Варианты:
|
|
nas_id aliases: nas-id string |
Пользовательский идентификатор NAS. |
|
nas_id_type aliases: nas-id-type string |
Настройка типа идентификатора NAS Варианты:
|
|
nas_ip aliases: nas-ip string |
IP-адрес NAS. |
|
password_encoding aliases: password-encoding string |
Кодирование пароля. Варианты:
|
|
password_renewal aliases: password-renewal string |
Обновление пароля. Варианты:
|
|
radius_coa aliases: radius-coa string |
CoA RADIUS. Варианты:
|
|
radius_port aliases: radius-port integer |
Порт RADIUS. |
|
require_message_authenticator aliases: require-message-authenticator string |
Требовать наличие аутентификатора сообщения в ответе аутентификации. Варианты:
|
|
rsso string |
RSSO. Варианты:
|
|
rsso_context_timeout aliases: rsso-context-timeout integer |
Время ожидания контекста RSSO. |
|
rsso_endpoint_attribute aliases: rsso-endpoint-attribute string |
Атрибут конечной точки Rsso. Варианты:
|
|
rsso_endpoint_block_attribute aliases: rsso-endpoint-block-attribute string |
Атрибут блока конечной точки Rsso. Варианты:
|
|
rsso_ep_one_ip_only aliases: rsso-ep-one-ip-only string |
Только один IP-адрес для конечной точки Rsso. Варианты:
|
|
rsso_flush_ip_session aliases: rsso-flush-ip-session string |
Очистка IP-сеанса Rsso. Варианты:
|
|
rsso_log_flags aliases: rsso-log-flags list / elements=string |
Флаги журнала Rsso. Варианты:
|
|
rsso_log_period aliases: rsso-log-period integer |
Период ведения журнала Rsso. |
|
rsso_radius_response aliases: rsso-radius-response string |
Ответ RADIUS Rsso. Варианты:
|
|
rsso_radius_server_port aliases: rsso-radius-server-port integer |
Порт RADIUS-сервера Rsso. |
|
rsso_secret aliases: rsso-secret any |
(список) Секрет Rsso. |
|
rsso_validate_request_secret aliases: rsso-validate-request-secret string |
Проверка секрета запроса Rsso. Варианты:
|
|
secondary_secret aliases: secondary-secret any |
(список) Вторичный секрет. |
|
secondary_server aliases: secondary-server string |
Вторичный сервер. |
|
secret any |
(список) Секрет. |
|
server string |
Сервер. |
|
server_identity_check aliases: server-identity-check string |
Включить/отключить проверку подлинности RADIUS-сервера Варианты:
|
|
source_ip aliases: source-ip string |
IP-адрес источника. |
|
source_ip_interface aliases: source-ip-interface any |
(список) Интерфейс источника для связи с RADIUS-сервером. |
|
sso_attribute aliases: sso-attribute string |
Атрибут SSO. Варианты:
|
|
sso_attribute_key aliases: sso-attribute-key string |
Ключ атрибута SSO. |
|
sso_attribute_value_override aliases: sso-attribute-value-override string |
Переопределение значения атрибута SSO. Варианты:
|
|
status_ttl aliases: status-ttl integer |
Время кэширования доступности сервера: если сервер недоступен, повторная попытка не будет выполняться как минимум в течение этого… |
|
switch_controller_acct_fast_framedip_detect aliases: switch-controller-acct-fast-framedip-detect integer |
Быстрое обнаружение framedip для учета контроллера коммутатора. |
|
switch_controller_nas_ip_dynamic aliases: switch-controller-nas-ip-dynamic string |
Включить/отключить динамическую настройку nas-ip контроллером коммутатора. Варианты:
|
|
switch_controller_service_type aliases: switch-controller-service-type list / elements=string |
Тип службы контроллера коммутатора. Варианты:
|
|
tertiary_secret aliases: tertiary-secret any |
(список) Третичный секрет. |
|
tertiary_server aliases: tertiary-server string |
Третичный сервер. |
|
timeout integer |
Тайм-аут. |
|
tls_min_proto_version aliases: tls-min-proto-version string |
Минимальная поддерживаемая версия протокола для TLS-соединений Варианты:
|
|
transport_protocol aliases: transport-protocol string |
Используемый транспортный протокол Варианты:
|
|
use_group_for_profile aliases: use-group-for-profile string |
Использовать группу для профиля. Варианты:
|
|
use_management_vdom aliases: use-management-vdom string |
Использовать административный VDOM. Варианты:
|
|
username_case_sensitive aliases: username-case-sensitive string |
Учитывать регистр имени пользователя. Варианты:
|
|
vrf_select aliases: vrf-select integer |
Идентификатор VRF, используемый для подключения к серверу. |
workspace_locking_adom string | ADOM, блокируемый для FortiManager, работающего в режиме рабочей области; значением может быть global или другие области, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания, пока другой пользователь снимет блокировку рабочей области. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure dynamic mappings of RADIUS server
fortinet.fortimanager.fmgr_user_radius_dynamicmapping:
bypass_validation: false
adom: ansible
radius: ansible-test-radius # name
state: present
user_radius_dynamicmapping:
_scope:
- name: FGT_AWS # need a valid device name
vdom: root # need a valid vdom name under the device
server: ansible
timeout: 100
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the dynamic mappings of RADIUS server
fortinet.fortimanager.fmgr_fact:
facts:
selector: "user_radius_dynamicmapping"
params:
adom: "ansible"
radius: "ansible-test-radius" # name
dynamic_mapping: "your_value"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 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_user_radius_dynamicmapping_module.html