스크립트 모듈의 확장자 : .psm1

스크립트 모듈을 사용하면 특정 경로에서 스크립트 파일을 실행하고 함수를 다시 호출하는 과정을 거치지 않아도 된다. 기본 파워셸 명령을 사용할 때처럼 단순히 이름과 필요한 매개변수를 입력하여 사용하면 된다.

작성한 모듈을 올바른 위치에 정확한 파일 확장자로 저장했다면, 파워셸을 시작할 때마다 자동으로 모듈을 찾아 로드하기 때문에작성한 함수를 해당 셸 내에서 편리하게 사용할 수 있다.

스크립트 모듈을 저장하는 위치를 확인할 때 살펴볼 환경 변수가 PSModulePath 이다.

PS /> Get-Content Env:/PSModulePath                                                                                                        
/Users/{User-Name}/.local/share/powershell/Modules:/usr/local/share/powershell/Modules:/usr/local/microsoft/powershell/6.0.2/Modules

• /Users/{User-Name}/.local/share/powershell/Modules
• /usr/local/share/powershell/Modules
• /usr/local/microsoft/powershell/6.0.2/Modules

스크립트 모듈을 만드는 방법

PSMail.psm1

function Send-OutlookMail{
    [CmdletBinding()]
    Param(
	    [Parameter(Mandatory=$False)]
        [string] $From = "김도균 ",
	    [Parameter(Mandatory=$True)]
        [string] $To,
        [Parameter(Mandatory=$False)]
        [string] $Cc = "steelflea@outlook.com",
        [Parameter(Mandatory=$True)]
        [string] $Subject,
        [Parameter(Mandatory=$False)]
        [string] $Body = "PowerShell에서 보낸 메일"
    )
    BEGIN 
    {
        $Cred = (Get-Credential)
        $SmtpSvr=“smtp.live.com”
        $SmtpPort="587"     
    }
    PROCESS
    {
        Send-MailMessage -From $From -To $To -Cc $Cc -Subject $Subject `
        -Body $Body -SmtpServer $SmtpSvr  -Port $SmtpPort -UseSsl `
        -Credential $Cred -Encoding UTF8
    }
    END
    {
        Clear-Variable -Name Cred
    }
}

위 모듈을 PSMail 이라는 폴더를 만들어 저정한다.

PS /usr/local/share/powershell/Modules/PSMail> ls -al                                                                                      
total 8
drwxr-xr-x  3 hongkun  admin  96  6 29 23:10 .
drwxr-xr-x  3 hongkun  admin  96  6 29 23:09 ..
-rw-r--r--@ 1 hongkun  admin  76  6 29 23:10 PSMail.psm1
PS /usr/local/share/powershell/Modules/PSMail> Send-                                                                                       
Send-MailMessage  Send-OutlookMail                                                                                                         
PS /usr/local/share/powershell/Modules/PSMail> Get-Module -ListAvailable                                                                   


    Directory: /usr/local/share/powershell/Modules


ModuleType Version    Name                                ExportedCommands                                                                
---------- -------    ----                                ----------------                                                                
Script     0.0        PSMail                              Send-OutlookMail                                                                


    Directory: /usr/local/microsoft/powershell/6.0.2/Modules


ModuleType Version    Name                                ExportedCommands                                                                
---------- -------    ----                                ----------------                                                                
Manifest   1.1.0.0    Microsoft.PowerShell.Archive        {Compress-Archive, Expand-Archive}                                              
Manifest   3.0.0.0    Microsoft.PowerShell.Host           {Start-Transcript, Stop-Transcript}                                             
Manifest   3.1.0.0    Microsoft.PowerShell.Management     {Add-Content, Clear-Content, Clear-ItemProperty, Join-Path...}                  
Manifest   3.0.0.0    Microsoft.PowerShell.Security       {Get-Credential, Get-ExecutionPolicy, Set-ExecutionPolicy, ConvertFrom-Secure...
Manifest   3.1.0.0    Microsoft.PowerShell.Utility        {Format-List, Format-Custom, Format-Table, Format-Wide...}                      
Script     1.1.7.0    PackageManagement                   {Find-Package, Get-Package, Get-PackageProvider, Get-PackageSource...}          
Script     1.6.0      PowerShellGet                       {Install-Module, Find-Module, Save-Module, Update-Module...}                    
Script     0.0        PSDesiredStateConfiguration         {ValidateNodeManager, Get-PublicKeyFromFile, Set-PSDefaultConfigurationDocume...
Script     1.2        PSReadLine                          {Get-PSReadlineKeyHandler, Set-PSReadlineKeyHandler, Remove-PSReadlineKeyHand...

Send- 까지만 입력하고 tab을 누르면 추가한 모듈을 확인 할 수 있다. 

예제를 통해서 파워셸 범위를 확인해 보자.

function global:CallFrom-Function {
    $callByFunction = "다른 함수에서 불렀어요."
    "callByFunction 변수는 $callByFunction"
}

function global:CallFrom-Script {
    $callByScript = "다른 스크립트에서 불렀어요."
    "callByScript 변수는 $callByScript"
}

$Global:globalVar = "전역 범위. 스크립트 밖에서 접근"
function Check-FunctionScope {
    $functionVar = '함수 범위, 함수내에서만 접근'
    "functionVar은 $functionVar"
    $Local:lovalVarInFunc = '함수내에서 선언한 로컬 범위'
    $Script:scriptVarInFunc = '함수내에서 선언한 스크리브 범위'
    $Global:globalVarInFunc = '함수내에서 선언한 전역 범위'
    ''
    CallFrom-Function
}
''

$scriptVar = "스크립트 범위. 스크립트 내에서만 접근"
"scriptVar은 $scriptVar"

Check-FunctionScope
''
CallFrom-Script

PS /Users/hongkun/workspace/powershell> /Users/hongkun/workspace/powershell/CallFrom-Script.ps1


PS /Users/hongkun/workspace/powershell> cd Function:
PS Function:/> ls
CallFrom-Script.ps1     Chap8Ex2.ps1            Check-FunctionScope     Check-FunctionScope.ps1 Get-SecurityEvents.ps1
PS Function:/> /Users/hongkun/workspace/powershell/Check-FunctionScope.ps1



scriptVar은 스크립트 범위. 스크립트 내에서만 접근
functionVar은 함수 범위, 함수내에서만 접근

callByFunction 변수는 다른 함수에서 불렀어요.

callByScript 변수는 다른 스크립트에서 불렀어요.
PS /Users/hongkun/workspace/powershell>

PS /Users/hongkun/workspace/powershell> $globalVar
전역 범위. 스크립트 밖에서 접근
PS /Users/hongkun/workspace/powershell> $scriptVar
스크립트 범위. 스크립트 내에서만 접근

모듈화는 특정 작업을 위해 작성한 여러 가지 도구(개별 스크립트)의 내용을 간단히 하나의 파일에 모으고, 각 도구를 별도의 블록으로 구분하는 일

파워셸에서는 이렇게 블록으로 구분한 각 도구의 하나의 기능 집합으로 인식하며, 이를 함수(Funciton)이라고 부른다.

파워셸 함수 템플릿

Function Noun-Verb {
    [CmdletBindin()]
    param()
    BEGIN{}
    PROCESS{}
    END{}
}

param()

Param 내에는 대괄호 내에 매개변수의 처리 방식을 설정하는 부분과 매개변수의 형식과 이름을 선언. 함수에서 매개 변수가 필요 없는 경우는 비워둔다.

[Paramter(위치, 필수 매개변수, 파이프라인 입력)]

[데이터 형식]$변수명 = 기본값(옵션)

• 함수에서 입력되는 매개변수 위치 : 지정하지 않아도 매개변수 위치를 자동으로 감지한다. 지정하면 조금 더 나은 가독성을 제공할 수 있다.

      Position = 정수 (예, 0, 1, 2 ....)

• 필수 매개변수 여부

      Mandatory=$True or $False (False가 기본값)

• 파이프라인 입력 허용 여부

      ValueFromPipeline=$True (기본값은 $False)

BEGIN

제일 마지막에 실행되는 부분이다.

주로 정리 작업에 해당되는 구문이 여기에 들어간다.

예를들어 데이터 베이스 연결 종료와 같은 처리를 하는 곳이다.

function Get-SecurituEvents {
    [CmdletBinding()]
    Param(
        [Parameter(Position=0, Mandatory=$true)]
        [string]$ComupterName,
        [int]$EventId = 4634
    )
    BEGIN
    {
        $LogName = Read-Host "로그 이름을 입력하세요."
    }
    PROCESS
    {
        Get-EventLog -ComputerName $ComupterName `
        -LogName $LogName |
        Where-Object -Property EventId -eq $EventId |
        Select-Object -First 7
    }
    END {}
}

PROCESS 블록에서는 이벤트 ID를 필터링해서 최초 7개의 로그 항목을 가져오는 작업 구문을 입력했다.

위 함수를 실행해 보자

1. PowerShell ISE나 콘솔에서 함수가 들어 있는 스크립트 파일을 실행한다. 이때 스크립트 내에서 작성한 모두 함수가 메모리에 올라간다.
2. 실행하고 싶은 함수 이름을 콘솔에서 호출한다.

PS > cd Function:
PS Function:\> ls