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 строка	Варианты: base64 text ←	Управляет типом ввода для 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 строка		Варианты: enterprise local ←	Определяет срок действия учетной записи. Если `local`, учетная запись будет сохраняться для всех входов одного и того же пользователя на одном и том же узле. `enterprise` — то же самое, что и `local`, но учетная запись видна тому же пользователю домена при запуске на других узлах, а не только на localhost.
secret строка			Секрет для учетной записи. Если опущено, для учетной записи не используется секрет, если создается новая учетная запись. Если type — тип пароля, это пароль для username. Если type — тип сертификата, это PIN для сертификата.
secret_format строка		Варианты: base64 text ←	Управляет типом ввода для secret. Если `text`, secret — строка текста, закодированная в UTF-16LE в байты. Если `base64`, secret — строка base64, декодированная в байты из base64.
state строка		Варианты: absent present ←	При `absent`, учетная запись, указанная параметрами name и type, удаляется. При `present`, учетная запись, указанная параметрами name и type, удаляется.
type строка / обязательно		Варианты: domain_certificate domain_password generic_certificate generic_password	Тип учетной записи для хранения. Используется с name для создания уникальной учетной записи. Если тип — `domain` тип, учетная запись используется пакетами аутентификации Microsoft, такими как Negotiate. Если тип — `generic` тип, учетная запись не используется ни одним конкретным пакетом аутентификации. Рекомендуется использовать тип `domain`, так как только поставщики аутентификации могут получить доступ к секрету.
update_secret строка		Варианты: always ← on_create	При `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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/windows/win_credential_module.html