Skip to main content

Powershell v2 Function Template

Powershell v2 Function Template
Powershell v2 has updated what you can do with creating functions over Powershell V1. The whole function experience has been updated to a cmdlet like feel with error handling, parameter validation, help creation and of course, tab completion! The following is a bare bones template that I've commented inline for easy reading!


function new-template {
<#
.SYNOPSIS
   Brief description of what the function does
.DESCRIPTION
   A better description
.NOTES
   Function Name : new-template
   Author : Adam Stone
   Requires : PowerShell V2
.LINK
   http://adadmin.blogspot.com/
.EXAMPLE
   Simple usage
   PS C:\> new-template -args values
.EXAMPLE
   Simple usage
   PS C:\> new-template -args values values etc
.PARAMETER first
   A description of the first parameter
.PARAMETER targetdomain
   A description of the sedond parameter
#>

#parameter validataion
param (
   #define the position of the parameter if required, specify if it is mandatory, and give a help message if anything is incorrect
   [Parameter(Position=0, Mandatory=$true,HelpMessage="Enter the source Domain DNS name (eg domain.com) of the OU Structure")]

   #add an alias to accept different names through the pipeline
   [alias("other")]

   #choose one of these if required

   #make sure the option is not null or empty
   #[validatenotnullorempty()]

   #valadate the input against a regex pattern
   #[validatepattern("regex")]

   #valadate the input against defined set of attributes
   #[validateset("one","two")]

   #define type if necessary and what the default value will be if not manditory
   [string] $first = "abcde"
   ,
   #new parameter after the comma
   [Parameter(Mandatory=$false)]
   [alias("out")]
   [string] $fileout = "none"
)
#the processes the function will complete
process {
   #do stuff!
}

}#end function


Comments

Popular posts from this blog

PowerShell 3 behavioural change

It's taken me way too long to get into PowerShell 3, I guess opportunity hasn't shown it's self until now and so, here, my V3 journey begins.

I was asked to debug a script that would run fine in PS v2 and not in v3.  The issue was a that a variable length was being checked and was failing in v3.  This is why...

In v2 if a variable is undefined, this test returns false

PS C:\windows\system32> $var.length -eq 0
False

In v3 the same test returns true....

PS C:\windows\system32> $var.length -eq 0
True

Not a biggie, but as in this case, a script has broken so something to consider!

cheers

Adam

Enable Powershell Remoting (WinRM) via Group Policy

I have been doing some testing on enabling WinRM via group policy, being that WinRM is the service that Powershell v2 sets up it remoting capabilities. Here are the GPO settings that you need to configure WinRM ....


set the winrm service to auto start


Computer Configuration \ Policies \ Windows Settings \ Security Settings \ System Services


Windows Remote Management (WS-Management)  set Startup Mode to Automatic

start the service


incorporated in to the above - you may need a restart.


create a winrm listener


Computer Configuration / Policies / Administrative Templates / Windows Components / Windows Remote Management (WinRM) / WinRM Service / Allow automatic configuration of listeners


IPv4 filter: *


* is listen on all addresses, or if you only want a particular IP address to respond use an iprange eg 10.1.1.1-10.1.1.254 - don't forget that this IP range has to be valid for all hosts that fall in the scope of the GPO you are creating.  You can use 10.1.1.1 - 10.1.1.254,10.1.1.3 - 10.1.4.254 …

compare-object in Powershell - comparing mulitple values

I'm starting to use compare-object more and more, and one thing I noticed, is that you can compare 2 objects based on multiple attributes. here is how it is constructed...
Compare-Object -ReferenceObject $object1 -DifferenceObject $object2 -Property a,b,c,d,eIf a,b,c and d are the same, but e is different, compare object will return a difference. In the following example, I use "-eq $null" as a check because by default compare-object returns $null if the objects are the same.
#create an array of objects to check against

$collection = @()
foreach ($entry in ("aaaaa","bbbbb","ccccc","ddddd")){
   $store = "" | select "a","b","c","d","e"
   $store.a = $entry*1
   $store.b = $entry*2
   $store.c = $entry*3
   $store.d = $entry*4
   $store.e = $entry*5
   $collection += $store
}

#create an object similar to those in the array
$object = "" | select "a","b…