Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_device_auth – Управление системной аутентификацией на 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.

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

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Управление конфигурацией системной аутентификации. Этот модуль помогает настроить различные типы системной аутентификации. Обратите внимание, что этот модуль нельзя использовать для настройки типов аутентификации APM.

Параметры

Параметр

Комментарии

accounting

string

Указывает, как система передаёт на сервер TACACS+ сведения учёта, например информацию о том, к каким службам обращаются пользователи и какой объём сетевых ресурсов они потребляют.

Если задано значение send-to-first-server, система передаёт сведения учёта на первый доступный сервер TACACS+ в списке.

Если задано значение send-to-all-servers, система передаёт сведения учёта на все серверы TACACS+ в списке.

Этот параметр поддерживается типом tacacs.

Варианты:

  • "send-to-first-server"
  • "send-to-all-servers"

authentication

string

Указывает процесс, используемый системой при отправке запросов аутентификации.

Если задано значение use-first-server, система отправляет запросы аутентификации только на первый сервер в списке.

Если задано значение use-all-servers, система отправляет запрос аутентификации на каждый сервер, пока аутентификация не будет выполнена успешно или пока система не отправит запрос на все серверы в списке.

Этот параметр поддерживается типом tacacs.

Варианты:

  • "use-first-server"
  • "use-all-servers"

protocol_name

string

Указывает протокол, связанный со значением, заданным в service_name, которое представляет собой подмножество связанной службы, используемой для авторизации клиентов или системного учёта.

Обратите внимание, что в большинстве реализаций TACACS+ используется тип протокола ip, поэтому сначала попробуйте его.

Варианты:

  • "lcp"
  • "ip"
  • "ipx"
  • "atalk"
  • "vines"
  • "lat"
  • "xremote"
  • "tn3270"
  • "telnet"
  • "rlogin"
  • "pad"
  • "vpdn"
  • "ftp"
  • "http"
  • "deccp"
  • "osicp"
  • "unknown"

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

secret

string

Секретный ключ, используемый для шифрования и расшифровки пакетов, отправляемых на сервер или получаемых с него.

Не используйте знак решётки в секрете для серверов TACACS+.

При первой настройке аутентификации TACACS+ это значение обязательно.

servers

any

Задаёт список IPv4-адресов серверов, использующих протокол Terminal Access Controller Access System (TACACS)+, с которыми система обменивается данными для получения сведений об авторизации.

Для каждого адреса можно указать альтернативный номер порта TCP с помощью ключа port.

Если номер порта не указан, используется порт по умолчанию 49163.

Этот параметр поддерживается типом tacacs.

address

string

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

Это поле обязательно, если только вы не указываете простой список серверов. В этом случае в простом списке можно указать IP-адреса серверов. Дополнительные пояснения см. в примерах.

port

string

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

service_name

string

Задаёт имя службы, для использования которой пользователь запрашивает авторизацию.

Указание того, на использование чего именно пользователь запрашивает авторизацию, позволяет серверу TACACS+ по-разному обрабатывать запросы на авторизацию различных типов.

Это значение необходимо при настройке данного типа системной аутентификации.

Обратите внимание, что в большинстве реализаций TACACS+ используется тип службы ppp, поэтому сначала попробуйте его.

Варианты:

  • "slip"
  • "ppp"
  • "arap"
  • "shell"
  • "tty-daemon"
  • "connection"
  • "system"
  • "firewall"

state

string

Состояние конфигурации аутентификации в системе.

Если задано значение present, гарантируется, что система настроена для указанного type.

Если задано значение absent, источник аутентификации системы возвращается к local.

Варианты:

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

type

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

Тип аутентификации, которым управляет этот модуль.

Обратите особое внимание на то, что поддерживаемые этим модулем параметры зависят от настраиваемого type.

В настоящее время этот модуль поддерживает только часть всех доступных типов аутентификации.

Варианты:

  • "tacacs"
  • "local"

update_secret

string

Значение always позволяет обновлять секреты, если пользователь решит это сделать.

Значение on_create задаёт секрет только в том случае, если use_auth_source имеет значение true, а TACACS+ в данный момент не является источником аутентификации.

Варианты:

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

use_for_auth

boolean

Указывает, используется ли этот источник аутентификации в системе.

Варианты:

  • false
  • true

Примечания

Примечание

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

Примеры

- name: Set the system auth to TACACS+, default server port
  bigip_device_auth:
    type: tacacs
    authentication: use-all-servers
    accounting: send-to-all-servers
    protocol_name: ip
    secret: secret
    servers:
      - 10.10.10.10
      - 10.10.10.11
    service_name: ppp
    state: present
    use_for_auth: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Set the system auth to TACACS+, override server port
  bigip_device_auth:
    type: tacacs
    authentication: use-all-servers
    protocol_name: ip
    secret: secret
    servers:
      - address: 10.10.10.10
        port: 1234
      - 10.10.10.11
    service_name: ppp
    use_for_auth: true
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ

Описание

accounting

string

Серверы, на которые отправляются сведения при использовании TACACS.

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

Пример: "send-to-all-servers"

authentication

string

Процесс, используемый системой для обработки запросов аутентификации при использовании TACACS.

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

Пример: "use-all-servers"

protocol_name

string

Имя протокола, связанного с service_name, используемым для аутентификации клиентов.

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

Пример: "ip"

servers

list / элементы=string

Список серверов, используемых для аутентификации TACACS.

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

Пример: ["1.2.2.1", "4.5.5.4"]

service_name

string

Имя службы, для использования которой пользователь запрашивает авторизацию.

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

Пример: "ppp"

Авторы

  • Tim Rupp (@caphrim007)
  • Nitin Khanna (@nitinthewiz)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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_module.html

Spec-Zone.ru

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