p008 Scheduled Job 다루기

schtasks.exe

윈도우즈에는 예전부터 schtasks라는 명령어가 있었습니다.

ScheduledJob vs ScheduledTask

저는 ScheduledJob을 사용합니다. ScheduledTask도 나쁘지 않은 접근입니다. 근본적인 차이점은

Scheduled Task 는 윈도우즈의 부분이고, 다른 부분들을 Powershell이 다룰 수 있는 것처럼 Powershell도 이를 컨트롤 할 수 있습니다.
반면 Scheduled Job은 거의 PowerShell 의 물건입니다. 바꿔 말하면 scheduled job은, Powershell 환경안에서 실행되는, 실행 예정된 PowerShell code 입니다.

그러므로 PowerShell환경이 아닌 곳에서는 Scheduled Task만 사용할 수 있지만, PowerShell환경에서는 양쪽 모두 사용할 수 있습니다.

GUI로 확인하고 싶다면, Task Scheduler GUI 프로그램 TaskSchd.msc 에서의 경로는 Microsoft\Windows\PowerShell\ScheduledJobs 에 있습니다.

디자인적인 측면

사실 윈도우즈의 반복작업 등록은, crontab과 비교하면, 알기 쉽게 쓸 수 있는 디자인은 아닌 것 같습니다. 특히 비 영어권에서는 금방 알아들을 수 없는 단어도 등장합니다.

등록하는 코드가 사용하는 옵션은 엄청 많습니다. 하나 하나 살펴보면

trigger

언제 실행할 지를 나타냅니다. `AC 전원이 들어올 때’와 ‘로그인할 때’를 선택할 수도 있습니다.

crontab이라면 @reboot 와
.bash_profile등에 따로 두어야 할 수도 있습니다.

credential

어떤 권한으로 실행할 지를 나타냅니다.

시스템권한, MSSql, 또는 Domain Administrator등 스크립트를 실행하는 권한을 지정할 수 있습니다.
스크립트로는 credential object를 생성하는 것은 참 꺼려지는 부분이긴 합니다.

option

공식페이지에서 설명을 보면 다음과 같이 여러 옵션이 있습니다. 이 페이지는 현재까지도 번역이 안되어있어 영어로 봐야합니다.

New-ScheduledJobOption
   [-RunElevated]
   [-HideInTaskScheduler]
   [-RestartOnIdleResume]
   [-MultipleInstancePolicy <TaskMultipleInstancePolicy>]
   [-DoNotAllowDemandStart]
   [-RequireNetwork]
   [-StopIfGoingOffIdle]
   [-WakeToRun]
   [-ContinueIfGoingOnBattery]
   [-StartIfOnBattery]
   [-IdleTimeout <TimeSpan>]
   [-IdleDuration <TimeSpan>]
   [-StartIfIdle]
   [<CommonParameters>]

RunElevated 관리자 그룹의 구성원의 권한으로 예약된 작업을 실행합니다.
HideInTaskScheduler 실행중인 태스크는 표시하지 않습니다. 스케쥴중인 태스크는 표시됩니다. 실행중의 태스크를 숨기더라도 태스크 스케줄러에서 숨겨진 태스크 보기 표시 옵션을 통해서 표시하는 것도 가능합니다.
RestartOnIdleResume Idle이 꺼지면 중지했던 태스크를 Idle상태로 돌아오면 다시 시작ㄴ합니다.
MultipleInstancePolicy
DoNotAllowDemandStart 수동으로 실행은 못하고 Trigger에 의해서만 실행됩니다.
RequireNetwork 네트웍이 될 때만 실행합니다.
StopIfGoingOffIdle Idle상태에서 실행을 시작했다가 Idle상태를 벗어나게되면 실행을 일단 중지 합니다.
WakeToRun 기본적으로 시스템이 예약된 시작 시간에 절전 모드 상태에 있으면 작업이 실행되지 않는데, 절전모드에서 일어나 작업하도록 한다.
ContinueIfGoingOnBattery 기본적으로 예약된 작업은 시스템의 AC 전원 연결이 끊기면 중지되는데, 이 옵션으로 중지하지 않고 계속 합니다.
StartIfOnBattery 노트북의 윈도우즈인 경우에도 실행하게 합니다. 기본값은 False 입니다.
IdleTimeout
IdleDuration
StartIfIdle 파라메터 IdleDuration 에 설정된만큼 Idle상태가 계속되면 실행합니다.

Register-ScheduledJob

ScheduledJob은 한 번 또는 반복 예약에 따라 자동으로 시작할 수 있는 윈도우즈 PowerShell 백그라운드 작업입니다. ScheduledJob은 Disk에 저장되고 태스크 스케줄러에 등록되는데, 등록된 Job은 Task Scheduler에서 관리하거나 PowerShell에서 스케줄링된 작업 cmdlet을 사용하여 관리할 수도 있습니다.

사용 예) 일단 등록하기

1
2
3
4
Register-ScheduledJob -Name "Archive-Scripts" -ScriptBlock {
  Get-ChildItem $home\*.ps1 -Recurse |
    Copy-Item -Destination "\\Server\Share\PSScriptArchive"
}

트리거가 없기 때문에 자동 실행되지 않습니다. Get-ScheduledTask하여 수동으로 실행할 수는 있습니다.

Trigger넣어서 만들기

1
2
3
4
$O = New-ScheduledJobOption -WakeToRun -StartIfIdle -MultipleInstancePolicy Queue
$T = New-JobTrigger -Weekly -At "9:00 PM" -DaysOfWeek Monday -WeeksInterval 2
$path = "\\Srv01\Scripts\UpdateVersion.ps1"
Register-ScheduledJob -Name "UpdateVersion" -FilePath $path -ScheduledJobOption $O -Trigger $T

Trigger와 Option 넣어서 만들기

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
$T = @{
  Frequency="Weekly"
  At="9:00PM"
  DaysOfWeek="Monday"
  Interval=2
}
$O = @{
  WakeToRun=$true
  StartIfNotIdle=$false
  MultipleInstancePolicy="Queue"
}
Register-ScheduledJob -Trigger $T -ScheduledJobOption $O -Name UpdateVersion -FilePath "\\Srv01\Scripts\Update-Version.ps1"

완성된 코드

다음의 스크립트는 1시간마다 한 번씩, 현재 blog의 통계를 구해서 무료 influxdb 서비스에 기록하는 스크립트입니다.

{{ if .Inner }}
$base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(“token:ba7a237dbd36661c8ba79fd332cdfc77”))
{{ end }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

#Define the interval to repeat the job
$trigger = New-JobTrigger -Once -At 10:00PM -RepetitionInterval (New-TimeSpan -Hours 1) -RepeatIndefinitely
 
#Get user credential so that the job has access to the network
$cred = Get-Credential -UserName Administrator
 
#Set job options
$opt = New-ScheduledJobOption -RunElevated -RequireNetwork

#  -FilePath c:\scripts\Get-DCDiskSpace.ps1  
Register-ScheduledJob -Name Update-HugoInflux -Trigger $trigger -Credential $cred -MaxResultCount 10 -ScheduledJobOption $opt `
-ScriptBlock {
    $posts = get-hugopost
    $post_count = $posts.Count

    $post_count_public = ($posts | where-object {! $_.FrontMatter.draft }).Count
    $post_count_draft = ($posts | where-object { $_.FrontMatter.draft }).Count

    "public : $post_count_public"
    "draft : $post_count_draft"

    $total_line = 0
    foreach ($p in $posts) {
        $total_line += $p.Content.Split("`n").Count
    }
    $total_line
    $line_count_total = $total_line

    $total_char = 0
    foreach ($p in $posts) {
        $total_char += $p.Content.ToCharArray().Count
    }
    $total_char

    $char_count_total = $total_char

    "hugoblog,site=tkimblog post_count=$post_count,post_count_public=$post_count_public,post_count_draft=$post_count_draft,line_count_total=$line_count_total,char_count_total=$char_count_total"

    $base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("token:this-is-a-token-string"))
    $base64AuthInfo
    $response = Invoke-RestMethod 'https://corlysis.com:8086/write?db=crowdy' -Method POST `
        -Headers @{Authorization=("Basic {0}" -f $base64AuthInfo)} `
        -Body "hugoblog,site=tkimblog post_count=$post_count,post_count_public=$post_count_public,post_count_draft=$post_count_draft,line_count_total=$line_count_total,char_count_total=$char_count_total"
}

감상: 통계를 갱신이 되는 시간이 가까워지면, 번쩍 정신이 들곤 합니다.

ScheduledJob 사용하는 경우

작성하고 있는 블로그 사이트의 포스트 수, 라인 수, 글 수등을 정기적으로 확인하고 싶을 때
참고하는 사이트에 새 글이 올라와 있는 지 살펴 볼 때