Модуль lowlydba.sqlserver.credential — настройка учетных данных на сервере SQL

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: lowlydba.sqlserver.credential.

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

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

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

Создает, заменяет или удаляет учетные данные на сервере SQL.

Требования

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

Модуль PowerShell dbatools

Параметры

Параметр	Комментарии
force логическое значение	Если этот параметр включен, существующие учетные данные будут удалены и созданы заново. Варианты: `false` ← (по умолчанию) `true`
identity строка / обязательный	Идентификатор учетных данных.
mapped_class_type строка	Задает класс, связанный с учетными данными. Варианты: `"CryptographicProvider"` `"None"`
name строка	Имя учетных данных.
password строка	Пароль для аутентификации по идентификатору учетных данных.
provider_name строка	Указывает имя криптографического поставщика для поставщика управления ключами предприятия.
sql_instance строка / обязательный	Экземпляр SQL Server для изменения.
sql_password строка	Пароль для аутентификации SQL.
sql_username строка	Имя пользователя для аутентификации SQL.
state строка	Указывает, должен ли объект быть `present` или `absent`. Варианты: `"present"` ← (по умолчанию) `"absent"`

Атрибуты

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

Примеры

- name: Create a credential with a password
  lowlydba.sqlserver.credential:
    sql_instance: sql-01.myco.io
    identity: ad\\user
    name: MyCredential
    password : <Password>

- name: Replace an existing credential
  lowlydba.sqlserver.credential:
    sql_instance: sql-01.myco.io
    identity: MyIdentity
    force: true

- name: Create a credential using a SAS token for a backup URL
  lowlydba.sqlserver.credential:
    sql_instance: sql-01.myco.io
    identity: SHARED ACCESS SIGNATURE
    name: https://<azure storage account name>.blob.core.windows.net/<blob container>
    password : <Shared Access Token>

- name: Remove a credential
  lowlydba.sqlserver.credential:
    sql_instance: sql-01.myco.io
    identity: MyIdentity
    state: absent

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

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

Ключ	Описание
data словарь	Результат функции `New-DbaDbCredential`, `Get-DbaDbCredential` или `Remove-DbaDbCredential`. Возвращается: при успешном выполнении, но не в режиме check_mode.

Авторы

Joe Krilov (@Joey40)
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/credential_module.html