A while back I posted an advanced PowerShell function that would take an object and convert it to a hashtable. The premise was simple enough: look at the incoming object with Get-Member to discover the property names then create a hashtable with each property name as a hashtable key. I've a need to use this over the last few weeks and realized the function could use a little updating.
ManageEngine ADManager Plus - Download Free Trial
Exclusive offer on ADManager Plus for US and UK regions. Claim now!
The new version works like the old, with the addition of one new parameter. I decided I wanted a way to exclude properties from the hashtable. Of course this presumes you know in advance about the object you are working with and what properties you wish to exclude. This is the core segment of code, which has also been revised over version 1.
#go through the list of names and add each property and value to the hash table $names | ForEach-Object { #only add properties that haven't been excluded if ($Exclude -notcontains $_) { #only add if -NoEmpty is not called and property has a value if ($NoEmpty -AND -Not ($inputobject.$_)) { Write-Verbose "Skipping $_ as empty" } else { Write-Verbose "Adding property $_" $hash.Add($_,$inputobject.$_) } } #if exclude notcontains else { Write-Verbose "Excluding $_" } } #foreach
In the first version I was duplicating some code and I generally try to avoid that. In this snippet $names is the collection of property names and $Inputobject is the piped in object. Armed with this tool I can create hashtables from objects with just the properties I want.
PS Scripts:\> $h = get-service spooler | ConvertTo-HashTable -NoEmpty -Exclude CanStop,CanPauseandContinue PS Scripts:\> $h Name Value ---- ----- ServiceName spooler ServiceType Win32OwnProcess, InteractiveProcess Name spooler DisplayName Print Spooler MachineName . Status Running ServiceHandle SafeServiceHandle DependentServices {Fax} RequiredServices {http, RPCSS} ServicesDependedOn {http, RPCSS}
This version should work in PowerShell 2.0 or 3.0. Download ConvertTo-Hashtable2.
This is a great function that I use very often. But I have change it additionally with a $Inclue parameter.
How it works:
If the [String[]] $Include Count ist equals to 0, then use the Get-Member function to get the member name, it its greather than 0, us this assignment: $names = $Include.
Greetings,
Claudio
Could use a link to your old article! I’m curious why you would do this?
I might want to take the object and transform it. Using a hashtable and modifying it is pretty easy. The hashtable can then be turned back into an object. Or I might want to combine objects. Much easier to join a few hash tables and then turn that back into an object. Or I might want a hash table of properties that I can splat later against some other cmdlet.
Thanks Jeff!
Thanks a lot for this useful instruction.
I like to work with Powershell and your Blog is a good source to learn more about it.