New-ScheduledScript.ps1


Description

@GitHub Copilot - Welcome @BanterBoy, I’m your Copilot and I’m here to help you get things done faster. I can identify issues, explain and even improve code.

You can ask generic questions, but what I’m really good at is helping you with your code. For example:

Generate unit tests for my code Explain the selected code Propose a fix for the bugs in my code If you want to learn more about my capabilities and limitations, check out the Copilot documentation.

I’m powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve.

@BanterBoy: - Explain what the script does and why it is useful.

@GitHub Copilot -


Script

<#
Establish Secure Remote Session
Create Script
- Create new directory - SoloScripts
- Create new file - ScheduledRestart.ps1
- Populate contents of new file with reboot script
Write Event Log message confirming creation of files
Schedule Task to run script at selected interval
#>

[CmdletBinding(DefaultParameterSetName = 'default')]
param(
    [Parameter(Mandatory = $True,
        HelpMessage = "Please enter the Scheduled Task Title.",
        ValueFromPipeline = $True,
        ValueFromPipelineByPropertyName = $True)]
    [Alias('tn')]
    [string[]]$TaskName,

    [Parameter(Mandatory = $True,
        HelpMessage = "Please enter script filename (e.g. script.ps1)",
        ValueFromPipeline = $True,
        ValueFromPipelineByPropertyName = $True)]
    [Alias('file')]
    [string[]]$PScriptFile,

    [Parameter(Mandatory = $True,
        HelpMessage = "Please enter new directoy name.",
        ValueFromPipeline = $True,
        ValueFromPipelineByPropertyName = $True)]
    [Alias('fn')]
    [string[]]$PScriptFolder
)

# Script variables
$PScriptDrive = "$env:HOMEDRIVE"
$PScriptPath = $PScriptDrive + "\" + $PScriptFolder
$PScript = $PScriptPath + "\" + $PScriptFile
$TestScript = Test-Path -LiteralPath $PScript

$NewEvent = [PSCustomObject]@{
    LogName   = 'System'
    Source    = 'EventLog'
    EntryType = 'Information'
    EventId1  = 4668
    EventId2  = 4666
    Message1  = 'The daily PC Restart folder/files have been created.'
    Message2  = 'The daily PC Restart Scheduled task has been created.'
}

$Content = { $params = [PSCustomObject]@{
        LogName   = 'System'
        Source    = 'EventLog'
        EntryType = 'Information'
        EventId   = 6006
        Message   = 'The daily PC Restart has taken place in order to update starter and leaver changes'
    }
    Write-EventLog -LogName $params.LogName -Source $params.Source -EntryType $params.EntryType -EventId $params.EventId -Message $params.Message
    Restart-Computer -Force
}


if ($TestScript -eq $false) {
    do {
        Set-Location "$PScriptDrive"
        New-Item -Path $PScriptDrive -Name $PScriptFolder -ItemType Directory
        New-Item -Path "$PScriptPath" -Name ScheduledRestart.ps1 -ItemType File
        Set-Content -Path $PScript -Value $Content
        Write-EventLog -LogName $NewEvent.LogName -Source $NewEvent.Source -EntryType $NewEvent.EntryType -EventId $NewEvent.EventId1 -Message $NewEvent.Message1
        $TestScript
    } until ($TestScript -eq $true)
}
else {
    do {
        # Create Remote Session
        $Username = Read-Host "Enter Username (domain\username)"
        $Password = Read-Host "Enter Password" -AsSecureString
        $Credentials = New-Object System.Management.Automation.PSCredential($Username, $Password)
        $Server = Read-Host "Enter Server (FQDN or IP)"

        Write-Output "Connecting to Server $Server"
        Enter-PSSession -ComputerName $Server -Credential $Credentials -Authentication Negotiate
        Wait-Event -Timeout 5
        Write-Output "You are PSRemoting to $Server as $Username"
        Wait-Event -Timeout 5

        Write-Output "================ $TaskName ================"
        Write-Output "1: Press '1' for Mid-day."
        Write-Output "2: Press '2' for Quarter Past."
        Write-Output "3: Press '3' for Half Past."
        Write-Output "Q: Press 'Q' to quit."

        New-ScheduledTask
        $input = Read-Host "Please make a selection"
        switch ($input) {
            '1' {
                if ($input -eq '1') {
                    $Midday = (Get-Date -Hour 12 -Minute 00 -Second 0 -Millisecond 0).ToShortTimeString()
                    $Action = New-ScheduledTaskAction -Execute "Powershell.exe" -Argument "-executionpolicy bypass -noprofile -file $scriptPath"
                    $Trigger = New-ScheduledTaskTrigger -Daily -At $Midday
                    Register-ScheduledTask -TaskName $TaskName -Trigger $Trigger -Action $Action -Description "A daily PC Restart is required in order to to update starter and leaver changes within the filemaker application." -RunLevel Highest -Force
                    Write-EventLog -LogName $NewEvent.LogName -Source $NewEvent.Source -EntryType $NewEvent.EntryType -EventId $NewEvent.EventId2 -Message $NewEvent.Message2
                    'Task has been scheduled for Mid-day'
                }
            }
            '2' {
                if ($input -eq '2') {
                    $QuarterPast = (Get-Date -Hour 12 -Minute 00 -Second 0 -Millisecond 0).AddMinutes(15).ToShortTimeString()
                    $Action = New-ScheduledTaskAction -Execute "Powershell.exe" -Argument "-executionpolicy bypass -noprofile -file $scriptPath"
                    $Trigger = New-ScheduledTaskTrigger -Daily -At $QuarterPast
                    Register-ScheduledTask -TaskName $TaskName -Trigger $Trigger -Action $Action -Description "A daily PC Restart is required in order to to update starter and leaver changes within the filemaker application." -RunLevel Highest -Force
                    Write-EventLog -LogName $NewEvent.LogName -Source $NewEvent.Source -EntryType $NewEvent.EntryType -EventId $NewEvent.EventId2 -Message $NewEvent.Message2
                    'Task has been scheduled for Quarter Past'
                }
            }
            '3' {
                if ($input -eq '3') {
                    $HalfPast = (Get-Date -Hour 12 -Minute 00 -Second 0 -Millisecond 0).AddMinutes(30).ToShortTimeString()
                    $Action = New-ScheduledTaskAction -Execute "Powershell.exe" -Argument "-executionpolicy bypass -noprofile -file $scriptPath"
                    $Trigger = New-ScheduledTaskTrigger -Daily -At $HalfPast
                    Register-ScheduledTask -TaskName $TaskName -Trigger $Trigger -Action $Action -Description "A daily PC Restart is required in order to to update starter and leaver changes within the filemaker application." -RunLevel Highest -Force
                    Write-EventLog -LogName $NewEvent.LogName -Source $NewEvent.Source -EntryType $NewEvent.EntryType -EventId $NewEvent.EventId2 -Message $NewEvent.Message2
                    'Task has been scheduled for Half Past'
                }
            }
            'q' {
                return
            }
        }
        pause
    }
    until ($input -eq 'q')

}

Back to Top


Download

Please feel free to copy parts of the script or if you would like to download the entire script, simple click the download button. You can download the complete repository in a zip file by clicking the Download link in the menu bar on the left hand side of the page.


Report Issues

You can report an issue or contribute to this site on GitHub. Simply click the button below and add any relevant notes. I will attempt to respond to all issues as soon as possible.

Issue


Back to Top