Модуль community.windows.win_credential – Управление учетными данными Windows в диспетчере учетных данных

Примечание

Этот модуль является частью коллекции community.windows (версия 2.3.0).

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

Для установки используйте: 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"` `"text"` ← (по умолчанию)
name строка / обязательно	Ключ атрибута. Это не уникальный идентификатор, так как несколько атрибутов могут иметь один и тот же ключ.
comment строка	Пользовательский комментарий к учетным данным.
name строка / обязательно	Целевое значение, которое идентифицирует сервер или серверы, для которых предназначены учетные данные. Если значение может быть именем NetBIOS, именем DNS-сервера, суффиксом имени DNS-хоста с символом подстановки (``), именем NetBIOS или DNS-домена, содержащим последовательность символов подстановки, или звездочкой. См. `TargetName` в https://docs.microsoft.com/en-us/windows/win32/api/wincred/ns-wincred-credentiala для получения более подробной информации о том, что может быть этим значением. Используется вместе с type* для создания уникальных учетных данных.
persistence строка	Определяет сохранение учетных данных. Если `local`, учетные данные сохранятся для всех входов пользователя на одном и том же хосте. `enterprise` — это то же самое, что и `local`, но учетные данные видны тому же пользователю домена при запуске на других хостах, а не только на локальном хосте. Варианты: `"enterprise"` `"local"` ← (по умолчанию)
secret строка	Секрет для учетных данных. Если опущено, то для учетных данных не используется секрет, если создаются новые учетные данные. Если type — тип пароля, это пароль для username. Если type — тип сертификата, это пин для сертификата.
secret_format строка	Управляет типом ввода для secret. Если `text`, secret — это текстовая строка, закодированная в байты с помощью UTF-16LE. Если `base64`, secret — это строка base64, декодированная в байты. Варианты: `"base64"` `"text"` ← (по умолчанию)
state строка	Если `absent`, учетные данные, указанные параметрами name и type, удаляются. Если `present`, учетные данные, указанные параметрами name и type, добавляются. Варианты: `"absent"` `"present"` ← (по умолчанию)
type строка / обязательно	Тип учетных данных для хранения. Используется вместе с name для создания уникальных учетных данных. Если тип — `domain` тип, учетные данные используются пакетами аутентификации Microsoft, такими как Negotiate. Если тип — `generic` тип, учетные данные не используются ни одним конкретным пакетом аутентификации. Рекомендуется использовать тип `domain` , так как только поставщики аутентификации могут получить доступ к секрету. Варианты: `"domain_certificate"` `"domain_password"` `"generic_certificate"` `"generic_password"`
update_secret строка	Если `always`, секрет всегда будет обновляться, если они отличаются. Если `on_create`, секрет будет проверяться/обновляться только при его первом создании. Если секрет не может быть получен, и это значение установлено на `always`, модуль всегда будет указывать на изменение. Варианты: `"always"` ← (по умолчанию) `"on_create"`
username строка	Если type — тип пароля, то это имя пользователя для хранения учетных данных. Если type — тип учетных данных, то это отпечаток сертификата в виде шестнадцатеричной строки для использования. Если `type=domain_password`, это должно быть в формате Netlogon (DOMAIN\ИмяПользователя) или UPN (username@DOMAIN). Если используется отпечаток сертификата, сертификат должен существовать в хранилище сертификатов `CurrentUser\My` для пользователя, выполняющего действие.

Примечания

Примечание

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

См. также

ansible.windows.win_user_right: Управление правами доступа пользователей Windows.
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/windows/win_credential_module.html