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

Примечание

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

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

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

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_remote_role.

Новое в f5networks.f5_modules 1.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
assigned_role string	Указывает авторизацию (уровень доступа) для учетной записи. При создании новой удаленной роли, если этот параметр не указан, по умолчанию используется `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 string	Указывает атрибуты учетной записи пользователя, сохраненные в группе, в формате `cn=, ou=, dc=`. При создании новой удаленной роли этот параметр обязателен.
line_order integer	Указывает порядок строки в файле `/config/bigip/auth/remoterole`. Серверы LDAP и Active Directory считывают этот файл построчно. Порядок информации важен; поэтому компания F5 рекомендует установить первую строку на 1000. Это позволит в будущем вставлять строки перед первой строкой. При создании новой удаленной роли этот параметр обязателен.
name string / required	Указывает имя удаленной роли.
partition_access string	Указывает доступные разделы для учетной записи. Этот параметр поддерживает зарезервированные имена `all` и `Common`, а также определенные разделы, к которым может получить доступ пользователь. Пользователи, имеющие доступ к разделу, могут работать с объектами в этом разделе, как это определено разрешениями, предоставленными `assigned_role` пользователя. При создании новой удаленной роли, если этот параметр не указан, по умолчанию используется `all`.
provider dictionary added in 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 aliases: pass, pwd string / required	Пароль для учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`.
server string / required	Хост BIG-IP или хост BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истекло до завершения операции, модуль выведет ошибку.
transport string	Настраивает транспортное соединение, которое следует использовать при подключении к удаленному устройству. Варианты: `"rest"` ← (по умолчанию)
user string / required	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь права администратора на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs boolean	Если `no`, сертификаты SSL не проверяются. Используйте это только на лично контролируемых сайтах, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
remote_access boolean	Включает или отключает удаленный доступ для указанной группы удаленно аутентифицированных пользователей. При создании новой удаленной роли, если этот параметр не указан, по умолчанию используется `true`. Варианты: `false` `true`

state

string

Когда present, гарантирует существование удаленной роли.

Когда absent, удаляет удаленную роль из системы.

Варианты:

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

terminal_access

string

Указывает терминальный доступ для удаленных учетных записей, которым еще не назначена роль пользователя.

Общие значения для этого параметра включают 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: ldap_group
    line_order: 1
    attribute_string: memberOf=cn=ldap_group,cn=ldap.group,ou=ldap
    remote_access: true
    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 string	Системная роль, связанная с этой удаленной ролью. Возвращается: changed Пример: `"administrator"`
attribute_string string	Новая строка атрибутов ресурса. Возвращается: changed Пример: `"memberOf=cn=ldap_group,cn=ldap.group,ou=ldap"`
line_order integer	Порядок удаленной роли для серверов LDAP и Active Directory. Возвращается: changed Пример: `1000`
partition_access string	Раздел, к которому есть доступ у роли. Возвращается: changed Пример: `"all"`
remote_access boolean	Разрешен ли удаленный доступ или нет. Возвращается: changed Пример: `false`
terminal_access string	Настройка терминала для удаленной роли. Возвращается: changed Пример: `"tmsh"`

Авторы

Tim Rupp (@caphrim007)

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

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