RestartSystem.adoc

DSC Resource 'RestartSystem'

RestartSystem forces a system reboot or triggers reboots based on pending reboot conditions (Windows Update, CBS, file rename, computer rename).

When to use 'RestartSystem'

Use this resource when your DSC configuration requires a reboot between steps, such as after installing Windows features, renaming the computer, or applying updates. It can also detect and act on pending reboot conditions from Component-Based Servicing, Windows Update, or pending file renames.

The DSC resource supports only one system reboot inside the DSC configuartion of a node. You can control the system reboot time by ordering the activated configurations in the YAML files (e.g. RestartSystem at last if you want a restart at the end of your configuration).

Source	https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/RestartSystem
DSC Resource	ComputerManagementDsc
Documentation	PendingReboot

Table 1. Attributes of category 'RestartSystem'

Parameter	Attribute	DataType	Description	Allowed Values
ForceReboot		Boolean	Force a system reboot Only one reboot after first start of a DSC configuration is supported. To re-enable the system reboot feature the registry key value Reboot_RestartSystem at HKLM:\SOFTWARE\DSC Community\CommonTasks\RebootRequests must be deleted.	False (default) True
PendingReboot		Boolean	Checks for pending system reboots See PendingReboot for detailed information.	False (default) True
SkipComponentBasedServicing		Boolean	Specifies whether to skip pending reboots triggered by the Component-Based Servicing component.	False (default) True
SkipWindowsUpdate		Boolean	Specifies whether to skip pending reboots triggered by Windows Update.	False (default) True
SkipPendingFileRename		Boolean	Specifies whether to skip pending file rename reboots.	False (default) True
SkipPendingComputerRename		Boolean	Specifies whether to skip pending reboots triggered by a pending computer rename.	False (default) True
SkipCcmClientSDK		Boolean	Specifies whether to skip pending reboots triggered by the ConfigMgr client.	False True (default)

Example

RestartSystem:
  ForceReboot: true
  PendingReboot: true
  SkipCcmClientSDK: false