win_dsc - Вызов конфигурации PowerShell DSC

Новая версия с 2.4.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Описание

Настраивает ресурс с помощью PowerShell DSC.
Требуется версия PowerShell 5.0 или более поздняя.
Большинство параметров этого модуля динамические и будут различаться в зависимости от ресурса DSC, указанного в параметре resource_name.
См. Конфигурация желаемого состояния для получения дополнительной информации о том, как использовать этот модуль.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
free_form обязательно		Модуль win_dsc принимает несколько свободных параметров, основанных на ресурсе DSC, вызываемом параметром resource_name. Нет параметра с именем `free_form`, поэтому обратитесь к примерам. Этот модуль попытается преобразовать параметр в требуемый тип ресурса DSC и выведет предупреждение, если это не удастся. Если тип параметра ресурса DSC — `CimInstance` или `CimInstance[]`, это означает, что значение должно быть словарем или списком словарей в соответствии с требованиями данного параметра. Если тип параметра ресурса DSC — `PSCredential`, необходимо установить 2 параметра в определении задачи Ansible, добавленные суффиксом `_username` и `_password`. Если тип параметра ресурса DSC — массив, то должен быть предоставлен список, но работает и строка с разделителем запятая. Используйте список, где это возможно, так как не требуется экранирование, и он работает с более сложными типами списков `CimInstance[]`.
module_version	Значение по умолчанию: "последняя версия"	Может быть использован для настройки конкретной версии ресурса DSC, который будет вызван. Полезно, если на целевом узле установлено несколько версий модуля, содержащего ресурс DSC. Если не указано, модуль будет следовать стандартной конвенции PowerShell и использовать последнюю доступную версию.
resource_name обязательно		Имя ресурса DSC для использования. Должен быть доступен для PowerShell с помощью стандартных путей.

Примечания

Примечание

По умолчанию есть несколько встроенных ресурсов, поставляемых с PowerShell 5.0. См. https://docs.microsoft.com/en-us/powershell/dsc/builtinresource для получения дополнительной информации об этих ресурсах.
Пользовательские ресурсы DSC можно установить с помощью win_psmodule с параметром name.
Движок DSC выполняет каждую задачу как учётная запись SYSTEM. Любые ресурсы, к которым необходимо получить доступ с другой учётной записью, должны иметь PsDscRunAsCredential.

Примеры

- name: Extract zip file
  win_dsc:
    resource_name: Archive
    Ensure: Present
    Path: C:\Temp\zipfile.zip
    Destination: C:\Temp\Temp2

- name: Install a Windows feature with the WindowsFeature resource
  win_dsc:
    resource_name: WindowsFeature
    Name: telnet-client

- name: Edit HKCU reg key under specific user
  win_regedit:
    resource_name: Registry
    Ensure: Present
    Key: HKEY_CURRENT_USER\ExampleKey
    ValueName: TestValue
    ValueData: TestData
    PsDscRunAsCredential_username: '{{ansible_user}}'
    PsDscRunAsCredentual_password: '{{ansible_password}}'
  no_log: true

- name: Create file with multiple attributes
  win_dsc:
    resource_name: File
    DestinationPath: C:\ansible\dsc
    Attributes: # can also be a comma separated string, e.g. 'Hidden, System'
    - Hidden
    - System
    Ensure: Present
    Type: Directory

# more complex example using custom DSC resource and dict values
- name: Setup the xWebAdministration module
  win_psmodule:
    name: xWebAdministration
    state: present

- name: Create IIS Website with Binding and Authentication options
  win_dsc:
    resource_name: xWebsite
    Ensure: Present
    Name: DSC Website
    State: Started
    PhysicalPath: C:\inetpub\wwwroot
    BindingInfo: # Example of a CimInstance[] DSC parameter (list of dicts)
    - Protocol: https
      Port: 1234
      CertificateStoreName: MY
      CertificateThumbprint: C676A89018C4D5902353545343634F35E6B3A659
      HostName: DSCTest
      IPAddress: '*'
      SSLFlags: '1'
    - Protocol: http
      Port: 4321
      IPAddress: '*'
    AuthenticationInfo: # Example of a CimInstance DSC parameter (dict)
      Anonymous: no
      Basic: true
      Digest: false
      Windows: yes

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

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

Ключ	Возвращаемое значение	Описание
message строка	ошибка	любое сообщение об ошибке при вызове ресурса DSC Пример: Найдено несколько модулей DSC с именем ресурса xyz
module_version строка	успех	Версия используемого ресурса/модуля dsc. Пример: 1.0.1
reboot_required булево	всегда	Флаг, возвращаемый движком DSC, указывающий, требуется ли перезагрузка машины для вступления в силу внесённых изменений. Пример: True

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, также поддерживаемых сообществом Ansible, см. в данном разделе.

Автор

Trond Hindenes (@trondhindenes)

Подсказка

Если вы обнаружите проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/win_dsc_module.html