computermanagementdsc

Table of Contents

1. Description
2. Requirements
3. Usage
4. Troubleshooting

Description

This is an auto-generated module, using the Puppet DSC Builder to vendor and expose the ComputerManagementDsc PowerShell module's DSC resources as Puppet resources. The functionality of this module comes entirely from the vendored PowerShell resources, which are pinned at v10.0.0. The PowerShell module describes itself like this:

DSC resources for configuration of a Windows computer. These DSC resources allow you to perform computer management tasks, such as renaming the computer, joining a domain and scheduling tasks as well as configuring items such as virtual memory, event logs, time zones and power settings.

For information on troubleshooting to determine whether any encountered problems are with the Puppet wrapper or the DSC resource, see the troubleshooting section below.

Requirements

This module, like all auto-generated Puppetized DSC modules, relies on two important technologies in the Puppet stack: the Puppet Resource API and the puppetlabs/pwshlib Puppet module.

The Resource API provides a simplified option for writing types and providers and is responsible for how this module is structured. The Resource API ships inside of Puppet starting with version 6. While it is technically possible to add the Resource API functionality to Puppet 5.5.x, the DSC functionality has not been tested in this setup. For more information on the Resource API, review the documentation.

The module also depends on the pwshlib module. This Puppet module includes two important things: the ruby-pwsh library for running PowerShell code from ruby and the base provider for DSC resources, which this module leverages.

All of the actual work being done to call the DSC resources vendored with this module is in this file from the pwshlib module. This is important for troubleshooting and bug reporting, but doesn't impact your use of the module except that the end result will be that nothing works, as the dependency is not installed alongside this module!

Long File Path Support

Several PowerShell modules with DSC Resources end up with very long file paths once vendored, many of which exceed the 260 character limit for file paths. Luckily in Windows 10 (build 1607+), Windows Server 2016 (build 1607+), and Windows Server 2019 there is now an option for supporting long file paths transparently!

We strongly recommend enabling long file path support on any machines using this module to avoid path length issues.

You can set this value using the Puppet registry_value resource:

registry_value { 'HKLM\System\CurrentControlSet\Control\FileSystem\LongPathsEnabled':
  ensure   => 'present',
  data     => [1],
  provider => 'registry',
  type     => 'dword',
}

You can also set this value outside of Puppet by following the Microsoft documentation.

Usage

You can specify any of the DSC resources from this module like a normal Puppet resource in your manifests. The examples below use DSC resources from from the PowerShellGet repository, regardless of what module you're looking at here; the syntax, not the specifics, is what's important.

For reference documentation about the DSC resources exposed in this module, see the Reference Forge tab, or the REFERENCE.md file.

# Include a meaningful title for your resource declaration
dsc_psrepository { 'Add team module repo':
    dsc_name               => 'foo',
    dsc_ensure             => present,
    # This location is nonsense, can be any valid folder on your
    # machine or in a share, any location the SourceLocation param
    # for the DSC resource will accept.
    dsc_sourcelocation     => 'C:\Program Files',
    # You must always pass an enum fully lower-cased;
    # Puppet is case sensitive even when PowerShell isn't
    dsc_installationpolicy => untrusted,
}

dsc_psrepository { 'Trust public gallery':
    dsc_name               => 'PSGallery',
    dsc_ensure             => present,
    dsc_installationpolicy => trusted,
}

dsc_psmodule { 'Make Ruby manageable via uru':
  dsc_name   => 'RubyInstaller',
  dsc_ensure => present,
}

Credentials

Credentials are always specified as a hash of the username and password for the account. The password must use the Puppet Sensitive type; this ensures that logs and reports redact the password, displaying it instead as <Sensitive [value redacted]>.

dsc_psrepository { 'PowerShell Gallery':
  dsc_name                 => 'psgAllery',
  dsc_installationpolicy   => 'Trusted',
  dsc_psdscrunascredential => {
    user     => 'apple',
    password => Sensitive('foobar'),
  },
}

Class-Based Resources

Class-based DSC Resources can be used like any other DSC Resource in this module, with one important note: Due to a bug in calling class-based DSC Resources by path instead of module name, each call to Invoke-DscResource needs to temporarily munge the system-level environment variable for PSModulePath; the variable is reset prior to the end of each invocation.

CIM Instances

Because the CIM instances for DSC resources are fully mapped, the types actually explain fairly precisely what the shape of each CIM instance has to be - and, moreover, the type definition means that you get checking at catalog compile time. Puppet parses CIM instances are structured hashes (or arrays of structured hashes) that explicitly declare their keys and the valid types of values for each key.

So, for the dsc_accesscontrolentry property of the dsc_ntfsaccessentry type, which has a MOF type of NTFSAccessControlList[], Puppet defines the CIM instance as:

Array[Struct[{
  accesscontrolentry => Array[Struct[{
    accesscontroltype => Enum['Allow', 'Deny'],
    inheritance => Enum['This folder only', 'This folder subfolders and files', 'This folder and subfolders', 'This folder and files', 'Subfolders and files only', 'Subfolders only', 'Files only'],
    ensure => Enum['Present', 'Absent'],
    cim_instance_type => 'NTFSAccessControlEntry',
    filesystemrights => Array[Enum['AppendData', 'ChangePermissions', 'CreateDirectories', 'CreateFiles', 'Delete', 'DeleteSubdirectoriesAndFiles', 'ExecuteFile', 'FullControl', 'ListDirectory', 'Modify', 'Read', 'ReadAndExecute', 'ReadAttributes', 'ReadData', 'ReadExtendedAttributes', 'ReadPermissions', 'Synchronize', 'TakeOwnership', 'Traverse', 'Write', 'WriteAttributes', 'WriteData', 'WriteExtendedAttributes']]
  }]],
  forceprincipal => Optional[Boolean],
  principal => Optional[String],
}]]

A valid example of that in a puppet manifest looks like this:

dsc_accesscontrollist => [
  {
    accesscontrolentry => [
      {
        accesscontroltype => 'Allow',
        inheritance       => 'This folder only',
        ensure            => 'Present',
        filesystemrights  => 'ChangePermissions',
        cim_instance_type => 'NTFSAccessControlEntry',
      },
    ],
    principal          => 'veryRealUserName',
  },
]

For more information about using a built module, check out our narrative documentation.

Properties

Note that the only properties specified in a resource declaration which are passed to Invoke-Dsc are all prepended with dsc. If a property does _not start with dsc_ it is used to control how Puppet interacts with DSC/other Puppet resources - for example, specifying a unique name for the resource for Puppet to distinguish between declarations or Puppet metaparameters (notifies, before, etc).

Validation Mode

By default, these resources use the property validation mode, which checks whether or not the resource is in the desired state the same way most Puppet resources are validated; by comparing the properties returned from the system with those specified in the manifest. Sometimes, however, this is insufficient; many DSC Resources return data that does not compare properly to the desired state (some are missing properties, others are malformed, some simply cannot be strictly compared). In these cases, you can set the validation mode to resource, which falls back on calling Invoke-DscResource with the Test method and trusts that result.

When using the resource validation mode, the resource is tested once and will then treat all properties of that resource as in sync (if the result returned true) or not in sync. This loses the granularity of change reporting for the resource but prevents flapping and unexpected behavior.

# This will flap because the DSC resource never returns name in SecurityPolicyDsc v2.10.0.0
dsc_securityoption { 'Enforce Anonoymous SID Translation':
  dsc_name => 'Enforce Anonymous SID Translation',
  dsc_network_access_allow_anonymous_sid_name_translation => 'Disabled',
}

# This will idempotently apply
dsc_psrepository { 'PowerShell Gallery':
  validation_mode => 'resource',
  dsc_name        => 'Enforce Anonymous SID Translation',
  dsc_network_access_allow_anonymous_sid_name_translation => 'Disabled',
}

It is important to note that this feature is only supported with a version of puppetlabs-pwshlib equal to or higher than 0.9.0, in which the supporting code for the DSC Base Provider to implement custom insync was shipped.

Finally, while this module's metadata says that the supported Puppet versions are 6.0.0 and up, the implementation of the validation_mode parameter relies on the custom_insync feature of the Puppet Resource API. The custom_insync feature first shipped in the puppet-resource_api version 1.8.14, which itself is only included in Puppet versions equal to or newer than 6.23.0 and 7.8.0 for the 6x and 7x platforms respectively. Using this module against older Puppet versions will result in a warning (example below) and only use the default property-by-property change reporting, regardless of the setting of validation_mode.

Warning: Unknown feature detected: ["custom_insync"]

Troubleshooting

In general, there are three broad categories of problems:

1. Problems with the way the underlying DSC resource works.
2. Problems with the type definition, where you can't specify a valid set of properties for the DSC resource
3. Problems with calling the underlying DSC resource - the parameters aren't being passed correctly or the resource can't be found

Unfortunately, problems with the way the underlying DSC resource works are something we can't help directly with. You'll need to file an issue with the upstream maintainers for the PowerShell module.

Problems with the type definition are when a value that should be valid according to the DSC resource's documentation and code is not accepted by the Puppet wrapper. If and when you run across one of these, please file an issue with the Puppet DSC Builder; this is where the conversion happens and once we know of a problem we can fix it and regenerate the Puppet modules. To help us identify the issue, please specify the DSC module, version, resource, property and values that are giving you issues. Once a fix is available we will regenerate and release updated versions of this Puppet wrapper.

Problems with calling the underlying DSC resource become apparent by comparing <value passed in in puppet> with <value received by DSC>. In this case, please file an issue with the puppetlabs/pwshlib module, which is where the DSC base provider actually lives. We'll investigate and prioritize a fix and update the puppetlabs/pwshlib module. Updating to the pwshlib version with the fix will immediately take advantage of the improved functionality without waiting for this module to be reconverted and published.

For specific information on troubleshooting a generated module, check the troubleshooting guide for the puppet.dsc module.

Known Limitations

• Currently, because of the way Puppet caches files on agents, use of the legacy puppetlabs-dsc module is not compatible with this or any auto-generated DSC module. Inclusion of both will lead to pluginsync conflicts.

• Right now, if you have the same version of a PowerShell module with class-based DSC Resources in your PSModulePath as vendored in a Puppetized DSC Module, you cannot use those class-based DSC Resources from inside of Puppet due to a bug in DSC which prevents using a module by path reference instead of name. Instead, DSC will see that there are two DSC Resources for the same module and version and then error out.

• When PowerShell Script Block Logging is enabled, data marked as sensitive in your manifest may appear in these logs as plain text. It is highly recommended, by both Puppet and Microsoft, that you also enable Protected Event Logging alongside this to encrypt the logs to protect this information.

Configuring the LCM

In order for a Puppetized DSC module to function, the DSC Local Configuration Manager (LCM) RefreshMode must be set to either Push or Disabled. The default value for RefreshMode in WMF 5.0 and WMF 5.1 is Push - so if it has not been set to anything else then there is no action needed on your part. However if the value of the LCM has been set to anything other than Push then the module will not function and so the value must either be changed back or disabled.

The Puppetized DSC modules use the Invoke-DscResource cmdlet to invoke DSC Resources of the target machine. If the RefreshMode is set to Pull, DSC Resources will only run from a DSC Pull Server - in this setting DSC does not allow any DSC Resources to be run interactively on the host.

Module Installation

If you're using this module with Puppet Enterprise and Code Manager, everything should "just work" - no errors or issues acquiring and deploying this or any Puppetized DSC module to nodes.

Unfortunately, due a bug in minitar which prevents it from unpacking archives with long file paths, both r10k and serverless Puppet (via puppet module install) methods of installing modules with long path names will fail. In short, minitar is unable to unpack modules that contain long file paths (though it can create them).

As a workaround, you can retrieve DSC modules from the forge via PowerShell and 7zip:

$ModuleAuthor = 'dsc'
$ModuleName = 'xremotedesktopsessionhost'
$ModuleVersion = '2.0.0-0-1'
$ArchiveFileName = "$ModuleAuthor-$ModuleName-$ModuleVersion.tar.gz"
$DownloadUri = "https://forge.puppet.com/v3/files/$ArchiveFileName"
# Download the module tar.gz to the current directory
Invoke-WebRequest -Uri $DownloadUri -OutFile ./$ArchiveFileName
# Use 7zip to extract the module to the current directory
& 7z x $ArchiveFileName -so | & 7z x -aoa -si -ttar

Reference

Table of Contents

Resource types

• dsc_computer: The DSC Computer resource type. Automatically generated from version 10.0.0
• dsc_ieenhancedsecurityconfiguration: The DSC IEEnhancedSecurityConfiguration resource type. Automatically generated from version 10.0.0
• dsc_offlinedomainjoin: The DSC OfflineDomainJoin resource type. Automatically generated from version 10.0.0
• dsc_pendingreboot: The DSC PendingReboot resource type. Automatically generated from version 10.0.0
• dsc_powerplan: The DSC PowerPlan resource type. Automatically generated from version 10.0.0
• dsc_powershellexecutionpolicy: The DSC PowerShellExecutionPolicy resource type. Automatically generated from version 10.0.0
• dsc_psresourcerepository: The DSC PSResourceRepository resource type. Automatically generated from version 10.0.0
• dsc_remotedesktopadmin: The DSC RemoteDesktopAdmin resource type. Automatically generated from version 10.0.0
• dsc_scheduledtask: The DSC ScheduledTask resource type. Automatically generated from version 10.0.0
• dsc_smbserverconfiguration: The DSC SmbServerConfiguration resource type. Automatically generated from version 10.0.0
• dsc_smbshare: The DSC SmbShare resource type. Automatically generated from version 10.0.0
• dsc_systemlocale: The DSC SystemLocale resource type. Automatically generated from version 10.0.0
• dsc_systemprotection: The DSC SystemProtection resource type. Automatically generated from version 10.0.0
• dsc_systemrestorepoint: The DSC SystemRestorePoint resource type. Automatically generated from version 10.0.0
• dsc_timezone: The DSC TimeZone resource type. Automatically generated from version 10.0.0
• dsc_useraccountcontrol: The DSC UserAccountControl resource type. Automatically generated from version 10.0.0
• dsc_virtualmemory: The DSC VirtualMemory resource type. Automatically generated from version 10.0.0
• dsc_windowscapability: The DSC WindowsCapability resource type. Automatically generated from version 10.0.0
• dsc_windowseventlog: The DSC WindowsEventLog resource type. Automatically generated from version 10.0.0

Resource types

dsc_computer

The DSC Computer resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_computer type.

dsc_currentou

Data type: Optional[String]

A read-only property that specifies the organizational unit that the computer account is currently in.

dsc_description

Data type: Optional[String]

The value assigned here will be set as the local computer description.

dsc_domainname

Data type: Optional[String]

The name of the domain to join.

dsc_options

Data type: Optional[Array[Enum['AccountCreate', 'accountcreate', 'Win9XUpgrade', 'win9xupgrade', 'UnsecuredJoin', 'unsecuredjoin', 'PasswordPass', 'passwordpass', 'JoinWithNewName', 'joinwithnewname', 'JoinReadOnly', 'joinreadonly', 'InstallInvoke', 'installinvoke']]]

Specifies advanced options for the Add-Computer join operation

dsc_server

Data type: Optional[String]

The Active Directory Domain Controller to use to join the domain

dsc_workgroupname

Data type: Optional[String]

The name of the workgroup.

Parameters

The following parameters are available in the dsc_computer type.

• dsc_credential
• dsc_joinou
• dsc_name
• dsc_psdscrunascredential
• dsc_timeout
• dsc_unjoincredential
• name
• validation_mode

dsc_credential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

Credential to be used to join a domain.

dsc_joinou

Data type: Optional[String]

The distinguished name of the organizational unit that the computer account will be created in.

dsc_name

namevar

Data type: String

The desired computer name.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

dsc_unjoincredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

Credential to be used to leave a domain.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_ieenhancedsecurityconfiguration

The DSC IEEnhancedSecurityConfiguration resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_ieenhancedsecurityconfiguration type.

dsc_enabled

Data type: Boolean

Specifies if IE Enhanced Security Configuration should be enabled or disabled.

dsc_suppressrestart

Data type: Optional[Boolean]

Specifies if a restart of the node should be suppressed. By default the node will be restarted if the value is changed.

Parameters

The following parameters are available in the dsc_ieenhancedsecurityconfiguration type.

• dsc_psdscrunascredential
• dsc_role
• dsc_timeout
• name
• validation_mode

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_role

namevar

Data type: Enum['Administrators', 'administrators', 'Users', 'users']

Specifies the role for which the IE Enhanced Security Configuration should be changed.

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_offlinedomainjoin

The DSC OfflineDomainJoin resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_offlinedomainjoin type.

dsc_requestfile

Data type: String

The full path to the Offline Domain Join Request file to use.

Parameters

The following parameters are available in the dsc_offlinedomainjoin type.

• dsc_issingleinstance
• dsc_psdscrunascredential
• dsc_timeout
• name
• validation_mode

dsc_issingleinstance

namevar

Data type: Enum['Yes', 'yes']

Specifies the resource is a single instance, the value must be 'Yes'.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_pendingreboot

The DSC PendingReboot resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_pendingreboot type.

dsc_ccmclientsdk

Data type: Optional[Boolean]

A value indicating whether the ConfigMgr client triggered a reboot.

dsc_componentbasedservicing

Data type: Optional[Boolean]

A value indicating whether the Component-Based Servicing component requested a reboot.

dsc_pendingcomputerrename

Data type: Optional[Boolean]

A value indicating whether a pending computer rename triggered a reboot.

dsc_pendingfilerename

Data type: Optional[Boolean]

A value indicating whether a pending file rename triggered a reboot.

dsc_rebootrequired

Data type: Optional[Boolean]

A value indicating whether the node requires a reboot.

dsc_skipccmclientsdk

Data type: Optional[Boolean]

Specifies whether to skip reboots triggered by the ConfigMgr client. Defaults to True.

dsc_skipcomponentbasedservicing

Data type: Optional[Boolean]

Specifies whether to skip reboots triggered by the Component-Based Servicing component.

dsc_skippendingcomputerrename

Data type: Optional[Boolean]

Specifies whether to skip reboots triggered by a pending computer rename.

dsc_skippendingfilerename

Data type: Optional[Boolean]

Specifies whether to skip pending file rename reboots.

dsc_skipwindowsupdate

Data type: Optional[Boolean]

Specifies whether to skip reboots triggered by Windows Update.

dsc_windowsupdate

Data type: Optional[Boolean]

A value indicating whether Windows Update requested a reboot.

Parameters

The following parameters are available in the dsc_pendingreboot type.

• dsc_name
• dsc_psdscrunascredential
• dsc_timeout
• name
• validation_mode

dsc_name

namevar

Data type: String

Specifies the name of this pending reboot check.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_powerplan

The DSC PowerPlan resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_powerplan type.

dsc_isactive

Data type: Optional[Boolean]

Determines if the power plan is active.

dsc_name

Data type: String

The name or GUID of the power plan to activate.

Parameters

The following parameters are available in the dsc_powerplan type.

• dsc_issingleinstance
• dsc_psdscrunascredential
• dsc_timeout
• name
• validation_mode

dsc_issingleinstance

namevar

Data type: Enum['Yes', 'yes']

Specifies the resource is a single instance, the value must be 'Yes'.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_powershellexecutionpolicy

The DSC PowerShellExecutionPolicy resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_powershellexecutionpolicy type.

dsc_executionpolicy

Data type: Enum['Bypass', 'bypass', 'Restricted', 'restricted', 'AllSigned', 'allsigned', 'RemoteSigned', 'remotesigned', 'Unrestricted', 'unrestricted']

Changes the preference for the Windows PowerShell execution policy.

Parameters

The following parameters are available in the dsc_powershellexecutionpolicy type.

• dsc_executionpolicyscope
• dsc_psdscrunascredential
• dsc_timeout
• name
• validation_mode

dsc_executionpolicyscope

namevar

Data type: Enum['CurrentUser', 'currentuser', 'LocalMachine', 'localmachine', 'MachinePolicy', 'machinepolicy', 'Process', 'process', 'UserPolicy', 'userpolicy']

Defines the scope for the preference of the Windows PowerShell execution policy.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_psresourcerepository

The DSC PSResourceRepository resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_psresourcerepository type.

dsc_default

Data type: Optional[Boolean]

dsc_ensure

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

dsc_installationpolicy

Data type: Optional[Enum['Untrusted', 'untrusted', 'Trusted', 'trusted']]

dsc_packagemanagementprovider

Data type: Optional[String]

dsc_proxy

Data type: Optional[String]

dsc_publishlocation

Data type: Optional[String]

dsc_reasons

Data type: Optional[Array[Struct[{ phrase => Optional[String], code => Optional[String], }]]]

dsc_scriptpublishlocation

Data type: Optional[String]

dsc_scriptsourcelocation

Data type: Optional[String]

dsc_sourcelocation

Data type: Optional[String]

Parameters

The following parameters are available in the dsc_psresourcerepository type.

• dsc_credential
• dsc_name
• dsc_proxycredential
• dsc_psdscrunascredential
• dsc_timeout
• name
• validation_mode

dsc_credential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_name

namevar

Data type: String

dsc_proxycredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_remotedesktopadmin

The DSC RemoteDesktopAdmin resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_remotedesktopadmin type.

dsc_ensure

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

Determines whether or not the computer should accept remote desktop connections. Present sets the value to Enabled and Absent sets the value to Disabled.

dsc_userauthentication

Data type: Optional[Enum['Secure', 'secure', 'NonSecure', 'nonsecure']]

Setting this value to Secure configures the machine to require Network Level Authentication (NLA) for remote desktop connections.

Parameters

The following parameters are available in the dsc_remotedesktopadmin type.

• dsc_issingleinstance
• dsc_psdscrunascredential
• dsc_timeout
• name
• validation_mode

dsc_issingleinstance

namevar

Data type: Enum['Yes', 'yes']

Specifies the resource is a single instance, the value must be 'Yes'

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_scheduledtask

The DSC ScheduledTask resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_scheduledtask type.

dsc_actionarguments

Data type: Optional[String]

The arguments to pass the executable.

dsc_actionexecutable

Data type: Optional[String]

The path to the .exe for this task.

dsc_actionworkingpath

Data type: Optional[String]

The working path to specify for the executable.

dsc_allowstartifonbatteries

Data type: Optional[Boolean]

Indicates whether the task should start if the machine is on batteries or not. Defaults to $false.

dsc_builtinaccount

Data type: Optional[Enum['SYSTEM', 'system', 'LOCAL SERVICE', 'local service', 'NETWORK SERVICE', 'network service']]

Run the task as one of the built in service accounts. When set ExecuteAsCredential will be ignored and LogonType will be set to 'ServiceAccount'.

dsc_compatibility

Data type: Optional[Enum['AT', 'at', 'V1', 'v1', 'Vista', 'vista', 'Win7', 'win7', 'Win8', 'win8']]

The task compatibility level. Defaults to Vista.

dsc_daysinterval

Data type: Optional[Integer[0, 4294967295]]

Specifies the interval between the days in the schedule. An interval of 1 produces a daily schedule. An interval of 2 produces an every-other day schedule. Can only be used in combination with ScheduleType Daily.

dsc_daysofweek

Data type: Optional[Array[String]]

Specifies an array of the days of the week on which Task Scheduler runs the task. Can only be used in combination with ScheduleType Weekly.

dsc_delay

Data type: Optional[String]

Specifies a delay to the start of the trigger. The delay is a static delay before the task is executed. Can only be used in combination with ScheduleType AtLogon, AtStartup, OnEvent, AtCreation and OnSessionState.

dsc_description

Data type: Optional[String]

The task description.

dsc_disallowdemandstart

Data type: Optional[Boolean]

Indicates whether the task is prohibited to run on demand or not. Defaults to $false.

dsc_disallowhardterminate

Data type: Optional[Boolean]

Indicates whether the task is prohibited to be terminated or not. Defaults to $false.

dsc_disallowstartonremoteappsession

Data type: Optional[Boolean]

Indicates that the task does not start if the task is triggered to run in a Remote Applications Integrated Locally (RAIL) session.

dsc_dontstopifgoingonbatteries

Data type: Optional[Boolean]

Indicates that the task does not stop if the computer switches to battery power.

dsc_dontstoponidleend

Data type: Optional[Boolean]

Indicates that Task Scheduler does not terminate the task if the idle condition ends before the task is completed.

dsc_enable

Data type: Optional[Boolean]

True if the task should be enabled, false if it should be disabled.

dsc_ensure

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

Present if the task should exist, Absent if it should be removed.

dsc_eventsubscription

Data type: Optional[String]

Specifies the EventSubscription in XML. This can be easily generated using the Windows Eventlog Viewer. For the query schema please check: https://docs.microsoft.com/en-us/windows/desktop/WES/queryschema-schema. Can only be used in combination with ScheduleType OnEvent.

dsc_eventvaluequeries

Data type: Optional[Array[Struct[{ key => Optional[String], value => Optional[String], }]]]

Specifies the EventValueQueries. Receives a hashtable where the key is a property value for an event and the value is an XPath event query. For more detailed syntax check: https://learn.microsoft.com/en-us/windows/win32/taskschd/eventtrigger-valuequeries. Can only be used in combination with ScheduleType OnEvent.

dsc_executeasgmsa

Data type: Optional[String]

The gMSA (Group Managed Service Account) this task should execute as. Cannot be used in combination with ExecuteAsCredential or BuiltInAccount.

dsc_executiontimelimit

Data type: Optional[String]

Specifies the amount of time that Task Scheduler is allowed to complete the task.

dsc_hidden

Data type: Optional[Boolean]

Indicates that the task is hidden in the Task Scheduler UI.

dsc_idleduration

Data type: Optional[String]

Specifies the amount of time that the computer must be in an idle state before Task Scheduler runs the task.

dsc_idlewaittimeout

Data type: Optional[String]

Specifies the amount of time that Task Scheduler waits for an idle condition to occur.

dsc_logontype

Data type: Optional[Enum['Group', 'group', 'Interactive', 'interactive', 'InteractiveOrPassword', 'interactiveorpassword', 'None', 'none', 'Password', 'password', 'S4U', 's4u', 'ServiceAccount', 'serviceaccount']]

Specifies the security logon method that Task Scheduler uses to run the tasks that are associated with the principal.

dsc_multipleinstances

Data type: Optional[Enum['IgnoreNew', 'ignorenew', 'Parallel', 'parallel', 'Queue', 'queue', 'StopExisting', 'stopexisting']]

Specifies the policy that defines how Task Scheduler handles multiple instances of the task.

dsc_networkname

Data type: Optional[String]

Specifies the name of a network profile that Task Scheduler uses to determine if the task can run. The Task Scheduler UI uses this setting for display purposes. Specify a network name if you specify the RunOnlyIfNetworkAvailable parameter.

dsc_priority

Data type: Optional[Integer[0, 4294967295]]

Specifies the priority level of the task. Priority must be an integer from 0 (highest priority) to 10 (lowest priority). The default value is 7. Priority levels 7 and 8 are used for background tasks. Priority levels 4, 5, and 6 are used for interactive tasks.

dsc_randomdelay

Data type: Optional[String]

Specifies a random amount of time to delay the start time of the trigger. The delay time is a random time between the time the task triggers and the time that you specify in this setting. Can only be used in combination with ScheduleType Once, Daily and Weekly.

dsc_repeatinterval

Data type: Optional[String]

How many units (minutes, hours, days) between each run of this task?

dsc_repetitionduration

Data type: Optional[String]

Specifies how long the repetition pattern repeats after the task starts. May be set to Indefinitely to specify an indefinite duration.

dsc_restartcount

Data type: Optional[Integer[0, 4294967295]]

Specifies the number of times that Task Scheduler attempts to restart the task.

dsc_restartinterval

Data type: Optional[String]

Specifies the amount of time that Task Scheduler attempts to restart the task.

dsc_restartonidle

Data type: Optional[Boolean]

Indicates that Task Scheduler restarts the task when the computer cycles into an idle condition more than once.

dsc_runlevel

Data type: Optional[Enum['Limited', 'limited', 'Highest', 'highest']]

Specifies the level of user rights that Task Scheduler uses to run the tasks that are associated with the principal. Defaults to 'Limited'.

dsc_runonlyifidle

Data type: Optional[Boolean]

Indicates that Task Scheduler runs the task only when the computer is idle.

dsc_runonlyifnetworkavailable

Data type: Optional[Boolean]

Indicates that Task Scheduler runs the task only when a network is available. Task Scheduler uses the NetworkID parameter and NetworkName parameter that you specify in this cmdlet to determine if the network is available.

dsc_scheduletype

Data type: Optional[Enum['Once', 'once', 'Daily', 'daily', 'Weekly', 'weekly', 'AtStartup', 'atstartup', 'AtLogon', 'atlogon', 'OnIdle', 'onidle', 'OnEvent', 'onevent', 'AtCreation', 'atcreation', 'OnSessionState', 'onsessionstate']]

When should the task be executed.

dsc_starttime

Data type: Optional[String]

The date and time of day this task should start at, or activate on, represented as a string for local conversion to DateTime format - defaults to 1st January 1980 at 12:00 AM.

dsc_startwhenavailable

Data type: Optional[Boolean]

Indicates that Task Scheduler can start the task at any time after its scheduled time has passed.

dsc_statechange

Data type: Optional[Enum['OnConnectionFromLocalComputer', 'onconnectionfromlocalcomputer', 'OnDisconnectFromLocalComputer', 'ondisconnectfromlocalcomputer', 'OnConnectionFromRemoteComputer', 'onconnectionfromremotecomputer', 'OnDisconnectFromRemoteComputer', 'ondisconnectfromremotecomputer', 'OnWorkstationLock', 'onworkstationlock', 'OnWorkstationUnlock', 'onworkstationunlock']]

Specifies the kind of session state change that would trigger a task launch. Can only be used in combination with ScheduleType OnSessionState.

dsc_stopatdurationend

Data type: Optional[Boolean]

Indicates that Task Scheduler stops all running tasks at the end of the repetition duration. Defaults to $false.

dsc_synchronizeacrosstimezone

Data type: Optional[Boolean]

Enable the scheduled task option to synchronize across time zones. This is enabled by including the timezone offset in the scheduled task trigger. Defaults to false which does not include the timezone offset.

dsc_taskpath

Data type: Optional[String]

The path to the task - defaults to the root directory.

dsc_triggerexecutiontimelimit

Data type: Optional[String]

Specifies the amount of time for the trigger that Task Scheduler is allowed to complete the task.

dsc_user

Data type: Optional[String]

Specifies the identifier of a user that will trigger the task to start. Can only be used in combination with ScheduleType AtLogon and OnSessionState.

dsc_waketorun

Data type: Optional[Boolean]

Indicates that Task Scheduler wakes the computer before it runs the task.

dsc_weeksinterval

Data type: Optional[Integer[0, 4294967295]]

Specifies the interval between the weeks in the schedule. An interval of 1 produces a weekly schedule. An interval of 2 produces an every-other week schedule. Can only be used in combination with ScheduleType Weekly.

Parameters

The following parameters are available in the dsc_scheduledtask type.

• dsc_executeascredential
• dsc_psdscrunascredential
• dsc_taskname
• dsc_timeout
• name
• validation_mode

dsc_executeascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

The credential this task should execute as. If not specified defaults to running as the local system account.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_taskname

namevar

Data type: String

The name of the task.

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_smbserverconfiguration

The DSC SmbServerConfiguration resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_smbserverconfiguration type.

dsc_announcecomment

Data type: Optional[String]

Specifies the announce comment string.

dsc_announceserver

Data type: Optional[Boolean]

Specifies whether this server announces itself by using browser announcements.

dsc_asynchronouscredits

Data type: Optional[Integer[0, 4294967295]]

Specifies the asynchronous credits.

dsc_auditsmb1access

Data type: Optional[Boolean]

Enables auditing of SMB version 1 protocol in Windows Event Log.

dsc_autodisconnecttimeout

Data type: Optional[Integer[0, 4294967295]]

Specifies the auto disconnect time-out.

dsc_autoshareserver

Data type: Optional[Boolean]

Specifies that the default server shares are shared out.

dsc_autoshareworkstation

Data type: Optional[Boolean]

Specifies whether the default workstation shares are shared out.

dsc_cachedopenlimit

Data type: Optional[Integer[0, 4294967295]]

Specifies the maximum number of cached open files.

dsc_durablehandlev2timeoutinseconds

Data type: Optional[Integer[0, 4294967295]]

Specifies the durable handle v2 time-out period, in seconds.

dsc_enableauthenticateusersharing

Data type: Optional[Boolean]

Specifies whether authenticate user sharing is enabled.

dsc_enabledownleveltimewarp

Data type: Optional[Boolean]

Specifies whether down-level timewarp support is disabled.

dsc_enableforcedlogoff

Data type: Optional[Boolean]

Specifies whether forced logoff is enabled.

dsc_enableleasing

Data type: Optional[Boolean]

Specifies whether leasing is disabled.

dsc_enablemultichannel

Data type: Optional[Boolean]

Specifies whether multi-channel is disabled.

dsc_enableoplocks

Data type: Optional[Boolean]

Specifies whether the opportunistic locks are enabled.

dsc_enablesecuritysignature

Data type: Optional[Boolean]

Specifies whether the security signature is enabled.

dsc_enablesmb1protocol

Data type: Optional[Boolean]

Specifies whether the SMB1 protocol is enabled.

dsc_enablesmb2protocol

Data type: Optional[Boolean]

Specifies whether the SMB2 protocol is enabled.

dsc_enablestrictnamechecking

Data type: Optional[Boolean]

Specifies whether the server should perform strict name checking on incoming connects.

dsc_encryptdata

Data type: Optional[Boolean]

Specifies whether the sessions established on this server are encrypted.

dsc_irpstacksize

Data type: Optional[Integer[0, 4294967295]]

Specifies the default IRP stack size.

dsc_keepalivetime

Data type: Optional[Integer[0, 4294967295]]

Specifies the keep alive time.

dsc_maxchannelpersession

Data type: Optional[Integer[0, 4294967295]]

Specifies the maximum channels per session.

dsc_maxmpxcount

Data type: Optional[Integer[0, 4294967295]]

Specifies the maximum MPX count for SMB1.

dsc_maxsessionperconnection

Data type: Optional[Integer[0, 4294967295]]

Specifies the maximum sessions per connection.

dsc_maxthreadsperqueue

Data type: Optional[Integer[0, 4294967295]]

Specifies the maximum threads per queue.

dsc_maxworkitems

Data type: Optional[Integer[0, 4294967295]]

Specifies the maximum SMB1 work items.

dsc_nullsessionpipes

Data type: Optional[String]

Specifies the null session pipes.

dsc_nullsessionshares

Data type: Optional[String]

Specifies the null session shares.

dsc_oplockbreakwait

Data type: Optional[Integer[0, 4294967295]]

Specifies how long the create caller waits for an opportunistic lock break.

dsc_pendingclienttimeoutinseconds

Data type: Optional[Integer[0, 4294967295]]

Specifies the pending client time-out period, in seconds.

dsc_rejectunencryptedaccess

Data type: Optional[Boolean]

Specifies whether the client that does not support encryption is denied access if it attempts to connect to an encrypted share.

dsc_requiresecuritysignature

Data type: Optional[Boolean]

Specifies whether the security signature is required.

dsc_serverhidden

Data type: Optional[Boolean]

Specifies whether the server announces itself.

dsc_smb2creditsmax

Data type: Optional[Integer[0, 4294967295]]

Specifies the maximum SMB2 credits.

dsc_smb2creditsmin

Data type: Optional[Integer[0, 4294967295]]

Specifies the minimum SMB2 credits.

dsc_smbservernamehardeninglevel

Data type: Optional[Integer[0, 4294967295]]

Specifies the SMB Service name hardening level.

dsc_treathostasstablestorage

Data type: Optional[Boolean]

Specifies whether the host is treated as the stable storage.

dsc_validatealiasnotcircular

Data type: Optional[Boolean]

Specifies whether the aliases that are not circular are validated.

dsc_validatesharescope

Data type: Optional[Boolean]

Specifies whether the existence of share scopes is checked during share creation.

dsc_validatesharescopenotaliased

Data type: Optional[Boolean]

Specifies whether the share scope being aliased is validated.

dsc_validatetargetname

Data type: Optional[Boolean]

Specifies whether the target name is validated.

Parameters

The following parameters are available in the dsc_smbserverconfiguration type.

• dsc_issingleinstance
• dsc_psdscrunascredential
• dsc_timeout
• name
• validation_mode

dsc_issingleinstance

namevar

Data type: Enum['Yes', 'yes']

Specifies the resource is a single instance, the value must be 'Yes'

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_smbshare

The DSC SmbShare resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_smbshare type.

dsc_cachingmode

Data type: Optional[Enum['None', 'none', 'Manual', 'manual', 'Programs', 'programs', 'Documents', 'documents', 'BranchCache', 'branchcache']]

Specifies the caching mode of the offline files for the SMB share.

dsc_changeaccess

Data type: Optional[Array[String]]

Specifies which accounts will be granted modify permission to access the SMB share.

dsc_concurrentuserlimit

Data type: Optional[Integer[0, 4294967295]]

Specifies the maximum number of concurrently connected users that the new SMB share may accommodate. If this parameter is set to zero (0), then the number of users is unlimited. The default value is zero (0).

dsc_continuouslyavailable

Data type: Optional[Boolean]

Specifies whether the SMB share should be continuously available.

dsc_description

Data type: Optional[String]

Specifies the description of the SMB share.

dsc_encryptdata

Data type: Optional[Boolean]

Indicates that the SMB share is encrypted.

dsc_ensure

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

Specifies if the SMB share should be added or removed.

dsc_folderenumerationmode

Data type: Optional[Enum['AccessBased', 'accessbased', 'Unrestricted', 'unrestricted']]

Specifies which files and folders in the new SMB share are visible to users.

dsc_fullaccess

Data type: Optional[Array[String]]

Specifies which accounts are granted full permission to access the SMB share.

dsc_noaccess

Data type: Optional[Array[String]]

Specifies which accounts are denied access to the SMB share.

dsc_path

Data type: String

Specifies the path of the SMB share.

dsc_readaccess

Data type: Optional[Array[String]]

Specifies which accounts is granted read permission to access the SMB share.

dsc_scopename

Data type: Optional[String]

Specifies the scope in which the share should be created.

dsc_shadowcopy

Data type: Optional[Boolean]

Specifies if this SMB share is a ShadowCopy.

dsc_sharestate

Data type: Optional[String]

Specifies the state of the SMB share.

dsc_sharetype

Data type: Optional[String]

Specifies the type of the SMB share.

dsc_special

Data type: Optional[Boolean]

Specifies if this SMB share is a special share. E.g. an admin share, default shares, or IPC$ share.

Parameters

The following parameters are available in the dsc_smbshare type.

• dsc_force
• dsc_name
• dsc_psdscrunascredential
• dsc_timeout
• name
• validation_mode

dsc_force

Data type: Optional[Boolean]

Specifies if the SMB share is allowed to be dropped and recreated (required when the path changes).

dsc_name

namevar

Data type: String

Specifies the name of the SMB share.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_systemlocale

The DSC SystemLocale resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_systemlocale type.

dsc_systemlocale

Data type: String

Specifies the System Locale.

Parameters

The following parameters are available in the dsc_systemlocale type.

• dsc_issingleinstance
• dsc_psdscrunascredential
• dsc_timeout
• name
• validation_mode

dsc_issingleinstance

namevar

Data type: Enum['Yes', 'yes']

Specifies the resource is a single instance, the value must be 'Yes'

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_systemprotection

The DSC SystemProtection resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_systemprotection type.

dsc_diskusage

Data type: Optional[Integer[-2147483648, 2147483647]]

Specifies the maximum disk space to use for protection as a percentage.

dsc_ensure

Data type: Enum['Present', 'present', 'Absent', 'absent']

Indicates that the computer restore is enabled or is disabled.

Parameters

The following parameters are available in the dsc_systemprotection type.

• dsc_driveletter
• dsc_force
• dsc_psdscrunascredential
• dsc_timeout
• name
• validation_mode

dsc_driveletter

namevar

Data type: String

Specifies the drive letter to enable or disable protection on.

dsc_force

Data type: Optional[Boolean]

Forces desired state to be applied regardless of data loss. Defaults to False.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_systemrestorepoint

The DSC SystemRestorePoint resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_systemrestorepoint type.

dsc_ensure

Data type: Enum['Present', 'present', 'Absent', 'absent']

Indicates that the computer restore is enabled or is disabled.

dsc_restorepointtype

Data type: Optional[Enum['APPLICATION_INSTALL', 'application_install', 'APPLICATION_UNINSTALL', 'application_uninstall', 'DEVICE_DRIVER_INSTALL', 'device_driver_install', 'MODIFY_SETTINGS', 'modify_settings', 'CANCELLED_OPERATION', 'cancelled_operation']]

Specifies the restore point type. Defaults to APPLICATION_INSTALL.

Parameters

The following parameters are available in the dsc_systemrestorepoint type.

• dsc_description
• dsc_psdscrunascredential
• dsc_timeout
• name
• validation_mode

dsc_description

namevar

Data type: String

Specifies a descriptive name for the restore point.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_timezone

The DSC TimeZone resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_timezone type.

dsc_timezone

Data type: String

Specifies the TimeZone.

Parameters

The following parameters are available in the dsc_timezone type.

• dsc_issingleinstance
• dsc_psdscrunascredential
• dsc_timeout
• name
• validation_mode

dsc_issingleinstance

namevar

Data type: Enum['Yes', 'yes']

Specifies the resource is a single instance, the value must be 'Yes'.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_useraccountcontrol

The DSC UserAccountControl resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_useraccountcontrol type.

dsc_consentpromptbehavioradmin

Data type: Optional[Enum['0', '1', '2', '3', '4', '5']]

Specifies the prompt behavior for the Consent Administrator.

dsc_consentpromptbehavioruser

Data type: Optional[Enum['0', '1', '3']]

Specifies how the operations that requires elevation is handled for users.

dsc_enableinstallerdetection

Data type: Optional[Enum['0', '1']]

Specifies how package installations are handled.

dsc_enablelua

Data type: Optional[Enum['0', '1']]

Specifies how the 'administrator in Admin Approval Mode' user type are handled.

dsc_enablevirtualization

Data type: Optional[Enum['0', '1']]

Specifies how redirection of legacy application File and Registry writes are handled.

dsc_filteradministratortoken

Data type: Optional[Enum['0', '1']]

Specifies the mode for the built-in administrator account (RID 500).

dsc_notificationlevel

Data type: Optional[Enum['AlwaysNotify', 'alwaysnotify', 'AlwaysNotifyAndAskForCredentials', 'alwaysnotifyandaskforcredentials', 'NotifyChanges', 'notifychanges', 'NotifyChangesWithoutDimming', 'notifychangeswithoutdimming', 'NeverNotify', 'nevernotify', 'NeverNotifyAndDisableAll', 'nevernotifyanddisableall']]

Specifies the desired notification level for the User Account Control setting. This parameter can not be used at the same time as any of the granular parameters.

dsc_promptonsecuredesktop

Data type: Optional[Enum['0', '1']]

Specifies if secure desktop prompting are used.

dsc_suppressrestart

Data type: Optional[Boolean]

Specifies if a restart of the node should be suppressed. By default the node will be restarted if the value is changed.

dsc_validateadmincodesignatures

Data type: Optional[Enum['0', '1']]

Specifies how cryptographic signatures on interactive applications are handled.

Parameters

The following parameters are available in the dsc_useraccountcontrol type.

• dsc_issingleinstance
• dsc_psdscrunascredential
• dsc_timeout
• name
• validation_mode

dsc_issingleinstance

namevar

Data type: Enum['Yes', 'yes']

Specifies the resource is a single instance, the value must be 'Yes'.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_virtualmemory

The DSC VirtualMemory resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_virtualmemory type.

dsc_initialsize

Data type: Optional[Integer[-9223372036854775808, 9223372036854775807]]

The initial size of the page file in Megabyte

dsc_maximumsize

Data type: Optional[Integer[-9223372036854775808, 9223372036854775807]]

The maximum size of the page file in Megabyte

Parameters

The following parameters are available in the dsc_virtualmemory type.

• dsc_drive
• dsc_psdscrunascredential
• dsc_timeout
• dsc_type
• name
• validation_mode

dsc_drive

namevar

Data type: String

The drive letter for which paging settings should be set. Can be letter only, letter and colon or letter with colon and trailing slash.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

dsc_type

namevar

Data type: Enum['AutoManagePagingFile', 'automanagepagingfile', 'CustomSize', 'customsize', 'SystemManagedSize', 'systemmanagedsize', 'NoPagingFile', 'nopagingfile']

The type of the paging setting to use. If set to AutoManagePagingFile, the drive letter will be ignored. If set to SystemManagedSize, the values for InitialSize and MaximumSize will be ignored

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_windowscapability

The DSC WindowsCapability resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_windowscapability type.

dsc_ensure

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

Specifies whether the Windows Capability should be installed or uninstalled. To install the Windows Capability, set this property to Present. To uninstall the Windows Capability, set the property to Absent.

dsc_loglevel

Data type: Optional[Enum['Errors', 'errors', 'Warnings', 'warnings', 'WarningsInfo', 'warningsinfo']]

Specifies the given Log Level of a Windows Capability. This is a write only parameter that is used when updating the status of a Windows Capability. If not specified, the default is 'WarningsInfo'.

dsc_logpath

Data type: Optional[String]

Specifies the full path and file name to log to. This is a write only parameter that is used when updating the status of a Windows Capability. If not specified, the default is '%WINDIR%\Logs\Dism\dism.log'.

dsc_source

Data type: Optional[String]

Specifies the location of the files that are required to add a Windows capability package to an image. You can specify the Windows directory of a mounted image or a running Windows installation that is shared on the network.

Parameters

The following parameters are available in the dsc_windowscapability type.

• dsc_name
• dsc_psdscrunascredential
• dsc_timeout
• name
• validation_mode

dsc_name

namevar

Data type: String

Specifies the name of the Windows Capability.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_windowseventlog

The DSC WindowsEventLog resource type. Automatically generated from version 10.0.0

Properties

The following properties are available in the dsc_windowseventlog type.

dsc_categoryresourcefile

Data type: Optional[String]

Specifies the category resource file for the event source

dsc_isenabled

Data type: Optional[Boolean]

Specifies whether the specified event log should be enabled or disabled

dsc_logfilepath

Data type: Optional[String]

Specifies the file name and path for the specified event log

dsc_logmode

Data type: Optional[Enum['AutoBackup', 'autobackup', 'Circular', 'circular', 'Retain', 'retain']]

Specifies the log mode for the specified event log

dsc_logretentiondays

Data type: Optional[Integer[-2147483648, 2147483647]]

Specifies the number of days to retain events when the log mode is AutoBackup

dsc_maximumsizeinbytes

Data type: Optional[Integer[-9223372036854775808, 9223372036854775807]]

Specifies the maximum size in bytes for the specified event log

dsc_messageresourcefile

Data type: Optional[String]

Specifies the message resource file for the event source

dsc_parameterresourcefile

Data type: Optional[String]

Specifies the parameter resource file for the event source

dsc_registeredsource

Data type: Optional[String]

Specifies the name of an event source to register for the specified event log

dsc_restrictguestaccess

Data type: Optional[Boolean]

Specifies whether to allow guests to have access to the specified event log

dsc_securitydescriptor

Data type: Optional[String]

Specifies the SDDL for the specified event log

Parameters

The following parameters are available in the dsc_windowseventlog type.

• dsc_logname
• dsc_psdscrunascredential
• dsc_timeout
• name
• validation_mode

dsc_logname

namevar

Data type: String

Specifies the name of a valid event log

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

dsc_timeout

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

[10.0.0] - 2025-01-25

Added

• SystemProtection
  • New resource to configure System Protection settings (formerly xWindowsRestore) - Fixes Issue #364.
• SystemRestorePoint
  • New resource to create and delete restore points (formerly xSystemRestorePoint) - Fixes Issue #364.
• ScheduledTask
  • Added support for ScheduleType 'OnIdle', 'AtCreation', 'OnSessionState'. Fixes Issue #282.
  • Added support for StateChange to allow specifying which session state changes should trigger the task (with ScheduleType = OnSessionState).
  • Added support for StopAtDurationEnd permitting control over the 'Stop all running tasks at the end of the repetition duration' feature. Fixes Issue #168.
  • Added support for TriggerExecutionTimeLimit permitting control over per-trigger 'Stop task if it runs longer than...' feature.

Fixed

• BREAKING CHANGE: ScheduledTask
  • Fixed SynchronizeAcrossTimeZone issue where Test always throws False when a date & time is used where Daylight Savings Time is in operation. Fixes Issue #374.
  • Fixed Test-DateStringContainsTimeZone to correctly process date strings behind UTC (-), as well as UTC Zulu 'Z' strings.
  • Fixed User parameter to correctly return the user that triggers an AtLogon or OnSessionState Schedule Type, instead of the current value of ExecuteAsCredential. This parameter is only valid when using the AtLogon and OnSessionState Schedule Types.
  • Fixed User parameter to permit use even if LogonType = Group.
  • Updated RandomDelay logic from a blacklist to a whitelist.
  • Updated Delay parameter logic to reflect other TimeSpan based values.
  • Updated unit tests to use Should -Invoke for Pester 5 compatibility.
  • Updated various parameters with requirements in documentation.
• VirtualMemory fix incorrect variable name
• SmbServerConfiguration remove errant argument
• Update all calls to edit the registry so that the value Type is explicitly set. Fixes Issue #433.
• Made AppVeyor use ModuleFast to resolve dependencies.

Changed

• BREAKING CHANGE: ScheduledTask
  • StartTime has chnage the type from DateTime to String.
  • StartTime is now processed on the device, rather than at compile time. This makes it possible to configure start times based on each device's timezone, rather than being fixed to the time zone configured on the device where the Desired State Configuration compilation was run.
  • Allow StartTime to be used to set the 'Activate' setting when adding ScheduleType triggers other than 'Once', 'Daily' and 'Weekly'.
  • Changed the default StartTime date from today to 1st January 1980 to prevent configuration flip flopping, and added note to configuration README to advise always supplying a date, and not just a time. Fixes Issue #148. Fixes Issue #411.
  • Added examples & note to configuration README to supply a timezone when using SynchronizeAcrossTimeZone.
  • Allow SynchronizeAcrossTimeZone to be used when adding ScheduleType triggers other than 'Once', 'Daily' and 'Weekly'.
  • Updated Delay parameter to support ScheduleType AtLogon, AtStartup, AtCreation, OnSessionState. Fixes Issue #345.
  • Updated User parameter for use with ScheduleType OnSessionState in addition to AtLogon.
  • Updated integration tests to ensure resource and configuration names are matching.
• Converted tests to Pester 5
• Rename Delete-ADSIObject to Delete-ADSIObject to satisfy HQRM
• No longer uses alias New-InvalidArgumentException but instead New-ArgumentException

Removed

• Removed Get-InvalidOperationRecord to use version provided by DscResource.Test