How To Create PowerShell Function
0 likes35,921 views
This document discusses PowerShell functions and provides an example of creating a simple function called Call_Function_Write_Welcome_Message. The function clears the host, lists function information, prints a purpose message, and outputs the text "Hello - PowerShell Script". To invoke the function, its name is called from the PowerShell CLI or ISE. When run, the function displays its output.
![Windows PowerShell Basics – Functions
1 | P a g e
Overview
PowerShell functions are helpful in saving time when you have repetitive task(s) to be executed.
Applies To
Tested on Windows 10, Windows 2008 R2 and Windows 2012.
Pre-Requisites
Launch PowerShell Command Console or PowerShell ISE.
To run this script, Execution Policy should be set to either of these “AllSigned” or “RemoteSigned” or
“Unrestricted”, you can get current execution policy by running the command; “Get-ExecutionPolicy”.
Each Policy type and its purpose is shown in the below table.
Policy Type Purpose
Restricted No scripts can be run. Windows PowerShell can be used only in interactive mode.
AllSigned Only scripts signed by a trusted publisher can be run.
RemoteSigned Downloaded scripts must be signed by a trusted publisher before they can be run.
Unrestricted No restrictions; all Windows PowerShell scripts can be run.
PowerShell Script – Function
This PowerShell script call function without any function arguments / parameters.
Code Snippet
#
# Simple Function
#
Function Call_Function_Write_Welcome_Message
{
Clear-Host
Write-Host "`nListing Function information that was created`n"
dir function: | Where-Object Name -Like "Call_function_Write_Welcome_Message"
Write-Host "`n__________________________________________"
Write-Host "`nPurpose of Function printing Hello Message"
Write-Host "__________________________________________"
Write-Host "`nHello – PowerShell Script"
[console]::beep(500,300)
}](https://image.slidesharecdn.com/howtocreatepowershellfunction-171129042249/85/How-To-Create-PowerShell-Function-2-320.jpg)
How To Create PowerShell Function
- 1. Windows PowerShell Basics – Functions i | P a g e Table of Contents Overview.......................................................................................................................................................1 Applies To..................................................................................................................................................1 Pre-Requisites ...........................................................................................................................................1 PowerShell Script – Function ........................................................................................................................1 Code Snippet.............................................................................................................................................1 Invoke Function.........................................................................................................................................2 PowerShell Output....................................................................................................................................2
- 2. Windows PowerShell Basics – Functions 1 | P a g e Overview PowerShell functions are helpful in saving time when you have repetitive task(s) to be executed. Applies To Tested on Windows 10, Windows 2008 R2 and Windows 2012. Pre-Requisites Launch PowerShell Command Console or PowerShell ISE. To run this script, Execution Policy should be set to either of these “AllSigned” or “RemoteSigned” or “Unrestricted”, you can get current execution policy by running the command; “Get-ExecutionPolicy”. Each Policy type and its purpose is shown in the below table. Policy Type Purpose Restricted No scripts can be run. Windows PowerShell can be used only in interactive mode. AllSigned Only scripts signed by a trusted publisher can be run. RemoteSigned Downloaded scripts must be signed by a trusted publisher before they can be run. Unrestricted No restrictions; all Windows PowerShell scripts can be run. PowerShell Script – Function This PowerShell script call function without any function arguments / parameters. Code Snippet # # Simple Function # Function Call_Function_Write_Welcome_Message { Clear-Host Write-Host "`nListing Function information that was created`n" dir function: | Where-Object Name -Like "Call_function_Write_Welcome_Message" Write-Host "`n__________________________________________" Write-Host "`nPurpose of Function printing Hello Message" Write-Host "__________________________________________" Write-Host "`nHello – PowerShell Script" [console]::beep(500,300) }
- 3. Windows PowerShell Basics – Functions 2 | P a g e Invoke Function To invoke /call the function, simply call the function name from the PowerShell CLI or PowerShell ISE. Call_Function_Write_Welcome_Message PowerShell Output When the function is called / executed; below output will be displayed.