f5networks.f5_modules.bigip_remote_role – Управление удалёнными ролями на BIG-IP

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).

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

Чтобы использовать его в книге задач, укажите: f5networks.f5_modules.bigip_remote_role.

Добавлено в версии 1.0.0: модуля f5networks.f5_modules

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

Обзор

Управляет удалёнными ролями на системе BIG-IP. Удалённые роли используются в ситуациях, когда аутентификация пользователей выполняется вне устройства. Местный контроль доступа к BIG-IP управляется определённой удалённой ролью, а аутентификация (и, как следствие, назначение роли) выполняется вне устройства.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
assigned_role строка			Указывает авторизацию (уровень доступа) для учётной записи. При создании новой удалённой роли, если этот параметр не указан, значение по умолчанию равно `none`. Параметр `partition_access` управляет тем, к каким разделам может получить доступ учётная запись. Выбранная роль может повлиять на доступные разделы. В частности, роли, такие как `administrator`, `auditor` и `resource-administrator` требуют `partition_access` `all`. Система поставляется с набором предварительно созданных ролей. Это `none`, `guest`, `operator`, `application-editor`, `manager`, `certificate-manager`, `irule-manager`, `user-manager`, `resource-administrator`, `auditor`, `administrator`, и `firewall-manager`.
attribute_string строка			Указывает атрибуты учётной записи, сохранённые в группе, в формате `cn=, ou=, dc=`. При создании новой удалённой роли этот параметр обязателен.
line_order целое число			Указывает порядок строки в файле `/config/bigip/auth/remoterole`. Сервера LDAP и Active Directory читают этот файл построчно. Порядок информации важен; поэтому F5 рекомендует установить первую строку на 1000. Это позволяет вставлять строки перед первой строкой в будущем. При создании новой удалённой роли этот параметр обязателен.
name строка / обязательно			Указывает имя удалённой роли.
partition_access строка			Указывает доступные разделы для учётной записи. Этот параметр поддерживает зарезервированные имена `all` и `Common`, а также определённые разделы, к которым пользователь может получить доступ. Пользователи, имеющие доступ к разделу, могут работать с объектами в этом разделе, как определено разрешениями, предоставленными ролью пользователя `assigned_role`. При создании новой удалённой роли, если этот параметр не указан, значение по умолчанию равно `all`.
provider словарь добавлено в версии 1.0.0 модуля f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации с удалённого устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem булево	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TEEM`.
	password строка / обязательно		Пароль для учётной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	timeout целое число		Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение для использования при подключении к удалённому устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
remote_access булево		Варианты: no yes	Включает или отключает удалённый доступ для указанной группы удалённо аутентифицированных пользователей. При создании новой удалённой роли, если этот параметр не указан, значение по умолчанию равно `yes`.
state строка		Варианты: absent present ←	Когда `present`, гарантирует существование удалённой роли. Когда `absent`, удаляет удалённую роль из системы.
terminal_access строка			Указывает доступ, основанный на терминале, для удалённых учётных записей, которым ещё не назначена роль пользователя. Общие значения для этого включают `tmsh` и `none`, но вы также можете указать пользовательские значения. При создании новой удалённой роли, если этот параметр не указан, значение по умолчанию равно `none`.

Примечания

Примечание

Дополнительную информацию об использовании 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 remote role
  bigip_remote_role:
    name: foo
    group_name: ldap_group
    line_order: 1
    attribute_string: memberOf=cn=ldap_group,cn=ldap.group,ou=ldap
    remote_access: enabled
    assigned_role: administrator
    partition_access: all
    terminal_access: none
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
assigned_role строка	changed	Система роли, связанной с этой удалённой ролью. Пример: administrator
attribute_string строка	changed	Новая строка атрибутов ресурса. Пример: memberOf=cn=ldap_group,cn=ldap.group,ou=ldap
line_order целое число	changed	Порядок удалённой роли для серверов LDAP и Active Directory. Пример: 1000
partition_access строка	changed	Раздел, к которому имеет доступ роль. Пример: all
remote_access булево	changed	Разрешён ли удалённый доступ или нет.
terminal_access строка	changed	Настройка терминала для удалённой роли. Пример: tmsh

Авторы

Tim Rupp (@caphrim007)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_remote_role_module.html