UserLock API
Public Types | Public Member Functions | Properties | List of all members
AgentDistributionProperties Class Reference

Agent distribution properties. See the property AgentDistributionProperties of the UserLockServer class to retrieve an instance of this class and update it. More...

Inherits UlServerComponent.

Public Types

enum  PropertyList { , Deployer = ForceReboot | ForceClose | RebootTimeOut | ExcludeServers | CheckPrevious | DeployMode | AutoMode | EnableRemoteRegistry | UrlOverInternet , Agent = DisplayErrors | DisableRefusedConnections | JoinMode | ProtectConsole | ScreenSaverAsLock , ComputerLists = ExcludedComputers | ExcludedComputersAuto | IncludedComputers , All = Deployer | Agent }
 Agent distribution property list. See the method SetInfo of the AgentDistributionProperties class. More...
 

Public Member Functions

override void GetInfo ()
 Get all properties from the UserLock server More...
 
void GetInfo (PropertyList propertyList)
 Retrieve selected properties from the UserLock server More...
 
override void SetInfo ()
 Upload all properties to the UserLock server. More...
 
void SetInfo (PropertyList propertyList)
 Upload selected properties to the UserLock server More...
 

Properties

bool ForceReboot [get, set]
 Get/set if a workstation is automatically rebooted if needed once the agent has been installed/uninstalled. More...
 
bool ForceClose [get, set]
 Get/set if applications are forced to close when a workstation needs to be rebooted. More...
 
int RebootTimeOut [get, set]
 Get/Set the notification timeout when a workstation needs to be rebooted. More...
 
bool ExcludeServers [get, set]
 Get/set if the automatic deployment mode installs the agent on servers (False by default). More...
 
bool CheckPrevious [get, set]
 Get/set if UserLock still checks computers on which the agent has already been deployed (True by default. Recommended to let the default value). More...
 
bool DeployMode [get, set]
 Get set if the automatic deployer will install (true) or uninstall (false) the agent. See the example in the AgentDistributionProperties property of the UserLockServer class. More...
 
bool AutoMode [get, set]
 Get/set if the automatic deployer is started. See the example in the AgentDistributionProperties property of the UserLockServer class. More...
 
bool EnableRemoteRegistry [get, set]
 Get/set if UserLock will automatically enable the Remote Registry service on computers to protect. More...
 
bool DisplayErrors [get, set]
 Get/set if the agent displays errors to the user (false by default). More...
 
bool DisableRefusedConnections [get, set]
 Get/set if logons denied Windows should not be notified to the UserLock server (false by default, logon denied by Windows are sent to the UserLock server). More...
 
JoinMode JoinMode [get, set]
 Get/set if UserLock should make a user join any existing terminal session on the same terminal server. See the enum JoinMode. Default value: JoinMode.Always. More...
 
bool ProtectConsole [get, set]
 Get/set if the session on the local console should be protected on servers. More...
 
bool ScreenSaverAsLock [get, set]
 Get/set if screensaver time should be considered as locked time. More...
 
List< string > IncludedComputers [get]
 By default, empty. List of computers that are not in the network zone protected by UserLock, but that you want to include in the protection. For each device, add its NetBIOS name. After that, restart the UserLock service. More...
 
List< string > ExcludedComputers [get]
 By default, empty. List of computers that are in the network zone protected by UserLock, but that you want to exclude from the protection. For each device, add its NetBIOS name. After that, restart the UserLock service. More...
 
List< string > ExcludedAutoComputers [get]
 By default, empty. List of computers that are in the network zone protected by UserLock, but that you want to exclude from the Desktop Agent auto-deployment. For each device, add its NetBIOS name. After that, restart the UserLock service. More...
 
string UrlToContactOverInternet [get, set]
 Public URL to the UserLock proxy application. If set, this will permit agents to contact the service then outside the network. More...
 

Detailed Description

Agent distribution properties. See the property AgentDistributionProperties of the UserLockServer class to retrieve an instance of this class and update it.

Member Enumeration Documentation

Agent distribution property list. See the method SetInfo of the AgentDistributionProperties class.

Enumerator
Deployer 

Deployer properties

Agent 

Agent configuration properties

ComputerLists 

Custom lists of computers to include/exclude from the protected network zone

All 

All properties

Member Function Documentation

override void GetInfo ( )

Get all properties from the UserLock server

void GetInfo ( PropertyList  propertyList)

Retrieve selected properties from the UserLock server

Parameters
propertyListList of properties to retrieve from the UserLock server. See the enum PropertyList
override void SetInfo ( )

Upload all properties to the UserLock server.

void SetInfo ( PropertyList  propertyList)

Upload selected properties to the UserLock server

Parameters
propertyListList of properties to upload to the UserLock server. See the enum PropertyList

Property Documentation

bool ForceReboot
getset

Get/set if a workstation is automatically rebooted if needed once the agent has been installed/uninstalled.

bool ForceClose
getset

Get/set if applications are forced to close when a workstation needs to be rebooted.

int RebootTimeOut
getset

Get/Set the notification timeout when a workstation needs to be rebooted.

bool ExcludeServers
getset

Get/set if the automatic deployment mode installs the agent on servers (False by default).

bool CheckPrevious
getset

Get/set if UserLock still checks computers on which the agent has already been deployed (True by default. Recommended to let the default value).

bool DeployMode
getset

Get set if the automatic deployer will install (true) or uninstall (false) the agent. See the example in the AgentDistributionProperties property of the UserLockServer class.

bool AutoMode
getset

Get/set if the automatic deployer is started. See the example in the AgentDistributionProperties property of the UserLockServer class.

bool EnableRemoteRegistry
getset

Get/set if UserLock will automatically enable the Remote Registry service on computers to protect.

bool DisplayErrors
getset

Get/set if the agent displays errors to the user (false by default).

bool DisableRefusedConnections
getset

Get/set if logons denied Windows should not be notified to the UserLock server (false by default, logon denied by Windows are sent to the UserLock server).

Get/set if UserLock should make a user join any existing terminal session on the same terminal server. See the enum JoinMode. Default value: JoinMode.Always.

bool ProtectConsole
getset

Get/set if the session on the local console should be protected on servers.

bool ScreenSaverAsLock
getset

Get/set if screensaver time should be considered as locked time.

List<string> IncludedComputers
get

By default, empty. List of computers that are not in the network zone protected by UserLock, but that you want to include in the protection. For each device, add its NetBIOS name. After that, restart the UserLock service.

List<string> ExcludedComputers
get

By default, empty. List of computers that are in the network zone protected by UserLock, but that you want to exclude from the protection. For each device, add its NetBIOS name. After that, restart the UserLock service.

List<string> ExcludedAutoComputers
get

By default, empty. List of computers that are in the network zone protected by UserLock, but that you want to exclude from the Desktop Agent auto-deployment. For each device, add its NetBIOS name. After that, restart the UserLock service.

string UrlToContactOverInternet
getset

Public URL to the UserLock proxy application. If set, this will permit agents to contact the service then outside the network.