Модуль lowlydba.sqlserver.user_role — настройка роли пользователя в базе данных.

Примечание

Этот модуль входит в коллекцию lowlydba.sqlserver (версия 2.8.1).

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

Чтобы установить её, используйте: ansible-galaxy collection install lowlydba.sqlserver. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: lowlydba.sqlserver.user_role.

Добавлено в lowlydba.sqlserver 2.4.0

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

Краткое описание

Добавляет пользователя в роль базы данных или удаляет его из неё.
Используйте параметр roles, чтобы одновременно работать с несколькими ролями по схеме add/remove/set.

Требования

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

Модуль PowerShell dbatools

Параметры

Параметр	Комментарии
database строка / обязательный	База данных пользователя.
role строка	Роль базы данных, которую необходимо изменить для пользователя. Устарел: Этот параметр устарел и будет удалён в версии 3.0.0. Вместо него используйте roles.
roles словарь добавлено в lowlydba.sqlserver 2.8.0	Словарь ролей, которыми нужно управлять для пользователя. Поддерживает три ключа: `add`, `remove` и `set`. `add` добавляет пользователя в указанные роли. Пустой список не выполняет никаких действий и возвращает текущее членство в ролях. `remove` удаляет пользователя из указанных ролей. Пустой список не выполняет никаких действий и возвращает текущее членство в ролях. `set` заменяет все текущие роли указанными ролями. Пустой список удаляет все членства в ролях. `set` нельзя использовать вместе с `add` или `remove`. Должен быть указан хотя бы один ключ.
add список / элементы=строка	Список названий ролей, в которые нужно добавить пользователя. Может быть пустым, чтобы запросить текущее членство без внесения изменений.
remove список / элементы=строка	Список названий ролей, из которых нужно удалить пользователя. Может быть пустым, чтобы запросить текущее членство без внесения изменений.
set список / элементы=строка	Список названий ролей, которыми будут заменены текущие роли пользователя. Пустой список удаляет все членства в ролях.
sql_instance строка / обязательный	Экземпляр SQL Server, который необходимо изменить.
sql_password строка	Пароль для аутентификации SQL.
sql_username строка	Имя пользователя для аутентификации SQL.
state строка	Требуемое состояние членства пользователя в роли. Применяется только при использовании параметра role (устаревший режим). Нельзя использовать вместе с roles. Варианты: `"present"` `"absent"`
username строка / обязательный	Имя пользователя.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.
platform	Платформы: все	Целевые ОС и семейства ОС, с которыми можно работать.

Примеры

- name: Add a user to a fixed db role (legacy)
  lowlydba.sqlserver.user_role:
    sql_instance: sql-01.myco.io
    username: TheIntern
    database: InternProject1
    role: db_owner

- name: Remove a user from a fixed db role (legacy)
  lowlydba.sqlserver.user_role:
    sql_instance: sql-01.myco.io
    username: TheIntern
    database: InternProject1
    role: db_owner
    state: absent

- name: Add user to multiple roles
  lowlydba.sqlserver.user_role:
    sql_instance: sql-01.myco.io
    username: TheIntern
    database: InternProject1
    roles:
      add:
        - db_owner
        - db_datareader

- name: Remove user from multiple roles
  lowlydba.sqlserver.user_role:
    sql_instance: sql-01.myco.io
    username: TheIntern
    database: InternProject1
    roles:
      remove:
        - db_owner
        - db_datareader

- name: Set user's roles (replace all current roles)
  lowlydba.sqlserver.user_role:
    sql_instance: sql-01.myco.io
    username: TheIntern
    database: InternProject1
    roles:
      set:
        - db_datareader
        - db_datawriter

- name: Combine add and remove operations
  lowlydba.sqlserver.user_role:
    sql_instance: sql-01.myco.io
    username: TheIntern
    database: InternProject1
    roles:
      add:
        - db_securityadmin
      remove:
        - db_owner

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

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

Ключ	Описание
data словарь	Для параметра `roles` — сводный объект, содержащий сведения о текущем членстве в ролях, а также о добавленных или удалённых ролях. Для устаревшего параметра `role` — вывод `Add-DbaDbRoleMember` или `Remove-DbaDbRoleMember`. Не возвращается в режиме check_mode. Возвращается: при успехе
added список / элементы=строка	Список ролей, в которые пользователь был добавлен (или был бы добавлен в режиме check_mode). Возвращается: при успехе
removed список / элементы=строка	Список ролей, из которых пользователь был удалён (или был бы удалён в режиме check_mode). Возвращается: при успехе
roleMembership список / элементы=строка	Список ролей, членом которых в данный момент является пользователь. В режиме check_mode отражает состояние до внесения изменений. Возвращается: при успехе Пример: `["db_owner", "db_datareader"]`

Авторы

John McCall (@lowlydba)

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

© 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/lowlydba/sqlserver/user_role_module.html