Template: Restart service to let instance changes take effect

[andreasjordan]

Some changes of instance settings need a service restart to take effect. But this should not be done without explicit request by the user. Therefore a switch like -Force or -RestartService should be used. To restart the dependent services only if needed, the command Restart-DbaService should be used.

Here is a code template:

    .PARAMETER Force
        Will restart SQL Server service to apply the change. Dependant services will be restarted if needed.


        [switch]$Force,


        if ($Force) {
            if ($PSCmdlet.ShouldProcess($instance, "Force provided, restarting Engine service for $instance")) {
                try {
                    $null = Restart-DbaService -SqlInstance $instance -Type Engine -Force -EnableException
                } catch {
                    Stop-Function -Message "Failed to restart Engine service for $instance" -Target $instance -ErrorRecord $_
                }
            }
        }

Commands that already use Restart-DbaService, but are not aligned with this template:

• Disable-DbaFilestream
• Enable-DbaFilestream
• Invoke-DbaAdvancedInstall
• Set-DbaNetworkCertificate
• Set-DbaNetworkConfiguration

Commands that use Stop-DbaService and Start-DbaService and should be changed:

• Disable-DbaAgHadr
• Enable-DbaAgHadr
• Update-DbaServiceAccount

Feedback to the proposed code is very welcome.