{"id":3143,"date":"2013-07-29T00:01:00","date_gmt":"2013-07-29T00:01:00","guid":{"rendered":"https:\/\/blogs.technet.microsoft.com\/heyscriptingguy\/2013\/07\/29\/add-a-couple-of-functions-to-powershell-profile\/"},"modified":"2013-07-29T00:01:00","modified_gmt":"2013-07-29T00:01:00","slug":"add-a-couple-of-functions-to-powershell-profile","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/scripting\/add-a-couple-of-functions-to-powershell-profile\/","title":{"rendered":"Add a Couple of Functions to PowerShell Profile"},"content":{"rendered":"

Summary<\/strong>: Microsoft Scripting Guy, Ed Wilson, adds a couple of new functions to his Windows PowerShell console profile.<\/span><\/p>\n

Microsoft Scripting Guy, Ed Wilson, is here. I have heard that necessity is the mother of invention. For me, annoyance is the mother of scripting. What I mean is that when it comes time for me to write a script (something short and quick), I only do it after I am tired of typing the same command over and over again. For example, consider the first two functions I recently added to my Windows PowerShell profile…<\/p>\n

Load and unload modules<\/h2>\n

Everyone knows we have automatic module loading in Windows PowerShell 3.0. But not everyone knows that when it comes time to use Get-Command<\/strong>, if I have not loaded the modules, an error generates, as shown here.<\/p>\n

\"Image<\/a><\/p>\n

If this is the case, why don’t I just add the command to load all modules into my profile? The reason is speed of launching. For example, on my laptop, it consistently takes 16 seconds to load all of my modules. This is shown here:<\/p>\n

PS C:\\> Measure-Command {Import-AllModules}<\/p>\n

Warning:  To run some commands exposed by this module on Windows Vista, Windows<\/p>\n

Server 2008, and later versions of Windows, you must start an elevated Windows<\/p>\n

PowerShell console.<\/p>\n

 <\/p>\n

Days              : 0<\/p>\n

Hours             : 0<\/p>\n

Minutes           : 0<\/p>\n

Seconds           : 16<\/p>\n

Milliseconds      : 43<\/p>\n

Ticks             : 160435770<\/p>\n

TotalDays         : 0.000185689548611111<\/p>\n

TotalHours        : 0.00445654916666667<\/p>\n

TotalMinutes      : 0.26739295<\/p>\n

TotalSeconds      : 16.043577<\/p>\n

TotalMilliseconds : 16043.577<\/p>\n

I want to be able to load or to unload all of the modules, but do it only when I need to do so. Therefore, this becomes a good excuse for writing a couple of functions.<\/p>\n

I have been typing the commands to load and to unload all modules for at least a year (as long as I have been using Windows PowerShell 3.0). Finally, it got to me, and I decided to write the simple functions that follow. Oh by the way, to make the functions easier to use, I created a couple of aliases for them too. Here are the two functions:<\/p>\n

Function Import-AllModules<\/strong><\/p>\n

{Get-Module -ListAvailable | Import-Module}<\/p>\n

 <\/p>\n

Function Remove-AllModules<\/p>\n

{Get-Module -ListAvailable | Remove-Module}<\/p>\n

Set-Alias -Name ram -Value Remove-AllModules<\/p>\n

Set-Alias -Name iam -Value import-allmodules<\/p>\n

Finding commands<\/h2>\n

Get-Command<\/strong> works great. But the default output is not what I normally would do. For example, because of all the cmdlets and functions, the output invariably scrolls, so I need to pipe the results to More<\/strong>. In addition, I normally am looking for cmdlets from the same module, so I like to sort by the module. I therefore came up with this function that I call Get-Commands<\/strong> (I also created an alias for it).<\/p>\n

Function Get-Commands<\/strong><\/p>\n

{<\/p>\n

 Param($verb,<\/p>\n

       $noun)<\/p>\n

 Get-Command @PSBoundParameters | Sort-Object module | more<\/p>\n

}<\/p>\n

 <\/p>\n

Set-Alias -Name gcms -Value get-commands<\/p>\n

About the only thing notable here, is the use of $psBoundParameters<\/strong>. This cool automatic variable keeps track of parameters that are supplied to a function. I need to know if –Verb<\/strong> or –Noun<\/strong> or both –Verb<\/strong> and –Noun<\/strong> are supplied so I can create the syntax for the Get-Command<\/strong> cmdlet.<\/p>\n

In the past, I would have needed to use a series of If \/ Else \/ Elseif types of construction to get the correct syntax. By using $PSBoundParameters<\/strong>, I do not need to do this. I simply pass whatever is supplied as arguments to the function to the command line via $PSBoundParameters<\/strong>. I then sort the results on the Module<\/strong> parameter and send the results to the More<\/strong> command. It works great, and saves me a lot of repetitive typing.<\/p>\n

Removing the AD: drive<\/h2>\n

Part of the slowness in loading the Active Directory module is due to the creation of the AD: drive. I do not use this drive all the time, but I do use the Active Directory cmdlets on nearly a daily basis. So I created a function to disable creating the AD: drive. Here is the function:<\/p>\n

Function Remove-ADDrive<\/p>\n

{$Env:ADPS_LoadDefaultDrive = 0} <\/span><\/p>\n

I load it directly via my Windows PowerShell profile. If I want the AD: drive, I just comment out the line that calls the Remove-ADDrive<\/strong> function.<\/p>\n

Admin or not?<\/h2>\n

The last thing I did was modify the title of my Windows PowerShell console based on if I have Admin rights. My Test-ISAdministrator<\/strong> function has been talked about (and copied) widely, so I am not going to repeat it here. I use it to see if I have Admin rights. If I do, I set the Windows PowerShell console title to SUPER PowerShell dude! If I do not have Admin rights, I set the title of the Windows PowerShell console to Regular PowerShell dude. The function is shown here:<\/p>\n

Function Set-ConsoleConfig<\/p>\n

{<\/p>\n

 if(-not (Test-IsAdministrator))<\/p>\n

  {$Host.ui.RawUI.WindowTitle = "Regular PowerShell dude"}<\/p>\n

 else {$Host.ui.RawUI.WindowTitle = "SUPER PowerShell dude!"}<\/p>\n

} #end function set-consoleconfig<\/p>\n

The Windows PowerShell console when launched with non-elevated permissions is shown here:<\/p>\n

\"Image<\/a><\/p>\n

That is all there is to adding a couple of functions to my profile. Join me tomorrow when I will talk about more cool Windows PowerShell stuff.<\/p>\n

I invite you to follow me on Twitter<\/a> and Facebook<\/a>. If you have any questions, send email to me at scripter@microsoft.com<\/a>, or post your questions on the Official Scripting Guys Forum<\/a>. See you tomorrow. Until then, peace.<\/p>\n

Ed Wilson, Microsoft Scripting Guy<\/strong><\/p>\n","protected":false},"excerpt":{"rendered":"

Summary: Microsoft Scripting Guy, Ed Wilson, adds a couple of new functions to his Windows PowerShell console profile. Microsoft Scripting Guy, Ed Wilson, is here. I have heard that necessity is the mother of invention. For me, annoyance is the mother of scripting. What I mean is that when it comes time for me to […]<\/p>\n","protected":false},"author":596,"featured_media":87096,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[51,144,3,4,45],"class_list":["post-3143","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scripting","tag-getting-started","tag-profiles","tag-scripting-guy","tag-scripting-techniques","tag-windows-powershell"],"acf":[],"blog_post_summary":"

Summary: Microsoft Scripting Guy, Ed Wilson, adds a couple of new functions to his Windows PowerShell console profile. Microsoft Scripting Guy, Ed Wilson, is here. I have heard that necessity is the mother of invention. For me, annoyance is the mother of scripting. What I mean is that when it comes time for me to […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/3143","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/users\/596"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/comments?post=3143"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/3143\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media\/87096"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media?parent=3143"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=3143"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=3143"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}