Quick Summary

  1<#
  2.SYNOPSIS
  3    Sets the Intune logging options.
  4.DESCRIPTION
  5    Sets the Intune log size and history.
  6.PARAMETER LogMaxSize
  7    Specifies the log maximum size in MB.
  8.PARAMETER LogMaxHistory
  9    Specifies the log maximum history in number of files to keep.
 10.PARAMETER RestartService
 11    Specifies whether to restart the Intune Management Extension service to apply the changes.
 12    I do not recommend using this parameter restarting the Intune Management Extension might cause some issues.
 13.EXAMPLE
 14    Set-IntuneLoggingOptions.ps1 -LogMaxSize 10 -LogMaxHistory 10 -RestartService
 15.INPUTS
 16    None.
 17.OUTPUTS
 18    None.
 19.NOTES
 20    Created by Ioan Popovici
 21.LINK
 22    https://MEMZ.one/Set-IntuneLoggingOptions
 23.LINK
 24    https://MEMZ.one/Set-IntuneLoggingOptions-CHANGELOG
 25.LINK
 26    https://MEMZ.one/Set-IntuneLoggingOptions-GIT
 27.LINK
 28    https://MEM.Zone/ISSUES
 29.COMPONENT
 30    Intune
 31.FUNCTIONALITY
 32    Intune Logging Options
 33#>
 34
 35## Set script requirements
 36#Requires -Version 5.0
 37
 38##*=============================================
 39##* VARIABLE DECLARATION
 40##*=============================================
 41#region VariableDeclaration
 42
 43## Get script parameters
 44Param (
 45    [Parameter(Mandatory = $false, Position = 0)]
 46    [ValidateNotNullorEmpty()]
 47    [Alias('Size')]
 48    [string]$LogMaxSize = '10',
 49    [Parameter(Mandatory = $false, Position = 1)]
 50    [ValidateNotNullorEmpty()]
 51    [Alias('History')]
 52    [string]$LogMaxHistory = '10',
 53    [Parameter(Mandatory = $false, Position = 3)]
 54    [switch]$RestartService
 55)
 56
 57#endregion
 58##*=============================================
 59##* END VARIABLE DECLARATION
 60##*=============================================
 61
 62##*=============================================
 63##* FUNCTION LISTINGS
 64##*=============================================
 65#region FunctionListings
 66
 67#region Function Set-IntuneLoggingOptions
 68Function Set-IntuneLoggingOptions {
 69<#
 70.SYNOPSIS
 71    Sets the Intune logging options.
 72.DESCRIPTION
 73    Sets the Intune log size and history.
 74.PARAMETER LogMaxSize
 75    Specifies the log maximum size in MB.
 76.PARAMETER LogMaxHistory
 77    Specifies the log maximum history in number of files to keep.
 78.PARAMETER RestartService
 79    Specifies whether to restart the Intune Management Extension service to apply the changes.
 80    I do not recommend using this parameter restarting the Intune Management Extension might cause some issues.
 81.EXAMPLE
 82    Set-IntuneLoggingOptions -LogMaxSize 10 -LogMaxHistory 10 -RestartService
 83.INPUTS
 84    None.
 85.OUTPUTS
 86    None.
 87.NOTES
 88    Created by Ioan Popovici
 89.NOTES
 90    This is an internal script function and should typically not be called directly.
 91.LINK
 92    https://MEM.Zone
 93.LINK
 94    https://MEM.Zone/GIT
 95.COMPONENT
 96    Intune
 97.FUNCTIONALITY
 98    Intune Logging Options
 99#>
100    [CmdletBinding()]
101    Param (
102        [Parameter(Mandatory = $false, Position = 0)]
103        [ValidateNotNullorEmpty()]
104        [Alias('Size')]
105        [Int16]$LogMaxSize = '10',
106        [Parameter(Mandatory = $false, Position = 1)]
107        [ValidateNotNullorEmpty()]
108        [Alias('History')]
109        [int16]$LogMaxHistory = '10',
110        [Parameter(Mandatory = $false, Position = 3)]
111        [switch]$RestartService
112    )
113
114    Begin {
115        $LogMaxSizeBytes = $LogMaxSize * 1MB
116    }
117    Process {
118        Try {
119
120            [string]$LogPath = 'HKLM:\SOFTWARE\Microsoft\IntuneWindowsAgent\Logging'
121            [boolean]$LogPathExists = Test-Path -Path $LogPath -ErrorAction 'SilentlyContinue'
122            If (-not $LogPathExists) { New-Item -Path $LogPath -Force }
123
124            # Set the registry values for logging options
125            Set-ItemProperty -Path $LogPath -Name 'LogMaxSize' -Value $LogMaxSizeBytes
126            Set-ItemProperty -Path $LogPath -Name 'LogMaxHistory' -Value $LogMaxHistory
127
128            # Restart the Intune Management Extension service to apply the changes
129            If ($PSBoundParameters.ContainsKey('RestartService')) {
130                Restart-Service -Name 'IntuneManagementExtension' -Force -ErrorAction 'Stop'
131            }
132        }
133        Catch {
134            Write-Error -Message $_.Exception.Message
135        }
136        Finally {
137        }
138    }
139    End {
140    }
141}
142#endregion
143
144#endregion
145##*=============================================
146##* END FUNCTION LISTINGS
147##*=============================================
148
149##*=============================================
150##* SCRIPT BODY
151##*=============================================
152#region ScriptBody
153
154Set-IntuneLoggingOptions -LogMaxSize $LogMaxSize -LogMaxHistory $LogMaxHistory -RestartService:$RestartService
155
156#endregion
157##*=============================================
158##* END SCRIPT BODY
159##*=============================================