Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию 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_server.

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

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

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

  • Управляет конфигурацией RADIUS-сервера устройства.
  • Используется вместе с модулем bigip_device_auth_radius.

Параметры

Параметр

Комментарии

description

string

Описание RADIUS-сервера.

ip

string

IP-адрес сервера.

Этот параметр обязателен при создании нового ресурса.

name

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

Имя RADIUS-сервера, которым нужно управлять.

partition

string

Раздел устройства, в котором нужно управлять ресурсами.

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

port

integer

Порт сервера.

Допустимый диапазон значений — от 0 до 65535 включительно.

provider

dictionary

добавлено в f5networks.f5_modules 1.0.0

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

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 ← (по умолчанию)

secret

string

Секрет для доступа к RADIUS-серверу.

Этот параметр обязателен при создании нового ресурса.

state

string

Если state равно present, обеспечивает наличие RADIUS-сервера.

Если state равно absent, обеспечивает удаление RADIUS-сервера.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

timeout

integer

Задаёт значение тайм-аута в секундах.

Допустимый диапазон значений — от 1 до 60 включительно.

update_secret

string

always обновит пароли, если указан secret.

on_create задаст пароль только для вновь созданных серверов.

Варианты:

  • "always" ← (по умолчанию)
  • "on_create"

Примечания

Примечание

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

Примеры

- name: Create a RADIUS server configuration
  bigip_device_auth_radius_server:
    name: "ansible_test"
    ip: "1.1.1.1"
    port: 1812
    secret: "secret"
    timeout: 5
    update_secret: on_create
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Update RADIUS server configuration
  bigip_device_auth_radius_server:
    name: "ansible_test"
    ip: "10.10.10.1"
    description: "this is a test"
    port: 1813
    timeout: 10
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove RADIUS server configuration
  bigip_device_auth_radius_server:
    name: "ansible_test"
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ

Описание

description

string

Описание RADIUS-сервера, заданное пользователем.

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

Пример: "this is my server"

ip

string

IP-адрес RADIUS-сервера.

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

Пример: "1.1.1.1"

port

integer

Порт службы RADIUS.

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

Пример: 1812

timeout

integer

Значение тайм-аута.

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

Пример: 3

Авторы

  • 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_server_module.html

Spec-Zone.ru

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