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

Новое в версии 2.7.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

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

Требования

Нижеперечисленные требования необходимы на хосте, на котором выполняется этот модуль.

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
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`.
password - / обязательно			Пароль учётной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
provider - добавлено в 2.5		По умолчанию: null	Объект словаря с данными подключения.
	password - / обязательно		Пароль учётной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
	server - / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
	server_port -	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
	ssh_keyfile -		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout -	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку.
	transport - / обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для подключения к удалённому устройству.
	user - / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
remote_access boolean		Варианты: no yes	Включает или отключает удалённый доступ для указанной группы удалённо аутентифицированных пользователей. При создании новой удалённой роли, если этот параметр не указан, значение по умолчанию — `yes`.
server - / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
server_port - добавлено в 2.2		По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
state -		Варианты: absent present ←	При значении `present`, гарантируется существование удалённой роли. При значении `absent`, удаляет удалённую роль из системы.
terminal_access -			Указывает доступ на основе терминала для удалённых учётных записей, которым ещё не явно назначена роль пользователя. Общие значения включают `tmsh` и `none`, но также могут быть указаны пользовательские значения. При создании новой удалённой роли, если этот параметр не указан, значение по умолчанию — `none`.
user - / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
validate_certs boolean добавлено в 2.0		Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется пакет Python f5-sdk на хосте. Это так же просто, как pip install f5-sdk.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только рабочую конфигурацию продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохраняется на диске, необходимо включить хотя бы одну задачу, использующую модуль 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

Статус

Гарантия обратной совместимости этого модуля не предоставляется. [превью]
Этот модуль поддерживается партнером Ansible. [сертифицировано]

Авторы

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.7/modules/bigip_remote_role_module.html