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

Assigning Permissions - AGDLP

AGDLP It seems I have been mildly distracted away from the title of this blog site.   It does say AD Admin, but I seem to have been taken away by file system stuff.   I have to say, it has all been worthwhile, but it’s probably time I got back to the real heart of what I do. There are probably a million permission assigning advice pages, but I thought I would put another one out there after referring to AGDLP in my last post. So, what is this all about – AGDLP.   Well, it is something I learned in my MCSE 2003 studies and has become ingrained into my ideals since.   As a contractor, I get to move job often.   This enables me to forge opinions on how to configure things in a domain, and more importantly how NOT to configure things. AGDLP is definitely on the to do list…for anyone in any size domain or forest, as it follows some very basic principals.   I will explain these whilst I go through what AGDPL stands for. A A is for...

Finding out what 'SearchFlags' are set on you AD attributes

Whilst doing some research into indexed attributes, I posted this  a while back on how to find your index attributes.  Since then, I have looked a little deeper into what indexing really means and found this excellent explanation on the numbers that can be found in the searchflags attribute of a schema object. Using Florian’s reference, I built the following script (which is both powershell v1 and v2 compatible) to get the schema attributes from the forest schema and return (among other things) the breakdown of your attributes search flags. $forest = [System.DirectoryServices.ActiveDirectory.forest]::getcurrentforest() $schema = [ADSI]('LDAP://CN=Schema,CN=Configuration,dc=' + ($($forest).name -replace "[.]",",dc=")) $attributes = $schema.psbase.children | where {$_.objectClass -eq "attributeSchema"} $collection = @() foreach ($attr in $attributes){ $store = "" | select "Name","lDAPDisplayName","singlev...

Updated : V0.992 Filesystem Powershell module

Update : version 0.992  now available including DFS-r Hot on the heals of my AD sites module , I have been looking at some file system functions.  This module is driven primarily by my own needs, but after a prompt on the powergui website from someone after a way of managing DFS with powershell (thanks packetboy), this is what I have come up with.  All help files are included with examples, but I will publish the help and examples over time. Requirements This module has been built on a Windows 2008 R2 platform and therefore the DFS functions will be based around the 2008 R2 version of DFSUTIL.  This is not to say that it is not compatible with anything earlier, it has just not been tested. Installation and use Download the zip file and extract to your modules folder. This can be found by running "explorer $pshome\modules" from a PowerShell console. To use, run "import-module Filesystem" Command list and Help To retrieve the list of comma...