Skip to main content

Windows - Wallpaper - Set

Summary​

This is an RMM implementation of the agnostic script Set-Wallpaper to set the active desktop wallpaper for all users from a local path or a URL. It can optionally be switched to enforce the wallpaper for all users on login.

Sample Run​

Sample Run

  • Set Mode
    Set Mode

  • Enforcement mode:
    Enforcement Mode

  • Reset Mode:
    Reset Mode

Dependencies​

Set-Wallpaper

User Parameters​

NameExampleRequiredDescription
PathC:/user/myuser/Pictures/CoolWallpaper.pngTrueEither a path to a local image or URL.
AllUsers1FalseSelect it to enforce the wallpaper for all users on login.
Reset1FalseSelect it to remove all enforcement and reset all users' wallpapers back to their previous one. If they do not have a previous wallpaper, the default Windows wallpaper will be used.

Task Creation​

Create a new Script Editor style script in the system to implement this Task.

Create Script

Name: Windows - Wallpaper - Set
Description: This script sets the active desktop wallpaper for all users from a local path or a URL. It can optionally be switched to enforce the wallpaper for all users on login.
Category: Custom
Category

Parameters​

Add a new parameter by clicking the Add Parameter button present at the top-right corner of the screen.

Add Parameter

This screen will appear.
Parameter Screen

  • Set Path in the Parameter Name field.

  • Select Text String from the Parameter Type dropdown menu.

  • Click the Save button.
    Save Parameter

  • It will ask for confirmation to proceed. Click the Confirm button to create the parameter.
    Confirm Parameter

Add another parameter by clicking the Add Parameter button present at the top-right corner of the screen.
Add Parameter

  • Set AllUsers in the Parameter Name field.

  • Select Flag from the Parameter Type dropdown menu.

  • Click the Save button.
    Save Parameter

  • It will ask for confirmation to proceed. Click the Confirm button to create the parameter.

Add another parameter by clicking the Add Parameter button present at the top-right corner of the screen.

  • Set Reset in the Parameter Name field.
  • Select Flag from the Parameter Type dropdown menu.
  • Click the Save button.
  • It will ask for confirmation to proceed. Click the Confirm button to create the parameter.
    Confirm Parameter

All the parameters will look like this:
Parameters

Task​

Navigate to the Script Editor Section and start by adding a row. You can do this by clicking the Add Row button at the bottom of the script page.
Add Row

A blank function will appear.
Blank Function

Row 1 Function: PowerShell Script​

Search and select the PowerShell Script function.
PowerShell Script

The following function will pop up on the screen:
Function Pop Up

Paste the following PowerShell script and set the expected time of script execution to 900 seconds. Click the Save button.

$Path = "@Path@"
$AllUsers = "@AllUsers@"
$Reset = "@Reset@"
#region Setup - Variables
$ProjectName = 'Set-Wallpaper'

[Net.ServicePointManager]::SecurityProtocol = [enum]::ToObject([Net.SecurityProtocolType], 3072)
$BaseURL = 'https://file.provaltech.com/repo'
$PS1URL = "$BaseURL/script/$ProjectName.ps1"
$WorkingDirectory = "C:\ProgramData\_automation\script\$ProjectName"
$PS1Path = "$WorkingDirectory\$ProjectName.ps1"
$Workingpath = $WorkingDirectory
$LogPath = "$WorkingDirectory\$ProjectName-log.txt"
$ErrorLogPath = "$WorkingDirectory\$ProjectName-Error.txt"
#endregion
#region Setup - Folder Structure
mkdir -Path $WorkingDirectory -ErrorAction SilentlyContinue | Out-Null
$response = Invoke-WebRequest -Uri $PS1URL -UseBasicParsing
if (($response.StatusCode -ne 200) -and (!(Test-Path -Path $PS1Path))) {
    Write-Error -Message "No pre-downloaded script exists and the script '$PS1URL' failed to download. Exiting."
    return
} elseif ($response.StatusCode -eq 200) {
    Remove-Item -Path $PS1Path -ErrorAction SilentlyContinue
    [System.IO.File]::WriteAllLines($PS1Path, $response.Content)
}
if (!(Test-Path -Path $PS1Path)) {
    Write-Error -Message 'An error occurred and the script was unable to be downloaded. Exiting.'
    return
}
#endregion
if ($AllUsers -match '1|Y|Yes|True' ) {
  & $PS1Path -uri $Path -Enforce
} 
elseif ($Reset -match '1|Y|Yes|True' ){
  & $PS1Path -Reset
}
else{
  & $PS1Path -uri $Path
}
if ( !(Test-Path $LogPath) ) {
  Throw 'PowerShell Failure. A Security application seems to have restricted the execution of the PowerShell Script.'
}
if ( Test-Path $ErrorLogPath ) {
  $ErrorContent = ( Get-Content -Path $ErrorLogPath )
  throw $ErrorContent
}
Get-Content -Path $LogPath

alt text

Row 2: Function: Script Log​

In the script log message, simply type %output% so that the script will send the results of the PowerShell script above to the output on the Automation tab for the target device.
Script Log

Completed Task​

Completed Task

Output​

  • Script Log