Get-UserLockAgentDistribution

Gets the distribution status of UserLock agents in the zone protected by UserLock.

Published May 31, 2025

Synopsis

Gets the distribution status of UserLock agents in the zone protected by UserLock.

Syntax

powershell
Get-UserLockAgentDistribution [-Name <string[]>] [-AgentType <AgentType[]>] [-UserLockServerName <string>][<CommonParameters>]

Description

The Get-UserLockAgentDistribution cmdlet gets the distribution status of UserLock agents in the zone protected by UserLock. Caution: PowerShell 3.0 is required.

Parameters

-Name <string[]>

Specifies the name(s) of the computer(s) to get the distribution status of UserLock agents. You can type multiple computer names (separated by commas). Wildcard characters are permited. MachineName or ComputerName are aliases of the parameter.

Required

false

Position

1

Accepts pipeline input

true (ByValue, ByPropertyName)

Accepts wildcard characters

true

-AgentType <AgentType[]>

Specifies the agent type to get the distribution status of UserLock agents. You can type multiple computer names (separated by commas). Possible values for this parameter include: Desktop or 0 RRAS or 2 IAS or 3 IIS or 4 Mac or 5 The default agent type is Desktop and Mac. Type is an alias of the parameter.

Required

false

Position

named

Accepts pipeline input

false

Accepts wildcard characters

false

Default Value

Desktop

-UserLockServerName <string>

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

Required

false

Position

named

Accepts pipeline input

false

Accepts wildcard characters

false

Default Value

'.'

<CommonParameters>

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

Input Type

None

Return Type

ISDecisions.UserLockLibrary.MachineState or None

Notes

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

Example

powershell
Get-UserLockAgentDistribution -UserLockServerName MyUlSrv

Gets the distribution status of UserLock desktop agents in the zone protected by the 'MyUlSrv' UserLock server.

Get-UserLockAgentDistributionConfiguration

Install-UserLockAgent

Uninstall-UserLockAgent

Stop-UserLockComputer

Restart-UserLockComputer

Start-UserLockComputer

Get-UserLockCommand