PowerShell Parameters for Modules

by Lewis · Wed 26th August, 2015

One for the personal digital scrapbook. When writing PowerShell modules I always have to dig this up as reference material and I’ve added an example as well.

about_Functions_Advanced_Parameters – https://technet.microsoft.com/en-us/library/hh847743.aspx

Function My-Function {

    param([parameter(Mandatory=$true)][string[]] $Computer,
          [string] $Username = "user",
          [string] $Password = 'password',
          [int] $Port = 443,
          [parameter(Mandatory=$true)]
          [ValidateSet( "Enable", "Disable" )]
          [string[]]
          $Status

    )
    # Do stuff
}

Function My-Function {

param([parameter(Mandatory=$true)][string[]] $Computer,

[string] $Username = "user",

[string] $Password = 'password',

[int] $Port = 443,

[parameter(Mandatory=$true)]

[ValidateSet( "Enable", "Disable" )]

[string[]]

$Status

)

# Do stuff

}

Obviously you need to Export-ModuleMember when you’ve created the function and save the file as .psm1 to identify it as a PowerShell Module.

After writing my personal use modules, I usually want them to load automatically when I fire up a PowerShell console so I add them to [Environment]::GetFolderPath('mydocuments') + "\WindowsPowerShell\Microsoft.PowerShell_profile.ps1" usually in a try/catch block.

-Lewis