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

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

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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

Статус

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

Автор

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.5/modules/win_dsc_module.html