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`, то в определении задачи Ansible должны быть установлены 2 параметра, оканчивающихся на `_username` и `_password`. Если тип параметра ресурса DSC — массив, то должен быть предоставлен список, но также работает и строка, разделённая запятыми. Используйте список, где это возможно, так как при этом не требуется экранирование, и он работает с более сложными типами списка `CimInstance[]`.
module_version -	Значение по умолчанию: "latest"	Может быть использован для настройки точной версии ресурса 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. [сообщество]

Авторы

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