ansible.builtin.win_dsc (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Configures a resource using PowerShell DSC.

Requires PowerShell version 5.0 or newer.

Most of the options for this module are dynamic and will vary depending on the DSC Resource specified in I(resource_name).

See :doc:`/user_guide/windows_dsc` for more information on how to use this module.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Call DSC resource with DateTime option
  win_dsc:
    resource_name: DateTimeResource
    DateTimeOption: '2019-02-22T13:57:31.2311892+00:00'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
free_form:
    description:
    - The M(win_dsc) module takes in multiple free form options based on the DSC resource
      being invoked by I(resource_name).
    - There is no option actually named C(free_form) so see the examples.
    - This module will try and convert the option to the correct type required by the
      DSC resource and throw a warning if it fails.
    - If the type of the DSC resource option is a C(CimInstance) or C(CimInstance[]),
      this means the value should be a dictionary or list of dictionaries based on the
      values required by that option.
    - If the type of the DSC resource option is a C(PSCredential) then there needs to
      be 2 options set in the Ansible task definition suffixed with C(_username) and C(_password).
    - If the type of the DSC resource option is an array, then a list should be provided
      but a comma separated string also work. Use a list where possible as no escaping
      is required and it works with more complex types list C(CimInstance[]).
    - If the type of the DSC resource option is a C(DateTime), you should use a string
      in the form of an ISO 8901 string to ensure the exact date is used.
    - Since Ansible 2.8, Ansible will now validate the input fields against the DSC resource
      definition automatically. Older versions will silently ignore invalid fields.
    required: true
    type: str

resource_name:
    description:
    - The name of the DSC Resource to use.
    - Must be accessible to PowerShell using any of the default paths.
    required: true
    type: str

module_version:
    default: latest
    description:
    - Can be used to configure the exact version of the DSC resource to be invoked.
    - Useful if the target node has multiple versions installed of the module containing
      the DSC resource.
    - If not specified, the module will follow standard PowerShell convention and use
      the highest version available.
    type: str

Outputs

module_version:
  description: The version of the dsc resource/module used.
  returned: always
  sample: 1.0.1
  type: str
reboot_required:
  description: Flag returned from the DSC engine indicating whether or not the machine
    requires a reboot for the invoked changes to take effect.
  returned: always
  sample: true
  type: bool
verbose_set:
  description: The verbose output as a list from executing the DSC Set method.
  returned: Ansible verbosity is -vvv or greater and a change occurred
  sample:
  - 'Perform operation ''Invoke CimMethod'' with the following parameters, '
  - '[SERVER]: LCM: [Start Set ] [[File]DirectResourceAccess]'
  - Operation 'Invoke CimMethod' complete.
  type: list
verbose_test:
  description: The verbose output as a list from executing the DSC test method.
  returned: Ansible verbosity is -vvv or greater
  sample:
  - 'Perform operation ''Invoke CimMethod'' with the following parameters, '
  - '[SERVER]: LCM: [Start Test ] [[File]DirectResourceAccess]'
  - Operation 'Invoke CimMethod' complete.
  type: list