2.36.0

Author: jdhitsolutions

PSScriptTools.psd1

@@ -4,11 +4,16 @@ if ($myinvocation.line -match "-verbose") {
 }
 Write-Verbose "Loading public functions"
 
-Get-ChildItem -path $PSScriptRoot\functions\*.ps1 | ForEach-Object -process {
+#exclude Get-MyCounter.ps1 because it requires a Windows platform
+Get-ChildItem -path $PSScriptRoot\functions\*.ps1  -Exclude 'Get-MyCounter.ps1' | ForEach-Object -process {
     Write-Verbose $_.fullname
     . $_.FullName
 }
 
+if ($IsWindows -OR ($PSEdition -eq 'Desktop')) {
+    . "$PSScriptRoot\functions\Get-MyCounter.ps1"
+}
+
 Write-Verbose "Define the global PSAnsiFileMap variable"
 $json = "psansifilemap.json"
 

PSScriptTools.psm1

@@ -390,11 +390,11 @@ PS C:\> Get-WindowsVersion | Select-Object *
 
 ProductName  : Windows 10 Pro
 EditionID    : Professional
-ReleaseID    : 1909
-Build        : 18363.657
-Branch       : 19h1_release
-InstalledUTC : 7/5/2019 10:54:49 PM
-Computername : BOVINE320
+ReleaseID    : 2009
+Build        : 19042.906
+Branch       : vb_release
+InstalledUTC : 10/16/2020 3:09:01 PM
+Computername : PROSPERO
 ```
 
 #### [Get-WindowsVersionString](docs/Get-WindowsVersionString.md)
@@ -403,8 +403,7 @@ This command is a variation of `Get-WindowsVersion` that returns a formatted str
 
 ```dos
 PS C:\> Get-WindowsVersionString
-BOVINE320 Windows 10 Pro Version Professional (OS Build 18363.657)
-
+PROSPERO Windows 10 Pro Version Professional (OS Build 19042.906)
 ```
 
 ### [New-PSDriveHere](docs/New-PSDriveHere.md)
@@ -1348,6 +1347,16 @@ These functions were first described at [https://jdhitsolutions.com/blog/powersh
 
 ## Console Utilities
 
+### [Get-PSSessionInfo](docs/Get-PSSessionInfo.md)
+
+`Get-PSSessionInfo` will display a summary of your current PowerShell session. It should work on all platforms.
+
+![windows session](images/pssessioninfo-windows.png)
+
+![linux session](images/pssessioninfo-linux.png)
+
+If you are running in a PowerShell console session, and the Elevated value is True, it will be displayed in color. The Memory and Runtime values are calculated ScriptProperties.
+
 ### [ConvertTo-ASCIIArt](docs/ConvertTo-ASCIIArt.md)
 
 `ConvertTo-ASCIIArt` can be used to transform a string of text into ASCII art. It utilizes the web service at https://artii.herokuapp.com which allows you to transform text. You might use this to create headers for your scripts or PowerShell profile.
@@ -1617,6 +1626,17 @@ TotalMemGB FreeMemGB PctFree
 
 ## Scripting Tools
 
+### [Test-IsElevated](docs/Test-IsElevated.md)
+
+This simple command will test if the current PowerShell session is running elevated, or as Administrator. On Windows platforms the function uses the .NET Framework to test. On non-Windows platforms, the command tests the user's UID value.
+
+```dos
+PS C:\> Test-IsElevated
+False
+```
+
+You can also use the `Get-PSWho` command to get more information.
+
 ### [New-FunctionItem](docs/New-FunctionItem.md)
 
 ```powershell
@@ -2202,8 +2222,13 @@ che                  Copy-HelpExample
 ...
 ```
 
-Use [Get-FormatView](docs/Get-FormatView.md) to discover available format views. Or if you'd like to create your own custom views look at [New-PSFormatXML](docs/New-PSFormatXML.md)
+Some custom formats use ANSI to highlight information, assuming you are running in PowerShell Console Host.
 
+![alias options](images/get-alias-option.png)
+
+In this format view, ReadOnly aliases are displayed in Red.
+
+Use [Get-FormatView](docs/Get-FormatView.md) to discover available format views. Or if you'd like to create your own custom views look at [New-PSFormatXML](docs/New-PSFormatXML.md)
 
 ### PSSpecialChar
 
@@ -2251,6 +2276,4 @@ If you find this module useful, you might also want to look at my PowerShell too
 
 ## Compatibility
 
-Where possible, module commands have been tested with PowerShell 7, but not on every platform. If you encounter problems, have suggestions, or other feedback, please post an [issue](https://github.com/jdhitsolutions/PSScriptTools/issues). It is assumed you will __not__ be running these commands on any edition of PowerShell Core or any beta releases of PowerShell 7.
-
-Last Updated *2021-03-25 14:54:50Z*
+Where possible, module commands have been tested with PowerShell 7, but not on every platform. If you encounter problems, have suggestions, or other feedback, please post an [issue](https://github.com/jdhitsolutions/PSScriptTools/issues). It is assumed you will __not__ be running these commands on any edition of PowerShell Core, i.e PowerShell 6.x.

PSScriptToolsManual.pdf

@@ -2,6 +2,20 @@
 
 This file contains the most recent change history for the PSScriptTools module.
 
+## v2.36.0
+
++ Update `Get-MyVariable` to make it more compatible with PowerShell 7 ([Issue #103](https://github.com/jdhitsolutions/PSScriptTools/issues/103)). This also makes the command now compatible with the PowerShell ISE.
++ Added table view called `Simple` to format file for Aliases.
++ Modified `Options` table view in `alias.format.ps1xml` to highlight read-only aliases in Red using ANSI if running in a PowerShell console host.
++ Updated `Get-PSLocation` to include `$PSHome`.
++ Modified module to only dot source `Get-MyCounter.ps1` if running Windows. The file contains a class definition that uses a Windows-only reference and PowerShell "scans" the file before it dot sources it, which throws an exception on non-Windows platforms.
++ Added command `Get-PSSessionInfo` and an alias of `gsin`. The command uses a new format file, `pssessioninfo.format.ps1xml`.
++ Added command `Test-IsElevated`.
++ Updated `Get-PSWho` to included elevated information for non-Windows platforms.
++ Added format file `pswho.format.ps1xml`.
++ Help updates
++ Updated `README.md`.
+
 ## v2.35.0
 
 + Added `ConvertTo-TitleCase` command with aliases of `totc` and `title`.

README.md

@@ -20,7 +20,7 @@ Find-CimClass [-Classname] <String> [-Exclude <String>]
 
 ## DESCRIPTION
 
-This function is designed to search an entire CIM repository for a class name. Sometimes, you can guess a CIM/WMI class name but not know the full name or even the correct namespace. Find-CimClass will recursively search for a given classname. You can use wildcards and search remote computers.
+This function is designed to search an entire CIM repository for a class name. Sometimes, you can guess a CIM/WMI class name but not know the full name or even the correct namespace. Find-CimClass will recursively search for a given classname in all namespaces. You can use wildcards and search remote computers.
 
 This command requires a Windows platform.
 

changelog.md

@@ -21,7 +21,6 @@ Get-MyVariable [[-Scope] <String>] [-NoTypeInformation] [<CommonParameters>]
 
 This function will return all variables not defined by PowerShell or by this function itself. The default is to return all user-created variables from the global scope but you can also specify a scope such as script, local, or a number 0 through 5. The command will also display the value type for each variable. If you want to suppress this output use the -NoTypeInformation switch.
 
-This function is designed to work with the PowerShell console, NOT the PowerShell ISE.
 
 ## EXAMPLES
 

docs/Find-CimClass.md

@@ -32,6 +32,7 @@ Temp       : C:\Users\Jeff\AppData\Local\Temp\
 Home       : C:\Users\Jeff\Documents
 Desktop    : C:\Users\Jeff\Desktop
 PowerShell : C:\Users\Jeff\Documents\WindowsPowerShell
+PSHome     : C:\Windows\System32\WindowsPowerShell\v1.0
 ```
 
 Results on a Windows system.
@@ -45,6 +46,7 @@ Temp       : /tmp/
 Home       : /home/jeff
 Desktop    :
 PowerShell : /home/jeff/.config/powershell
+PSHome     : /opt/microsoft/powershell/7
 ```
 
 Results on a Linux system running PowerShell.
@@ -61,7 +63,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## OUTPUTS
 
-### System.Object
+### PSLocation
 
 ## NOTES
 

docs/Get-MyVariable.md

@@ -0,0 +1,86 @@
+---
+external help file: PSScriptTools-help.xml
+Module Name: PSScriptTools
+online version:
+schema: 2.0.0
+---
+
+# Get-PSSessionInfo
+
+## SYNOPSIS
+
+Get details about the current PowerShell session
+
+## SYNTAX
+
+```yaml
+Get-PSSessionInfo [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+This command will provide a snapshot of the current PowerShell session. The Runtime and Memory properties are defined by script so if you save the result to a variable, you will get current values everytime you look at the variable.
+
+## EXAMPLES
+
+### Example 1
+
+```powershell
+PS C:\> Get-PSSessionInfo
+
+ProcessID   : 1112
+Command     : "C:\Program Files\PowerShell\7\pwsh.exe" -noprofile
+Host        : ConsoleHost
+Started     : 4/9/2021 9:36:13 AM
+PSVersion   : 7.1.3
+Elevated    : True
+Parent      : System.Diagnostics.Process (WindowsTerminal)
+Runtime     : 00:31:26.2716486
+MemoryMB    : 129
+```
+
+The Memory value is in MB. If running in a PowerShell console session, the Elevated value will be displayed in color.
+
+### Example 2
+
+```powershell
+PS /home> Get-PSSessionInfo
+
+ProcessID   : 71
+Command     : pwsh
+Host        : ConsoleHost
+Started     : 04/09/2021 09:38:55
+PSVersion   : 7.1.3
+Elevated    : False
+Parent      : System.Diagnostics.Process (bash)
+Runtime     : 00:30:07.1669248
+MemoryMB    : 133
+```
+
+The result from a Linux host.
+
+## PARAMETERS
+
+### CommonParameters
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### PSSessionInfo
+
+## NOTES
+
+This command has an alias of gsin.
+
+Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/
+
+## RELATED LINKS
+
+[Get-Host]()
+
+[Get-Process]()

docs/Get-PSLocation.md

@@ -30,12 +30,12 @@ The default behavior is to write an object to the pipeline, but you can use the
 ```powershell
 PS C:\> Get-PSWho
 
-User            : WIN10\Jeff
-Elevated        : True
-Computername    : WIN10
+User            : Desk01\Jeff
+Elevated        : False
+Computername    : Desk01
 OperatingSystem : Microsoft Windows 10 Pro [64-bit]
-OSVersion       : 10.0.18363
-PSVersion       : 5.1.18362.145
+OSVersion       : 10.0.19042
+PSVersion       : 5.1.19041.906
 Edition         : Desktop
 PSHost          : ConsoleHost
 WSMan           : 3.0
@@ -49,11 +49,11 @@ Culture         : English (United States)
 PS /home/jhicks> Get-PSWho
 
 User            : jeff
-Elevated        : NA
-Computername    : WIN10
-OperatingSystem : Linux 4.4.0-18362-Microsoft #476-Microsoft Fri Nov 01 16:53:00 PST 2019
-OSVersion       : Ubuntu 18.04.3 LTS
-PSVersion       : 7.0.0-rc.2
+Elevated        : False
+Computername    : Desk01
+OperatingSystem : Linux 5.4.72-microsoft-standard-WSL2 #1 SMP Wed Oct 28 23:40:43 UTC 2020
+OSVersion       : Ubuntu 20.04.2 LTS
+PSVersion       : 7.1.3
 Edition         : Core
 PSHost          : ConsoleHost
 WSMan           : 3.0
@@ -66,12 +66,12 @@ Culture         : Invariant Language (Invariant Country)
 ```powershell
 PS C:\> Get-PSWho
 
-User            : WIN10\Jeff
+User            : Desk01\Jeff
 Elevated        : True
-Computername    : WIN10
+Computername    : Desk01
 OperatingSystem : Microsoft Windows 10 Pro [64-bit]
 OSVersion       : 10.0.19042
-PSVersion       : 7.1.0
+PSVersion       : 7.1.3
 Edition         : Core
 PSHost          : ConsoleHost
 WSMan           : 3.0
@@ -123,6 +123,8 @@ Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell
 
 ## RELATED LINKS
 
+[Test-IsElevated](Test-IsElevated.md)
+
 [Get-CimInstance]()
 
 [Get-ExecutionPolicy]()

docs/Get-PSSessionInfo.md

@@ -0,0 +1,53 @@
+---
+external help file: PSScriptTools-help.xml
+Module Name: PSScriptTools
+online version:
+schema: 2.0.0
+---
+
+# Test-IsElevated
+
+## SYNOPSIS
+
+Test if the current user is running elevated.
+
+## SYNTAX
+
+```yaml
+Test-IsElevated [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+This command will test if the current session is running elevated, or as Administrator. On Windows platforms, the command uses the NET Framework to determine if the user is running as Administrator. On non-Windows systems, the command is checking the user's UID value.
+
+## EXAMPLES
+
+### Example 1
+
+```powershell
+PS C:\> Test-IsElevated
+True
+```
+
+## PARAMETERS
+
+### CommonParameters
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### Boolean
+
+## NOTES
+
+Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/
+
+## RELATED LINKS
+
+[Get-PSWho](Get-PSWho.md)