PoSH–vscode analyzer and parameters

The more I work with Visual Studio code the more I like it, especially for PowerShell. The Integrated Terminal just gets better and better. It just makes working with scripts much easier and makes me better at crossing the t’s and dotting the i’s.

One thing I came across recently was how the ScriptAnalyzer (a tool not just for vscode ) and Visual Studio Code work together. I was working with some colleagues on taking some code for a project and assembling it into a script. Of course that meant adding advanced functionality.  I wanted to provide parameters for the input that is needed. I started adding a password parameter. While it isn’t a formal credential but rather a simple string applied to a step within the script I used the word password in the parameter name. Then I noticed green squiggly lines for the complete parameter statement. Understanding that this was just a recommendation I messed around with it a little. As soon as I changed the parameter name to something other than “password” the warning/suggestion indicator disappeared. Since I want the operator to understand what the parameter is I kept the name and will live with the green squiggly lines but I just thought that was a nice implementation.

param-detection

Powershell, Visual Studio Code and Extensions

While getting the feel for, and getting even more comfortable with, Visual Studio code I have been playing with a good number of Extensions. While fun, this can be overwhelming as there are a great number of extensions available depending on what you plan on using Visual Studio Code for. The ones I am favoring so far:

I am leaving out themes as I still have not found the Theme for me but there are some interesting choices.

Just some quick code:

Begin {
    $extPath = "C:\Program Files (x86)\Microsoft VS Code Insiders\resources\app\extensions"
}
Process {
    $codeExtensions = get-childitem -Path $extPath -Directory | sort-object -Property Name
    ForEach ($ext in $codeExtensions) {
        $ext.Name
    }
}

I am using Open Live Writer to write blog posts, still hoping a Code Syntax plugin becomes available because in my opinion this a a great blogging tool.

Visual Studio Code and Powershell Snippets the easy way

I spent more time working with Visual Studio Code and Snippets. For my Comment Based Help I did find a way to add the file name but sadly there seems to be no way to include a Date. I have been spoiled by some of the stuff Sapien does and wanted to see if I could reproduce that. Maybe more on that later. If you are looking to quickly create snippets, and this is not just Powershell, but there is an extension that makes it a very simple process. Check out https://marketplace.visualstudio.com/items?itemName=tariky.easy-snippet-maker . There is another one I am testing but as I started to work through these I found something that had me thinking there was a problem but I looked a little further and nope no problem if you know where to look.

What am I talking about? So this extension allows you to select some code, right-click create snippet… enter the Name, prefix and Description and wala you have a snippet. Then I tried it in the Insiders version of Visual Studio Code… hmmm doesn’t seem to work. Uggh. Try again and it says a Snippet with that name already exists. I open the powershell.json file and I can’t find it. What the heck…. then I compared \Roaming\Code\User\Snippets to \Roaming\Code – Insiders\User\Snippets the extension is putting the Snippet in the non Insiders version of the Snippets folder. Just an FYI.

Visual Studio Code Snippets

I am trying to get comfortable with Visual Studio Code for working with PowerShell scripts. Admittedly I still revert back to the ISE to debug the code. Maybe Code will provide that integrated interface one day but we will see. Moving on, one thing I use a great deal of are snippets. Admittedly I was completely lost on how to implement snippets in this IDE, then I found a great article from Keith Hill. This post provides information as well as a great starter file.

Now I want to add my own Snippets. The process is easy enough and the JSON editing in Visual Studio Code is pretty slick. I then found myself struggling with how to create a snippet and using PowerShell syntax create a variable. It starts with a dollar sign, easy enough right? Not really. The dollar sign is part of the snippet language as well. Yes I read this doc but didn’t put one and one together I guess. After some trial and error I found that $$ would then create the PowerShell syntax I was looking to achieve.

https://gist.github.com/jkavanagh58/1e06ac75860340cb1c1399b7676f7ebb.js

image

So in a PowerShell script I start typing the prefix and Intellisense detects possible matches, one of them being my Snippet:

image

Then I click on the User Snippet reference and the result is…

image

Now I have to start converting my library of snippets and then play with the dollar sign operator of Visual Studio Code snippets.

Delprof Alternative

So I wrote this ugly code quite some time ago. Since I have seen a few new posts in the script gallery with versions I figured I should at least post a version of what I had done a few years ago and re-used recently. Situations like shared computers and RDS can have a computer looking ragged with local profiles created on login and then not touched again. This causes capacity issues but can also cause performance issues. There used to be a utility called delprof which was great but even if it were around why not script it right?

Function clean-localprofiles {
    [CmdletBinding()]
    Param (
        [Parameter(Position = 0)]
        [ValidateNotNullorEmpty()]
        [int]$Days = 30,
        [string]$rptFile = "somefile name here"
    )
    BEGIN 
    {
        "---- Internal RDS Profile Monitor Start {0}" -f (get-date -f "MM/dd/yy hh:mm") | out-file $rptFile -Append
        Write-Warning "Filtering for user profiles older than $Days days"
        $profs = Get-CimInstance win32_userprofile -ComputerName computer1, computer2  |
        Where { $_.LastUseTime -lt $(Get-Date).Date.AddDays(- $days) -AND $_.SID.Length -gt 8 -AND $_.Loaded -eq $False }
    }
    PROCESS
    {
        ForEach ($obj in $profs) {
            $uname = $obj.LocalPath.Split("\") | select -Last 1
            "Removing profile for {0} from {1} which was last used {2}" -f $uname, $obj.pscomputername, $obj.LastUseTime |
            out-file $rptFile -Append
            Try {
                Remove-CimInstance -InputObject $obj -ComputerName $obj.pscomputername
            }
            Catch {
                "Unable to remove profile" | out-file $rptFile -Append
            }       
        }
        # Complete
    }
    END
    {
        "---- Internal RDS Profile Monitor Complete {0}" -f (get-date -f "MM/dd/yy hh:mm") |
            out-file $rptFile -Append
    }    
}
Clean-localprofiles

That’s about it. I updated the process from WMI to CIM (where possible) and tweaked based on changes to Powershell but relatively unchanged. Yeah checked my OneDrive, first script was dated in 2012…

Quick Hit – PowerCLI as a Module and Loading it up

PowerCLI is a great tool, has been since about day one of Powershell. As Powershell has progressed and PSSnapins where replaced with Modules, PowerCLI took a long time to make the jump to modules. While stiff functional it was a point of question. So with version 6 it is mostly modules which is great, however now I have to tweak my Powershell profiles. Much like other customized shells (Operations Manager, SharePoint, etc …), I hate the single purpose shells so I had to customize my profiles. So what I have put together is real simple, and gets me started loading it up:

(get-module -Name vm* -ListAvailable).Foreach{Import-Module $_.Name}