Skip to main content

Powershell Common Parameters - Sometimes they need to go in the bin


This will be a short post. Now and again I find myself needing to know the names of the common parameters that is added to an advanced function. Usually this is because I want to use splatting and want to remove any usage of those built-in parameters. Here is how you can do it.

This time I was working on an advanced function that had a lot of parameters, counting in at 34 to be more precise. There was also a nice mixture of default values and calculated values that required my attention. The function should output those parameters with their values like so:

-Param1 <value>
-Param2 <value>


Now I could use $PSboundparameters, however that would not include the parameters with default values, hence I went the other way and used $MyInvocation.MyCommand.Parameters. This will give me a dictionary list of all the parameters including the common parameters (see help about_commonparameters) and those have to be removed.

A couple of days ago I was browsing around the [System.Management.Automation] and [Microsoft.Powershell] .Net classes looking for something else and I found this cute little static property:
[System.Management.Automation.Cmdlet]::CommonParameters

image

Have been looking for this little bugger for some time now, really nice to find it! Armed with this it is quite easy to remove the CommonParameters from my list of parameters.


image
       
That was nice!

Cheers

Tore

Comments

Popular posts from this blog

Developing PowerShell modules for REST APIs – Part1

Over the years I have developed different PowerShell modules for different web APIs. I thought it would be a good idea to write a 2 series post about how you could go about to do this. This will be a 2 part blog series where we will run through the entire process of building a module for a REST API. I will try my best to keep this as simple as possible and leave more advanced stuff for a follow up post if the interest is there.What you needDepending on your experience with source control and PowerShell in general, you might want to use GIT or some other software repro for the code. In addition we are going to create a test REST API using the splendid UniversalDashboard PowerShell module created by Adam Driscoll. It is available on the PowershellGallery. Other prerequisites are built-in to Powershell. I will assume that you will be following along using at least PowerShell version 5 or greater.
What is HTTP metods for REST API.The primary or most common HTTP verbs used are POST, GET, PU…

Serialize data with PowerShell

Currently I am working on a big new module. In this module, I need to persist data to disk and reprocess them at some point even if the module/PowerShell session was closed. I needed to serialize objects and save them to disk. It needed to be very efficient to be able to support a high volume of objects. Hence I decided to turn this serializer into a module called HashData.



Other Serializing methods

In PowerShell we have several possibilities to serialize objects. There are two cmdlets you can use which are built in:
Export-CliXmlConvertTo-JSON
Both are excellent options if you do not care about the size of the file. In my case I needed something lean and mean in terms of the size on disk for the serialized object. Lets do some tests to compare the different types:


(Hashdata.Object.ps1)

You might be curious why I do not use the Export-CliXML cmdlet and just use the [System.Management.Automation.PSSerializer]::Serialize static method. The static method will generate the same xml, however we …

Build your local powershell module repository - ProGet

So Windows Powershell Blog released a blog a couple of days ago (link). Not too long after, a discussion emerged about it being to complicated to setup. Even though the required software is open source (nugetgalleryserver), it looks like you need to have Visual Studio Installed to compile it. I looked into doing it without visual stuidio, however I have been unable to come up with a solution. I even tweeted about it since I am not an developer. Maybe someone how is familiar with “msbuild” could do a post on how to do it without VS.

Anyhow one of my twitter-friends (@sstranger) came to the rescue and pointed me in the direction of ProGet, hence the title of this post. ProGet comes in 2 different licensing modes
Free (reduced functionality)Enterprise (paid version with extra features)The good news is that the free version supports hosting a local PowershellGet repository which was my intention anyway. So off we go and create a Configration that can install ProGet for us. This is the conf…