Public/Get-CCMTaskSequence.ps1
|
function Get-CCMTaskSequence { <# .SYNOPSIS Return deployed task sequences from a computer .DESCRIPTION Pulls a list of deployed task sequences from the specified computer(s) or CIMSession(s) with optional filters, and can be passed on to Invoke-CCMTaskSequence if desired. Note that the parameters for filter are all joined together with OR. .PARAMETER PackageID An array of PackageID to filter on .PARAMETER TaskSequenceName An array of task sequence names to filter on .PARAMETER CimSession Provides CimSession to gather deployed task sequence info from .PARAMETER ComputerName Provides computer names to gather deployed task sequence info from .PARAMETER PSSession Provides PSSessions to gather deployed task sequence info from .PARAMETER ConnectionPreference Determines if the 'Get-CCMConnection' function should check for a PSSession, or a CIMSession first when a ComputerName is passed to the function. This is ultimately going to result in the function running faster. The typical use case is when you are using the pipeline. In the pipeline scenario, the 'ComputerName' parameter is what is passed along the pipeline. The 'Get-CCMConnection' function is used to find the available connections, falling back from the preference specified in this parameter, to the the alternative (eg. you specify, PSSession, it falls back to CIMSession), and then falling back to ComputerName. Keep in mind that the 'ConnectionPreference' also determines what type of connection / command the ComputerName parameter is passed to. .EXAMPLE PS> Get-CCMTaskSequence Returns all deployed task sequences listed in WMI on the local computer .EXAMPLE PS> Get-CCMTaskSequence -TaskSequenceName 'Windows 10' -PackageID 'TST00443' Returns all deployed task sequences listed in WMI on the local computer which have either a task sequence name of 'Windows 10' or a PackageID of 'TST00443' .NOTES FileName: Get-CCMTaskSequence.ps1 Author: Cody Mathis Contact: @CodyMathis123 Created: 2020-01-14 Updated: 2020-02-27 #> [CmdletBinding(DefaultParameterSetName = 'ComputerName')] param ( [Parameter(Mandatory = $false)] [string[]]$PackageID, [Parameter(Mandatory = $false)] [string[]]$TaskSequenceName, [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'CimSession')] [Microsoft.Management.Infrastructure.CimSession[]]$CimSession, [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'ComputerName')] [Alias('Connection', 'PSComputerName', 'PSConnectionName', 'IPAddress', 'ServerName', 'HostName', 'DNSHostName')] [string[]]$ComputerName = $env:ComputerName, [Parameter(Mandatory = $false, ParameterSetName = 'PSSession')] [Alias('Session')] [System.Management.Automation.Runspaces.PSSession[]]$PSSession, [Parameter(Mandatory = $false, ParameterSetName = 'ComputerName')] [ValidateSet('CimSession', 'PSSession')] [string]$ConnectionPreference ) begin { #region define our hash tables for parameters to pass to Get-CIMInstance and our return hash table $getPackageSplat = @{ NameSpace = 'root\CCM\Policy\Machine\ActualConfig' } #endregion define our hash tables for parameters to pass to Get-CIMInstance and our return hash table } process { foreach ($Connection in (Get-Variable -Name $PSCmdlet.ParameterSetName -ValueOnly)) { $getConnectionInfoSplat = @{ $PSCmdlet.ParameterSetName = $Connection } switch ($PSBoundParameters.ContainsKey('ConnectionPreference')) { $true { $getConnectionInfoSplat['Prefer'] = $ConnectionPreference } } $ConnectionInfo = Get-CCMConnection @getConnectionInfoSplat $Computer = $ConnectionInfo.ComputerName $connectionSplat = $ConnectionInfo.connectionSplat try { $FilterParts = switch ($PSBoundParameters.Keys) { 'PackageID' { [string]::Format('PKG_PackageID = "{0}"', [string]::Join('" OR PRG_ProgramName = "', $PackageID)) } 'TaskSequenceName' { [string]::Format('PKG_Name = "{0}"', [string]::Join('" OR PKG_Name = "', $TaskSequenceName)) } } $Filter = switch ($null -ne $FilterParts) { $true { [string]::Format(' WHERE {0}', [string]::Join(' OR ', $FilterParts)) } $false { ' ' } } $getPackageSplat['Query'] = [string]::Format('SELECT * FROM CCM_TaskSequence{0}', $Filter) [ciminstance[]]$Packages = switch ($Computer -eq $env:ComputerName) { $true { Get-CimInstance @getPackageSplat @connectionSplat } $false { Get-CCMCimInstance @getPackageSplat @connectionSplat } } if ($Packages -is [Object] -and $Packages.Count -gt 0) { Write-Output -InputObject $Packages } else { Write-Warning "No deployed task sequences found for $Computer based on input filters" } } catch { $ErrorMessage = $_.Exception.Message Write-Error $ErrorMessage } } } } |