Resource Type: dsc_xwindowsoptionalfeature

Defined in:

lib/puppet/type/dsc_xwindowsoptionalfeature.rb

Providers:

powershell

Overview

The DSC xWindowsOptionalFeature resource type. Automatically generated from ‘xPSDesiredStateConfiguration/DSCResources/MSFT_xWindowsOptionalFeature/MSFT_xWindowsOptionalFeature.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present
  • absent

Parameters

• dsc_customproperties

  CustomProperties - The custom properties retrieved from the Windows optional feature as an array of strings.

• dsc_description

  Description - The description retrieved from the Windows optional feature.

• dsc_displayname

  DisplayName - The display name retrieved from the Windows optional feature.

• dsc_ensure

  Ensure - Specifies whether the feature should be enabled or disabled. To enable the feature, set this property to Present. To disable the feature, set the property to Absent. Valid values are Present, Absent.

• dsc_loglevel

  LogLevel - The maximum output level to show in the log. Accepted values are: ErrorsOnly (only errors are logged), ErrorsAndWarning (errors and warnings are logged), and ErrorsAndWarningAndInformation (errors, warnings, and debug information are logged). Valid values are ErrorsOnly, ErrorsAndWarning, ErrorsAndWarningAndInformation.

• dsc_logpath

  LogPath - The path to the log file to log this operation.

• dsc_name

  Name - The name of the feature to enable or disable.

• dsc_nowindowsupdatecheck

  NoWindowsUpdateCheck - Specifies whether or not DISM contacts Windows Update (WU) when searching for the source files to enable the feature. If $true, DISM will not contact WU.

  Supported values:

  • true
  • false
• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_removefilesondisable

  RemoveFilesOnDisable - Specifies that all files associated with the feature should be removed if the feature is being disabled.

  Supported values:

  • true
  • false
• name (namevar)
• provider

  The specific backend to use for this ‘dsc_xwindowsoptionalfeature` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.