Set-UserLockAgentDistributionConfiguration

Modifies the UserLock deployer options and the configuration of the UserLock Desktop agent.

Published May 31, 2025

Synopsis

Modifies the UserLock deployer options and the configuration of the UserLock Desktop agent.

Syntax

powershell
Set-UserLockAgentDistributionConfiguration [-Property] <string> [-Value] <string> [-UserLockServerName <string>] [-PassThru] [-Force] [-Confirm] [-WhatIf][<CommonParameters>]

Set-UserLockAgentDistributionConfiguration [-InputObject] <AgentDistributionProperties> [-UserLockServerName <string>] [-PassThru] [-Force] [-Confirm] [-WhatIf][<CommonParameters>]

Description

The Set-UserLockAgentDistributionConfiguration cmdlet modifies the UserLock deployer options and the configuration of the UserLock Desktop agent. Caution: PowerShell 3.0 is required.

Parameters

-Property <string>

Specifies the name of the property to modify.

Required

false

Position

named

Accepts pipeline input

false

Accepts wildcard characters

false

-Value <string>

Specifies the new value of the property.

Required

false

Position

named

Accepts pipeline input

false

Accepts wildcard characters

false

-InputObject <AgentDistributionProperties>

Specifies a AgentDistributionProperties object representing the UserLock deployer options and the configuration of the UserLock Desktop agent. Enter a variable that contains the object, or type a command or expression that gets the object. You can also pipe the objects to Set-UserLockAgentDistributionConfiguration.

Required

true

Position

named

Accepts pipeline input

true (ByValue)

Accepts wildcard characters

false

-UserLockServerName <string>

Specifies the name of the UserLock server. The default is the localhost name.

Required

true

Position

named

Accepts pipeline input

true (ByValue, ByPropertyName)

Accepts wildcard characters

true

-PassThru <SwitchParameter>

Returns the concerned agent distribution property object (1st parameter set) or an AgentDistributionProperties object (2nd parameter set). By default, this cmdlet does not generate any output.

Required

false

Position

named

Accepts pipeline input

false

Accepts wildcard characters

false

-Force <SwitchParameter>

Modifies the configuration of the UserLock agent distribution with no confirmation.

Required

false

Position

named

Accepts pipeline input

false

Accepts wildcard characters

false

-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.

Required

false

Position

named

Accepts pipeline input

false

Accepts wildcard characters

false

-WhatIf <SwitchParameter>

Describes what would happen if you executed the command without actually executing the command.

Required

false

Position

named

Accepts pipeline input

false

Accepts wildcard characters

false

<CommonParameters>

For more information about common parameters, type "Get-Help about_commonparameters".

Input Type

ISDecisions.UserLockLibrary.AgentDistributionProperties

Return Type

None, Boolean, System.String or ISDecisions.UserLockLibrary.AgentDistributionProperties.

Notes

You can also refer to Set-UserLockAgentDistributionConfiguration by its alias, "suladc". For more information, see about_Aliases. To use Set-UserLockAgentDistributionConfiguration, you must have the "Agent distribution" UserLock administrative access right.

Examples

Example 1

powershell
Set-UserLockAgentDistributionConfiguration -Property ExcludeServers -Value True

Sets the ExcludeServers property of the localhost UserLock server to False, therefore the automatic deployer will install the agent on servers.

Example 2

powershell
$uladc = Get-UserLockAgentDistributionConfiguration
$uladc.DisplayErrors = $true
$uladc.ExcludeServers =$false
$uladc | suladc -Force

Get agent distribution properties into a local variable, modify DisplayErrors and ExcludeServers properties of that variable, then sets all UserLock agent distribution properties with that variable as the input object, and with no confirmation prompt.

Get-UserLockAgentDistributionConfiguration

Get-UserLockAgentDistribution

Get-UserLockCommand