Модуль f5networks.f5_modules.bigip_device_auth_radius — управление конфигурацией аутентификации RADIUS на устройстве BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

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

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_device_auth_radius.

Добавлено в f5networks.f5_modules 1.3.0

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

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

Модуль создаёт конфигурацию RADIUS.

Параметры

Параметр	Комментарии
accounting_bug boolean	Включает или отключает проверку вектора ответа учёта. Этот параметр нужен только для старых серверов. Варианты: `false` `true`
fallback_to_local boolean	Указывает, что система использует локальный метод аутентификации, если удалённый метод недоступен. Параметр доступен только в `TMOS 13.0.0` и более поздних версиях. Варианты: `false` `true`
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения о подключении.
auth_provider string	Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр используется преимущественно при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, данные телеметрии TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную окружения `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, так как её название было неоднозначным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_PASSWORD`.
server string / обязательный	Имя хоста BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Задаёт время ожидания в секундах при подключении к сетевому устройству или отправке команд. Если время ожидания истечёт до завершения операции, модуль завершится с ошибкой.
transport string	Настраивает транспортное соединение, используемое при подключении к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную окружения `F5_USER`.
validate_certs boolean	Если `no`, сертификаты SSL не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
retries integer	Задаёт количество повторных попыток аутентификации, разрешённых системой BIG-IP Local Traffic Management до её завершения с ошибкой.
servers list / elements=string	Задаёт имена серверов RADIUS, используемых в профилях аутентификации RADIUS.
service_type string	Задаёт тип службы, запрашиваемой у сервера RADIUS. Значение по умолчанию — `authenticate-only`. Варианты: `"authenticate-only"` `"login"` `"default"` `"framed"` `"callback-login"` `"callback-framed"` `"outbound"` `"administrative"` `"nas-prompt"` `"callback-nas-prompt"` `"call-check"` `"callback-administrative"`
state string	Если `state` равно `present`, обеспечивает наличие сервера RADIUS. Если `state` равно `absent`, обеспечивает удаление сервера RADIUS. Варианты: `"present"` ← (по умолчанию) `"absent"`
use_for_auth boolean	Указывает, будет ли этот источник аутентификации использоваться в системе. Если `true`, модуль задаёт текущий тип аутентификации системы равным значению `radius`. Если `false`, модуль задаёт тип аутентификации `local`. Это поведение аналогично случаю, когда `state` равно `absent`, но настроенный ресурс RADIUS не удаляется. Варианты: `false` `true`

Примечания

Примечание

Этот модуль использует возможности настройки аутентификации RADIUS через командную строку (TMSH), а не через графический интерфейс.
Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы сохранить конфигурацию BIG-IP на диск, обязательно включите как минимум одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Правильный способ сохранения текущей конфигурации описан в документации модуля.

Примеры

- name: Create an RADIUS device configuration
  bigip_device_auth_radius:
    servers:
      - "ansible_test1"
      - "ansible_test2"
    retries: 3
    service_type: authenticate-only
    accounting_bug: false
    use_for_auth: true
    fallback_to_local: true
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Update an RADIUS device configuration
  bigip_device_auth_radius:
    retries: 5
    service_type: administrative
    accounting_bug: true
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Delete RADIUS auth configuration
  bigip_device_auth_radius:
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Описание
accounting_bug boolean	Включает или отключает проверку вектора ответа учёта. Возвращается: changed Пример: `true`
retries integer	Количество повторных попыток аутентификации до её завершения с ошибкой. Возвращается: changed Пример: `10`
servers list / elements=string	Значение поля servers ресурса. Возвращается: changed Пример: `["hash/dictionary of values"]`
service_type string	Тип службы, запрашиваемой у сервера RADIUS. Возвращается: changed Пример: `"login"`

Авторы

Andrey Kashcheev (@andreykashcheev)
Wojciech Wypior (@wojtek0806)

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

© 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/f5networks/f5_modules/bigip_device_auth_radius_module.html