Public/Set-CCMProvisioningMode.ps1
|
function Set-CCMProvisioningMode { <# .SYNOPSIS Set ConfigMgr client provisioning mode to enabled or disabled, and control ProvisioningMaxMinutes .DESCRIPTION This function will allow you to set the configuration manager client provisioning mode using CIM queries. You can provide an array of computer names, or cimsession, or you can pass them through the pipeline. It will return a pscustomobject detailing the operations .PARAMETER Status Should provisioning mode be enabled, or disabled? Validate set ('Enabled','Disabled') .PARAMETER ProvisioningMaxMinutes Set the ProvisioningMaxMinutes value for provisioning mode. After this interval, provisioning mode is automatically disabled. This defaults to 48 hours. The client checks this every 60 minutes, so any value under 60 minutes will result in an effective ProvisioningMaxMinutes of 60 minutes. .PARAMETER CimSession Provides CimSessions to set provisioning mode for .PARAMETER ComputerName Provides computer names to set provisioning mode for .EXAMPLE C:\PS> Set-CCMProvisioningMode -Status Enabled Enables provisioning mode on the local computer .EXAMPLE C:\PS> Set-CCMProvisioningMode -ComputerName 'Workstation1234','Workstation4321' -Status Disabled Disables provisioning mode for Workstation1234, and Workstation4321 .EXAMPLE C:\PS> Set-CCMProvisioningMode -ProvisioningMaxMinutes 360 Sets ProvisioningMaxMinutes to 360 on the local computer so that provisioning mode is automatically disabled after 6 hours, instead of the default 48 hours .NOTES FileName: Set-CCMProvisioningMode.ps1 Author: Cody Mathis Contact: @CodyMathis123 Created: 2020-01-09 Updated: 2020-01-12 #> [CmdletBinding(SupportsShouldProcess = $true, DefaultParameterSetName = 'ComputerName')] param ( [parameter(Mandatory = $false)] [ValidateSet('Enabled', 'Disabled')] [string]$Status, [parameter(Mandatory = $false)] [ValidateRange(60, [int]::MaxValue)] [int]$ProvisioningMaxMinutes, [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 ) begin { $connectionSplat = @{ } [bool]$ProvisioningMode = switch ($Status) { 'Enabled' { $true } 'Disabled' { $false } } $SetProvisioningModeSplat = @{ Namespace = 'root\CCM' ClassName = 'SMS_Client' MethodName = 'SetClientProvisioningMode' Arguments = @{ bEnable = $ProvisioningMode } } $invokeCIMPowerShellSplat = @{ FunctionsToLoad = 'Set-CCMProvisioningMode' } $setCIMRegistryPropertySplat = @{ RegRoot = 'HKEY_LOCAL_MACHINE' Key = 'Software\Microsoft\CCM\CcmExec' Property = 'ProvisioningMaxMinutes' Value = $ProvisioningMaxMinutes PropertyType = 'DWORD' Force = $true } } process { foreach ($Connection in (Get-Variable -Name $PSCmdlet.ParameterSetName -ValueOnly)) { $Computer = switch ($PSCmdlet.ParameterSetName) { 'ComputerName' { Write-Output -InputObject $Connection switch ($Connection -eq $env:ComputerName) { $false { if ($ExistingCimSession = Get-CimSession -ComputerName $Connection -ErrorAction Ignore) { Write-Verbose "Active CimSession found for $Connection - Passing CimSession to CIM cmdlets" $connectionSplat.Remove('ComputerName') $connectionSplat['CimSession'] = $ExistingCimSession } else { Write-Verbose "No active CimSession found for $Connection - falling back to -ComputerName parameter for CIM cmdlets" $connectionSplat.Remove('CimSession') $connectionSplat['ComputerName'] = $Connection } } $true { $connectionSplat.Remove('CimSession') $connectionSplat.Remove('ComputerName') Write-Verbose 'Local computer is being queried - skipping computername, and cimsession parameter' } } } 'CimSession' { Write-Verbose "Active CimSession found for $Connection - Passing CimSession to CIM cmdlets" Write-Output -InputObject $Connection.ComputerName $connectionSplat.Remove('ComputerName') $connectionSplat['CimSession'] = $Connection } } $Return = [System.Collections.Specialized.OrderedDictionary]::new() $Return['ComputerName'] = $Computer $Return['ProvisioningModeChanged'] = $false $Return['ProvisioningMaxMinutesChanged'] = $false try { if ($PSCmdlet.ShouldProcess("[ComputerName = '$Computer'] [ProvisioningMode = '$Status'] [ProvisioningMaxMinutes = '$ProvisioningMaxMinutes']", "Set CCM Provisioning Mode")) { switch ($PSBoundParameters.Keys) { 'Status' { $Invocation = switch ($Computer -eq $env:ComputerName) { $true { Invoke-CimMethod @SetProvisioningModeSplat } $false { $ScriptBlock = [string]::Format('Set-CCMProvisioningMode -Status {0}', $Status) $invokeCIMPowerShellSplat['ScriptBlock'] = [scriptblock]::Create($ScriptBlock) Invoke-CIMPowerShell @invokeCIMPowerShellSplat @connectionSplat } } if ($Invocation) { Write-Verbose "Successfully set provisioning mode to $Status for $Computer via the 'SetClientProvisioningMode' CIM method" $Return['ProvisioningModeChanged'] = $true } } 'ProvisioningMaxMinutes' { $MaxMinutesChange = Set-CIMRegistryProperty @setCIMRegistryPropertySplat @connectionSplat if ($MaxMinutesChange[$Computer]) { Write-Verbose "Successfully set ProvisioningMaxMinutes for $Computer to $ProvisioningMaxMinutes" $Return['ProvisioningMaxMinutesChanged'] = $true } } } } } catch { $ErrorMessage = $_.Exception.Message Write-Error $ErrorMessage } [pscustomobject]$Return } } } |