community.windows.win_credential – Управляет учетными данными Windows в диспетчере учетных данных
Примечание
Этот плагин входит в сборку community.windows (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install community.windows.
Для использования в книге задач укажите: community.windows.win_credential.
Обзор
- Используется для создания и удаления учетных данных Windows в диспетчере учетных данных.
- Этот модуль может управлять как стандартными учетными данными (имя пользователя/пароль), так и учетными данными сертификатов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| alias строка | Добавляет псевдоним для учетных данных. Обычно это имя NetBIOS узла, если name задано как имя DNS. | ||
| attributes список / элементы=словарь | Список словарей, задающих атрибуты, специфичные для приложения, для учетных данных. При установке существующие атрибуты будут сравниваться со списком в целом. Любые различия означают, что все атрибуты будут заменены. | ||
| data строка | Значение атрибута. | ||
| data_format строка |
| Управляет типом входных данных для data. Если text, data — текстовая строка, закодированная в UTF-16LE в байты.Если base64, data — строка base64, декодированная в байты base64. | |
| name строка / обязательно | Ключ атрибута. Это не уникальный идентификатор, поскольку несколько атрибутов могут иметь один и тот же ключ. | ||
| comment строка | Пользовательский комментарий к учетным данным. | ||
| name строка / обязательно | Цель, которая идентифицирует сервер(ы) или сервера, для которых предназначены учетные данные. Если значение может быть именем NetBIOS, именем сервера DNS, суффиксом имени хоста DNS с символом подстановки ( *), именем NetBIOS или именем домена DNS, содержащим последовательность символов подстановки, или звездочкой.См. TargetName в https://docs.microsoft.com/en-us/windows/desktop/api/wincred/ns-wincred-_credentiala для получения дополнительных сведений о том, каким может быть это значение.Используется с type для создания уникальных учетных данных. | ||
| persistence строка |
| Определяет сохранение учетных данных. Если local, учетные данные будут сохранены для всех входов одного и того же пользователя на одном и том же узле.enterprise аналогично local, но учетные данные будут видны одному и тому же пользователю домена при запуске на других узлах, а не только на локальном. | |
| secret строка | Секрет для учетных данных. Если опущено, для учетных данных не используется никакого секрета, если создаются новые учетные данные. Если type — тип пароля, это пароль для username. Если type — тип сертификата, это пин-код для сертификата. | ||
| secret_format строка |
| Управляет типом входных данных для secret. Если text, secret — текстовая строка, закодированная в UTF-16LE в байты.Если base64, secret — строка base64, декодированная в байты base64. | |
| state строка |
| Когда absent, учетные данные, указанные name и type, удаляются.Когда present, учетные данные, указанные name и type, удаляются. | |
| type строка / обязательно |
| Тип хранимых учетных данных. Используется с name для создания уникальных учетных данных. Когда тип — domain тип, учетные данные используются пакетами аутентификации Microsoft, такими как Negotiate.Когда тип — generic тип, учетные данные не используются ни одним конкретным пакетом аутентификации.Рекомендуется использовать domain тип, так как только поставщики аутентификации могут получить доступ к секрету. | |
| update_secret строка |
| Когда always, секрет всегда обновляется, если они отличаются.Когда on_create, секрет проверяется/обновляется только при его первом создании.Если секрет не может быть получен, а это значение установлено как always, модуль всегда укажет на изменение. | |
| username строка | Если type — тип пароля, это имя пользователя для хранения учетных данных. Если type — тип учетных данных, это отпечаток сертификата в виде шестнадцатеричной строки, который нужно использовать. Когда type=domain_password, это должно быть в формате Netlogon (DOMAIN\Username) или UPN (username@DOMAIN).Если используется отпечаток сертификата, сертификат должен существовать в хранилище сертификатов CurrentUser\My для выполняющего пользователя. | ||
Примечания
Примечание
- Для работы с этим модулем требуется запуск с
becomeдля доступа к хранилищу учетных данных пользователя. - Может быть только одна учетная запись на один узел и тип. Если определена вторая учетная запись, использующая тот же узел и тип, то исходная учетная запись перезаписывается.
См. также
См. также
- ansible.windows.win_user_right
-
Официальная документация по модулю ansible.windows.win_user_right.
- ansible.windows.win_whoami
-
Официальная документация по модулю ansible.windows.win_whoami.
Примеры
- name: Create a local only credential
community.windows.win_credential:
name: server.domain.com
type: domain_password
username: DOMAIN\username
secret: Password01
state: present
- name: Remove a credential
community.windows.win_credential:
name: server.domain.com
type: domain_password
state: absent
- name: Create a credential with full values
community.windows.win_credential:
name: server.domain.com
type: domain_password
alias: server
username: username@DOMAIN.COM
secret: Password01
comment: Credential for server.domain.com
persistence: enterprise
attributes:
- name: Source
data: Ansible
- name: Unique Identifier
data: Y3VzdG9tIGF0dHJpYnV0ZQ==
data_format: base64
- name: Create a certificate credential
community.windows.win_credential:
name: '*.domain.com'
type: domain_certificate
username: 0074CC4F200D27DC3877C24A92BA8EA21E6C7AF4
state: present
- name: Create a generic credential
community.windows.win_credential:
name: smbhost
type: generic_password
username: smbuser
secret: smbuser
state: present
- name: Remove a generic credential
community.windows.win_credential:
name: smbhost
type: generic_password
state: absent
Авторы
- Jordan Borean (@jborean93)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/windows/win_credential_module.html