fortinet.fortimanager.fmgr_user_radius_dynamicmapping модуль — Настройка записей сервера RADIUS.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое значение | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
radius строка / обязательно | Параметр (radius) в запрошенном URL. |
rc_failed список / элементы=целое число | Список кодов rc, с помощью которых будут переопределены условия для неудачи. |
rc_succeeded список / элементы=целое число | Список кодов rc, с помощью которых будут переопределены условия для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
user_radius_dynamicmapping словарь | Настройка верхнего уровня параметров. |
|
_scope список / элементы=словарь |
Область. |
|
name строка |
Имя. |
|
vdom строка |
Vdom. |
|
account_key_cert_field строка |
Устарело, пожалуйста, переименуйте на account_key_cert_field. Определите поле идентификатора субъекта в сертификате для права доступа пользователя… Варианты:
|
|
account_key_processing строка |
Устарело, пожалуйста, переименуйте на account_key_processing. Операция обработки ключа учетной записи. Варианты:
|
|
accounting_server список / элементы=словарь |
Устарело, пожалуйста, переименуйте на accounting_server. Сервер учета. |
|
id целое число |
Идентификатор. |
|
interface строка |
Интерфейс. |
|
interface_select_method строка |
Устарело, пожалуйста, переименуйте на interface_select_method. Метод выбора интерфейса. Варианты:
|
|
port целое число |
Порт. |
|
секрет любой |
(список) Секрет. |
|
сервер строка |
Сервер. |
|
source-ip строка |
Устаревшее, пожалуйста, переименуйте его на source_ip. Источник ip. |
|
состояние строка |
Состояние. Варианты:
|
|
acct-all-servers строка |
Устаревшее, пожалуйста, переименуйте его на acct_all_servers. Все серверы acct. Варианты:
|
|
acct-интервал-промежутка целое число |
Устаревшее, пожалуйста, переименуйте его на acct_interim_interval. Промежуток acct. |
|
all-группа-пользователей строка |
Устаревшее, пожалуйста, переименуйте его на all_usergroup. Все группы пользователей. Варианты:
|
|
auth-тип строка |
Устаревшее, пожалуйста, переименуйте его на auth_type. Тип авторизации. Варианты:
|
|
ca-сертификат строка |
Устаревшее, пожалуйста, переименуйте его на ca_cert. Сертификат CA для доверия сервера по TLS. |
|
call-станция-id-тип строка |
Устаревшее, пожалуйста, переименуйте его на call_station_id_type. Конфигурация типа идентификатора вызывающей и вызываемой станции Варианты:
|
|
класс любой |
(список) Класс. |
|
client-сертификат строка |
Устаревшее, пожалуйста, переименуйте его на client_cert. Клиентский сертификат для использования по TLS. |
|
разделитель строка |
Настройка разделителя, используемого для разделения имён групп профилей в атрибуте SSO Варианты:
|
|
dp-носитель-точка-окончания-атрибут строка |
Устаревшее, пожалуйста, переименуйте его на dp_carrier_endpoint_attribute. Атрибут точки окончания dp носителя. Варианты:
|
|
dp-carrier-endpoint-block-attribute string |
Устарело, переименуйте в dp_carrier_endpoint_block_attribute. Атрибут блока конечной точки оператора Dp. Варианты:
|
|
dp-context-timeout integer |
Устарело, переименуйте в dp_context_timeout. Время ожидания контекста Dp. |
|
dp-flush-ip-session string |
Устарело, переименуйте в dp_flush_ip_session. Сброс сеанса IP Dp. Варианты:
|
|
dp-hold-time integer |
Устарело, переименуйте в dp_hold_time. Время удержания Dp. |
|
dp-http-header string |
Устарело, переименуйте в dp_http_header. HTTP-заголовок Dp. |
|
dp-http-header-fallback string |
Устарело, переименуйте в dp_http_header_fallback. Резервный HTTP-заголовок Dp. Варианты:
|
|
dp-http-header-status string |
Устарело, переименуйте в dp_http_header_status. Статус HTTP-заголовка Dp. Варианты:
|
|
dp-http-header-suppress string |
Устарело, переименуйте в dp_http_header_suppress. Подавление HTTP-заголовка Dp. Варианты:
|
|
dp-log-dyn_flags list / elements=string |
Устарело, переименуйте в dp_log_dyn_flags. Флаги динамического журнала Dp. Варианты:
|
|
dp-log-period integer |
Устарело, переименуйте в dp_log_period. Период журнала Dp. |
|
dp-mem-percent integer |
Устарело, переименуйте в dp_mem_percent. Процент памяти Dp. |
|
dp-profile-attribute string |
Устарело, переименуйте в dp_profile_attribute. Атрибут профиля Dp. Варианты:
|
|
dp-profile-attribute-key string |
Устарело, переименуйте в dp_profile_attribute_key. Ключ атрибута профиля Dp. |
|
dp-radius-response string |
Устарело, переименуйте в dp_radius_response. Ответ Radius Dp. Варианты:
|
|
dp-radius-server-port integer |
Устарело, переименуйте в dp_radius_server_port. Порт сервера Radius Dp. |
|
dp-secret any |
(list) Устарело, переименуйте в dp_secret. Секрет Dp. |
|
dp-validate-request-secret string |
Устарело, переименуйте в dp_validate_request_secret. Секрет проверки запроса Dp. Варианты:
|
|
dynamic-profile string |
Устарело, переименуйте в dynamic_profile. Динамический профиль. Варианты:
|
|
endpoint-translation string |
Устарело, переименуйте в endpoint_translation. Преобразование конечной точки. Варианты:
|
|
ep-carrier-endpoint-convert-hex string |
Устарело, переименуйте в ep_carrier_endpoint_convert_hex. Преобразование конечной точки оператора в шестнадцатеричный формат. Варианты:
|
|
ep-carrier-endpoint-header string |
Устарело, переименуйте в ep_carrier_endpoint_header. Заголовок конечной точки оператора. |
|
ep-carrier-endpoint-header-suppress string |
Устарело, переименуйте в ep_carrier_endpoint_header_suppress. Подавление заголовка конечной точки оператора. Варианты:
|
|
ep-carrier-endpoint-prefix string |
Устарело, переименуйте в ep_carrier_endpoint_prefix. Префикс конечной точки оператора. Варианты:
|
|
ep-carrier-endpoint-prefix-range-max integer |
Устарело, переименуйте в ep_carrier_endpoint_prefix_range_max. Максимальный диапазон префикса конечной точки оператора. |
|
ep-carrier-endpoint-prefix-range-min integer |
Устарело, переименуйте в ep_carrier_endpoint_prefix_range_min. Минимальный диапазон префикса конечной точки оператора. |
|
ep-carrier-endpoint-prefix-string string |
Устарело, переименуйте в ep_carrier_endpoint_prefix_string. Строка префикса конечной точки оператора. |
|
ep-carrier-endpoint-source string |
Устарело, переименуйте в ep_carrier_endpoint_source. Источник конечной точки оператора. Варианты:
|
|
ep-ip-header string |
Устарело, переименуйте в ep_ip_header. IP-заголовок. |
|
ep-ip-header-suppress string |
Устарело, переименуйте в ep_ip_header_suppress. Подавление IP-заголовка. Варианты:
|
|
ep-missing-header-fallback string |
Устарело, переименуйте в ep_missing_header_fallback. Резервный вариант при отсутствующем заголовке. Варианты:
|
|
ep-profile-query-type string |
Устарело, переименуйте в ep_profile_query_type. Тип запроса профиля EP. Варианты:
|
|
group-override-attr-type string |
Устарело, переименуйте в group_override_attr_type. Тип атрибута перезаписи группы. Варианты:
|
|
h3c-compatibility string |
Устарело, переименуйте в h3c_compatibility. Совместимость с H3c. Варианты:
|
|
interface string |
Интерфейс. |
|
interface-select-method string |
Устарело, переименуйте в interface_select_method. Метод выбора интерфейса. Варианты:
|
|
mac-case string |
Устарело, переименуйте в mac_case. Регистр MAC-адреса при аутентификации. Варианты:
|
|
mac-password-delimiter string |
Устарело, переименуйте в mac_password_delimiter. Разделитель пароля при MAC-аутентификации. Варианты:
|
|
mac-username-delimiter string |
Устарело, переименуйте в mac_username_delimiter. Разделитель имени пользователя при MAC-аутентификации. Варианты:
|
|
nas-id string |
Устарело, переименуйте в nas_id. Пользовательский идентификатор NAS. |
|
nas-id-type string |
Устарело, переименуйте в nas_id_type. Конфигурация типа идентификатора NAS. Варианты:
|
|
nas-ip string |
Устарело, переименуйте в nas_ip. IP-адрес NAS. |
|
password-encoding string |
Устарело, переименуйте в password_encoding. Кодирование пароля. Варианты:
|
|
password-renewal string |
Устарело, переименуйте в password_renewal. Обновление пароля. Варианты:
|
|
radius-coa string |
Устарело, переименуйте в radius_coa. Radius COA. Варианты:
|
|
radius-port integer |
Устарело, переименуйте в radius_port. Порт Radius. |
|
rsso string |
Rsso. Варианты:
|
|
rsso-context-timeout integer |
Устарело, переименуйте в rsso_context_timeout. Время ожидания контекста Rsso. |
|
rsso-endpoint-attribute string |
Устарело, переименуйте в rsso_endpoint_attribute. Атрибут конечной точки Rsso. Choices:
|
|
rsso-endpoint-block-attribute string |
Устарело, переименуйте в rsso_endpoint_block_attribute. Атрибут блокировки конечной точки Rsso. Choices:
|
|
rsso-ep-one-ip-only string |
Устарело, переименуйте в rsso_ep_one_ip_only. Только один IP для конечной точки Rsso. Choices:
|
|
rsso-flush-ip-session string |
Устарело, переименуйте в rsso_flush_ip_session. Очистка сессии IP Rsso. Choices:
|
|
rsso-log-flags list / elements=string |
Устарело, переименуйте в rsso_log_flags. Флаги журнала Rsso. Choices:
|
|
rsso-log-period integer |
Устарело, переименуйте в rsso_log_period. Период регистрации Rsso. |
|
rsso-radius-response string |
Устарело, переименуйте в rsso_radius_response. Ответ Radius Rsso. Choices:
|
|
rsso-radius-server-port integer |
Устарело, переименуйте в rsso_radius_server_port. Порт сервера Radius Rsso. |
|
rsso-secret any |
(list) Устарело, переименуйте в rsso_secret. Секрет Rsso. |
|
rsso-validate-request-secret string |
Устарело, переименуйте в rsso_validate_request_secret. Секрет проверки запроса Rsso. Choices:
|
|
secondary-secret any |
(list) Устарело, переименуйте в secondary_secret. Вторичный секрет. |
|
secondary-server string |
Устарело, переименуйте в secondary_server. Вторичный сервер. |
|
secret any |
(list) Секрет. |
|
server string |
Сервер. |
|
server-identity-check string |
Устарело, пожалуйста, переименуйте в server_identity_check. Включить/выключить проверку подлинности RADIUS-сервера Choices:
|
|
source-ip string |
Устарело, пожалуйста, переименуйте в source_ip. Исходный IP-адрес. |
|
source-ip-interface any |
(list) Устарело, пожалуйста, переименуйте в source_ip_interface. Исходный интерфейс для связи с RADIUS-сервером. |
|
sso-attribute string |
Устарело, пожалуйста, переименуйте в sso_attribute. Атрибут SSO. Choices:
|
|
sso-attribute-key string |
Устарело, пожалуйста, переименуйте в sso_attribute_key. Ключ атрибута SSO. |
|
sso-attribute-value-override string |
Устарело, пожалуйста, переименуйте в sso_attribute_value_override. Переопределение значения атрибута SSO. Choices:
|
|
status-ttl integer |
Устарело, пожалуйста, переименуйте в status_ttl. Время, в течение которого кэшируется доступность сервера, так что когда сервер недоступен… |
|
switch-controller-acct-fast-framedip-detect integer |
Устарело, пожалуйста, переименуйте в switch_controller_acct_fast_framedip_detect. Обнаружение switch controller acct fast framedip. |
|
switch-controller-nas-ip-dynamic string |
Устарело, пожалуйста, переименуйте в switch_controller_nas_ip_dynamic. Включить/выключить динамический IP-адрес switch-controller nas для динамич… Choices:
|
|
switch-controller-service-type list / elements=string |
Устарело, пожалуйста, переименуйте в switch_controller_service_type. Тип службы контроллера коммутатора. Choices:
|
|
tertiary-secret any |
(list) Устарело, пожалуйста, переименуйте в tertiary_secret. Третичный секрет. |
|
tertiary-server string |
Устарело, пожалуйста, переименуйте в tertiary_server. Третичный сервер. |
|
timeout integer |
Тайм-аут. |
|
tls-min-proto-version string |
Устарело, пожалуйста, переименуйте в tls_min_proto_version. Минимально поддерживаемая версия протокола для TLS-соединений Choices:
|
|
transport-protocol string |
Устаревшее, пожалуйста, переименуйте на transport_protocol. Протокол транспорта, который необходимо использовать Варианты:
|
|
use-group-for-profile string |
Устаревшее, пожалуйста, переименуйте на use_group_for_profile. Использование группы для профиля. Варианты:
|
|
use-management-vdom string |
Устаревшее, пожалуйста, переименуйте на use_management_vdom. Использование управляемого vdom. Варианты:
|
|
username-case-sensitive string |
Устаревшее, пожалуйста, переименуйте на username_case_sensitive. Имя пользователя чувствительно к регистру. Варианты:
|
workspace_locking_adom string | ADOM для блокировки в режиме работы FortiManager в рабочем пространстве. Значение может быть глобальным и другими, включая корневой. |
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 помогают в работе.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно, выполнение одного модуля может завершиться ошибкой, если возвращен ненулевой rc. Вы также можете переопределить условия для завершения ошибкой или успехом с параметрами rc_failed и rc_succeeded
Примеры
- name: Example playbook
hosts: fortimanagers
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_user_radius_dynamicmapping_module.html