Skip to main content

Set-ServiceLogin

Summary

This task is used to change the service login account for a target service. This is an RMM version of Set-ServiceLogin. Please review the process mentioned in Set-ServiceLogin on how to use USER or SYSTEM mode in the script.

Sample Run

Sample Run 1

Sets the Print Spooler service to run as 'Local System'.

Sample Run 2

Sets the Print Spooler service to run as 'User1'. Grants 'User1' the Logon as a Service right.

Sample Run 3

Dependencies

Set-ServiceLogin

User Parameters

NameExampleAccepted ValuesRequiredDefaultTypeDescription
NameSpoolerFalseStringThe service name to alter.
DisplayNamePrint SpoolerFalse$falseStringThe service display name to alter.
UserUser1FalseStringThe username of the account to set the service to run as.
Passwordp@55w0rDFalseStringThe password of the account to set the service to run as.
SystemMarkedFalseFlagUse this switch to set the service to run as the Local System account.
ForceMarkedFalse$falseFlagIntended to force DNS address updates to DHCP-enabled adapters.

Task Creation

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

Task Creation Step 1

Name: Set-ServiceLogin
Description: Used to change the service login account for a target service.
Category: Custom

Task Creation Step 2

Parameters

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

Add Parameter Step 1

This screen will appear.

Add Parameter Step 2

  • Set Name in the Parameter Name field.
  • Select String from the Parameter Type dropdown menu.
  • Toggle Required Field.
  • Click the Save button.

Add Parameter Step 3

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

Add Parameter Confirmation

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

Add Parameter Step 4

  • Set System in the Parameter Name field.
  • Select Flag from the Parameter Type dropdown menu.
  • Toggle Default Value.
  • Set Default Value as False.
  • Click the Save button.
  • Click the Confirm button to create the parameter.

Add Parameter Step 5

Add another parameter.

  • Set User in the Parameter Name field.
  • Select String from the Parameter Type dropdown menu.
  • Toggle Required Field.
  • Click the Save button.

Add Parameter Step 6

Add another parameter.

  • Set Password in the Parameter Name field.
  • Select String from the Parameter Type dropdown menu.
  • Toggle Required Field.
  • Click the Save button.

Add Parameter Step 7

Add another parameter.

  • Set DisplayName in the Parameter Name field.
  • Select String from the Parameter Type dropdown menu.
  • Toggle Required Field.
  • Click the Save button.

Add Parameter Step 8

Add another parameter.

  • Set Force in the Parameter Name field.
  • Select Flag from the Parameter Type dropdown menu.
  • Toggle Default Value.
  • Set Default Value as False.
  • Click the Save button.
  • Click the Confirm button to create the parameter.

Parameters will look like as shown below:

Parameters Overview

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 Selection

The following function will pop up on the screen:

PowerShell Script Function

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

$Name = '@Name@'
$System = '@System@'
$user = '@User@'
$pass = '@Password@'
$DisplayName = '@DisplayName@'
$Force = '@Force@'
$parameters = @{}
#we are priotizing Name if both Name and DisplayNames are specified
if ( ($Name -Notmatch '\SAddress\S') -and ($Name -match '[A-z]{2,}') ) {
#For parameterSets Name and NameSystem
$parameters.Add('Name', $Name)
if ( $System -match '1|Yes|True' ) {
#For Parameter Set NameSystem
$parameters.Add('System', $True)
} else {
#For parameterSet Name
if ( $user -match '/SUser/S' -or ( $null -eq $user ) ) {
throw 'Either Set the ''System'' parameter or set the ''User'' and ''Pass'''
} elseif ( $user.Length -lt 2 ) {
throw 'Either Set the ''System'' parameter or set the ''User'' and ''Pass'''
} else {
$parameters.Add('User', $user)
}
if ( $pass -match '/Spass/S' -or ( $null -eq $pass ) ) {
throw 'Either Set the ''System'' parameter or set the ''User'' and ''Pass'''
} elseif ( $pass.Length -lt 2 ) {
throw 'Either Set the ''System'' parameter or set the ''User'' and ''Pass'''
} else {
$parameters.Add('Pass', $pass)
}
$parameters.Add('Force', $true) # Setting it to true without checking since it's mandatory for the parameter set Name
}
} else {
#for parameter set DisplayName and DisplayName System
if ( ($DisplayName -Notmatch '\SAddress\S') -and ($DisplayName -match '[A-z]{2,}') ) {
$parameters.Add('DisplayName', $DisplayName)
if ( $System -match '1|Yes|True' ) {
#For Parameter Set DisplayNameSystem
$parameters.Add('System', $True)
} else {
#For parameterSet DisplayName
if ( $user -match '/SUser/S' -or ( $null -eq $user ) ) {
throw 'Either Set the ''System'' parameter or set the ''User'' and ''Pass'''
} elseif ( $user.Length -lt 2 ) {
throw 'Either Set the ''System'' parameter or set the ''User'' and ''Pass'''
} else {
$parameters.Add('User', $user)
}
if ( $pass -match '/Spass/S' -or ( $null -eq $pass ) ) {
throw 'Either Set the ''System'' parameter or set the ''User'' and ''Pass'''
} elseif ( $pass.Length -lt 2 ) {
throw 'Either Set the ''System'' parameter or set the ''User'' and ''Pass'''
} else {
$parameters.Add('Pass', $pass)
}
if ( $Force -match '1|Yes|True' ) {
$parameters.Add('Force', $true) # Not Setting it to true without checking since it's not mandatory for the parameter set DisplayName
}
}
} else {
throw 'Either Set the ''Name'' or the ''DisplayName'' parameter.'
}
}

#region Setup - Variables
$ProjectName = 'Set-ServiceLogin'
[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
New-Item -Path $WorkingDirectory -ItemType Directory -ErrorAction SilentlyContinue | Out-Null
try {
Invoke-WebRequest -Uri $PS1URL -OutFile $PS1path -UseBasicParsing -ErrorAction Stop
} catch {
if (!(Test-Path -Path $PS1Path )) {
throw ('Failed to download the script from ''{0}'', and no local copy of the script exists on the machine. Reason: {1}' -f $PS1URL, $($Error[0].Exception.Message))
}
}
#endregion
#region Execution
if ($Parameters) {
& $PS1Path @Parameters
} else {
& $PS1Path
}
#endregion
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

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