ps.checkModuleUpdates.psm1
|
function Get-ModuleUpdates { <# .Synopsis Check powershell modules for updates .Description Check powershell modules for updates .Example Check-ModuleUpdates Check imported modules for updates .Example Check-ModuleUpdates -all Check all available modules for updates .Example Check-ModuleUpdates PowershellGet -all Check module PowershellGet for updates .Example Check-ModuleUpdates -update -skipUpdate "PSReadLine" Will update all imported modules except module PSReadLine .Example "scour|PSWindowsUpdate|Pscx" | cmu -allowPrerelease -update -skipScan Will update modules "scour|PSWindowsUpdate|Pscx" with no scan of installed module versions .Example cmu "scour|PSWindowsUpdate|Pscx" -allowPrerelease -update -skipScan Will update modules "scour|PSWindowsUpdate|Pscx" with no scan of installed module versions .Example Check-ModuleUpdates PackageManagement -all -update Will check and update module PackageManagement .Example Check-ModuleUpdates -all -update Will try to update all available modules .Example Check-ModuleUpdates -createSchedTask Will create scheduled task to run the script every Friday at 5am. SchedTask will be created for powershell edition, the command was ran from .Example cmu -createSchedTaskWithTranscript Will create scheduled task with transcript enabled .Example cmu -getLastUpdateCommand Get latest module update command from the transcript file, created by scheduled task .Example cmu -getLastUpdateCommand | iex Run latest module update command .Example cmu (gmo ps.check*) Will check for updates (gmo ps.check*) modules .Example Check-ModuleUpdates -all -update -skipUpdate "PSReadLine|PSWindowsUpdate" Will update all modules available except modules PSReadLine and PSWindowsUpdate .Example Check-ModuleUpdates -all -skipUpdate "VMware.VimAutomation.Srm|VMware.VimAutomation.Storage" For PowerCLI, only VMware.PowerCLI should be installed .Example Check-ModuleUpdates -allowPrerelease -all Will check also prerelease versions .Example Check-ModuleUpdates -allowPrerelease -update "PSReadLine" Will update PSReadLine to higher prerelease .Example Check-ModuleUpdates -all -sendToast Will check all modules for updates and send toast notification to Action center .Example cmu -compressTranscriptDir Will set compression attribute to log/transcript directory ($env:USERPROFILE\.ps.checkModuleUpdate) .Example cmu "aws|psreadline" -getModuleAllVersions | ? count -gt 1 Get-InstalledModule AWSPowerShell -AllVersions | ? version -notmatch "version1|version2" | Uninstall-Module -force -AllowPrerelease Get the list of all installed module versions and then uninstall the older ones except two latest versions .Example Start-ThreadJob {Get-InstalledModule VMware.VimAutomation.Srm -AllVersions | ? version -NotMatch 1.5.0.14899557 | Uninstall-Module -force} Get-Job | Receive-Job -Keep Remove old module versions and then check job results #> [CmdletBinding()] [Alias("cmu","Check-ModuleUpdates")] param ( [Parameter(Mandatory=$False,ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True,Position=0)][string]$module="", [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelineByPropertyName=$False)][string]$skipUpdate="", [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelineByPropertyName=$False)][string]$schedTaskScriptPath="", [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelineByPropertyName=$False)][string]$schedTaskTranscriptPath="$env:USERPROFILE\.ps.checkModuleUpdate\Transcripts", [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelineByPropertyName=$False)][string][ValidateSet("AllUsers","CurrentUser")]$Scope="AllUsers", [Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelineByPropertyName=$False)][string][ValidateSet("AllUsers","CurrentUser")]$ScopeCore="CurrentUser", [switch]$update, [switch]$all, [switch]$sendToast, [switch]$createSchedTask, [switch]$createSchedTaskWithTranscript, [switch]$allowPrerelease, [switch]$skipScan, [switch]$getLastUpdateCommand, [switch]$compressTranscriptDir, [switch]$getModuleAllVersions ) begin { $exclude="excludePermanetSomethingIfNeeded" [string[]]$changelist="" # Set toast [Windows.UI.Notifications.ToastNotificationManager, Windows.UI.Notifications, ContentType = WindowsRuntime] | Out-Null [Windows.Data.Xml.Dom.XmlDocument, Windows.Data.Xml.Dom.XmlDocument, ContentType = WindowsRuntime] | Out-Null $ToastXml=[Windows.Data.Xml.Dom.XmlDocument]::new() # Get-StartApps | sort name $appID='{1AC14E77-02E7-4E5D-B744-2EB1AE5198B7}\WindowsPowerShell\v1.0\powershell.exe' # Default scope according platform # https://blogs.msmvps.com/richardsiddaway/2019/09/29/receive-job-keep-parameter/ if ($PSVersionTable.PSEdition -eq "Core") {$PSDefaultParameterValues=@{'Install-module:Scope'="$ScopeCore";'Update-Module:Scope'="$ScopeCore"}} else {$PSDefaultParameterValues=@{'Install-module:Scope'="$Scope";'Update-Module:Scope'="$Scope"}} if ($getLastUpdateCommand) { try {dir $schedTaskTranscriptPath\*$($PSVersionTable.PSEdition)* | sort LastWriteTime -desc | select -first 1 | gc | sls "cmu -update -all -allowPrerelease -skipScan"; break} catch {$_.Exception} } if ($compressTranscriptDir) {compact.exe /s /c $env:USERPROFILE\.ps.checkModuleUpdate\; break} } Process { if (!$module -and $skipScan) {Write-Host "ERROR: No module names provided for update. Run command with no -skipScan!" -f Red; return} if ($getModuleAllVersions) {get-module -ListAvailable | ? name -match $module | select ModuleType,Version,Name,PSEdition,path | group name | sort count -desc | select count -ExpandProperty group | select count,name,version,path | sort count,name,version,path; return} # Create sched task if ($createSchedTask) { # $actionArgCommandString="-command . $SchedTaskScriptPath; Check-ModuleUpdates -all -sendToast" $actionArgCommandString="-command import-module ps.checkModuleUpdates; Check-ModuleUpdates -all -sendToast" if ($PSVersionTable.PSEdition -eq "Core") { $splatNewSchT=@{ Execute="pwsh" Argument=$actionArgCommandString } $splatArgs=@{ Action=New-ScheduledTaskAction @splatNewSchT Trigger=New-ScheduledTaskTrigger -Weekly -DaysOfWeek Friday -At 5am TaskName="RunModuleUpdateScriptCore" } } elseif ($PSVersionTable.PSEdition -eq "Desktop") { $splatNewSchT=@{ Execute="powershell" Argument=$actionArgCommandString } $splatArgs=@{ Action=New-ScheduledTaskAction @splatNewSchT Trigger=New-ScheduledTaskTrigger -Weekly -DaysOfWeek Friday -At 5am TaskName="RunModuleUpdateScript" } } Register-ScheduledTask @splatArgs return } if ($createSchedTaskWithTranscript) { $schedTaskTranscriptPathFile="Transcript-$($PSVersionTable.PSEdition)-"+'$(date -f yyyy-MM-dd)-$(Get-Random 1000).txt' $actionArgCommandString="-command import-module ps.checkModuleUpdates; if (!(Test-Path $schedTaskTranscriptPath)) {mkdir -force $schedTaskTranscriptPath}; Start-Transcript -Path $schedTaskTranscriptPath\$schedTaskTranscriptPathFile; Check-ModuleUpdates -all -sendToast; Stop-Transcript" if ($PSVersionTable.PSEdition -eq "Core") { $splatNewSchT=@{ Execute="pwsh" Argument=$actionArgCommandString } $splatArgs=@{ Action=New-ScheduledTaskAction @splatNewSchT Trigger=New-ScheduledTaskTrigger -Weekly -DaysOfWeek Friday -At 5am TaskName="RunModuleUpdateScriptCoreWithTranscript" } } elseif ($PSVersionTable.PSEdition -eq "Desktop") { $splatNewSchT=@{ Execute="powershell" Argument=$actionArgCommandString } $splatArgs=@{ Action=New-ScheduledTaskAction @splatNewSchT Trigger=New-ScheduledTaskTrigger -Weekly -DaysOfWeek Friday -At 5am TaskName="RunModuleUpdateScriptWithTranscript" } } Register-ScheduledTask @splatArgs return } if (!$skipScan) { if ($all) {$gModParam=@{ListAvailable=$true}} else {$gModParam=@{ListAvailable=$false}} if ($allowPrerelease) { get-module @gModParam | ? name -notmatch "$exclude" | ? name -match "$module" | select -Unique -pv localModule | %{ "--> $_ --> $($_.author)", $( if ($_.PrivateData.psdata.prerelease) {$localPrerel=$_.version.ToString()+"-"+$_.PrivateData.psdata.prerelease;"$localPrerel"} else {$_.version.toString()}), ( find-module -name $_ -ea silent -AllowPrerelease | %{ if ($localPrerel) { if (diff $_.version ($localPrerel)) {$_.version.ToString() + " <--"; [array]$changelist+=$localModule.name} else {($_.version).tostring()} $localPrerel="" } elseif ($_.version -match '[a-zA-Z]') {if (diff $_.version $localModule.version.toString()) {$_.version.ToString() + " <--"; [array]$changelist+=$localModule.name} else {($_.version).tostring()}} else {if ([version]$_.version -gt $localModule.version) {$_.version + ' <--'; [array]$changelist+=$localModule.name} else {($_.version).tostring()} } } ) } } else { get-module @gModParam | ? name -notmatch "$exclude" | ? name -match "$module" | select -Unique -pv localModule | %{"--> $_ --> $($_.author)", $_.version.ToString(), (find-module -name $_ -ea silent | %{if ([version]$_.version -gt $localModule.version) {[string]$_.version + ' <--'; [array]$changelist+=$localModule.name} else {($_.version).tostring()} })} } $changelist=$changelist | ?{$_} if ($skipUpdate) {$changelist=$changelist | ?{$_ -notmatch "$skipUpdate"} | ?{$_}} if (!$changelist -and !$skipUpdate) {write-host "All is up to date." -f green} elseif (!$changelist -and $skipUpdate) {write-host "All is up to date." -f green; write-host "Module(s) skipped: " -f green -nonewline; write-host "$skipUpdate" -f yellow} elseif ($changelist -and $skipUpdate) {Write-Host "Module(s) to update: " -f yellow -nonewline; Write-Host "$changelist" -f red; write-host "Module(s) skipped: " -f green -nonewline; write-host "$skipUpdate" -f yellow} elseif ($update -and $skipUpdate -and !$changelist) {write-host "All is up to date." -f green; write-host "Module(s) skipped: " -f green -nonewline; write-host "$skipUpdate" -f yellow} else {Write-Host "Module(s) to update: " -f yellow -nonewline; Write-Host "$changelist" -f red; Write-Host "Run: " -nonewline -f yellow; Write-Host "`"$($changelist -join "|")`" | cmu -update -all -allowPrerelease -skipScan`n" -f cyan} } if ($module -and $skipScan) {[array]$changelist=($module).split('|')} if ($update -and $changelist -and $allowPrerelease) { Write-Output "`nWill update: $changelist ..."; foreach ($modName in $changelist) {install-module $modName -force -allowClobber -AllowPrerelease} } elseif ($update -and $changelist) {Write-Output "`nWill update: $changelist ..."; install-module $changelist -force -allowClobber} # Send toast if ($sendToast -and $changelist) { if ($PSVersionTable.PSEdition -eq "Core") { $XmlString = @" <toast> <visual> <binding template="ToastGeneric"> <text>Module updates (PSCore):</text> <text>$changelist</text> </binding> </visual> </toast> "@ } elseif ($PSVersionTable.PSEdition -eq "Desktop") { $XmlString = @" <toast> <visual> <binding template="ToastGeneric"> <text>Module updates:</text> <text>$changelist</text> </binding> </visual> </toast> "@ } $ToastXml.LoadXml($XmlString) $toast=[Windows.UI.Notifications.ToastNotificationManager]::CreateToastNotifier($appID) $toast.Show($ToastXml) } } } |