Set-DscMachineRebootRequired

SYNOPSIS

Set the DSC reboot required status variable.

SYNTAX

Set-DscMachineRebootRequired [<CommonParameters>]

DESCRIPTION

Sets the global DSCMachineStatus variable to a value of 1. This function is used to set the global variable that indicates to the LCM that a reboot of the node is required.

EXAMPLES

EXAMPLE 1

Set-DscMachineRebootRequired

Sets the $global:DSCMachineStatus variable to 1.

PARAMETERS

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

None

NOTES

This function is implemented so that individual resource modules do not need to use and therefore suppress Global variables directly. It also enables mocking to increase testability of consumers.

RELATED LINKS