Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_remote_role — управление удаленными ролями на 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_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 / обязательный

Указывает имя удаленной роли.

partition_access

string

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

Этот параметр поддерживает зарезервированные имена all и Common, а также конкретные разделы, к которым пользователь может получить доступ.

Пользователи, имеющие доступ к разделу, могут выполнять операции с объектами в этом разделе в соответствии с разрешениями, предоставленными их assigned_role.

При создании новой удаленной роли, если этот параметр не указан, используется значение по умолчанию all.

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

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

Системная роль, связанная с этой удаленной ролью.

Возвращается: при изменении

Пример: "administrator"

attribute_string

string

Новое значение строки атрибутов ресурса.

Возвращается: при изменении

Пример: "memberOf=cn=ldap_group,cn=ldap.group,ou=ldap"

line_order

integer

Порядок удаленной роли для серверов LDAP и Active Directory.

Возвращается: при изменении

Пример: 1000

partition_access

string

Раздел, к которому имеет доступ роль.

Возвращается: при изменении

Пример: "all"

remote_access

boolean

Разрешен ли удаленный доступ.

Возвращается: при изменении

Пример: false

terminal_access

string

Настройка терминального доступа для удаленной роли.

Возвращается: при изменении

Пример: "tmsh"

Авторы

  • Tim Rupp (@caphrim007)

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

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

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

Spec-Zone.ru

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